vendor/pimcore/admin-ui-classic-bundle/src/Controller/Admin/MiscController.php line 210

  1. <?php
  2. declare(strict_types=1);
  4. /**
  5.  * Pimcore
  6.  *
  7.  * This source file is available under two different licenses:
  8.  * - GNU General Public License version 3 (GPLv3)
  9.  * - Pimcore Commercial License (PCL)
  10.  * Full copyright and license information is available in
  11.  * LICENSE.md which is distributed with this source code.
  12.  *
  13.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  14.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  15.  */
  17. namespace Pimcore\Bundle\AdminBundle\Controller\Admin;
  19. use Pimcore\Bundle\AdminBundle\Controller\AdminAbstractController;
  20. use Pimcore\Bundle\AdminBundle\System\AdminConfig;
  21. use Pimcore\Bundle\AdminBundle\Tool as AdminTool;
  22. use Pimcore\Config;
  23. use Pimcore\Controller\Config\ControllerDataProvider;
  24. use Pimcore\Localization\LocaleServiceInterface;
  25. use Pimcore\Tool;
  26. use Pimcore\Tool\Storage;
  27. use Pimcore\Translation\Translator;
  28. use Symfony\Component\HttpFoundation\BinaryFileResponse;
  29. use Symfony\Component\HttpFoundation\JsonResponse;
  30. use Symfony\Component\HttpFoundation\Request;
  31. use Symfony\Component\HttpFoundation\Response;
  32. use Symfony\Component\HttpKernel\Profiler\Profiler;
  33. use Symfony\Component\Routing\Annotation\Route;
  34. use Symfony\Contracts\Translation\TranslatorInterface;
  36. /**
  37.  * @Route("/misc")
  38.  *
  39.  * @internal
  40.  */
  41. class MiscController extends AdminAbstractController
  42. {
  43.     /**
  44.      * @Route("/get-available-controller-references", name="pimcore_admin_misc_getavailablecontroller_references", methods={"GET"})
  45.      *
  46.      * @param Request $request
  47.      * @param ControllerDataProvider $provider
  48.      *
  49.      * @return JsonResponse
  50.      */
  51.     public function getAvailableControllerReferencesAction(Request $request, ControllerDataProvider $provider): JsonResponse
  52.     {
  53.         $controllerReferences = $provider->getControllerReferences();
  55.         $result = array_map(function ($controller) {
  56.             return [
  57.                 'name' => $controller,
  58.             ];
  59.         }, $controllerReferences);
  61.         return $this->adminJson([
  62.             'success' => true,
  63.             'data' => $result,
  64.             'total' => count($result),
  65.         ]);
  66.     }
  68.     /**
  69.      * @Route("/get-available-templates", name="pimcore_admin_misc_getavailabletemplates", methods={"GET"})
  70.      *
  71.      * @param ControllerDataProvider $provider
  72.      *
  73.      * @return JsonResponse
  74.      */
  75.     public function getAvailableTemplatesAction(ControllerDataProvider $provider): JsonResponse
  76.     {
  77.         $templates = $provider->getTemplates();
  79.         sort($templates, SORT_NATURAL | SORT_FLAG_CASE);
  81.         $result = array_map(static function ($template) {
  82.             return [
  83.                 'path' => $template,
  84.             ];
  85.         }, $templates);
  87.         return $this->adminJson([
  88.             'data' => $result,
  89.         ]);
  90.     }
  92.     /**
  93.      * @Route("/json-translations-system", name="pimcore_admin_misc_jsontranslationssystem", methods={"GET"})
  94.      *
  95.      *
  96.      */
  97.     public function jsonTranslationsSystemAction(Request $request, TranslatorInterface $translator): Response
  98.     {
  99.         $language = $request->get('language');
  101.         /** @var Translator $translator */
  102.         $translator->lazyInitialize('admin', $language);
  104.         $translations = [];
  106.         $fallbackLanguages = [];
  107.         if (null !== \Locale::getRegion($language)) {
  108.             // if language is region specific, add the primary language as fallback
  109.             $fallbackLanguages[] = \Locale::getPrimaryLanguage($language);
  110.         }
  111.         if ($language != 'en') {
  112.             // add en as a fallback
  113.             $fallbackLanguages[] = 'en';
  114.         }
  116.         foreach (['admin', 'admin_ext'] as $domain) {
  117.             $translations = array_merge($translations, $translator->getCatalogue($language)->all($domain));
  119.             foreach ($fallbackLanguages as $fallbackLanguage) {
  120.                 $translator->lazyInitialize($domain, $fallbackLanguage);
  121.                 foreach ($translator->getCatalogue($fallbackLanguage)->all($domain) as $key => $value) {
  122.                     if (empty($translations[$key])) {
  123.                         $translations[$key] = $value;
  124.                     }
  125.                 }
  126.             }
  127.         }
  129.         $response = new Response('pimcore.system_i18n = ' . $this->encodeJson($translations) . ';');
  130.         $response->headers->set('Content-Type', 'text/javascript');
  132.         return $response;
  133.     }
  135.     /**
  136.      * @Route("/script-proxy", name="pimcore_admin_misc_scriptproxy", methods={"GET"})
  137.      *
  138.      * @param Request $request
  139.      *
  140.      * @return Response
  141.      *
  142.      * @internal
  143.      */
  144.     public function scriptProxyAction(Request $request): Response
  145.     {
  146.         $storageFile = $request->get('storageFile');
  147.         if(!$storageFile) {
  148.             throw new \InvalidArgumentException('The parameter storageFile is required');
  149.         }
  151.         $fileExtension = pathinfo($storageFile, PATHINFO_EXTENSION);
  152.         $storage = Storage::get('admin');
  153.         $scriptsContent = $storage->read($storageFile);
  155.         if (!empty($scriptsContent)) {
  156.             $contentType = 'text/javascript';
  157.             if ($fileExtension == 'css') {
  158.                 $contentType = 'text/css';
  159.             }
  161.             $lifetime = 86400;
  163.             $response = new Response($scriptsContent);
  164.             $response->headers->set('Cache-Control', 'max-age=' . $lifetime);
  165.             $response->headers->set('Pragma', '');
  166.             $response->headers->set('Content-Type', $contentType);
  167.             $response->headers->set('Expires', gmdate('D, d M Y H:i:s', time() + $lifetime) . ' GMT');
  169.             return $response;
  170.         } else {
  171.             throw $this->createNotFoundException('Scripts not found');
  172.         }
  173.     }
  175.     /**
  176.      * @Route("/admin-css", name="pimcore_admin_misc_admincss", methods={"GET"})
  177.      *
  178.      * @param Request $request
  179.      * @param Config $config
  180.      *
  181.      * @return Response
  182.      */
  183.     public function adminCssAction(Request $request, Config $config): Response
  184.     {
  185.         // customviews config
  186.         $cvData = \Pimcore\Bundle\AdminBundle\CustomView\Config::get();
  188.         // languages
  189.         $languages = \Pimcore\Tool::getValidLanguages();
  190.         $adminLanguages = \Pimcore\Tool\Admin::getLanguages();
  191.         $languages = array_unique(array_merge($languages, $adminLanguages));
  193.         $response = $this->render('@PimcoreAdmin/admin/misc/admin_css.html.twig', [
  194.             'customviews' => $cvData,
  195.             'adminSettings' => AdminConfig::get(),
  196.             'languages' => $languages,
  197.         ]);
  198.         $response->headers->set('Content-Type', 'text/css; charset=UTF-8');
  200.         return $response;
  201.     }
  203.     /**
  204.      * @Route("/ping", name="pimcore_admin_misc_ping", methods={"GET"})
  205.      *
  206.      * @param Request $request
  207.      *
  208.      * @return JsonResponse
  209.      */
  210.     public function pingAction(Request $request): JsonResponse
  211.     {
  212.         $response = [
  213.             'success' => true,
  214.         ];
  216.         return $this->adminJson($response);
  217.     }
  219.     /**
  220.      * @Route("/available-languages", name="pimcore_admin_misc_availablelanguages", methods={"GET"})
  221.      *
  222.      * @param Request $request
  223.      *
  224.      * @return Response
  225.      */
  226.     public function availableLanguagesAction(Request $request): Response
  227.     {
  228.         $locales = Tool::getSupportedLocales();
  229.         $response = new Response('pimcore.available_languages = ' . $this->encodeJson($locales) . ';');
  230.         $response->headers->set('Content-Type', 'text/javascript');
  232.         return $response;
  233.     }
  235.     /**
  236.      * @Route("/get-valid-filename", name="pimcore_admin_misc_getvalidfilename", methods={"GET"})
  237.      *
  238.      * @param Request $request
  239.      *
  240.      * @return JsonResponse
  241.      */
  242.     public function getValidFilenameAction(Request $request): JsonResponse
  243.     {
  244.         return $this->adminJson([
  245.             'filename' => \Pimcore\Model\Element\Service::getValidKey($request->get('value'), $request->get('type')),
  246.         ]);
  247.     }
  249.     /**
  250.      * @Route("/maintenance", name="pimcore_admin_misc_maintenance", methods={"POST"})
  251.      *
  252.      * @param Request $request
  253.      *
  254.      * @return JsonResponse
  255.      */
  256.     public function maintenanceAction(Request $request): JsonResponse
  257.     {
  258.         $this->checkPermission('maintenance_mode');
  260.         if ($request->get('activate')) {
  261.             Tool\Admin::activateMaintenanceMode($request->getSession()->getId());
  262.         }
  264.         if ($request->get('deactivate')) {
  265.             Tool\Admin::deactivateMaintenanceMode();
  266.         }
  268.         return $this->adminJson([
  269.             'success' => true,
  270.         ]);
  271.     }
  273.     /**
  274.      * @Route("/country-list", name="pimcore_admin_misc_countrylist", methods={"GET"})
  275.      *
  276.      * @param LocaleServiceInterface $localeService
  277.      *
  278.      * @return JsonResponse
  279.      */
  280.     public function countryListAction(LocaleServiceInterface $localeService): JsonResponse
  281.     {
  282.         $countries = $localeService->getDisplayRegions();
  283.         asort($countries);
  284.         $options = [];
  286.         foreach ($countries as $short => $translation) {
  287.             if (strlen($short) == 2) {
  288.                 $options[] = [
  289.                     'name' => $translation,
  290.                     'code' => $short,
  291.                 ];
  292.             }
  293.         }
  295.         return $this->adminJson(['data' => $options]);
  296.     }
  298.     /**
  299.      * @Route("/language-list", name="pimcore_admin_misc_languagelist", methods={"GET"})
  300.      *
  301.      * @param Request $request
  302.      *
  303.      * @return JsonResponse
  304.      */
  305.     public function languageListAction(Request $request): JsonResponse
  306.     {
  307.         $locales = Tool::getSupportedLocales();
  308.         $options = [];
  310.         foreach ($locales as $short => $translation) {
  311.             $options[] = [
  312.                 'name' => $translation,
  313.                 'code' => $short,
  314.             ];
  315.         }
  317.         return $this->adminJson(['data' => $options]);
  318.     }
  320.     /**
  321.      * @Route("/get-language-flag", name="pimcore_admin_misc_getlanguageflag", methods={"GET"})
  322.      *
  323.      * @param Request $request
  324.      *
  325.      * @return BinaryFileResponse
  326.      */
  327.     public function getLanguageFlagAction(Request $request): BinaryFileResponse
  328.     {
  329.         $iconPath = AdminTool::getLanguageFlagFile($request->get('language'));
  330.         $response = new BinaryFileResponse($iconPath);
  331.         $response->headers->set('Content-Type', 'image/svg+xml');
  333.         return $response;
  334.     }
  336.     /**
  337.      * @Route("/icon-list", name="pimcore_admin_misc_iconlist", methods={"GET"})
  338.      *
  339.      * @param Request $request
  340.      * @param Profiler|null $profiler
  341.      *
  342.      * @return Response
  343.      */
  344.     public function iconListAction(Request $request, ?Profiler $profiler): Response
  345.     {
  346.         if ($profiler) {
  347.             $profiler->disable();
  348.         }
  350.         $publicDir = PIMCORE_WEB_ROOT . '/bundles/pimcoreadmin';
  351.         $iconDir = $publicDir . '/img';
  352.         $colorIcons = rscandir($iconDir . '/flat-color-icons/');
  353.         $whiteIcons = rscandir($iconDir . '/flat-white-icons/');
  354.         $twemoji = rscandir($iconDir . '/twemoji/');
  356.         //flag icons for locales
  357.         $locales = Tool::getSupportedLocales();
  358.         $languageOptions = [];
  359.         foreach ($locales as $short => $translation) {
  360.             if (!empty($short)) {
  361.                 $languageOptions[] = [
  362.                     'language' => $short,
  363.                     'display' => $translation . " ($short)",
  364.                     'flag' => AdminTool::getLanguageFlagFile($short, true),
  365.                 ];
  366.             }
  367.         }
  369.         $iconsCss = file_get_contents($publicDir . '/css/icons.css');
  371.         return $this->render('@PimcoreAdmin/admin/misc/icon_list.html.twig', [
  372.             'colorIcons' => $colorIcons,
  373.             'whiteIcons' => $whiteIcons,
  374.             'twemoji' => $twemoji,
  375.             'languageOptions' => $languageOptions,
  376.             'iconsCss' => $iconsCss,
  377.         ]);
  378.     }
  380.     /**
  381.      * @Route("/test", name="pimcore_admin_misc_test")
  382.      *
  383.      * @param Request $request
  384.      *
  385.      * @return Response
  386.      */
  387.     public function testAction(Request $request): Response
  388.     {
  389.         return new Response('done');
  390.     }
  391. }