src/Controller/ConfigureHelpdesk.php line 57

Open in your IDE?
  1. <?php
  2. namespace App\Controller;
  3. use App\Console\Wizard\ConfigureHelpdesk as Helpdesk;
  4. use Doctrine\DBAL\DriverManager;
  5. use Doctrine\ORM\Tools\Setup;
  6. use Doctrine\ORM\EntityManager;
  7. use Symfony\Bundle\FrameworkBundle\Console\Application;
  8. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  9. use Symfony\Component\Yaml\Yaml;
  10. use Symfony\Component\HttpFoundation\Request;
  11. use Symfony\Component\HttpFoundation\Response;
  12. use Symfony\Component\Console\Input\ArrayInput;
  13. use Symfony\Component\Console\Output\NullOutput;
  14. use Symfony\Component\HttpKernel\KernelInterface;
  15. use Symfony\Component\HttpFoundation\JsonResponse;
  16. use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;
  17. use Webkul\UVDesk\CoreFrameworkBundle\Entity\SupportRole;
  18. use Webkul\UVDesk\CoreFrameworkBundle\Entity\User;
  19. use Webkul\UVDesk\CoreFrameworkBundle\Entity\UserInstance;
  20. use Webkul\UVDesk\CoreFrameworkBundle\Services\UVDeskService;
  21. class ConfigureHelpdesk extends AbstractController
  22. {
  23.     const DB_URL_TEMPLATE "mysql://[user]:[password]@[host]:[port]";
  24.     const DB_ENV_PATH_TEMPLATE "DATABASE_URL=DB_DRIVER://DB_USER:DB_PASSWORD@DB_HOST/DB_NAME\n";
  25.     const DB_ENV_PATH_PARAM_TEMPLATE "env(DATABASE_URL): 'DB_DRIVER://DB_USER:DB_PASSWORD@DB_HOST/DB_NAME'\n";
  26.     const DEFAULT_JSON_HEADERS = [
  27.         'Content-Type' => 'application/json',
  28.     ];
  29.     private static $requiredExtensions = [
  30.         [
  31.             'name' => 'imap',
  32.         ],
  33.         [
  34.             'name' => 'mailparse',
  35.         ],
  36.         [
  37.             'name' => 'mysqli',
  38.         ],
  39.     ];
  40.     private static $requiredConfigfiles = [
  41.         [
  42.             'name' => 'uvdesk',
  43.         ],
  44.         [
  45.             'name' => 'swiftmailer',
  46.         ],
  47.         [
  48.             'name' => 'uvdesk_mailbox',
  49.         ],
  50.     ];
  51.     public function load()
  52.     {
  53.         return $this->render('installation-wizard/index.html.twig');
  54.     }
  55.     public function evaluateSystemRequirements(Request $requestKernelInterface $kernel)
  56.     {
  57.         $max_execution_time ini_get('max_execution_time');
  58.         // Evaluate system specification requirements
  59.         switch (strtolower($request->request->get('specification'))) {
  60.             case 'php-version':
  61.                 $response = [
  62.                     'status'  => version_compare(phpversion(), '7.0.0''<') ? false true,
  63.                     'version' => sprintf('%s.%s.%s'PHP_MAJOR_VERSIONPHP_MINOR_VERSIONPHP_RELEASE_VERSION),
  64.                 ];
  65.                 if ($response['status']) {
  66.                     $response['message'] = sprintf('Using PHP v%s'$response['version']);
  67.                 } else {
  68.                     $response['message'] = sprintf('Currently using PHP v%s. Please use PHP 7 or greater.'$response['version']);
  69.                 }
  70.                 break;
  71.             case 'php-extensions':
  72.                 $extensions_status array_map(function ($extension) {
  73.                     return [
  74.                         $extension['name'] => extension_loaded($extension['name']),
  75.                     ];
  76.                 }, self::$requiredExtensions);
  77.                 $response = [
  78.                     'extensions' => $extensions_status,
  79.                 ];
  80.                 break;
  81.             case 'php-maximum-execution':
  82.                 $response['status' ] = $max_execution_time >= 30 true false;
  83.                 if ($response['status']) {
  84.                     $response['message'] = sprintf('Maximum execution time is %s'ini_get('max_execution_time').' sec');
  85.                 } else {
  86.                     $response['message'] = sprintf('Please increase your max execution time.' );
  87.                     $response['description'] = '</span>Issue can be resolved by simply<p><a href="https://www.simplified.guide/php/increase-max-execution-time" target="_blank"> increasing your maximum execution time</a> make it 60 or more and restart your server after making this change, refresh the browser and try again.</p>';
  88.                 }
  89.                 break;
  90.             case 'php-envfile-permission':
  91.                     $filename =  $kernel->getProjectDir().'/.env';
  92.                     $response['status'] = is_writable($filename) ? true false;
  93.    
  94.                     if ($response['status']) {
  95.                         $response['message'] = sprintf('Read/Write permission enabled for .env file.');
  96.                     } else {
  97.                         $response['message'] = sprintf('Please enable read/write permission for <b>.env</b> file of your project.');
  98.                         $response['description'] = '</span> Issue can be resolved by simply <a href="https://www.uvdesk.com/en/blog/open-source-helpdesk-installation-on-ubuntu-uvdesk/" target="_blank"><p> enabling your <b>.env</b> file read/write permission</a> refresh the browser and try again.</p>';
  99.                     }
  100.                 break;
  101.             case 'php-configfiles-permission':
  102.                     $configfiles_status array_map(function ($configfile) use ($kernel) {
  103.                         return [
  104.                             $configfile['name'] => is_writable($kernel->getProjectDir().'/config/packages/'.$configfile['name'].'.yaml') ,
  105.                         ];
  106.                     }, self::$requiredConfigfiles);
  107.    
  108.                     $response = [
  109.                         'configfiles' => $configfiles_status,
  110.                         'description' => '</span> <br><p> Issue can be resolved by simply <a href="https://www.uvdesk.com/en/blog/open-source-helpdesk-installation-on-ubuntu-uvdesk/" target="_blank"> enabling read/write permissions for your files under config/packages folder of your project.</a></p>',
  111.                     ];
  112.                 break;
  113.             case 'redis-status':
  114.                 if (extension_loaded('redis')) {
  115.                     return new JsonResponse([
  116.                         'status'      => false,
  117.                         'message'     => "Redis extension is installed on your server follow the details",               
  118.                         'description' =>'<span>Please check the  <a href="https://github.com/uvdesk/community-skeleton/issues/364#issuecomment-780486976" target="_blank">Redis host</a> specified in the <span style="font-weight:600;">setup.php</span> file. If your Redis server host is different, you can either update it with your Redis host or follow the steps in the <a href="https://github.com/uvdesk/community-skeleton/issues/364#issuecomment-780486976" target="_blank">URL</a>. After making the changes, reload the page and try again.</span>'
  119.                         ]);
  120.                 }
  121.                 break;
  122.             default:
  123.                 $code 404;
  124.                 break;
  125.         }
  126.         
  127.         return new Response(json_encode($response ?? []), $code ?? 200self::DEFAULT_JSON_HEADERS);
  128.     }
  129.     public function verifyDatabaseCredentials(Request $request)
  130.     {
  131.         if (session_status() == PHP_SESSION_NONE) {
  132.             session_start();
  133.         }
  134.         
  135.         try {
  136.             $connectionUrl strtr(self::DB_URL_TEMPLATE, [
  137.                 '[host]'     => $request->request->get('serverName'),
  138.                 '[port]'     => $request->request->get('serverPort'),
  139.                 '[user]'     => $request->request->get('username'),
  140.                 '[password]' => $request->request->get('password'),
  141.             ]);
  142.             if ($request->request->get('serverVersion') != null) {
  143.                 $connectionUrl .= "?serverVersion=" $request->request->get('serverVersion');
  144.             }
  145.             $databaseConnection DriverManager::getConnection([
  146.                 'url' => $connectionUrl,
  147.             ]);
  148.             $entityManager EntityManager::create($databaseConnectionSetup::createAnnotationMetadataConfiguration(['src/Entity'], false));
  149.             
  150.             // Establish a connection if not active
  151.             if (false == $databaseConnection->isConnected()) {
  152.                 $databaseConnection->connect();
  153.             }
  154.             // Check if database exists
  155.             $createDatabase = (bool) $request->request->get('createDatabase');
  156.             if (
  157.                 ! in_array($request->request->get('database'), $databaseConnection->getSchemaManager()->listDatabases()) 
  158.                 && false == $createDatabase
  159.             ) {
  160.                 return new JsonResponse([
  161.                     'status'  => false,
  162.                     'message' => "The requested database was not found."
  163.                 ]);
  164.             }
  165.             // Storing database configuration to session.
  166.             $_SESSION['DB_CONFIG'] = [
  167.                 'host'           => $request->request->get('serverName'),
  168.                 'port'           => $request->request->get('serverPort'),
  169.                 'version'        => $request->request->get('serverVersion'),
  170.                 'username'       => $request->request->get('username'),
  171.                 'password'       => $request->request->get('password'),
  172.                 'database'       => $request->request->get('database'),
  173.                 'createDatabase' => $createDatabase,
  174.             ];
  175.         } catch (\Exception $e) {
  176.             return new JsonResponse([
  177.                 'status'  => false,
  178.                 'message' => "Failed to establish a connection with database server."
  179.             ]);
  180.         }
  181.         
  182.         return new JsonResponse(['status' => true]);
  183.     }
  184.     public function prepareSuperUserDetailsXHR(Request $request)
  185.     {
  186.         if (session_status() == PHP_SESSION_NONE) {
  187.             session_start();
  188.         }
  189.         
  190.         // unset($_SESSION['USER_DETAILS']);
  191.         $_SESSION['USER_DETAILS'] = [
  192.             'name'     => $request->request->get('name'),
  193.             'email'    => $request->request->get('email'),
  194.             'password' => $request->request->get('password'),
  195.         ];
  196.         return new Response(json_encode(['status' => true]), 200self::DEFAULT_JSON_HEADERS);
  197.     }
  198.     public function updateConfigurationsXHR(Request $requestKernelInterface $kernel)
  199.     {
  200.         if (session_status() == PHP_SESSION_NONE) {
  201.             session_start();
  202.         }
  203.         $database_host    $_SESSION['DB_CONFIG']['host'];
  204.         $database_port    $_SESSION['DB_CONFIG']['port'];
  205.         $database_version $_SESSION['DB_CONFIG']['version'];
  206.         $database_user    $_SESSION['DB_CONFIG']['username'];
  207.         $database_pass    $_SESSION['DB_CONFIG']['password'];
  208.         $database_name    $_SESSION['DB_CONFIG']['database'];
  209.         $create_database $_SESSION['DB_CONFIG']['createDatabase'];
  210.         try {
  211.             $connectionUrl strtr(self::DB_URL_TEMPLATE, [
  212.                 '[host]'     => $database_host,
  213.                 '[port]'     => $database_port,
  214.                 '[user]'     => $database_user,
  215.                 '[password]' => $database_pass,
  216.             ]);
  217.             if (! empty($database_version)) {
  218.                 $connectionUrl .= "?serverVersion=$database_version";
  219.             }
  220.             $databaseConnection DriverManager::getConnection([
  221.                 'url' => $connectionUrl,
  222.             ]);
  223.             $entityManager EntityManager::create($databaseConnectionSetup::createAnnotationMetadataConfiguration(['src/Entity'], false));
  224.             // Establish an active connection with database server
  225.             if (false == $databaseConnection->isConnected()) {
  226.                 $databaseConnection->connect();
  227.             }
  228.             // Check if database exists
  229.             if (! in_array($database_name$databaseConnection->getSchemaManager()->listDatabases())) {
  230.                 if (false == $create_database) {
  231.                     throw new \Exception('Database does not exist.');
  232.                 }
  233.                 
  234.                 // Create database
  235.                 $databaseConnection->getSchemaManager()->createDatabase($databaseConnection->getDatabasePlatform()->quoteSingleIdentifier($database_name));
  236.             }
  237.             $connectionUrl strtr(self::DB_URL_TEMPLATE "/[database]", [
  238.                 '[host]'     => $database_host,
  239.                 '[port]'     => $database_port,
  240.                 '[user]'     => $database_user,
  241.                 '[password]' => $database_pass,
  242.                 '[database]' => $database_name,
  243.             ]);
  244.             if (!empty($database_version)) {
  245.                 $connectionUrl .= "?serverVersion=$database_version";
  246.             }
  247.             // Update .env
  248.             $application = new Application($kernel);
  249.             $application->setAutoExit(false);
  250.             $returnCode $application->run(new ArrayInput([
  251.                 'command' => 'uvdesk_wizard:env:update'
  252.                 'name'    => 'DATABASE_URL'
  253.                 'value'   => $connectionUrl
  254.             ]), new NullOutput());
  255.     
  256.             if (=== $returnCode) {
  257.                 return new JsonResponse(['success' => true]);
  258.             }
  259.         } catch (\Exception $e) {
  260.             return new JsonResponse([
  261.                 'status'  => false,
  262.                 'message' => "An unexpected error occurred: " $e->getMessage(), 
  263.             ]);
  264.         }
  265.         return new JsonResponse(['success' => false], 500);
  266.     }
  267.     public function migrateDatabaseSchemaXHR(Request $requestKernelInterface $kernel)
  268.     {
  269.         $application = new Application($kernel);
  270.         $application->setAutoExit(false);
  271.         $resultCode $application->run(new ArrayInput([
  272.             'command' => 'uvdesk_wizard:database:migrate'
  273.         ]), new NullOutput());
  274.         
  275.         return new Response(json_encode([]), 200self::DEFAULT_JSON_HEADERS);
  276.     }
  277.     public function populateDatabaseEntitiesXHR(Request $requestKernelInterface $kernel)
  278.     {
  279.         $application = new Application($kernel);
  280.         $application->setAutoExit(false);
  281.         $resultCode $application->run(new ArrayInput([
  282.             'command'  => 'doctrine:fixtures:load',
  283.             '--append' => true,
  284.         ]), new NullOutput());
  285.         return new Response(json_encode([]), 200self::DEFAULT_JSON_HEADERS);
  286.     }
  287.     public function createDefaultSuperUserXHR(Request $requestUserPasswordEncoderInterface $encoder)
  288.     {
  289.         if (session_status() == PHP_SESSION_NONE) {
  290.             session_start();
  291.         }
  292.         // $entityManager = $this->getDoctrine()->getEntityManager();
  293.         $entityManager $this->getDoctrine()->getManager();
  294.         $role $entityManager->getRepository(SupportRole::class)->findOneByCode('ROLE_SUPER_ADMIN');
  295.         $userInstance $entityManager->getRepository(UserInstance::class)->findOneBy([
  296.             'isActive'    => true,
  297.             'supportRole' => $role,
  298.         ]);
  299.             
  300.         if (empty($userInstance)) {
  301.             list($name$email$password) = array_values($_SESSION['USER_DETAILS']);
  302.             // Retrieve existing user or generate new empty user
  303.             $accountExistsFlag false;
  304.             $user $entityManager->getRepository(User::class)->findOneByEmail($email) ?: (new User())->setEmail($email);
  305.             if ($user->getId() != null) {
  306.                 $userInstance $user->getAgentInstance();
  307.                 if (!empty($userInstance)) {
  308.                     $accountExistsFlag true;
  309.                     if ($userInstance->getSupportRole()->getId() != $role->getId()) {
  310.                         $userInstance->setSupportRole($role);
  311.                         $entityManager->persist($userInstance);
  312.                         $entityManager->flush();
  313.                     }
  314.                 }
  315.             } else {
  316.                 $username explode(' '$name2);
  317.                 $encodedPassword $encoder->encodePassword($user$password);
  318.                 $user
  319.                     ->setFirstName($username[0])
  320.                     ->setLastName(! empty($username[1]) ? $username[1] : '')
  321.                     ->setPassword($encodedPassword)
  322.                     ->setIsEnabled(true);
  323.                 
  324.                 $entityManager->persist($user);
  325.                 $entityManager->flush();
  326.             }
  327.             
  328.             if (false == $accountExistsFlag) {
  329.                 $userInstance = new UserInstance();
  330.                 $userInstance->setSource('website');
  331.                 $userInstance->setIsActive(true);
  332.                 $userInstance->setIsVerified(true);
  333.                 $userInstance->setUser($user);
  334.                 $userInstance->setSupportRole($role);
  335.                 $entityManager->persist($userInstance);
  336.                 $entityManager->flush();
  337.             }
  338.         }
  339.         return new Response(json_encode([]), 200self::DEFAULT_JSON_HEADERS);
  340.     }
  341.     public function websiteConfigurationXHR(Request $requestUVDeskService $uvdesk)
  342.     {
  343.         switch ($request->getMethod()) {
  344.             case "GET":
  345.                 $currentWebsitePrefixCollection $uvdesk->getCurrentWebsitePrefixes();
  346.                 
  347.                 if ($currentWebsitePrefixCollection) {
  348.                     $result $currentWebsitePrefixCollection;
  349.                     $result['status'] = true;
  350.                 } else {
  351.                     $result['status'] = false;
  352.                 }
  353.                 break;
  354.             case "POST":
  355.                 if (session_status() == PHP_SESSION_NONE) {
  356.                     session_start();
  357.                 }
  358.                 
  359.                 $_SESSION['PREFIXES_DETAILS'] = [
  360.                     'member'   => $request->request->get('member-prefix'),
  361.                     'customer' => $request->request->get('customer-prefix'),
  362.                 ];
  363.                 $result = ['status' => true];
  364.                 break;
  365.             default:
  366.                 break;
  367.         }
  368.         return new Response(json_encode($result ?? []), 200self::DEFAULT_JSON_HEADERS);
  369.     }
  370.     public function updateWebsiteConfigurationXHR(Request $requestUVDeskService $uvdesk)
  371.     {
  372.         if (session_status() == PHP_SESSION_NONE) {
  373.             session_start();
  374.         }
  375.         $collectionURL$uvdesk->updateWebsitePrefixes(
  376.             $_SESSION['PREFIXES_DETAILS']['member'],
  377.             $_SESSION['PREFIXES_DETAILS']['customer']
  378.         );
  379.         
  380.         // uvdesk tracker
  381.         $userDetails =[
  382.             'name'   => $_SESSION['USER_DETAILS']['name'],
  383.             'email'  => $_SESSION['USER_DETAILS']['email'],
  384.             'domain' => $this->getParameter('uvdesk.site_url'),
  385.         ];
  386.         
  387.         Helpdesk::addUserDetailsInTracker($userDetails);
  388.         return new Response(json_encode($collectionURL), 200self::DEFAULT_JSON_HEADERS);
  389.     }
  390. }