vendor/pimcore/pimcore/bundles/AdminBundle/Controller/Admin/SettingsController.php line 72

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Bundle\AdminBundle\Controller\Admin;
  18. use Pimcore\Bundle\AdminBundle\Controller\AdminController;
  19. use Pimcore\Cache;
  20. use Pimcore\Cache\Core\CoreCacheHandler;
  21. use Pimcore\Cache\Symfony\CacheClearer;
  22. use Pimcore\Config;
  23. use Pimcore\Db;
  24. use Pimcore\Event\SystemEvents;
  25. use Pimcore\File;
  26. use Pimcore\Helper\StopMessengerWorkersTrait;
  27. use Pimcore\Localization\LocaleServiceInterface;
  28. use Pimcore\Model;
  29. use Pimcore\Model\Asset;
  30. use Pimcore\Model\Document;
  31. use Pimcore\Model\Element;
  32. use Pimcore\Model\Exception\ConfigWriteException;
  33. use Pimcore\Model\Glossary;
  34. use Pimcore\Model\Metadata;
  35. use Pimcore\Model\Property;
  36. use Pimcore\Model\Staticroute;
  37. use Pimcore\Model\Tool\SettingsStore;
  38. use Pimcore\Model\WebsiteSetting;
  39. use Pimcore\Tool;
  40. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  41. use Symfony\Component\EventDispatcher\GenericEvent;
  42. use Symfony\Component\Filesystem\Filesystem;
  43. use Symfony\Component\HttpFoundation\File\UploadedFile;
  44. use Symfony\Component\HttpFoundation\JsonResponse;
  45. use Symfony\Component\HttpFoundation\Request;
  46. use Symfony\Component\HttpFoundation\Response;
  47. use Symfony\Component\HttpFoundation\StreamedResponse;
  48. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  49. use Symfony\Component\HttpKernel\KernelEvents;
  50. use Symfony\Component\HttpKernel\KernelInterface;
  51. use Symfony\Component\Routing\Annotation\Route;
  52. use Symfony\Component\Yaml\Yaml;
  54. /**
  55.  * @Route("/settings")
  56.  *
  57.  * @internal
  58.  */
  59. class SettingsController extends AdminController
  60. {
  61.     use StopMessengerWorkersTrait;
  63.     private const CUSTOM_LOGO_PATH = 'custom-logo.image';
  65.     /**
  66.      * @Route("/display-custom-logo", name="pimcore_settings_display_custom_logo", methods={"GET"})
  67.      *
  68.      * @param Request $request
  69.      *
  70.      * @return StreamedResponse
  71.      */
  72.     public function displayCustomLogoAction(Request $request)
  73.     {
  74.         $mime = 'image/svg+xml';
  75.         if ($request->get('white')) {
  76.             $logo = PIMCORE_WEB_ROOT . '/bundles/pimcoreadmin/img/logo-claim-white.svg';
  77.         } else {
  78.             $logo = PIMCORE_WEB_ROOT . '/bundles/pimcoreadmin/img/logo-claim-gray.svg';
  79.         }
  81.         $stream = fopen($logo, 'rb');
  83.         $storage = Tool\Storage::get('admin');
  84.         if ($storage->fileExists(self::CUSTOM_LOGO_PATH)) {
  85.             try {
  86.                 $mime = $storage->mimeType(self::CUSTOM_LOGO_PATH);
  87.                 $stream = $storage->readStream(self::CUSTOM_LOGO_PATH);
  88.             } catch (\Exception $e) {
  89.                 // do nothing
  90.             }
  91.         }
  93.         return new StreamedResponse(function () use ($stream) {
  94.             fpassthru($stream);
  95.         }, 200, [
  96.             'Content-Type' => $mime,
  97.             'Content-Security-Policy' => "script-src 'none'",
  98.         ]);
  99.     }
  101.     /**
  102.      * @Route("/upload-custom-logo", name="pimcore_admin_settings_uploadcustomlogo", methods={"POST"})
  103.      *
  104.      * @param Request $request
  105.      *
  106.      * @return JsonResponse
  107.      *
  108.      * @throws \Exception
  109.      */
  110.     public function uploadCustomLogoAction(Request $request)
  111.     {
  112.         $logoFile = $request->files->get('Filedata');
  114.         if (!$logoFile instanceof UploadedFile
  115.             || !in_array($logoFile->guessExtension(), ['svg', 'png', 'jpg'])
  116.         ) {
  117.             throw new \Exception('Unsupported file format.');
  118.         }
  120.         $storage = Tool\Storage::get('admin');
  121.         $storage->writeStream(self::CUSTOM_LOGO_PATH, fopen($logoFile->getPathname(), 'rb'));
  123.         // set content-type to text/html, otherwise (when application/json is sent) chrome will complain in
  124.         // Ext.form.Action.Submit and mark the submission as failed
  126.         $response = $this->adminJson(['success' => true]);
  127.         $response->headers->set('Content-Type', 'text/html');
  129.         return $response;
  130.     }
  132.     /**
  133.      * @Route("/delete-custom-logo", name="pimcore_admin_settings_deletecustomlogo", methods={"DELETE"})
  134.      *
  135.      * @param Request $request
  136.      *
  137.      * @return JsonResponse
  138.      */
  139.     public function deleteCustomLogoAction(Request $request)
  140.     {
  141.         if (Tool\Storage::get('admin')->fileExists(self::CUSTOM_LOGO_PATH)) {
  142.             Tool\Storage::get('admin')->delete(self::CUSTOM_LOGO_PATH);
  143.         }
  145.         return $this->adminJson(['success' => true]);
  146.     }
  148.     /**
  149.      * Used by the predefined metadata grid
  150.      *
  151.      * @Route("/predefined-metadata", name="pimcore_admin_settings_metadata", methods={"POST"})
  152.      *
  153.      * @param Request $request
  154.      *
  155.      * @return JsonResponse
  156.      */
  157.     public function metadataAction(Request $request)
  158.     {
  159.         $this->checkPermission('asset_metadata');
  161.         if ($request->get('data')) {
  162.             if ($request->get('xaction') == 'destroy') {
  163.                 $data = $this->decodeJson($request->get('data'));
  164.                 $id = $data['id'];
  165.                 $metadata = Metadata\Predefined::getById($id);
  166.                 if (!$metadata->isWriteable()) {
  167.                     throw new ConfigWriteException();
  168.                 }
  169.                 $metadata->delete();
  171.                 return $this->adminJson(['success' => true, 'data' => []]);
  172.             } elseif ($request->get('xaction') == 'update') {
  173.                 $data = $this->decodeJson($request->get('data'));
  175.                 // save type
  176.                 $metadata = Metadata\Predefined::getById($data['id']);
  177.                 if (!$metadata->isWriteable()) {
  178.                     throw new ConfigWriteException();
  179.                 }
  180.                 $metadata->setValues($data);
  182.                 $existingItem = Metadata\Predefined\Listing::getByKeyAndLanguage($metadata->getName(), $metadata->getLanguage(), $metadata->getTargetSubtype());
  183.                 if ($existingItem && $existingItem->getId() != $metadata->getId()) {
  184.                     return $this->adminJson(['message' => 'rule_violation', 'success' => false]);
  185.                 }
  187.                 $metadata->minimize();
  188.                 $metadata->save();
  189.                 $metadata->expand();
  191.                 $responseData = $metadata->getObjectVars();
  192.                 $responseData['writeable'] = $metadata->isWriteable();
  194.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  195.             } elseif ($request->get('xaction') == 'create') {
  196.                 if (!(new Metadata\Predefined())->isWriteable()) {
  197.                     throw new ConfigWriteException();
  198.                 }
  199.                 $data = $this->decodeJson($request->get('data'));
  200.                 unset($data['id']);
  202.                 // save type
  203.                 $metadata = Metadata\Predefined::create();
  205.                 $metadata->setValues($data);
  207.                 $existingItem = Metadata\Predefined\Listing::getByKeyAndLanguage($metadata->getName(), $metadata->getLanguage(), $metadata->getTargetSubtype());
  208.                 if ($existingItem) {
  209.                     return $this->adminJson(['message' => 'rule_violation', 'success' => false]);
  210.                 }
  212.                 $metadata->save();
  214.                 $responseData = $metadata->getObjectVars();
  215.                 $responseData['writeable'] = $metadata->isWriteable();
  217.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  218.             }
  219.         } else {
  220.             // get list of types
  221.             $list = new Metadata\Predefined\Listing();
  223.             if ($filter = $request->get('filter')) {
  224.                 $list->setFilter(function (Metadata\Predefined $predefined) use ($filter) {
  225.                     foreach ($predefined->getObjectVars() as $value) {
  226.                         if (stripos($value, $filter) !== false) {
  227.                             return true;
  228.                         }
  229.                     }
  231.                     return false;
  232.                 });
  233.             }
  235.             $properties = [];
  236.             foreach ($list->getDefinitions() as $metadata) {
  237.                 $metadata->expand();
  238.                 $data = $metadata->getObjectVars();
  239.                 $data['writeable'] = $metadata->isWriteable();
  240.                 $properties[] = $data;
  241.             }
  243.             return $this->adminJson(['data' => $properties, 'success' => true, 'total' => $list->getTotalCount()]);
  244.         }
  246.         return $this->adminJson(['success' => false]);
  247.     }
  249.     /**
  250.      * @Route("/get-predefined-metadata", name="pimcore_admin_settings_getpredefinedmetadata", methods={"GET"})
  251.      *
  252.      * @param Request $request
  253.      *
  254.      * @return JsonResponse
  255.      */
  256.     public function getPredefinedMetadataAction(Request $request)
  257.     {
  258.         $type = $request->get('type');
  259.         $subType = $request->get('subType');
  260.         $group = $request->get('group');
  261.         $list = Metadata\Predefined\Listing::getByTargetType($type, [$subType]);
  262.         $result = [];
  263.         foreach ($list as $item) {
  264.             $itemGroup = $item->getGroup() ?? '';
  265.             if ($group === 'default' || $group === $itemGroup) {
  266.                 $item->expand();
  267.                 $data = $item->getObjectVars();
  268.                 $data['writeable'] = $item->isWriteable();
  269.                 $result[] = $data;
  270.             }
  271.         }
  273.         return $this->adminJson(['data' => $result, 'success' => true]);
  274.     }
  276.     /**
  277.      * @Route("/properties", name="pimcore_admin_settings_properties", methods={"POST"})
  278.      *
  279.      * @param Request $request
  280.      *
  281.      * @return JsonResponse
  282.      */
  283.     public function propertiesAction(Request $request)
  284.     {
  285.         if ($request->get('data')) {
  286.             $this->checkPermission('predefined_properties');
  288.             if ($request->get('xaction') == 'destroy') {
  289.                 $data = $this->decodeJson($request->get('data'));
  290.                 $id = $data['id'];
  291.                 $property = Property\Predefined::getById($id);
  292.                 if (!$property->isWriteable()) {
  293.                     throw new ConfigWriteException();
  294.                 }
  295.                 $property->delete();
  297.                 return $this->adminJson(['success' => true, 'data' => []]);
  298.             } elseif ($request->get('xaction') == 'update') {
  299.                 $data = $this->decodeJson($request->get('data'));
  301.                 // save type
  302.                 $property = Property\Predefined::getById($data['id']);
  303.                 if (!$property->isWriteable()) {
  304.                     throw new ConfigWriteException();
  305.                 }
  306.                 if (is_array($data['ctype'])) {
  307.                     $data['ctype'] = implode(',', $data['ctype']);
  308.                 }
  309.                 $property->setValues($data);
  311.                 $property->save();
  313.                 $responseData = $property->getObjectVars();
  314.                 $responseData['writeable'] = $property->isWriteable();
  316.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  317.             } elseif ($request->get('xaction') == 'create') {
  318.                 if (!(new Property\Predefined())->isWriteable()) {
  319.                     throw new ConfigWriteException();
  320.                 }
  321.                 $data = $this->decodeJson($request->get('data'));
  322.                 unset($data['id']);
  324.                 // save type
  325.                 $property = Property\Predefined::create();
  326.                 $property->setValues($data);
  328.                 $property->save();
  330.                 $responseData = $property->getObjectVars();
  331.                 $responseData['writeable'] = $property->isWriteable();
  333.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  334.             }
  335.         } else {
  336.             // get list of types
  337.             $list = new Property\Predefined\Listing();
  339.             if ($filter = $request->get('filter')) {
  340.                 $list->setFilter(function (Property\Predefined $predefined) use ($filter) {
  341.                     foreach ($predefined->getObjectVars() as $value) {
  342.                         if ($value) {
  343.                             $cellValues = is_array($value) ? $value : [$value];
  345.                             foreach ($cellValues as $cellValue) {
  346.                                 if (stripos($cellValue, $filter) !== false) {
  347.                                     return true;
  348.                                 }
  349.                             }
  350.                         }
  351.                     }
  353.                     return false;
  354.                 });
  355.             }
  357.             $properties = [];
  358.             foreach ($list->getProperties() as $property) {
  359.                 $data = $property->getObjectVars();
  360.                 $data['writeable'] = $property->isWriteable();
  361.                 $properties[] = $data;
  362.             }
  364.             return $this->adminJson(['data' => $properties, 'success' => true, 'total' => $list->getTotalCount()]);
  365.         }
  367.         return $this->adminJson(['success' => false]);
  368.     }
  370.     /**
  371.      * @Route("/get-system", name="pimcore_admin_settings_getsystem", methods={"GET"})
  372.      *
  373.      * @param Request $request
  374.      * @param Config $config
  375.      *
  376.      * @return JsonResponse
  377.      */
  378.     public function getSystemAction(Request $request, Config $config)
  379.     {
  380.         $this->checkPermission('system_settings');
  382.         $valueArray = [
  383.             'general' => $config['general'],
  384.             'documents' => $config['documents'],
  385.             'assets' => $config['assets'],
  386.             'objects' => $config['objects'],
  387.             'branding' => $config['branding'],
  388.             'email' => $config['email'],
  389.         ];
  391.         $locales = Tool::getSupportedLocales();
  392.         $languageOptions = [];
  393.         $validLanguages = [];
  394.         foreach ($locales as $short => $translation) {
  395.             if (!empty($short)) {
  396.                 $languageOptions[] = [
  397.                     'language' => $short,
  398.                     'display' => $translation . " ($short)",
  399.                 ];
  400.                 $validLanguages[] = $short;
  401.             }
  402.         }
  404.         $valueArray['general']['valid_language'] = explode(',', $valueArray['general']['valid_languages']);
  406.         //for "wrong" legacy values
  407.         if (is_array($valueArray['general']['valid_language'])) {
  408.             foreach ($valueArray['general']['valid_language'] as $existingValue) {
  409.                 if (!in_array($existingValue, $validLanguages)) {
  410.                     $languageOptions[] = [
  411.                         'language' => $existingValue,
  412.                         'display' => $existingValue,
  413.                     ];
  414.                 }
  415.             }
  416.         }
  418.         $response = [
  419.             'values' => $valueArray,
  420.             'config' => [
  421.                 'languages' => $languageOptions,
  422.             ],
  423.         ];
  425.         return $this->adminJson($response);
  426.     }
  428.     /**
  429.      * @Route("/set-system", name="pimcore_admin_settings_setsystem", methods={"PUT"})
  430.      *
  431.      * @param Request $request
  432.      * @param LocaleServiceInterface $localeService
  433.      *
  434.      * @return JsonResponse
  435.      */
  436.     public function setSystemAction(
  437.         LocaleServiceInterface $localeService,
  438.         Request $request,
  439.         KernelInterface $kernel,
  440.         EventDispatcherInterface $eventDispatcher,
  441.         CoreCacheHandler $cache,
  442.         Filesystem $filesystem,
  443.         CacheClearer $symfonyCacheClearer
  444.     ) {
  445.         $this->checkPermission('system_settings');
  447.         $values = $this->decodeJson($request->get('data'));
  449.         $existingValues = [];
  451.         try {
  452.             $file = Config::locateConfigFile('system.yml');
  453.             $existingValues = Config::getConfigInstance($file, true);
  454.         } catch (\Exception $e) {
  455.             // nothing to do
  456.         }
  458.         // localized error pages
  459.         $localizedErrorPages = [];
  461.         // fallback languages
  462.         $fallbackLanguages = [];
  463.         $existingValues['pimcore']['general']['fallback_languages'] = [];
  464.         $languages = explode(',', $values['general.validLanguages']);
  465.         $filteredLanguages = [];
  467.         foreach ($languages as $language) {
  468.             if (isset($values['general.fallbackLanguages.' . $language])) {
  469.                 $fallbackLanguages[$language] = str_replace(' ', '', $values['general.fallbackLanguages.' . $language]);
  470.             }
  472.             // localized error pages
  473.             if (isset($values['documents.error_pages.localized.' . $language])) {
  474.                 $localizedErrorPages[$language] = $values['documents.error_pages.localized.' . $language];
  475.             }
  477.             if ($localeService->isLocale($language)) {
  478.                 $filteredLanguages[] = $language;
  479.             }
  480.         }
  482.         // check if there's a fallback language endless loop
  483.         foreach ($fallbackLanguages as $sourceLang => $targetLang) {
  484.             $this->checkFallbackLanguageLoop($sourceLang, $fallbackLanguages);
  485.         }
  487.         $settings['pimcore'] = [
  488.             'general' => [
  489.                 'domain' => $values['general.domain'],
  490.                 'redirect_to_maindomain' => $values['general.redirect_to_maindomain'],
  491.                 'language' => $values['general.language'],
  492.                 'valid_languages' => implode(',', $filteredLanguages),
  493.                 'fallback_languages' => $fallbackLanguages,
  494.                 'default_language' => $values['general.defaultLanguage'],
  495.                 'debug_admin_translations' => $values['general.debug_admin_translations'],
  496.             ],
  497.             'documents' => [
  498.                 'versions' => [
  499.                     'days' => $values['documents.versions.days'] ?? null,
  500.                     'steps' => $values['documents.versions.steps'] ?? null,
  501.                 ],
  502.                 'error_pages' => [
  503.                     'default' => $values['documents.error_pages.default'],
  504.                     'localized' => $localizedErrorPages,
  505.                 ],
  506.             ],
  507.             'objects' => [
  508.                 'versions' => [
  509.                     'days' => $values['objects.versions.days'] ?? null,
  510.                     'steps' => $values['objects.versions.steps'] ?? null,
  511.                 ],
  512.             ],
  513.             'assets' => [
  514.                 'versions' => [
  515.                     'days' => $values['assets.versions.days'] ?? null,
  516.                     'steps' => $values['assets.versions.steps'] ?? null,
  517.                 ],
  518.                 'hide_edit_image' => $values['assets.hide_edit_image'],
  519.                 'disable_tree_preview' => $values['assets.disable_tree_preview'],
  520.             ],
  521.         ];
  523.         //branding
  524.         $settings['pimcore_admin'] = [
  525.             'branding' =>
  526.                 [
  527.                     'login_screen_invert_colors' => $values['branding.login_screen_invert_colors'],
  528.                     'color_login_screen' => $values['branding.color_login_screen'],
  529.                     'color_admin_interface' => $values['branding.color_admin_interface'],
  530.                     'color_admin_interface_background' => $values['branding.color_admin_interface_background'],
  531.                     'login_screen_custom_image' => str_replace('%', '%%', $values['branding.login_screen_custom_image']),
  532.                 ],
  533.         ];
  535.         if (array_key_exists('email.debug.emailAddresses', $values) && $values['email.debug.emailAddresses']) {
  536.             $settings['pimcore']['email']['debug']['email_addresses'] = $values['email.debug.emailAddresses'];
  537.         }
  539.         $settingsYml = Yaml::dump($settings, 5);
  540.         $configFile = Config::locateConfigFile('system.yml');
  541.         File::put($configFile, $settingsYml);
  543.         // clear all caches
  544.         $this->clearSymfonyCache($request, $kernel, $eventDispatcher, $symfonyCacheClearer);
  545.         $this->stopMessengerWorkers();
  547.         $eventDispatcher->addListener(KernelEvents::TERMINATE, function (TerminateEvent $event) use (
  548.             $cache, $eventDispatcher, $filesystem
  549.         ) {
  550.             // we need to clear the cache with a delay, because the cache is used by messenger:stop-workers
  551.             // to send the stop signal to all worker processes
  552.             sleep(2);
  553.             $this->clearPimcoreCache($cache, $eventDispatcher, $filesystem);
  554.         });
  556.         return $this->adminJson(['success' => true]);
  557.     }
  559.     /**
  560.      * @param string $source
  561.      * @param array $definitions
  562.      * @param array $fallbacks
  563.      *
  564.      * @throws \Exception
  565.      */
  566.     protected function checkFallbackLanguageLoop($source, $definitions, $fallbacks = [])
  567.     {
  568.         if (isset($definitions[$source])) {
  569.             $targets = explode(',', $definitions[$source]);
  570.             foreach ($targets as $l) {
  571.                 $target = trim($l);
  572.                 if ($target) {
  573.                     if (in_array($target, $fallbacks)) {
  574.                         throw new \Exception("Language `$source` | `$target` causes an infinte loop.");
  575.                     }
  576.                     $fallbacks[] = $target;
  578.                     $this->checkFallbackLanguageLoop($target, $definitions, $fallbacks);
  579.                 }
  580.             }
  581.         } else {
  582.             throw new \Exception("Language `$source` doesn't exist");
  583.         }
  584.     }
  586.     /**
  587.      * @Route("/get-web2print", name="pimcore_admin_settings_getweb2print", methods={"GET"})
  588.      *
  589.      * @param Request $request
  590.      *
  591.      * @return JsonResponse
  592.      */
  593.     public function getWeb2printAction(Request $request)
  594.     {
  595.         $this->checkPermission('web2print_settings');
  597.         $values = Config::getWeb2PrintConfig();
  598.         $valueArray = $values->toArray();
  600.         $optionsString = [];
  601.         if ($valueArray['wkhtml2pdfOptions'] ?? false) {
  602.             foreach ($valueArray['wkhtml2pdfOptions'] as $key => $value) {
  603.                 $tmpStr = '--'.$key;
  604.                 if ($value !== null && $value !== '') {
  605.                     $tmpStr .= ' '.$value;
  606.                 }
  607.                 $optionsString[] = $tmpStr;
  608.             }
  609.         }
  610.         $valueArray['wkhtml2pdfOptions'] = implode("\n", $optionsString);
  612.         $response = [
  613.             'values' => $valueArray,
  614.         ];
  616.         return $this->adminJson($response);
  617.     }
  619.     /**
  620.      * @Route("/set-web2print", name="pimcore_admin_settings_setweb2print", methods={"PUT"})
  621.      *
  622.      * @param Request $request
  623.      *
  624.      * @return JsonResponse
  625.      */
  626.     public function setWeb2printAction(Request $request)
  627.     {
  628.         $this->checkPermission('web2print_settings');
  630.         $values = $this->decodeJson($request->get('data'));
  632.         unset($values['documentation']);
  633.         unset($values['additions']);
  634.         unset($values['json_converter']);
  636.         if ($values['wkhtml2pdfOptions']) {
  637.             $optionArray = [];
  638.             $lines = explode("\n", $values['wkhtml2pdfOptions']);
  639.             foreach ($lines as $line) {
  640.                 $parts = explode(' ', substr($line, 2));
  641.                 $key = trim($parts[0]);
  642.                 if ($key) {
  643.                     $value = trim($parts[1] ?? '');
  644.                     $optionArray[$key] = $value;
  645.                 }
  646.             }
  647.             $values['wkhtml2pdfOptions'] = $optionArray;
  648.         }
  650.         \Pimcore\Web2Print\Config::save($values);
  652.         return $this->adminJson(['success' => true]);
  653.     }
  655.     /**
  656.      * @Route("/clear-cache", name="pimcore_admin_settings_clearcache", methods={"DELETE"})
  657.      *
  658.      * @param Request $request
  659.      * @param KernelInterface $kernel
  660.      * @param EventDispatcherInterface $eventDispatcher
  661.      * @param CoreCacheHandler $cache
  662.      * @param Filesystem $filesystem
  663.      * @param CacheClearer $symfonyCacheClearer
  664.      *
  665.      * @return JsonResponse
  666.      */
  667.     public function clearCacheAction(
  668.         Request $request,
  669.         KernelInterface $kernel,
  670.         EventDispatcherInterface $eventDispatcher,
  671.         CoreCacheHandler $cache,
  672.         Filesystem $filesystem,
  673.         CacheClearer $symfonyCacheClearer
  674.     ) {
  675.         $this->checkPermissionsHasOneOf(['clear_cache', 'system_settings']);
  677.         $result = [
  678.             'success' => true,
  679.         ];
  681.         $clearPimcoreCache = !(bool)$request->get('only_symfony_cache');
  682.         $clearSymfonyCache = !(bool)$request->get('only_pimcore_cache');
  684.         if ($clearPimcoreCache) {
  685.             $this->clearPimcoreCache($cache, $eventDispatcher, $filesystem);
  686.         }
  688.         if ($clearSymfonyCache) {
  689.             $this->clearSymfonyCache($request, $kernel, $eventDispatcher, $symfonyCacheClearer);
  690.         }
  692.         $response = new JsonResponse($result);
  694.         if ($clearSymfonyCache) {
  695.             // we send the response directly here and exit to make sure no code depending on the stale container
  696.             // is running after this
  697.             $response->sendHeaders();
  698.             $response->sendContent();
  699.             exit;
  700.         }
  702.         return $response;
  703.     }
  705.     private function clearPimcoreCache(
  706.         CoreCacheHandler $cache,
  707.         EventDispatcherInterface $eventDispatcher,
  708.         Filesystem $filesystem,
  709.     ): void {
  710.         // empty document cache
  711.         $cache->clearAll();
  713.         if ($filesystem->exists(PIMCORE_CACHE_DIRECTORY)) {
  714.             $filesystem->remove(PIMCORE_CACHE_DIRECTORY);
  715.         }
  717.         // PIMCORE-1854 - recreate .dummy file => should remain
  718.         File::put(PIMCORE_CACHE_DIRECTORY . '/.gitkeep', '');
  720.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR);
  721.     }
  723.     private function clearSymfonyCache(
  724.         Request $request,
  725.         KernelInterface $kernel,
  726.         EventDispatcherInterface $eventDispatcher,
  727.         CacheClearer $symfonyCacheClearer,
  728.     ): void {
  729.         // pass one or move env parameters to clear multiple envs
  730.         // if no env is passed it will use the current one
  731.         $environments = $request->get('env', $kernel->getEnvironment());
  733.         if (!is_array($environments)) {
  734.             $environments = trim((string)$environments);
  736.             if (empty($environments)) {
  737.                 $environments = [];
  738.             } else {
  739.                 $environments = [$environments];
  740.             }
  741.         }
  743.         if (empty($environments)) {
  744.             $environments = [$kernel->getEnvironment()];
  745.         }
  747.         $result['environments'] = $environments;
  749.         if (in_array($kernel->getEnvironment(), $environments)) {
  750.             // remove terminate and exception event listeners for the current env as they break with a
  751.             // cleared container - see #2434
  752.             foreach ($eventDispatcher->getListeners(KernelEvents::TERMINATE) as $listener) {
  753.                 $eventDispatcher->removeListener(KernelEvents::TERMINATE, $listener);
  754.             }
  756.             foreach ($eventDispatcher->getListeners(KernelEvents::EXCEPTION) as $listener) {
  757.                 $eventDispatcher->removeListener(KernelEvents::EXCEPTION, $listener);
  758.             }
  759.         }
  761.         foreach ($environments as $environment) {
  762.             try {
  763.                 $symfonyCacheClearer->clear($environment);
  764.             } catch (\Throwable $e) {
  765.                 $errors = $result['errors'] ?? [];
  766.                 $errors[] = $e->getMessage();
  768.                 $result = array_merge($result, [
  769.                     'success' => false,
  770.                     'errors' => $errors,
  771.                 ]);
  772.             }
  773.         }
  774.     }
  776.     /**
  777.      * @Route("/clear-output-cache", name="pimcore_admin_settings_clearoutputcache", methods={"DELETE"})
  778.      *
  779.      * @param EventDispatcherInterface $eventDispatcher
  780.      *
  781.      * @return JsonResponse
  782.      */
  783.     public function clearOutputCacheAction(EventDispatcherInterface $eventDispatcher)
  784.     {
  785.         $this->checkPermission('clear_fullpage_cache');
  787.         // remove "output" out of the ignored tags, if a cache lifetime is specified
  788.         Cache::removeIgnoredTagOnClear('output');
  790.         // empty document cache
  791.         Cache::clearTags(['output', 'output_lifetime']);
  793.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR_FULLPAGE_CACHE);
  795.         return $this->adminJson(['success' => true]);
  796.     }
  798.     /**
  799.      * @Route("/clear-temporary-files", name="pimcore_admin_settings_cleartemporaryfiles", methods={"DELETE"})
  800.      *
  801.      * @param EventDispatcherInterface $eventDispatcher
  802.      *
  803.      * @return JsonResponse
  804.      */
  805.     public function clearTemporaryFilesAction(EventDispatcherInterface $eventDispatcher)
  806.     {
  807.         $this->checkPermission('clear_temp_files');
  809.         // public files
  810.         Tool\Storage::get('thumbnail')->deleteDirectory('/');
  811.         Db::get()->query('TRUNCATE TABLE assets_image_thumbnail_cache');
  813.         Tool\Storage::get('asset_cache')->deleteDirectory('/');
  815.         // system files
  816.         recursiveDelete(PIMCORE_SYSTEM_TEMP_DIRECTORY, false);
  818.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR_TEMPORARY_FILES);
  820.         return $this->adminJson(['success' => true]);
  821.     }
  823.     /**
  824.      * @Route("/staticroutes", name="pimcore_admin_settings_staticroutes", methods={"POST"})
  825.      *
  826.      * @param Request $request
  827.      *
  828.      * @return JsonResponse
  829.      */
  830.     public function staticroutesAction(Request $request)
  831.     {
  832.         if ($request->get('data')) {
  833.             $this->checkPermission('routes');
  835.             $data = $this->decodeJson($request->get('data'));
  837.             if (is_array($data)) {
  838.                 foreach ($data as &$value) {
  839.                     if (is_string($value)) {
  840.                         $value = trim($value);
  841.                     }
  842.                 }
  843.             }
  845.             if ($request->get('xaction') == 'destroy') {
  846.                 $data = $this->decodeJson($request->get('data'));
  847.                 $id = $data['id'];
  848.                 $route = Staticroute::getById($id);
  849.                 if (!$route->isWriteable()) {
  850.                     throw new ConfigWriteException();
  851.                 }
  852.                 $route->delete();
  854.                 return $this->adminJson(['success' => true, 'data' => []]);
  855.             } elseif ($request->get('xaction') == 'update') {
  856.                 // save routes
  857.                 $route = Staticroute::getById($data['id']);
  858.                 if (!$route->isWriteable()) {
  859.                     throw new ConfigWriteException();
  860.                 }
  862.                 $route->setValues($data);
  864.                 $route->save();
  866.                 return $this->adminJson(['data' => $route->getObjectVars(), 'success' => true]);
  867.             } elseif ($request->get('xaction') == 'create') {
  868.                 if (!(new Staticroute())->isWriteable()) {
  869.                     throw new ConfigWriteException();
  870.                 }
  871.                 unset($data['id']);
  873.                 // save route
  874.                 $route = new Staticroute();
  875.                 $route->setValues($data);
  877.                 $route->save();
  879.                 $responseData = $route->getObjectVars();
  880.                 $responseData['writeable'] = $route->isWriteable();
  882.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  883.             }
  884.         } else {
  885.             // get list of routes
  887.             $list = new Staticroute\Listing();
  889.             if ($filter = $request->get('filter')) {
  890.                 $list->setFilter(function (Staticroute $staticRoute) use ($filter) {
  891.                     foreach ($staticRoute->getObjectVars() as $value) {
  892.                         if (!is_scalar($value)) {
  893.                             continue;
  894.                         }
  895.                         if (stripos((string)$value, $filter) !== false) {
  896.                             return true;
  897.                         }
  898.                     }
  900.                     return false;
  901.                 });
  902.             }
  904.             $routes = [];
  905.             foreach ($list->getRoutes() as $routeFromList) {
  906.                 $route = $routeFromList->getObjectVars();
  907.                 $route['writeable'] = $routeFromList->isWriteable();
  908.                 if (is_array($routeFromList->getSiteId())) {
  909.                     $route['siteId'] = implode(',', $routeFromList->getSiteId());
  910.                 }
  911.                 $routes[] = $route;
  912.             }
  914.             return $this->adminJson(['data' => $routes, 'success' => true, 'total' => $list->getTotalCount()]);
  915.         }
  917.         return $this->adminJson(['success' => false]);
  918.     }
  920.     /**
  921.      * @Route("/get-available-admin-languages", name="pimcore_admin_settings_getavailableadminlanguages", methods={"GET"})
  922.      *
  923.      * @param Request $request
  924.      *
  925.      * @return JsonResponse
  926.      */
  927.     public function getAvailableAdminLanguagesAction(Request $request)
  928.     {
  929.         $langs = [];
  930.         $availableLanguages = Tool\Admin::getLanguages();
  931.         $locales = Tool::getSupportedLocales();
  933.         foreach ($availableLanguages as $lang) {
  934.             if (array_key_exists($lang, $locales)) {
  935.                 $langs[] = [
  936.                     'language' => $lang,
  937.                     'display' => $locales[$lang],
  938.                 ];
  939.             }
  940.         }
  942.         usort($langs, function ($a, $b) {
  943.             return strcmp($a['display'], $b['display']);
  944.         });
  946.         return $this->adminJson($langs);
  947.     }
  949.     /**
  950.      * @Route("/glossary", name="pimcore_admin_settings_glossary", methods={"POST"})
  951.      *
  952.      * @param Request $request
  953.      *
  954.      * @return JsonResponse
  955.      */
  956.     public function glossaryAction(Request $request)
  957.     {
  958.         if ($request->get('data')) {
  959.             $this->checkPermission('glossary');
  961.             Cache::clearTag('glossary');
  963.             if ($request->get('xaction') == 'destroy') {
  964.                 $data = $this->decodeJson($request->get('data'));
  965.                 $id = $data['id'];
  966.                 $glossary = Glossary::getById($id);
  967.                 $glossary->delete();
  969.                 return $this->adminJson(['success' => true, 'data' => []]);
  970.             } elseif ($request->get('xaction') == 'update') {
  971.                 $data = $this->decodeJson($request->get('data'));
  973.                 // save glossary
  974.                 $glossary = Glossary::getById($data['id']);
  976.                 if (!empty($data['link'])) {
  977.                     if ($doc = Document::getByPath($data['link'])) {
  978.                         $data['link'] = $doc->getId();
  979.                     }
  980.                 }
  982.                 $glossary->setValues($data);
  984.                 $glossary->save();
  986.                 if ($link = $glossary->getLink()) {
  987.                     if ((int)$link > 0) {
  988.                         if ($doc = Document::getById((int)$link)) {
  989.                             $glossary->setLink($doc->getRealFullPath());
  990.                         }
  991.                     }
  992.                 }
  994.                 return $this->adminJson(['data' => $glossary, 'success' => true]);
  995.             } elseif ($request->get('xaction') == 'create') {
  996.                 $data = $this->decodeJson($request->get('data'));
  997.                 unset($data['id']);
  999.                 // save glossary
  1000.                 $glossary = new Glossary();
  1002.                 if (!empty($data['link'])) {
  1003.                     if ($doc = Document::getByPath($data['link'])) {
  1004.                         $data['link'] = $doc->getId();
  1005.                     }
  1006.                 }
  1008.                 $glossary->setValues($data);
  1010.                 $glossary->save();
  1012.                 if ($link = $glossary->getLink()) {
  1013.                     if ((int)$link > 0) {
  1014.                         if ($doc = Document::getById((int)$link)) {
  1015.                             $glossary->setLink($doc->getRealFullPath());
  1016.                         }
  1017.                     }
  1018.                 }
  1020.                 return $this->adminJson(['data' => $glossary->getObjectVars(), 'success' => true]);
  1021.             }
  1022.         } else {
  1023.             // get list of glossaries
  1025.             $list = new Glossary\Listing();
  1026.             $list->setLimit($request->get('limit'));
  1027.             $list->setOffset($request->get('start'));
  1029.             $sortingSettings = \Pimcore\Bundle\AdminBundle\Helper\QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  1030.             if ($sortingSettings['orderKey']) {
  1031.                 $list->setOrderKey($sortingSettings['orderKey']);
  1032.                 $list->setOrder($sortingSettings['order']);
  1033.             }
  1035.             if ($request->get('filter')) {
  1036.                 $list->setCondition('`text` LIKE ' . $list->quote('%'.$request->get('filter').'%'));
  1037.             }
  1039.             $list->load();
  1041.             $glossaries = [];
  1042.             foreach ($list->getGlossary() as $glossary) {
  1043.                 if ($link = $glossary->getLink()) {
  1044.                     if ((int)$link > 0) {
  1045.                         if ($doc = Document::getById((int)$link)) {
  1046.                             $glossary->setLink($doc->getRealFullPath());
  1047.                         }
  1048.                     }
  1049.                 }
  1051.                 $glossaries[] = $glossary->getObjectVars();
  1052.             }
  1054.             return $this->adminJson(['data' => $glossaries, 'success' => true, 'total' => $list->getTotalCount()]);
  1055.         }
  1057.         return $this->adminJson(['success' => false]);
  1058.     }
  1060.     /**
  1061.      * @Route("/get-available-sites", name="pimcore_admin_settings_getavailablesites", methods={"GET"})
  1062.      *
  1063.      * @param Request $request
  1064.      *
  1065.      * @return JsonResponse
  1066.      */
  1067.     public function getAvailableSitesAction(Request $request)
  1068.     {
  1069.         $excludeMainSite = $request->get('excludeMainSite');
  1071.         $sitesList = new Model\Site\Listing();
  1072.         $sitesObjects = $sitesList->load();
  1073.         $sites = [];
  1074.         if (!$excludeMainSite) {
  1075.             $sites[] = [
  1076.                 'id' => 'default',
  1077.                 'rootId' => 1,
  1078.                 'domains' => '',
  1079.                 'rootPath' => '/',
  1080.                 'domain' => $this->trans('main_site'),
  1081.             ];
  1082.         }
  1084.         foreach ($sitesObjects as $site) {
  1085.             if ($site->getRootDocument()) {
  1086.                 if ($site->getMainDomain()) {
  1087.                     $sites[] = [
  1088.                         'id' => $site->getId(),
  1089.                         'rootId' => $site->getRootId(),
  1090.                         'domains' => implode(',', $site->getDomains()),
  1091.                         'rootPath' => $site->getRootPath(),
  1092.                         'domain' => $site->getMainDomain(),
  1093.                     ];
  1094.                 }
  1095.             } else {
  1096.                 // site is useless, parent doesn't exist anymore
  1097.                 $site->delete();
  1098.             }
  1099.         }
  1101.         return $this->adminJson($sites);
  1102.     }
  1104.     /**
  1105.      * @Route("/get-available-countries", name="pimcore_admin_settings_getavailablecountries", methods={"GET"})
  1106.      *
  1107.      * @param LocaleServiceInterface $localeService
  1108.      *
  1109.      * @return JsonResponse
  1110.      */
  1111.     public function getAvailableCountriesAction(LocaleServiceInterface $localeService)
  1112.     {
  1113.         $countries = $localeService->getDisplayRegions();
  1114.         asort($countries);
  1116.         $options = [];
  1118.         foreach ($countries as $short => $translation) {
  1119.             if (strlen($short) == 2) {
  1120.                 $options[] = [
  1121.                     'key' => $translation . ' (' . $short . ')',
  1122.                     'value' => $short,
  1123.                 ];
  1124.             }
  1125.         }
  1127.         $result = ['data' => $options, 'success' => true, 'total' => count($options)];
  1129.         return $this->adminJson($result);
  1130.     }
  1132.     /**
  1133.      * @Route("/thumbnail-adapter-check", name="pimcore_admin_settings_thumbnailadaptercheck", methods={"GET"})
  1134.      *
  1135.      * @param Request $request
  1136.      *
  1137.      * @return Response
  1138.      */
  1139.     public function thumbnailAdapterCheckAction(Request $request)
  1140.     {
  1141.         $content = '';
  1143.         $instance = \Pimcore\Image::getInstance();
  1144.         if ($instance instanceof \Pimcore\Image\Adapter\GD) {
  1145.             $content = '<span style="color: red; font-weight: bold;padding: 10px;margin:0 0 20px 0;border:1px solid red;display:block;">' .
  1146.                 $this->trans('important_use_imagick_pecl_extensions_for_best_results_gd_is_just_a_fallback_with_less_quality') .
  1147.                 '</span>';
  1148.         }
  1150.         return new Response($content);
  1151.     }
  1153.     /**
  1154.      * @Route("/thumbnail-tree", name="pimcore_admin_settings_thumbnailtree", methods={"GET", "POST"})
  1155.      *
  1156.      * @return JsonResponse
  1157.      */
  1158.     public function thumbnailTreeAction()
  1159.     {
  1160.         $this->checkPermission('thumbnails');
  1162.         $thumbnails = [];
  1164.         $list = new Asset\Image\Thumbnail\Config\Listing();
  1166.         $groups = [];
  1167.         foreach ($list->getThumbnails() as $item) {
  1168.             if ($item->getGroup()) {
  1169.                 if (empty($groups[$item->getGroup()])) {
  1170.                     $groups[$item->getGroup()] = [
  1171.                         'id' => 'group_' . $item->getName(),
  1172.                         'text' => htmlspecialchars($item->getGroup()),
  1173.                         'expandable' => true,
  1174.                         'leaf' => false,
  1175.                         'allowChildren' => true,
  1176.                         'iconCls' => 'pimcore_icon_folder',
  1177.                         'group' => $item->getGroup(),
  1178.                         'children' => [],
  1179.                     ];
  1180.                 }
  1181.                 $groups[$item->getGroup()]['children'][] =
  1182.                     [
  1183.                         'id' => $item->getName(),
  1184.                         'text' => $item->getName(),
  1185.                         'leaf' => true,
  1186.                         'iconCls' => 'pimcore_icon_thumbnails',
  1187.                         'cls' => 'pimcore_treenode_disabled',
  1188.                         'writeable' => $item->isWriteable(),
  1189.                     ];
  1190.             } else {
  1191.                 $thumbnails[] = [
  1192.                     'id' => $item->getName(),
  1193.                     'text' => $item->getName(),
  1194.                     'leaf' => true,
  1195.                     'iconCls' => 'pimcore_icon_thumbnails',
  1196.                     'cls' => 'pimcore_treenode_disabled',
  1197.                     'writeable' => $item->isWriteable(),
  1198.                 ];
  1199.             }
  1200.         }
  1202.         foreach ($groups as $group) {
  1203.             $thumbnails[] = $group;
  1204.         }
  1206.         return $this->adminJson($thumbnails);
  1207.     }
  1209.     /**
  1210.      * @Route("/thumbnail-downloadable", name="pimcore_admin_settings_thumbnaildownloadable", methods={"GET"})
  1211.      *
  1212.      * @return JsonResponse
  1213.      */
  1214.     public function thumbnailDownloadableAction()
  1215.     {
  1216.         $thumbnails = [];
  1218.         $list = new Asset\Image\Thumbnail\Config\Listing();
  1219.         $list->setFilter(function (Asset\Image\Thumbnail\Config $config) {
  1220.             return $config->isDownloadable();
  1221.         });
  1223.         foreach ($list->getThumbnails() as $item) {
  1224.             $thumbnails[] = [
  1225.                 'id' => $item->getName(),
  1226.                 'text' => $item->getName(),
  1227.             ];
  1228.         }
  1230.         return $this->adminJson($thumbnails);
  1231.     }
  1233.     /**
  1234.      * @Route("/thumbnail-add", name="pimcore_admin_settings_thumbnailadd", methods={"POST"})
  1235.      *
  1236.      * @param Request $request
  1237.      *
  1238.      * @return JsonResponse
  1239.      */
  1240.     public function thumbnailAddAction(Request $request)
  1241.     {
  1242.         $this->checkPermission('thumbnails');
  1244.         $success = false;
  1246.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1248.         if (!$pipe) {
  1249.             $pipe = new Asset\Image\Thumbnail\Config();
  1250.             if (!$pipe->isWriteable()) {
  1251.                 throw new ConfigWriteException();
  1252.             }
  1254.             $pipe->setName($request->get('name'));
  1255.             $pipe->save();
  1257.             $success = true;
  1258.         } else {
  1259.             if (!$pipe->isWriteable()) {
  1260.                 throw new ConfigWriteException();
  1261.             }
  1262.         }
  1264.         return $this->adminJson(['success' => $success, 'id' => $pipe->getName()]);
  1265.     }
  1267.     /**
  1268.      * @Route("/thumbnail-delete", name="pimcore_admin_settings_thumbnaildelete", methods={"DELETE"})
  1269.      *
  1270.      * @param Request $request
  1271.      *
  1272.      * @return JsonResponse
  1273.      */
  1274.     public function thumbnailDeleteAction(Request $request)
  1275.     {
  1276.         $this->checkPermission('thumbnails');
  1278.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1280.         if (!$pipe->isWriteable()) {
  1281.             throw new ConfigWriteException();
  1282.         }
  1284.         $pipe->delete();
  1286.         return $this->adminJson(['success' => true]);
  1287.     }
  1289.     /**
  1290.      * @Route("/thumbnail-get", name="pimcore_admin_settings_thumbnailget", methods={"GET"})
  1291.      *
  1292.      * @param Request $request
  1293.      *
  1294.      * @return JsonResponse
  1295.      */
  1296.     public function thumbnailGetAction(Request $request)
  1297.     {
  1298.         $this->checkPermission('thumbnails');
  1300.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1301.         $data = $pipe->getObjectVars();
  1302.         $data['writeable'] = $pipe->isWriteable();
  1304.         return $this->adminJson($data);
  1305.     }
  1307.     /**
  1308.      * @Route("/thumbnail-update", name="pimcore_admin_settings_thumbnailupdate", methods={"PUT"})
  1309.      *
  1310.      * @param Request $request
  1311.      *
  1312.      * @return JsonResponse
  1313.      */
  1314.     public function thumbnailUpdateAction(Request $request)
  1315.     {
  1316.         $this->checkPermission('thumbnails');
  1318.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1320.         if (!$pipe->isWriteable()) {
  1321.             throw new ConfigWriteException();
  1322.         }
  1324.         $settingsData = $this->decodeJson($request->get('settings'));
  1325.         $mediaData = $this->decodeJson($request->get('medias'));
  1326.         $mediaOrder = $this->decodeJson($request->get('mediaOrder'));
  1328.         foreach ($settingsData as $key => $value) {
  1329.             $setter = 'set' . ucfirst($key);
  1330.             if (method_exists($pipe, $setter)) {
  1331.                 $pipe->$setter($value);
  1332.             }
  1333.         }
  1335.         $pipe->resetItems();
  1337.         uksort($mediaData, function ($a, $b) use ($mediaOrder) {
  1338.             if ($a === 'default') {
  1339.                 return -1;
  1340.             }
  1342.             return ($mediaOrder[$a] < $mediaOrder[$b]) ? -1 : 1;
  1343.         });
  1345.         foreach ($mediaData as $mediaName => $items) {
  1346.             if (preg_match('/["<>]/', $mediaName)) {
  1347.                 throw new \Exception('Invalid media query name');
  1348.             }
  1350.             foreach ($items as $item) {
  1351.                 $type = $item['type'];
  1352.                 unset($item['type']);
  1354.                 $pipe->addItem($type, $item, $mediaName);
  1355.             }
  1356.         }
  1358.         $pipe->save();
  1360.         return $this->adminJson(['success' => true]);
  1361.     }
  1363.     /**
  1364.      * @Route("/video-thumbnail-adapter-check", name="pimcore_admin_settings_videothumbnailadaptercheck", methods={"GET"})
  1365.      *
  1366.      * @param Request $request
  1367.      *
  1368.      * @return Response
  1369.      */
  1370.     public function videoThumbnailAdapterCheckAction(Request $request)
  1371.     {
  1372.         $content = '';
  1374.         if (!\Pimcore\Video::isAvailable()) {
  1375.             $content = '<span style="color: red; font-weight: bold;padding: 10px;margin:0 0 20px 0;border:1px solid red;display:block;">' .
  1376.                 $this->trans('php_cli_binary_and_or_ffmpeg_binary_setting_is_missing') .
  1377.                 '</span>';
  1378.         }
  1380.         return new Response($content);
  1381.     }
  1383.     /**
  1384.      * @Route("/video-thumbnail-tree", name="pimcore_admin_settings_videothumbnailtree", methods={"GET", "POST"})
  1385.      *
  1386.      * @return JsonResponse
  1387.      */
  1388.     public function videoThumbnailTreeAction()
  1389.     {
  1390.         $this->checkPermission('thumbnails');
  1392.         $thumbnails = [];
  1394.         $list = new Asset\Video\Thumbnail\Config\Listing();
  1396.         $groups = [];
  1397.         foreach ($list->getThumbnails() as $item) {
  1398.             if ($item->getGroup()) {
  1399.                 if (empty($groups[$item->getGroup()])) {
  1400.                     $groups[$item->getGroup()] = [
  1401.                         'id' => 'group_' . $item->getName(),
  1402.                         'text' => htmlspecialchars($item->getGroup()),
  1403.                         'expandable' => true,
  1404.                         'leaf' => false,
  1405.                         'allowChildren' => true,
  1406.                         'iconCls' => 'pimcore_icon_folder',
  1407.                         'group' => $item->getGroup(),
  1408.                         'children' => [],
  1409.                     ];
  1410.                 }
  1411.                 $groups[$item->getGroup()]['children'][] =
  1412.                     [
  1413.                         'id' => $item->getName(),
  1414.                         'text' => $item->getName(),
  1415.                         'leaf' => true,
  1416.                         'iconCls' => 'pimcore_icon_videothumbnails',
  1417.                         'cls' => 'pimcore_treenode_disabled',
  1418.                         'writeable' => $item->isWriteable(),
  1419.                     ];
  1420.             } else {
  1421.                 $thumbnails[] = [
  1422.                     'id' => $item->getName(),
  1423.                     'text' => $item->getName(),
  1424.                     'leaf' => true,
  1425.                     'iconCls' => 'pimcore_icon_videothumbnails',
  1426.                     'cls' => 'pimcore_treenode_disabled',
  1427.                     'writeable' => $item->isWriteable(),
  1428.                 ];
  1429.             }
  1430.         }
  1432.         foreach ($groups as $group) {
  1433.             $thumbnails[] = $group;
  1434.         }
  1436.         return $this->adminJson($thumbnails);
  1437.     }
  1439.     /**
  1440.      * @Route("/video-thumbnail-add", name="pimcore_admin_settings_videothumbnailadd", methods={"POST"})
  1441.      *
  1442.      * @param Request $request
  1443.      *
  1444.      * @return JsonResponse
  1445.      */
  1446.     public function videoThumbnailAddAction(Request $request)
  1447.     {
  1448.         $this->checkPermission('thumbnails');
  1450.         $success = false;
  1452.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1454.         if (!$pipe) {
  1455.             $pipe = new Asset\Video\Thumbnail\Config();
  1456.             if (!$pipe->isWriteable()) {
  1457.                 throw new ConfigWriteException();
  1458.             }
  1460.             $pipe->setName($request->get('name'));
  1461.             $pipe->save();
  1463.             $success = true;
  1464.         } else {
  1465.             if (!$pipe->isWriteable()) {
  1466.                 throw new ConfigWriteException();
  1467.             }
  1468.         }
  1470.         return $this->adminJson(['success' => $success, 'id' => $pipe->getName()]);
  1471.     }
  1473.     /**
  1474.      * @Route("/video-thumbnail-delete", name="pimcore_admin_settings_videothumbnaildelete", methods={"DELETE"})
  1475.      *
  1476.      * @param Request $request
  1477.      *
  1478.      * @return JsonResponse
  1479.      */
  1480.     public function videoThumbnailDeleteAction(Request $request)
  1481.     {
  1482.         $this->checkPermission('thumbnails');
  1484.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1486.         if (!$pipe->isWriteable()) {
  1487.             throw new ConfigWriteException();
  1488.         }
  1490.         $pipe->delete();
  1492.         return $this->adminJson(['success' => true]);
  1493.     }
  1495.     /**
  1496.      * @Route("/video-thumbnail-get", name="pimcore_admin_settings_videothumbnailget", methods={"GET"})
  1497.      *
  1498.      * @param Request $request
  1499.      *
  1500.      * @return JsonResponse
  1501.      */
  1502.     public function videoThumbnailGetAction(Request $request)
  1503.     {
  1504.         $this->checkPermission('thumbnails');
  1506.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1508.         $data = $pipe->getObjectVars();
  1509.         $data['writeable'] = $pipe->isWriteable();
  1511.         return $this->adminJson($data);
  1512.     }
  1514.     /**
  1515.      * @Route("/video-thumbnail-update", name="pimcore_admin_settings_videothumbnailupdate", methods={"PUT"})
  1516.      *
  1517.      * @param Request $request
  1518.      *
  1519.      * @return JsonResponse
  1520.      */
  1521.     public function videoThumbnailUpdateAction(Request $request)
  1522.     {
  1523.         $this->checkPermission('thumbnails');
  1525.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1527.         if (!$pipe->isWriteable()) {
  1528.             throw new ConfigWriteException();
  1529.         }
  1531.         $settingsData = $this->decodeJson($request->get('settings'));
  1532.         $mediaData = $this->decodeJson($request->get('medias'));
  1533.         $mediaOrder = $this->decodeJson($request->get('mediaOrder'));
  1535.         foreach ($settingsData as $key => $value) {
  1536.             $setter = 'set' . ucfirst($key);
  1537.             if (method_exists($pipe, $setter)) {
  1538.                 $pipe->$setter($value);
  1539.             }
  1540.         }
  1542.         $pipe->resetItems();
  1544.         uksort($mediaData, function ($a, $b) use ($mediaOrder) {
  1545.             if ($a === 'default') {
  1546.                 return -1;
  1547.             }
  1549.             return ($mediaOrder[$a] < $mediaOrder[$b]) ? -1 : 1;
  1550.         });
  1552.         foreach ($mediaData as $mediaName => $items) {
  1553.             foreach ($items as $item) {
  1554.                 $type = $item['type'];
  1555.                 unset($item['type']);
  1557.                 $pipe->addItem($type, $item, $mediaName);
  1558.             }
  1559.         }
  1561.         $pipe->save();
  1563.         return $this->adminJson(['success' => true]);
  1564.     }
  1566.     /**
  1567.      * @Route("/robots-txt", name="pimcore_admin_settings_robotstxtget", methods={"GET"})
  1568.      *
  1569.      * @return JsonResponse
  1570.      */
  1571.     public function robotsTxtGetAction()
  1572.     {
  1573.         $this->checkPermission('robots.txt');
  1575.         $config = Config::getRobotsConfig();
  1576.         $config = $config->toArray();
  1578.         return $this->adminJson([
  1579.             'success' => true,
  1580.             'data' => $config,
  1581.             'onFileSystem' => file_exists(PIMCORE_WEB_ROOT . '/robots.txt'),
  1582.         ]);
  1583.     }
  1585.     /**
  1586.      * @Route("/robots-txt", name="pimcore_admin_settings_robotstxtput", methods={"PUT"})
  1587.      *
  1588.      * @param Request $request
  1589.      *
  1590.      * @return JsonResponse
  1591.      */
  1592.     public function robotsTxtPutAction(Request $request)
  1593.     {
  1594.         $this->checkPermission('robots.txt');
  1596.         $values = $request->get('data');
  1597.         if (!is_array($values)) {
  1598.             $values = [];
  1599.         }
  1601.         foreach ($values as $siteId => $robotsContent) {
  1602.             SettingsStore::set('robots.txt-' . $siteId, $robotsContent, 'string', 'robots.txt');
  1603.         }
  1605.         return $this->adminJson([
  1606.             'success' => true,
  1607.         ]);
  1608.     }
  1610.     /**
  1611.      * @Route("/website-settings", name="pimcore_admin_settings_websitesettings", methods={"POST"})
  1612.      *
  1613.      * @param Request $request
  1614.      *
  1615.      * @return JsonResponse
  1616.      *
  1617.      * @throws \Exception
  1618.      */
  1619.     public function websiteSettingsAction(Request $request)
  1620.     {
  1621.         $this->checkPermission('website_settings');
  1623.         if ($request->get('data')) {
  1624.             $data = $this->decodeJson($request->get('data'));
  1626.             if (is_array($data)) {
  1627.                 foreach ($data as &$value) {
  1628.                     $value = trim($value);
  1629.                 }
  1630.             }
  1632.             if ($request->get('xaction') == 'destroy') {
  1633.                 $id = $data['id'];
  1634.                 $setting = WebsiteSetting::getById($id);
  1635.                 if ($setting instanceof WebsiteSetting) {
  1636.                     $setting->delete();
  1638.                     return $this->adminJson(['success' => true, 'data' => []]);
  1639.                 }
  1640.             } elseif ($request->get('xaction') == 'update') {
  1641.                 // save routes
  1642.                 $setting = WebsiteSetting::getById($data['id']);
  1643.                 if ($setting instanceof WebsiteSetting) {
  1644.                     switch ($setting->getType()) {
  1645.                         case 'document':
  1646.                         case 'asset':
  1647.                         case 'object':
  1648.                             if (isset($data['data'])) {
  1649.                                 $element = Element\Service::getElementByPath($setting->getType(), $data['data']);
  1650.                                 $data['data'] = $element;
  1651.                             }
  1653.                             break;
  1654.                     }
  1656.                     $setting->setValues($data);
  1657.                     $setting->save();
  1659.                     $data = $this->getWebsiteSettingForEditMode($setting);
  1661.                     return $this->adminJson(['data' => $data, 'success' => true]);
  1662.                 }
  1663.             } elseif ($request->get('xaction') == 'create') {
  1664.                 unset($data['id']);
  1666.                 // save route
  1667.                 $setting = new WebsiteSetting();
  1668.                 $setting->setValues($data);
  1670.                 $setting->save();
  1672.                 return $this->adminJson(['data' => $setting->getObjectVars(), 'success' => true]);
  1673.             }
  1674.         } else {
  1675.             $list = new WebsiteSetting\Listing();
  1677.             $list->setLimit($request->get('limit'));
  1678.             $list->setOffset($request->get('start'));
  1680.             $sortingSettings = \Pimcore\Bundle\AdminBundle\Helper\QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  1681.             if ($sortingSettings['orderKey']) {
  1682.                 $list->setOrderKey($sortingSettings['orderKey']);
  1683.                 $list->setOrder($sortingSettings['order']);
  1684.             } else {
  1685.                 $list->setOrderKey('name');
  1686.                 $list->setOrder('asc');
  1687.             }
  1689.             if ($request->get('filter')) {
  1690.                 $list->setCondition('`name` LIKE ' . $list->quote('%'.$request->get('filter').'%'));
  1691.             }
  1693.             $totalCount = $list->getTotalCount();
  1694.             $list = $list->load();
  1696.             $settings = [];
  1697.             foreach ($list as $item) {
  1698.                 $resultItem = $this->getWebsiteSettingForEditMode($item);
  1699.                 $settings[] = $resultItem;
  1700.             }
  1702.             return $this->adminJson(['data' => $settings, 'success' => true, 'total' => $totalCount]);
  1703.         }
  1705.         return $this->adminJson(['success' => false]);
  1706.     }
  1708.     /**
  1709.      * @param WebsiteSetting $item
  1710.      *
  1711.      * @return array
  1712.      */
  1713.     private function getWebsiteSettingForEditMode($item)
  1714.     {
  1715.         $resultItem = [
  1716.             'id' => $item->getId(),
  1717.             'name' => $item->getName(),
  1718.             'language' => $item->getLanguage(),
  1719.             'type' => $item->getType(),
  1720.             'data' => null,
  1721.             'siteId' => $item->getSiteId(),
  1722.             'creationDate' => $item->getCreationDate(),
  1723.             'modificationDate' => $item->getModificationDate(),
  1724.         ];
  1726.         switch ($item->getType()) {
  1727.             case 'document':
  1728.             case 'asset':
  1729.             case 'object':
  1730.                 $element = $item->getData();
  1731.                 if ($element) {
  1732.                     $resultItem['data'] = $element->getRealFullPath();
  1733.                 }
  1735.                 break;
  1736.             default:
  1737.                 $resultItem['data'] = $item->getData();
  1739.                 break;
  1740.         }
  1742.         return $resultItem;
  1743.     }
  1745.     /**
  1746.      * @Route("/get-available-algorithms", name="pimcore_admin_settings_getavailablealgorithms", methods={"GET"})
  1747.      *
  1748.      * @param Request $request
  1749.      *
  1750.      * @return JsonResponse
  1751.      */
  1752.     public function getAvailableAlgorithmsAction(Request $request)
  1753.     {
  1754.         $options = [
  1755.             [
  1756.                 'key' => 'password_hash',
  1757.                 'value' => 'password_hash',
  1758.             ],
  1759.         ];
  1761.         $algorithms = hash_algos();
  1762.         foreach ($algorithms as $algorithm) {
  1763.             $options[] = [
  1764.                 'key' => $algorithm,
  1765.                 'value' => $algorithm,
  1766.             ];
  1767.         }
  1769.         $result = ['data' => $options, 'success' => true, 'total' => count($options)];
  1771.         return $this->adminJson($result);
  1772.     }
  1774.     /**
  1775.      * deleteViews
  1776.      * delete views for localized fields when languages are removed to
  1777.      * prevent mysql errors
  1778.      *
  1779.      * @param string $language
  1780.      * @param string $dbName
  1781.      */
  1782.     protected function deleteViews($language, $dbName)
  1783.     {
  1784.         $db = \Pimcore\Db::get();
  1785.         $views = $db->fetchAll('SHOW FULL TABLES IN ' . $db->quoteIdentifier($dbName) . " WHERE TABLE_TYPE LIKE 'VIEW'");
  1787.         foreach ($views as $view) {
  1788.             if (preg_match('/^object_localized_[0-9]+_' . $language . '$/', $view['Tables_in_' . $dbName])) {
  1789.                 $sql = 'DROP VIEW ' . $db->quoteIdentifier($view['Tables_in_' . $dbName]);
  1790.                 $db->query($sql);
  1791.             }
  1792.         }
  1793.     }
  1795.     /**
  1796.      * @Route("/test-web2print", name="pimcore_admin_settings_testweb2print", methods={"GET"})
  1797.      *
  1798.      * @param Request $request
  1799.      *
  1800.      * @return Response
  1801.      */
  1802.     public function testWeb2printAction(Request $request)
  1803.     {
  1804.         $this->checkPermission('web2print_settings');
  1806.         $response = $this->render('@PimcoreAdmin/Admin/Settings/testWeb2print.html.twig');
  1807.         $html = $response->getContent();
  1809.         $adapter = \Pimcore\Web2Print\Processor::getInstance();
  1810.         $params = [];
  1812.         if ($adapter instanceof \Pimcore\Web2Print\Processor\WkHtmlToPdf) {
  1813.             $params['adapterConfig'] = '-O landscape';
  1814.         } elseif ($adapter instanceof \Pimcore\Web2Print\Processor\PdfReactor) {
  1815.             $params['adapterConfig'] = [
  1816.                 'javaScriptMode' => 0,
  1817.                 'addLinks' => true,
  1818.                 'appendLog' => true,
  1819.                 'enableDebugMode' => true,
  1820.             ];
  1821.         } elseif ($adapter instanceof \Pimcore\Web2Print\Processor\HeadlessChrome) {
  1822.             $params = Config::getWeb2PrintConfig();
  1823.             $params = $params->get('headlessChromeSettings');
  1824.             $params = json_decode($params, true);
  1825.         }
  1827.         $responseOptions = [
  1828.             'Content-Type' => 'application/pdf',
  1829.         ];
  1831.         $pdfData = $adapter->getPdfFromString($html, $params);
  1833.         return new \Symfony\Component\HttpFoundation\Response(
  1834.             $pdfData,
  1835.             200,
  1836.             $responseOptions
  1838.         );
  1839.     }
  1840. }