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

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\AdminAbstractController;
  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;
  53. use Symfony\Contracts\Translation\TranslatorInterface;
  55. /**
  56.  * @Route("/settings")
  57.  *
  58.  * @internal
  59.  */
  60. class SettingsController extends AdminAbstractController
  61. {
  62.     use StopMessengerWorkersTrait;
  64.     private const CUSTOM_LOGO_PATH = 'custom-logo.image';
  66.     public function __construct(protected TranslatorInterface $translator)
  67.     {
  68.     }
  70.     /**
  71.      * @Route("/display-custom-logo", name="pimcore_settings_display_custom_logo", methods={"GET"})
  72.      *
  73.      * @param Request $request
  74.      *
  75.      * @return StreamedResponse
  76.      */
  77.     public function displayCustomLogoAction(Request $request)
  78.     {
  79.         $mime = 'image/svg+xml';
  80.         if ($request->get('white')) {
  81.             $logo = PIMCORE_WEB_ROOT . '/bundles/pimcoreadmin/img/logo-claim-white.svg';
  82.         } else {
  83.             $logo = PIMCORE_WEB_ROOT . '/bundles/pimcoreadmin/img/logo-claim-gray.svg';
  84.         }
  86.         $stream = fopen($logo, 'rb');
  88.         $storage = Tool\Storage::get('admin');
  89.         if ($storage->fileExists(self::CUSTOM_LOGO_PATH)) {
  90.             try {
  91.                 $mime = $storage->mimeType(self::CUSTOM_LOGO_PATH);
  92.                 $stream = $storage->readStream(self::CUSTOM_LOGO_PATH);
  93.             } catch (\Exception $e) {
  94.                 // do nothing
  95.             }
  96.         }
  98.         return new StreamedResponse(function () use ($stream) {
  99.             fpassthru($stream);
  100.         }, 200, [
  101.             'Content-Type' => $mime,
  102.             'Content-Security-Policy' => "script-src 'none'",
  103.         ]);
  104.     }
  106.     /**
  107.      * @Route("/upload-custom-logo", name="pimcore_admin_settings_uploadcustomlogo", methods={"POST"})
  108.      *
  109.      * @param Request $request
  110.      *
  111.      * @return JsonResponse
  112.      *
  113.      * @throws \Exception
  114.      */
  115.     public function uploadCustomLogoAction(Request $request)
  116.     {
  117.         $logoFile = $request->files->get('Filedata');
  119.         if (!$logoFile instanceof UploadedFile
  120.             || !in_array($logoFile->guessExtension(), ['svg', 'png', 'jpg'])
  121.         ) {
  122.             throw new \Exception('Unsupported file format.');
  123.         }
  125.         $storage = Tool\Storage::get('admin');
  126.         $storage->writeStream(self::CUSTOM_LOGO_PATH, fopen($logoFile->getPathname(), 'rb'));
  128.         // set content-type to text/html, otherwise (when application/json is sent) chrome will complain in
  129.         // Ext.form.Action.Submit and mark the submission as failed
  131.         $response = $this->adminJson(['success' => true]);
  132.         $response->headers->set('Content-Type', 'text/html');
  134.         return $response;
  135.     }
  137.     /**
  138.      * @Route("/delete-custom-logo", name="pimcore_admin_settings_deletecustomlogo", methods={"DELETE"})
  139.      *
  140.      * @param Request $request
  141.      *
  142.      * @return JsonResponse
  143.      */
  144.     public function deleteCustomLogoAction(Request $request)
  145.     {
  146.         if (Tool\Storage::get('admin')->fileExists(self::CUSTOM_LOGO_PATH)) {
  147.             Tool\Storage::get('admin')->delete(self::CUSTOM_LOGO_PATH);
  148.         }
  150.         return $this->adminJson(['success' => true]);
  151.     }
  153.     /**
  154.      * Used by the predefined metadata grid
  155.      *
  156.      * @Route("/predefined-metadata", name="pimcore_admin_settings_metadata", methods={"POST"})
  157.      *
  158.      * @param Request $request
  159.      *
  160.      * @return JsonResponse
  161.      */
  162.     public function metadataAction(Request $request)
  163.     {
  164.         $this->checkPermission('asset_metadata');
  166.         if ($request->get('data')) {
  167.             if ($request->get('xaction') == 'destroy') {
  168.                 $data = $this->decodeJson($request->get('data'));
  169.                 $id = $data['id'];
  170.                 $metadata = Metadata\Predefined::getById($id);
  171.                 if (!$metadata->isWriteable()) {
  172.                     throw new ConfigWriteException();
  173.                 }
  174.                 $metadata->delete();
  176.                 return $this->adminJson(['success' => true, 'data' => []]);
  177.             } elseif ($request->get('xaction') == 'update') {
  178.                 $data = $this->decodeJson($request->get('data'));
  180.                 // save type
  181.                 $metadata = Metadata\Predefined::getById($data['id']);
  182.                 if (!$metadata->isWriteable()) {
  183.                     throw new ConfigWriteException();
  184.                 }
  185.                 $metadata->setValues($data);
  187.                 $existingItem = Metadata\Predefined\Listing::getByKeyAndLanguage($metadata->getName(), $metadata->getLanguage(), $metadata->getTargetSubtype());
  188.                 if ($existingItem && $existingItem->getId() != $metadata->getId()) {
  189.                     return $this->adminJson(['message' => 'rule_violation', 'success' => false]);
  190.                 }
  192.                 $metadata->minimize();
  193.                 $metadata->save();
  194.                 $metadata->expand();
  196.                 $responseData = $metadata->getObjectVars();
  197.                 $responseData['writeable'] = $metadata->isWriteable();
  199.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  200.             } elseif ($request->get('xaction') == 'create') {
  201.                 if (!(new Metadata\Predefined())->isWriteable()) {
  202.                     throw new ConfigWriteException();
  203.                 }
  204.                 $data = $this->decodeJson($request->get('data'));
  205.                 unset($data['id']);
  207.                 // save type
  208.                 $metadata = Metadata\Predefined::create();
  210.                 $metadata->setValues($data);
  212.                 $existingItem = Metadata\Predefined\Listing::getByKeyAndLanguage($metadata->getName(), $metadata->getLanguage(), $metadata->getTargetSubtype());
  213.                 if ($existingItem) {
  214.                     return $this->adminJson(['message' => 'rule_violation', 'success' => false]);
  215.                 }
  217.                 $metadata->save();
  219.                 $responseData = $metadata->getObjectVars();
  220.                 $responseData['writeable'] = $metadata->isWriteable();
  222.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  223.             }
  224.         } else {
  225.             // get list of types
  226.             $list = new Metadata\Predefined\Listing();
  228.             if ($filter = $request->get('filter')) {
  229.                 $list->setFilter(function (Metadata\Predefined $predefined) use ($filter) {
  230.                     foreach ($predefined->getObjectVars() as $value) {
  231.                         if (stripos((string)$value, $filter) !== false) {
  232.                             return true;
  233.                         }
  234.                     }
  236.                     return false;
  237.                 });
  238.             }
  240.             $properties = [];
  241.             foreach ($list->getDefinitions() as $metadata) {
  242.                 $metadata->expand();
  243.                 $data = $metadata->getObjectVars();
  244.                 $data['writeable'] = $metadata->isWriteable();
  245.                 $properties[] = $data;
  246.             }
  248.             return $this->adminJson(['data' => $properties, 'success' => true, 'total' => $list->getTotalCount()]);
  249.         }
  251.         return $this->adminJson(['success' => false]);
  252.     }
  254.     /**
  255.      * @Route("/get-predefined-metadata", name="pimcore_admin_settings_getpredefinedmetadata", methods={"GET"})
  256.      *
  257.      * @param Request $request
  258.      *
  259.      * @return JsonResponse
  260.      */
  261.     public function getPredefinedMetadataAction(Request $request)
  262.     {
  263.         $type = $request->get('type');
  264.         $subType = $request->get('subType');
  265.         $group = $request->get('group');
  266.         $list = Metadata\Predefined\Listing::getByTargetType($type, [$subType]);
  267.         $result = [];
  268.         foreach ($list as $item) {
  269.             $itemGroup = $item->getGroup() ?? '';
  270.             if ($group === 'default' || $group === $itemGroup) {
  271.                 $item->expand();
  272.                 $data = $item->getObjectVars();
  273.                 $data['writeable'] = $item->isWriteable();
  274.                 $result[] = $data;
  275.             }
  276.         }
  278.         return $this->adminJson(['data' => $result, 'success' => true]);
  279.     }
  281.     /**
  282.      * @Route("/properties", name="pimcore_admin_settings_properties", methods={"POST"})
  283.      *
  284.      * @param Request $request
  285.      *
  286.      * @return JsonResponse
  287.      */
  288.     public function propertiesAction(Request $request)
  289.     {
  290.         if ($request->get('data')) {
  291.             $this->checkPermission('predefined_properties');
  293.             if ($request->get('xaction') == 'destroy') {
  294.                 $data = $this->decodeJson($request->get('data'));
  295.                 $id = $data['id'];
  296.                 $property = Property\Predefined::getById($id);
  297.                 if (!$property->isWriteable()) {
  298.                     throw new ConfigWriteException();
  299.                 }
  300.                 $property->delete();
  302.                 return $this->adminJson(['success' => true, 'data' => []]);
  303.             } elseif ($request->get('xaction') == 'update') {
  304.                 $data = $this->decodeJson($request->get('data'));
  306.                 // save type
  307.                 $property = Property\Predefined::getById($data['id']);
  308.                 if (!$property->isWriteable()) {
  309.                     throw new ConfigWriteException();
  310.                 }
  311.                 if (is_array($data['ctype'])) {
  312.                     $data['ctype'] = implode(',', $data['ctype']);
  313.                 }
  314.                 $property->setValues($data);
  316.                 $property->save();
  318.                 $responseData = $property->getObjectVars();
  319.                 $responseData['writeable'] = $property->isWriteable();
  321.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  322.             } elseif ($request->get('xaction') == 'create') {
  323.                 if (!(new Property\Predefined())->isWriteable()) {
  324.                     throw new ConfigWriteException();
  325.                 }
  326.                 $data = $this->decodeJson($request->get('data'));
  327.                 unset($data['id']);
  329.                 // save type
  330.                 $property = Property\Predefined::create();
  331.                 $property->setValues($data);
  333.                 $property->save();
  335.                 $responseData = $property->getObjectVars();
  336.                 $responseData['writeable'] = $property->isWriteable();
  338.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  339.             }
  340.         } else {
  341.             // get list of types
  342.             $list = new Property\Predefined\Listing();
  344.             if ($filter = $request->get('filter')) {
  345.                 $list->setFilter(function (Property\Predefined $predefined) use ($filter) {
  346.                     foreach ($predefined->getObjectVars() as $value) {
  347.                         if ($value) {
  348.                             $cellValues = is_array($value) ? $value : [$value];
  350.                             foreach ($cellValues as $cellValue) {
  351.                                 if (stripos((string)$cellValue, $filter) !== false) {
  352.                                     return true;
  353.                                 }
  354.                             }
  355.                         }
  356.                     }
  358.                     return false;
  359.                 });
  360.             }
  362.             $properties = [];
  363.             foreach ($list->getProperties() as $property) {
  364.                 $data = $property->getObjectVars();
  365.                 $data['writeable'] = $property->isWriteable();
  366.                 $properties[] = $data;
  367.             }
  369.             return $this->adminJson(['data' => $properties, 'success' => true, 'total' => $list->getTotalCount()]);
  370.         }
  372.         return $this->adminJson(['success' => false]);
  373.     }
  375.     /**
  376.      * @Route("/get-system", name="pimcore_admin_settings_getsystem", methods={"GET"})
  377.      *
  378.      * @param Request $request
  379.      * @param Config $config
  380.      *
  381.      * @return JsonResponse
  382.      */
  383.     public function getSystemAction(Request $request, Config $config)
  384.     {
  385.         $this->checkPermission('system_settings');
  387.         $valueArray = [
  388.             'general' => $config['general'],
  389.             'documents' => $config['documents'],
  390.             'assets' => $config['assets'],
  391.             'objects' => $config['objects'],
  392.             'branding' => $config['branding'],
  393.             'email' => $config['email'],
  394.         ];
  396.         $locales = Tool::getSupportedLocales();
  397.         $languageOptions = [];
  398.         $validLanguages = [];
  399.         foreach ($locales as $short => $translation) {
  400.             if (!empty($short)) {
  401.                 $languageOptions[] = [
  402.                     'language' => $short,
  403.                     'display' => $translation . " ($short)",
  404.                 ];
  405.                 $validLanguages[] = $short;
  406.             }
  407.         }
  409.         $valueArray['general']['valid_language'] = explode(',', $valueArray['general']['valid_languages']);
  411.         //for "wrong" legacy values
  412.         foreach ($valueArray['general']['valid_language'] as $existingValue) {
  413.             if (!in_array($existingValue, $validLanguages)) {
  414.                 $languageOptions[] = [
  415.                     'language' => $existingValue,
  416.                     'display' => $existingValue,
  417.                 ];
  418.             }
  419.         }
  421.         $response = [
  422.             'values' => $valueArray,
  423.             'config' => [
  424.                 'languages' => $languageOptions,
  425.             ],
  426.         ];
  428.         return $this->adminJson($response);
  429.     }
  431.     /**
  432.      * @Route("/set-system", name="pimcore_admin_settings_setsystem", methods={"PUT"})
  433.      *
  434.      * @param Request $request
  435.      * @param LocaleServiceInterface $localeService
  436.      *
  437.      * @return JsonResponse
  438.      */
  439.     public function setSystemAction(
  440.         LocaleServiceInterface $localeService,
  441.         Request $request,
  442.         KernelInterface $kernel,
  443.         EventDispatcherInterface $eventDispatcher,
  444.         CoreCacheHandler $cache,
  445.         Filesystem $filesystem,
  446.         CacheClearer $symfonyCacheClearer
  447.     ) {
  448.         $this->checkPermission('system_settings');
  450.         $values = $this->decodeJson($request->get('data'));
  452.         $existingValues = [];
  454.         try {
  455.             $file = Config::locateConfigFile('system.yml');
  456.             $existingValues = Config::getConfigInstance($file, true);
  457.         } catch (\Exception $e) {
  458.             // nothing to do
  459.         }
  461.         // localized error pages
  462.         $localizedErrorPages = [];
  464.         // fallback languages
  465.         $fallbackLanguages = [];
  466.         $existingValues['pimcore']['general']['fallback_languages'] = [];
  467.         $languages = explode(',', $values['general.validLanguages']);
  468.         $filteredLanguages = [];
  470.         foreach ($languages as $language) {
  471.             if (isset($values['general.fallbackLanguages.' . $language])) {
  472.                 $fallbackLanguages[$language] = str_replace(' ', '', $values['general.fallbackLanguages.' . $language]);
  473.             }
  475.             // localized error pages
  476.             if (isset($values['documents.error_pages.localized.' . $language])) {
  477.                 $localizedErrorPages[$language] = $values['documents.error_pages.localized.' . $language];
  478.             }
  480.             if ($localeService->isLocale($language)) {
  481.                 $filteredLanguages[] = $language;
  482.             }
  483.         }
  485.         // check if there's a fallback language endless loop
  486.         foreach ($fallbackLanguages as $sourceLang => $targetLang) {
  487.             $this->checkFallbackLanguageLoop($sourceLang, $fallbackLanguages);
  488.         }
  490.         $settings['pimcore'] = [
  491.             'general' => [
  492.                 'domain' => $values['general.domain'],
  493.                 'redirect_to_maindomain' => $values['general.redirect_to_maindomain'],
  494.                 'language' => $values['general.language'],
  495.                 'valid_languages' => implode(',', $filteredLanguages),
  496.                 'fallback_languages' => $fallbackLanguages,
  497.                 'default_language' => $values['general.defaultLanguage'],
  498.                 'debug_admin_translations' => $values['general.debug_admin_translations'],
  499.             ],
  500.             'documents' => [
  501.                 'versions' => [
  502.                     'days' => $values['documents.versions.days'] ?? null,
  503.                     'steps' => $values['documents.versions.steps'] ?? null,
  504.                 ],
  505.                 'error_pages' => [
  506.                     'default' => $values['documents.error_pages.default'],
  507.                     'localized' => $localizedErrorPages,
  508.                 ],
  509.             ],
  510.             'objects' => [
  511.                 'versions' => [
  512.                     'days' => $values['objects.versions.days'] ?? null,
  513.                     'steps' => $values['objects.versions.steps'] ?? null,
  514.                 ],
  515.             ],
  516.             'assets' => [
  517.                 'versions' => [
  518.                     'days' => $values['assets.versions.days'] ?? null,
  519.                     'steps' => $values['assets.versions.steps'] ?? null,
  520.                 ],
  521.                 'hide_edit_image' => $values['assets.hide_edit_image'],
  522.                 'disable_tree_preview' => $values['assets.disable_tree_preview'],
  523.             ],
  524.         ];
  526.         //branding
  527.         $settings['pimcore_admin'] = [
  528.             'branding' =>
  529.                 [
  530.                     'login_screen_invert_colors' => $values['branding.login_screen_invert_colors'],
  531.                     'color_login_screen' => $values['branding.color_login_screen'],
  532.                     'color_admin_interface' => $values['branding.color_admin_interface'],
  533.                     'color_admin_interface_background' => $values['branding.color_admin_interface_background'],
  534.                     'login_screen_custom_image' => str_replace('%', '%%', $values['branding.login_screen_custom_image']),
  535.                 ],
  536.         ];
  538.         if (array_key_exists('email.debug.emailAddresses', $values) && $values['email.debug.emailAddresses']) {
  539.             $settings['pimcore']['email']['debug']['email_addresses'] = $values['email.debug.emailAddresses'];
  540.         }
  542.         $settingsYml = Yaml::dump($settings, 5);
  543.         $configFile = Config::locateConfigFile('system.yml');
  544.         File::put($configFile, $settingsYml);
  546.         // clear all caches
  547.         $this->clearSymfonyCache($request, $kernel, $eventDispatcher, $symfonyCacheClearer);
  548.         $this->stopMessengerWorkers();
  550.         $eventDispatcher->addListener(KernelEvents::TERMINATE, function (TerminateEvent $event) use (
  551.             $cache, $eventDispatcher, $filesystem
  552.         ) {
  553.             // we need to clear the cache with a delay, because the cache is used by messenger:stop-workers
  554.             // to send the stop signal to all worker processes
  555.             sleep(2);
  556.             $this->clearPimcoreCache($cache, $eventDispatcher, $filesystem);
  557.         });
  559.         return $this->adminJson(['success' => true]);
  560.     }
  562.     /**
  563.      * @param string $source
  564.      * @param array $definitions
  565.      * @param array $fallbacks
  566.      *
  567.      * @throws \Exception
  568.      */
  569.     protected function checkFallbackLanguageLoop($source, $definitions, $fallbacks = [])
  570.     {
  571.         if (isset($definitions[$source])) {
  572.             $targets = explode(',', $definitions[$source]);
  573.             foreach ($targets as $l) {
  574.                 $target = trim($l);
  575.                 if ($target) {
  576.                     if (in_array($target, $fallbacks)) {
  577.                         throw new \Exception("Language `$source` | `$target` causes an infinte loop.");
  578.                     }
  579.                     $fallbacks[] = $target;
  581.                     $this->checkFallbackLanguageLoop($target, $definitions, $fallbacks);
  582.                 }
  583.             }
  584.         } else {
  585.             throw new \Exception("Language `$source` doesn't exist");
  586.         }
  587.     }
  589.     /**
  590.      * @Route("/get-web2print", name="pimcore_admin_settings_getweb2print", methods={"GET"})
  591.      *
  592.      * @param Request $request
  593.      *
  594.      * @return JsonResponse
  595.      */
  596.     public function getWeb2printAction(Request $request)
  597.     {
  598.         $this->checkPermission('web2print_settings');
  600.         $values = Config::getWeb2PrintConfig();
  601.         $valueArray = $values->toArray();
  603.         $optionsString = [];
  604.         if ($valueArray['wkhtml2pdfOptions'] ?? false) {
  605.             foreach ($valueArray['wkhtml2pdfOptions'] as $key => $value) {
  606.                 $tmpStr = '--'.$key;
  607.                 if ($value !== null && $value !== '') {
  608.                     $tmpStr .= ' '.$value;
  609.                 }
  610.                 $optionsString[] = $tmpStr;
  611.             }
  612.         }
  613.         $valueArray['wkhtml2pdfOptions'] = implode("\n", $optionsString);
  615.         $response = [
  616.             'values' => $valueArray,
  617.         ];
  619.         return $this->adminJson($response);
  620.     }
  622.     /**
  623.      * @Route("/set-web2print", name="pimcore_admin_settings_setweb2print", methods={"PUT"})
  624.      *
  625.      * @param Request $request
  626.      *
  627.      * @return JsonResponse
  628.      */
  629.     public function setWeb2printAction(Request $request)
  630.     {
  631.         $this->checkPermission('web2print_settings');
  633.         $values = $this->decodeJson($request->get('data'));
  635.         unset($values['documentation']);
  636.         unset($values['additions']);
  637.         unset($values['json_converter']);
  639.         if ($values['wkhtml2pdfOptions']) {
  640.             $optionArray = [];
  641.             $lines = explode("\n", $values['wkhtml2pdfOptions']);
  642.             foreach ($lines as $line) {
  643.                 $parts = explode(' ', substr($line, 2));
  644.                 $key = trim($parts[0]);
  645.                 if ($key) {
  646.                     $value = trim($parts[1] ?? '');
  647.                     $optionArray[$key] = $value;
  648.                 }
  649.             }
  650.             $values['wkhtml2pdfOptions'] = $optionArray;
  651.         }
  653.         \Pimcore\Web2Print\Config::save($values);
  655.         return $this->adminJson(['success' => true]);
  656.     }
  658.     /**
  659.      * @Route("/clear-cache", name="pimcore_admin_settings_clearcache", methods={"DELETE"})
  660.      *
  661.      * @param Request $request
  662.      * @param KernelInterface $kernel
  663.      * @param EventDispatcherInterface $eventDispatcher
  664.      * @param CoreCacheHandler $cache
  665.      * @param Filesystem $filesystem
  666.      * @param CacheClearer $symfonyCacheClearer
  667.      *
  668.      * @return JsonResponse
  669.      */
  670.     public function clearCacheAction(
  671.         Request $request,
  672.         KernelInterface $kernel,
  673.         EventDispatcherInterface $eventDispatcher,
  674.         CoreCacheHandler $cache,
  675.         Filesystem $filesystem,
  676.         CacheClearer $symfonyCacheClearer
  677.     ) {
  678.         $this->checkPermissionsHasOneOf(['clear_cache', 'system_settings']);
  680.         $result = [
  681.             'success' => true,
  682.         ];
  684.         $clearPimcoreCache = !(bool)$request->get('only_symfony_cache');
  685.         $clearSymfonyCache = !(bool)$request->get('only_pimcore_cache');
  687.         if ($clearPimcoreCache) {
  688.             $this->clearPimcoreCache($cache, $eventDispatcher, $filesystem);
  689.         }
  691.         if ($clearSymfonyCache) {
  692.             $this->clearSymfonyCache($request, $kernel, $eventDispatcher, $symfonyCacheClearer);
  693.         }
  695.         $response = new JsonResponse($result);
  697.         if ($clearSymfonyCache) {
  698.             // we send the response directly here and exit to make sure no code depending on the stale container
  699.             // is running after this
  700.             $response->sendHeaders();
  701.             $response->sendContent();
  702.             exit;
  703.         }
  705.         return $response;
  706.     }
  708.     private function clearPimcoreCache(
  709.         CoreCacheHandler $cache,
  710.         EventDispatcherInterface $eventDispatcher,
  711.         Filesystem $filesystem,
  712.     ): void {
  713.         // empty document cache
  714.         $cache->clearAll();
  716.         if ($filesystem->exists(PIMCORE_CACHE_DIRECTORY)) {
  717.             $filesystem->remove(PIMCORE_CACHE_DIRECTORY);
  718.         }
  720.         // PIMCORE-1854 - recreate .dummy file => should remain
  721.         File::put(PIMCORE_CACHE_DIRECTORY . '/.gitkeep', '');
  723.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR);
  724.     }
  726.     private function clearSymfonyCache(
  727.         Request $request,
  728.         KernelInterface $kernel,
  729.         EventDispatcherInterface $eventDispatcher,
  730.         CacheClearer $symfonyCacheClearer,
  731.     ): void {
  732.         // pass one or move env parameters to clear multiple envs
  733.         // if no env is passed it will use the current one
  734.         $environments = $request->get('env', $kernel->getEnvironment());
  736.         if (!is_array($environments)) {
  737.             $environments = trim((string)$environments);
  739.             if (empty($environments)) {
  740.                 $environments = [];
  741.             } else {
  742.                 $environments = [$environments];
  743.             }
  744.         }
  746.         if (empty($environments)) {
  747.             $environments = [$kernel->getEnvironment()];
  748.         }
  750.         $result['environments'] = $environments;
  752.         if (in_array($kernel->getEnvironment(), $environments)) {
  753.             // remove terminate and exception event listeners for the current env as they break with a
  754.             // cleared container - see #2434
  755.             foreach ($eventDispatcher->getListeners(KernelEvents::TERMINATE) as $listener) {
  756.                 $eventDispatcher->removeListener(KernelEvents::TERMINATE, $listener);
  757.             }
  759.             foreach ($eventDispatcher->getListeners(KernelEvents::EXCEPTION) as $listener) {
  760.                 $eventDispatcher->removeListener(KernelEvents::EXCEPTION, $listener);
  761.             }
  762.         }
  764.         foreach ($environments as $environment) {
  765.             try {
  766.                 $symfonyCacheClearer->clear($environment);
  767.             } catch (\Throwable $e) {
  768.                 $errors = $result['errors'] ?? [];
  769.                 $errors[] = $e->getMessage();
  771.                 $result = array_merge($result, [
  772.                     'success' => false,
  773.                     'errors' => $errors,
  774.                 ]);
  775.             }
  776.         }
  777.     }
  779.     /**
  780.      * @Route("/clear-output-cache", name="pimcore_admin_settings_clearoutputcache", methods={"DELETE"})
  781.      *
  782.      * @param EventDispatcherInterface $eventDispatcher
  783.      *
  784.      * @return JsonResponse
  785.      */
  786.     public function clearOutputCacheAction(EventDispatcherInterface $eventDispatcher)
  787.     {
  788.         $this->checkPermission('clear_fullpage_cache');
  790.         // remove "output" out of the ignored tags, if a cache lifetime is specified
  791.         Cache::removeIgnoredTagOnClear('output');
  793.         // empty document cache
  794.         Cache::clearTags(['output', 'output_lifetime']);
  796.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR_FULLPAGE_CACHE);
  798.         return $this->adminJson(['success' => true]);
  799.     }
  801.     /**
  802.      * @Route("/clear-temporary-files", name="pimcore_admin_settings_cleartemporaryfiles", methods={"DELETE"})
  803.      *
  804.      * @param EventDispatcherInterface $eventDispatcher
  805.      *
  806.      * @return JsonResponse
  807.      */
  808.     public function clearTemporaryFilesAction(EventDispatcherInterface $eventDispatcher)
  809.     {
  810.         $this->checkPermission('clear_temp_files');
  812.         // public files
  813.         Tool\Storage::get('thumbnail')->deleteDirectory('/');
  814.         Db::get()->executeQuery('TRUNCATE TABLE assets_image_thumbnail_cache');
  816.         Tool\Storage::get('asset_cache')->deleteDirectory('/');
  818.         // system files
  819.         recursiveDelete(PIMCORE_SYSTEM_TEMP_DIRECTORY, false);
  821.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR_TEMPORARY_FILES);
  823.         return $this->adminJson(['success' => true]);
  824.     }
  826.     /**
  827.      * @Route("/staticroutes", name="pimcore_admin_settings_staticroutes", methods={"POST"})
  828.      *
  829.      * @param Request $request
  830.      *
  831.      * @return JsonResponse
  832.      */
  833.     public function staticroutesAction(Request $request)
  834.     {
  835.         if ($request->get('data')) {
  836.             $this->checkPermission('routes');
  838.             $data = $this->decodeJson($request->get('data'));
  840.             if (is_array($data)) {
  841.                 foreach ($data as &$value) {
  842.                     if (is_string($value)) {
  843.                         $value = trim($value);
  844.                     }
  845.                 }
  846.             }
  848.             if ($request->get('xaction') == 'destroy') {
  849.                 $data = $this->decodeJson($request->get('data'));
  850.                 $id = $data['id'];
  851.                 $route = Staticroute::getById($id);
  852.                 if (!$route->isWriteable()) {
  853.                     throw new ConfigWriteException();
  854.                 }
  855.                 $route->delete();
  857.                 return $this->adminJson(['success' => true, 'data' => []]);
  858.             } elseif ($request->get('xaction') == 'update') {
  859.                 // save routes
  860.                 $route = Staticroute::getById($data['id']);
  861.                 if (!$route->isWriteable()) {
  862.                     throw new ConfigWriteException();
  863.                 }
  865.                 $route->setValues($data);
  867.                 $route->save();
  869.                 return $this->adminJson(['data' => $route->getObjectVars(), 'success' => true]);
  870.             } elseif ($request->get('xaction') == 'create') {
  871.                 if (!(new Staticroute())->isWriteable()) {
  872.                     throw new ConfigWriteException();
  873.                 }
  874.                 unset($data['id']);
  876.                 // save route
  877.                 $route = new Staticroute();
  878.                 $route->setValues($data);
  880.                 $route->save();
  882.                 $responseData = $route->getObjectVars();
  883.                 $responseData['writeable'] = $route->isWriteable();
  885.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  886.             }
  887.         } else {
  888.             // get list of routes
  890.             $list = new Staticroute\Listing();
  892.             if ($filter = $request->get('filter')) {
  893.                 $list->setFilter(function (Staticroute $staticRoute) use ($filter) {
  894.                     foreach ($staticRoute->getObjectVars() as $value) {
  895.                         if (!is_scalar($value)) {
  896.                             continue;
  897.                         }
  898.                         if (stripos((string)$value, $filter) !== false) {
  899.                             return true;
  900.                         }
  901.                     }
  903.                     return false;
  904.                 });
  905.             }
  907.             $routes = [];
  908.             foreach ($list->getRoutes() as $routeFromList) {
  909.                 $route = $routeFromList->getObjectVars();
  910.                 $route['writeable'] = $routeFromList->isWriteable();
  911.                 if (is_array($routeFromList->getSiteId())) {
  912.                     $route['siteId'] = implode(',', $routeFromList->getSiteId());
  913.                 }
  914.                 $routes[] = $route;
  915.             }
  917.             return $this->adminJson(['data' => $routes, 'success' => true, 'total' => $list->getTotalCount()]);
  918.         }
  920.         return $this->adminJson(['success' => false]);
  921.     }
  923.     /**
  924.      * @Route("/get-available-admin-languages", name="pimcore_admin_settings_getavailableadminlanguages", methods={"GET"})
  925.      *
  926.      * @param Request $request
  927.      *
  928.      * @return JsonResponse
  929.      */
  930.     public function getAvailableAdminLanguagesAction(Request $request)
  931.     {
  932.         $langs = [];
  933.         $availableLanguages = Tool\Admin::getLanguages();
  934.         $locales = Tool::getSupportedLocales();
  936.         foreach ($availableLanguages as $lang) {
  937.             if (array_key_exists($lang, $locales)) {
  938.                 $langs[] = [
  939.                     'language' => $lang,
  940.                     'display' => $locales[$lang],
  941.                 ];
  942.             }
  943.         }
  945.         usort($langs, function ($a, $b) {
  946.             return strcmp($a['display'], $b['display']);
  947.         });
  949.         return $this->adminJson($langs);
  950.     }
  952.     /**
  953.      * @Route("/glossary", name="pimcore_admin_settings_glossary", methods={"POST"})
  954.      *
  955.      * @param Request $request
  956.      *
  957.      * @return JsonResponse
  958.      */
  959.     public function glossaryAction(Request $request)
  960.     {
  961.         if ($request->get('data')) {
  962.             $this->checkPermission('glossary');
  964.             Cache::clearTag('glossary');
  966.             if ($request->get('xaction') == 'destroy') {
  967.                 $data = $this->decodeJson($request->get('data'));
  968.                 $id = $data['id'];
  969.                 $glossary = Glossary::getById($id);
  970.                 $glossary->delete();
  972.                 return $this->adminJson(['success' => true, 'data' => []]);
  973.             } elseif ($request->get('xaction') == 'update') {
  974.                 $data = $this->decodeJson($request->get('data'));
  976.                 // save glossary
  977.                 $glossary = Glossary::getById($data['id']);
  979.                 if (!empty($data['link'])) {
  980.                     if ($doc = Document::getByPath($data['link'])) {
  981.                         $data['link'] = $doc->getId();
  982.                     }
  983.                 }
  985.                 $glossary->setValues($data);
  987.                 $glossary->save();
  989.                 if ($link = $glossary->getLink()) {
  990.                     if ((int)$link > 0) {
  991.                         if ($doc = Document::getById((int)$link)) {
  992.                             $glossary->setLink($doc->getRealFullPath());
  993.                         }
  994.                     }
  995.                 }
  997.                 return $this->adminJson(['data' => $glossary, 'success' => true]);
  998.             } elseif ($request->get('xaction') == 'create') {
  999.                 $data = $this->decodeJson($request->get('data'));
  1000.                 unset($data['id']);
  1002.                 // save glossary
  1003.                 $glossary = new Glossary();
  1005.                 if (!empty($data['link'])) {
  1006.                     if ($doc = Document::getByPath($data['link'])) {
  1007.                         $data['link'] = $doc->getId();
  1008.                     }
  1009.                 }
  1011.                 $glossary->setValues($data);
  1013.                 $glossary->save();
  1015.                 if ($link = $glossary->getLink()) {
  1016.                     if ((int)$link > 0) {
  1017.                         if ($doc = Document::getById((int)$link)) {
  1018.                             $glossary->setLink($doc->getRealFullPath());
  1019.                         }
  1020.                     }
  1021.                 }
  1023.                 return $this->adminJson(['data' => $glossary->getObjectVars(), 'success' => true]);
  1024.             }
  1025.         } else {
  1026.             // get list of glossaries
  1028.             $list = new Glossary\Listing();
  1029.             $list->setLimit($request->get('limit'));
  1030.             $list->setOffset($request->get('start'));
  1032.             $sortingSettings = \Pimcore\Bundle\AdminBundle\Helper\QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  1033.             if ($sortingSettings['orderKey']) {
  1034.                 $list->setOrderKey($sortingSettings['orderKey']);
  1035.                 $list->setOrder($sortingSettings['order']);
  1036.             }
  1038.             if ($request->get('filter')) {
  1039.                 $list->setCondition('`text` LIKE ' . $list->quote('%'.$request->get('filter').'%'));
  1040.             }
  1042.             $list->load();
  1044.             $glossaries = [];
  1045.             foreach ($list->getGlossary() as $glossary) {
  1046.                 if ($link = $glossary->getLink()) {
  1047.                     if ((int)$link > 0) {
  1048.                         if ($doc = Document::getById((int)$link)) {
  1049.                             $glossary->setLink($doc->getRealFullPath());
  1050.                         }
  1051.                     }
  1052.                 }
  1054.                 $glossaries[] = $glossary->getObjectVars();
  1055.             }
  1057.             return $this->adminJson(['data' => $glossaries, 'success' => true, 'total' => $list->getTotalCount()]);
  1058.         }
  1060.         return $this->adminJson(['success' => false]);
  1061.     }
  1063.     /**
  1064.      * @Route("/get-available-sites", name="pimcore_admin_settings_getavailablesites", methods={"GET"})
  1065.      *
  1066.      * @param Request $request
  1067.      *
  1068.      * @return JsonResponse
  1069.      */
  1070.     public function getAvailableSitesAction(Request $request)
  1071.     {
  1072.         $excludeMainSite = $request->get('excludeMainSite');
  1074.         $sitesList = new Model\Site\Listing();
  1075.         $sitesObjects = $sitesList->load();
  1076.         $sites = [];
  1077.         if (!$excludeMainSite) {
  1078.             $sites[] = [
  1079.                 'id' => 'default',
  1080.                 'rootId' => 1,
  1081.                 'domains' => '',
  1082.                 'rootPath' => '/',
  1083.                 'domain' => $this->translator->trans('main_site'),
  1084.             ];
  1085.         }
  1087.         foreach ($sitesObjects as $site) {
  1088.             if ($site->getRootDocument()) {
  1089.                 if ($site->getMainDomain()) {
  1090.                     $sites[] = [
  1091.                         'id' => $site->getId(),
  1092.                         'rootId' => $site->getRootId(),
  1093.                         'domains' => implode(',', $site->getDomains()),
  1094.                         'rootPath' => $site->getRootPath(),
  1095.                         'domain' => $site->getMainDomain(),
  1096.                     ];
  1097.                 }
  1098.             } else {
  1099.                 // site is useless, parent doesn't exist anymore
  1100.                 $site->delete();
  1101.             }
  1102.         }
  1104.         return $this->adminJson($sites);
  1105.     }
  1107.     /**
  1108.      * @Route("/get-available-countries", name="pimcore_admin_settings_getavailablecountries", methods={"GET"})
  1109.      *
  1110.      * @param LocaleServiceInterface $localeService
  1111.      *
  1112.      * @return JsonResponse
  1113.      */
  1114.     public function getAvailableCountriesAction(LocaleServiceInterface $localeService)
  1115.     {
  1116.         $countries = $localeService->getDisplayRegions();
  1117.         asort($countries);
  1119.         $options = [];
  1121.         foreach ($countries as $short => $translation) {
  1122.             if (strlen($short) == 2) {
  1123.                 $options[] = [
  1124.                     'key' => $translation . ' (' . $short . ')',
  1125.                     'value' => $short,
  1126.                 ];
  1127.             }
  1128.         }
  1130.         $result = ['data' => $options, 'success' => true, 'total' => count($options)];
  1132.         return $this->adminJson($result);
  1133.     }
  1135.     /**
  1136.      * @Route("/thumbnail-adapter-check", name="pimcore_admin_settings_thumbnailadaptercheck", methods={"GET"})
  1137.      *
  1138.      * @param Request $request
  1139.      * @param TranslatorInterface $translator
  1140.      *
  1141.      * @return Response
  1142.      */
  1143.     public function thumbnailAdapterCheckAction(Request $request, TranslatorInterface $translator)
  1144.     {
  1145.         $content = '';
  1147.         $instance = \Pimcore\Image::getInstance();
  1148.         if ($instance instanceof \Pimcore\Image\Adapter\GD) {
  1149.             $content = '<span style="color: red; font-weight: bold;padding: 10px;margin:0 0 20px 0;border:1px solid red;display:block;">' .
  1150.                 $translator->trans('important_use_imagick_pecl_extensions_for_best_results_gd_is_just_a_fallback_with_less_quality', [], 'admin') .
  1151.                 '</span>';
  1152.         }
  1154.         return new Response($content);
  1155.     }
  1157.     /**
  1158.      * @Route("/thumbnail-tree", name="pimcore_admin_settings_thumbnailtree", methods={"GET", "POST"})
  1159.      *
  1160.      * @return JsonResponse
  1161.      */
  1162.     public function thumbnailTreeAction()
  1163.     {
  1164.         $this->checkPermission('thumbnails');
  1166.         $thumbnails = [];
  1168.         $list = new Asset\Image\Thumbnail\Config\Listing();
  1170.         $groups = [];
  1171.         foreach ($list->getThumbnails() as $item) {
  1172.             if ($item->getGroup()) {
  1173.                 if (empty($groups[$item->getGroup()])) {
  1174.                     $groups[$item->getGroup()] = [
  1175.                         'id' => 'group_' . $item->getName(),
  1176.                         'text' => htmlspecialchars($item->getGroup()),
  1177.                         'expandable' => true,
  1178.                         'leaf' => false,
  1179.                         'allowChildren' => true,
  1180.                         'iconCls' => 'pimcore_icon_folder',
  1181.                         'group' => $item->getGroup(),
  1182.                         'children' => [],
  1183.                     ];
  1184.                 }
  1185.                 $groups[$item->getGroup()]['children'][] =
  1186.                     [
  1187.                         'id' => $item->getName(),
  1188.                         'text' => $item->getName(),
  1189.                         'leaf' => true,
  1190.                         'iconCls' => 'pimcore_icon_thumbnails',
  1191.                         'cls' => 'pimcore_treenode_disabled',
  1192.                         'writeable' => $item->isWriteable(),
  1193.                     ];
  1194.             } else {
  1195.                 $thumbnails[] = [
  1196.                     'id' => $item->getName(),
  1197.                     'text' => $item->getName(),
  1198.                     'leaf' => true,
  1199.                     'iconCls' => 'pimcore_icon_thumbnails',
  1200.                     'cls' => 'pimcore_treenode_disabled',
  1201.                     'writeable' => $item->isWriteable(),
  1202.                 ];
  1203.             }
  1204.         }
  1206.         foreach ($groups as $group) {
  1207.             $thumbnails[] = $group;
  1208.         }
  1210.         return $this->adminJson($thumbnails);
  1211.     }
  1213.     /**
  1214.      * @Route("/thumbnail-downloadable", name="pimcore_admin_settings_thumbnaildownloadable", methods={"GET"})
  1215.      *
  1216.      * @return JsonResponse
  1217.      */
  1218.     public function thumbnailDownloadableAction()
  1219.     {
  1220.         $thumbnails = [];
  1222.         $list = new Asset\Image\Thumbnail\Config\Listing();
  1223.         $list->setFilter(function (Asset\Image\Thumbnail\Config $config) {
  1224.             return $config->isDownloadable();
  1225.         });
  1227.         foreach ($list->getThumbnails() as $item) {
  1228.             $thumbnails[] = [
  1229.                 'id' => $item->getName(),
  1230.                 'text' => $item->getName(),
  1231.             ];
  1232.         }
  1234.         return $this->adminJson($thumbnails);
  1235.     }
  1237.     /**
  1238.      * @Route("/thumbnail-add", name="pimcore_admin_settings_thumbnailadd", methods={"POST"})
  1239.      *
  1240.      * @param Request $request
  1241.      *
  1242.      * @return JsonResponse
  1243.      */
  1244.     public function thumbnailAddAction(Request $request)
  1245.     {
  1246.         $this->checkPermission('thumbnails');
  1248.         $success = false;
  1250.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1252.         if (!$pipe) {
  1253.             $pipe = new Asset\Image\Thumbnail\Config();
  1254.             if (!$pipe->isWriteable()) {
  1255.                 throw new ConfigWriteException();
  1256.             }
  1258.             $pipe->setName($request->get('name'));
  1259.             $pipe->save();
  1261.             $success = true;
  1262.         } else {
  1263.             if (!$pipe->isWriteable()) {
  1264.                 throw new ConfigWriteException();
  1265.             }
  1266.         }
  1268.         return $this->adminJson(['success' => $success, 'id' => $pipe->getName()]);
  1269.     }
  1271.     /**
  1272.      * @Route("/thumbnail-delete", name="pimcore_admin_settings_thumbnaildelete", methods={"DELETE"})
  1273.      *
  1274.      * @param Request $request
  1275.      *
  1276.      * @return JsonResponse
  1277.      */
  1278.     public function thumbnailDeleteAction(Request $request)
  1279.     {
  1280.         $this->checkPermission('thumbnails');
  1282.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1284.         if (!$pipe->isWriteable()) {
  1285.             throw new ConfigWriteException();
  1286.         }
  1288.         $pipe->delete();
  1290.         return $this->adminJson(['success' => true]);
  1291.     }
  1293.     /**
  1294.      * @Route("/thumbnail-get", name="pimcore_admin_settings_thumbnailget", methods={"GET"})
  1295.      *
  1296.      * @param Request $request
  1297.      *
  1298.      * @return JsonResponse
  1299.      */
  1300.     public function thumbnailGetAction(Request $request)
  1301.     {
  1302.         $this->checkPermission('thumbnails');
  1304.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1305.         $data = $pipe->getObjectVars();
  1306.         $data['writeable'] = $pipe->isWriteable();
  1308.         return $this->adminJson($data);
  1309.     }
  1311.     /**
  1312.      * @Route("/thumbnail-update", name="pimcore_admin_settings_thumbnailupdate", methods={"PUT"})
  1313.      *
  1314.      * @param Request $request
  1315.      *
  1316.      * @return JsonResponse
  1317.      */
  1318.     public function thumbnailUpdateAction(Request $request)
  1319.     {
  1320.         $this->checkPermission('thumbnails');
  1322.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1324.         if (!$pipe->isWriteable()) {
  1325.             throw new ConfigWriteException();
  1326.         }
  1328.         $settingsData = $this->decodeJson($request->get('settings'));
  1329.         $mediaData = $this->decodeJson($request->get('medias'));
  1330.         $mediaOrder = $this->decodeJson($request->get('mediaOrder'));
  1332.         foreach ($settingsData as $key => $value) {
  1333.             $setter = 'set' . ucfirst($key);
  1334.             if (method_exists($pipe, $setter)) {
  1335.                 $pipe->$setter($value);
  1336.             }
  1337.         }
  1339.         $pipe->resetItems();
  1341.         uksort($mediaData, function ($a, $b) use ($mediaOrder) {
  1342.             if ($a === 'default') {
  1343.                 return -1;
  1344.             }
  1346.             return ($mediaOrder[$a] < $mediaOrder[$b]) ? -1 : 1;
  1347.         });
  1349.         foreach ($mediaData as $mediaName => $items) {
  1350.             if (preg_match('/["<>]/', $mediaName)) {
  1351.                 throw new \Exception('Invalid media query name');
  1352.             }
  1354.             foreach ($items as $item) {
  1355.                 $type = $item['type'];
  1356.                 unset($item['type']);
  1358.                 $pipe->addItem($type, $item, $mediaName);
  1359.             }
  1360.         }
  1362.         $pipe->save();
  1364.         return $this->adminJson(['success' => true]);
  1365.     }
  1367.     /**
  1368.      * @Route("/video-thumbnail-adapter-check", name="pimcore_admin_settings_videothumbnailadaptercheck", methods={"GET"})
  1369.      *
  1370.      * @param Request $request
  1371.      * @param TranslatorInterface $translator
  1372.      *
  1373.      * @return Response
  1374.      */
  1375.     public function videoThumbnailAdapterCheckAction(Request $request, TranslatorInterface $translator)
  1376.     {
  1377.         $content = '';
  1379.         if (!\Pimcore\Video::isAvailable()) {
  1380.             $content = '<span style="color: red; font-weight: bold;padding: 10px;margin:0 0 20px 0;border:1px solid red;display:block;">' .
  1381.                 $translator->trans('php_cli_binary_and_or_ffmpeg_binary_setting_is_missing', [], 'admin') .
  1382.                 '</span>';
  1383.         }
  1385.         return new Response($content);
  1386.     }
  1388.     /**
  1389.      * @Route("/video-thumbnail-tree", name="pimcore_admin_settings_videothumbnailtree", methods={"GET", "POST"})
  1390.      *
  1391.      * @return JsonResponse
  1392.      */
  1393.     public function videoThumbnailTreeAction()
  1394.     {
  1395.         $this->checkPermission('thumbnails');
  1397.         $thumbnails = [];
  1399.         $list = new Asset\Video\Thumbnail\Config\Listing();
  1401.         $groups = [];
  1402.         foreach ($list->getThumbnails() as $item) {
  1403.             if ($item->getGroup()) {
  1404.                 if (empty($groups[$item->getGroup()])) {
  1405.                     $groups[$item->getGroup()] = [
  1406.                         'id' => 'group_' . $item->getName(),
  1407.                         'text' => htmlspecialchars($item->getGroup()),
  1408.                         'expandable' => true,
  1409.                         'leaf' => false,
  1410.                         'allowChildren' => true,
  1411.                         'iconCls' => 'pimcore_icon_folder',
  1412.                         'group' => $item->getGroup(),
  1413.                         'children' => [],
  1414.                     ];
  1415.                 }
  1416.                 $groups[$item->getGroup()]['children'][] =
  1417.                     [
  1418.                         'id' => $item->getName(),
  1419.                         'text' => $item->getName(),
  1420.                         'leaf' => true,
  1421.                         'iconCls' => 'pimcore_icon_videothumbnails',
  1422.                         'cls' => 'pimcore_treenode_disabled',
  1423.                         'writeable' => $item->isWriteable(),
  1424.                     ];
  1425.             } else {
  1426.                 $thumbnails[] = [
  1427.                     'id' => $item->getName(),
  1428.                     'text' => $item->getName(),
  1429.                     'leaf' => true,
  1430.                     'iconCls' => 'pimcore_icon_videothumbnails',
  1431.                     'cls' => 'pimcore_treenode_disabled',
  1432.                     'writeable' => $item->isWriteable(),
  1433.                 ];
  1434.             }
  1435.         }
  1437.         foreach ($groups as $group) {
  1438.             $thumbnails[] = $group;
  1439.         }
  1441.         return $this->adminJson($thumbnails);
  1442.     }
  1444.     /**
  1445.      * @Route("/video-thumbnail-add", name="pimcore_admin_settings_videothumbnailadd", methods={"POST"})
  1446.      *
  1447.      * @param Request $request
  1448.      *
  1449.      * @return JsonResponse
  1450.      */
  1451.     public function videoThumbnailAddAction(Request $request)
  1452.     {
  1453.         $this->checkPermission('thumbnails');
  1455.         $success = false;
  1457.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1459.         if (!$pipe) {
  1460.             $pipe = new Asset\Video\Thumbnail\Config();
  1461.             if (!$pipe->isWriteable()) {
  1462.                 throw new ConfigWriteException();
  1463.             }
  1465.             $pipe->setName($request->get('name'));
  1466.             $pipe->save();
  1468.             $success = true;
  1469.         } else {
  1470.             if (!$pipe->isWriteable()) {
  1471.                 throw new ConfigWriteException();
  1472.             }
  1473.         }
  1475.         return $this->adminJson(['success' => $success, 'id' => $pipe->getName()]);
  1476.     }
  1478.     /**
  1479.      * @Route("/video-thumbnail-delete", name="pimcore_admin_settings_videothumbnaildelete", methods={"DELETE"})
  1480.      *
  1481.      * @param Request $request
  1482.      *
  1483.      * @return JsonResponse
  1484.      */
  1485.     public function videoThumbnailDeleteAction(Request $request)
  1486.     {
  1487.         $this->checkPermission('thumbnails');
  1489.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1491.         if (!$pipe->isWriteable()) {
  1492.             throw new ConfigWriteException();
  1493.         }
  1495.         $pipe->delete();
  1497.         return $this->adminJson(['success' => true]);
  1498.     }
  1500.     /**
  1501.      * @Route("/video-thumbnail-get", name="pimcore_admin_settings_videothumbnailget", methods={"GET"})
  1502.      *
  1503.      * @param Request $request
  1504.      *
  1505.      * @return JsonResponse
  1506.      */
  1507.     public function videoThumbnailGetAction(Request $request)
  1508.     {
  1509.         $this->checkPermission('thumbnails');
  1511.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1513.         $data = $pipe->getObjectVars();
  1514.         $data['writeable'] = $pipe->isWriteable();
  1516.         return $this->adminJson($data);
  1517.     }
  1519.     /**
  1520.      * @Route("/video-thumbnail-update", name="pimcore_admin_settings_videothumbnailupdate", methods={"PUT"})
  1521.      *
  1522.      * @param Request $request
  1523.      *
  1524.      * @return JsonResponse
  1525.      */
  1526.     public function videoThumbnailUpdateAction(Request $request)
  1527.     {
  1528.         $this->checkPermission('thumbnails');
  1530.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1532.         if (!$pipe->isWriteable()) {
  1533.             throw new ConfigWriteException();
  1534.         }
  1536.         $settingsData = $this->decodeJson($request->get('settings'));
  1537.         $mediaData = $this->decodeJson($request->get('medias'));
  1538.         $mediaOrder = $this->decodeJson($request->get('mediaOrder'));
  1540.         foreach ($settingsData as $key => $value) {
  1541.             $setter = 'set' . ucfirst($key);
  1542.             if (method_exists($pipe, $setter)) {
  1543.                 $pipe->$setter($value);
  1544.             }
  1545.         }
  1547.         $pipe->resetItems();
  1549.         uksort($mediaData, function ($a, $b) use ($mediaOrder) {
  1550.             if ($a === 'default') {
  1551.                 return -1;
  1552.             }
  1554.             return ($mediaOrder[$a] < $mediaOrder[$b]) ? -1 : 1;
  1555.         });
  1557.         foreach ($mediaData as $mediaName => $items) {
  1558.             foreach ($items as $item) {
  1559.                 $type = $item['type'];
  1560.                 unset($item['type']);
  1562.                 $pipe->addItem($type, $item, htmlspecialchars($mediaName));
  1563.             }
  1564.         }
  1566.         $pipe->save();
  1568.         return $this->adminJson(['success' => true]);
  1569.     }
  1571.     /**
  1572.      * @Route("/robots-txt", name="pimcore_admin_settings_robotstxtget", methods={"GET"})
  1573.      *
  1574.      * @return JsonResponse
  1575.      */
  1576.     public function robotsTxtGetAction()
  1577.     {
  1578.         $this->checkPermission('robots.txt');
  1580.         $config = Config::getRobotsConfig();
  1581.         $config = $config->toArray();
  1583.         return $this->adminJson([
  1584.             'success' => true,
  1585.             'data' => $config,
  1586.             'onFileSystem' => file_exists(PIMCORE_WEB_ROOT . '/robots.txt'),
  1587.         ]);
  1588.     }
  1590.     /**
  1591.      * @Route("/robots-txt", name="pimcore_admin_settings_robotstxtput", methods={"PUT"})
  1592.      *
  1593.      * @param Request $request
  1594.      *
  1595.      * @return JsonResponse
  1596.      */
  1597.     public function robotsTxtPutAction(Request $request)
  1598.     {
  1599.         $this->checkPermission('robots.txt');
  1601.         $values = $request->get('data');
  1602.         if (!is_array($values)) {
  1603.             $values = [];
  1604.         }
  1606.         foreach ($values as $siteId => $robotsContent) {
  1607.             SettingsStore::set('robots.txt-' . $siteId, $robotsContent, 'string', 'robots.txt');
  1608.         }
  1610.         return $this->adminJson([
  1611.             'success' => true,
  1612.         ]);
  1613.     }
  1615.     /**
  1616.      * @Route("/website-settings", name="pimcore_admin_settings_websitesettings", methods={"POST"})
  1617.      *
  1618.      * @param Request $request
  1619.      *
  1620.      * @return JsonResponse
  1621.      *
  1622.      * @throws \Exception
  1623.      */
  1624.     public function websiteSettingsAction(Request $request)
  1625.     {
  1626.         $this->checkPermission('website_settings');
  1628.         if ($request->get('data')) {
  1629.             $data = $this->decodeJson($request->get('data'));
  1631.             if (is_array($data)) {
  1632.                 foreach ($data as &$value) {
  1633.                     $value = trim($value);
  1634.                 }
  1635.             }
  1637.             if ($request->get('xaction') == 'destroy') {
  1638.                 $id = $data['id'];
  1639.                 $setting = WebsiteSetting::getById($id);
  1640.                 if ($setting instanceof WebsiteSetting) {
  1641.                     $setting->delete();
  1643.                     return $this->adminJson(['success' => true, 'data' => []]);
  1644.                 }
  1645.             } elseif ($request->get('xaction') == 'update') {
  1646.                 // save routes
  1647.                 $setting = WebsiteSetting::getById($data['id']);
  1648.                 if ($setting instanceof WebsiteSetting) {
  1649.                     switch ($setting->getType()) {
  1650.                         case 'document':
  1651.                         case 'asset':
  1652.                         case 'object':
  1653.                             if (isset($data['data'])) {
  1654.                                 $element = Element\Service::getElementByPath($setting->getType(), $data['data']);
  1655.                                 $data['data'] = $element;
  1656.                             }
  1658.                             break;
  1659.                     }
  1661.                     $setting->setValues($data);
  1662.                     $setting->save();
  1664.                     $data = $this->getWebsiteSettingForEditMode($setting);
  1666.                     return $this->adminJson(['data' => $data, 'success' => true]);
  1667.                 }
  1668.             } elseif ($request->get('xaction') == 'create') {
  1669.                 unset($data['id']);
  1671.                 // save route
  1672.                 $setting = new WebsiteSetting();
  1673.                 $setting->setValues($data);
  1675.                 $setting->save();
  1677.                 return $this->adminJson(['data' => $setting->getObjectVars(), 'success' => true]);
  1678.             }
  1679.         } else {
  1680.             $list = new WebsiteSetting\Listing();
  1682.             $list->setLimit($request->get('limit'));
  1683.             $list->setOffset($request->get('start'));
  1685.             $sortingSettings = \Pimcore\Bundle\AdminBundle\Helper\QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  1686.             if ($sortingSettings['orderKey']) {
  1687.                 $list->setOrderKey($sortingSettings['orderKey']);
  1688.                 $list->setOrder($sortingSettings['order']);
  1689.             } else {
  1690.                 $list->setOrderKey('name');
  1691.                 $list->setOrder('asc');
  1692.             }
  1694.             if ($request->get('filter')) {
  1695.                 $list->setCondition('`name` LIKE ' . $list->quote('%'.$request->get('filter').'%'));
  1696.             }
  1698.             $totalCount = $list->getTotalCount();
  1699.             $list = $list->load();
  1701.             $settings = [];
  1702.             foreach ($list as $item) {
  1703.                 $resultItem = $this->getWebsiteSettingForEditMode($item);
  1704.                 $settings[] = $resultItem;
  1705.             }
  1707.             return $this->adminJson(['data' => $settings, 'success' => true, 'total' => $totalCount]);
  1708.         }
  1710.         return $this->adminJson(['success' => false]);
  1711.     }
  1713.     /**
  1714.      * @param WebsiteSetting $item
  1715.      *
  1716.      * @return array
  1717.      */
  1718.     private function getWebsiteSettingForEditMode($item)
  1719.     {
  1720.         $resultItem = [
  1721.             'id' => $item->getId(),
  1722.             'name' => $item->getName(),
  1723.             'language' => $item->getLanguage(),
  1724.             'type' => $item->getType(),
  1725.             'data' => null,
  1726.             'siteId' => $item->getSiteId(),
  1727.             'creationDate' => $item->getCreationDate(),
  1728.             'modificationDate' => $item->getModificationDate(),
  1729.         ];
  1731.         switch ($item->getType()) {
  1732.             case 'document':
  1733.             case 'asset':
  1734.             case 'object':
  1735.                 $element = $item->getData();
  1736.                 if ($element) {
  1737.                     $resultItem['data'] = $element->getRealFullPath();
  1738.                 }
  1740.                 break;
  1741.             default:
  1742.                 $resultItem['data'] = $item->getData();
  1744.                 break;
  1745.         }
  1747.         return $resultItem;
  1748.     }
  1750.     /**
  1751.      * @Route("/get-available-algorithms", name="pimcore_admin_settings_getavailablealgorithms", methods={"GET"})
  1752.      *
  1753.      * @param Request $request
  1754.      *
  1755.      * @return JsonResponse
  1756.      */
  1757.     public function getAvailableAlgorithmsAction(Request $request)
  1758.     {
  1759.         $options = [
  1760.             [
  1761.                 'key' => 'password_hash',
  1762.                 'value' => 'password_hash',
  1763.             ],
  1764.         ];
  1766.         $algorithms = hash_algos();
  1767.         foreach ($algorithms as $algorithm) {
  1768.             $options[] = [
  1769.                 'key' => $algorithm,
  1770.                 'value' => $algorithm,
  1771.             ];
  1772.         }
  1774.         $result = ['data' => $options, 'success' => true, 'total' => count($options)];
  1776.         return $this->adminJson($result);
  1777.     }
  1779.     /**
  1780.      * deleteViews
  1781.      * delete views for localized fields when languages are removed to
  1782.      * prevent mysql errors
  1783.      *
  1784.      * @param string $language
  1785.      * @param string $dbName
  1786.      */
  1787.     protected function deleteViews($language, $dbName)
  1788.     {
  1789.         $db = \Pimcore\Db::get();
  1790.         $views = $db->fetchAllAssociative('SHOW FULL TABLES IN ' . $db->quoteIdentifier($dbName) . " WHERE TABLE_TYPE LIKE 'VIEW'");
  1792.         foreach ($views as $view) {
  1793.             if (preg_match('/^object_localized_[0-9]+_' . $language . '$/', $view['Tables_in_' . $dbName])) {
  1794.                 $sql = 'DROP VIEW ' . $db->quoteIdentifier($view['Tables_in_' . $dbName]);
  1795.                 $db->executeQuery($sql);
  1796.             }
  1797.         }
  1798.     }
  1800.     /**
  1801.      * @Route("/test-web2print", name="pimcore_admin_settings_testweb2print", methods={"GET"})
  1802.      *
  1803.      * @param Request $request
  1804.      *
  1805.      * @return Response
  1806.      */
  1807.     public function testWeb2printAction(Request $request)
  1808.     {
  1809.         $this->checkPermission('web2print_settings');
  1811.         $response = $this->render('@PimcoreAdmin/Admin/Settings/testWeb2print.html.twig');
  1812.         $html = $response->getContent();
  1814.         $adapter = \Pimcore\Web2Print\Processor::getInstance();
  1815.         $params = [];
  1817.         if ($adapter instanceof \Pimcore\Web2Print\Processor\WkHtmlToPdf) {
  1818.             $params['adapterConfig'] = '-O landscape';
  1819.         } elseif ($adapter instanceof \Pimcore\Web2Print\Processor\PdfReactor) {
  1820.             $params['adapterConfig'] = [
  1821.                 'javaScriptMode' => 0,
  1822.                 'addLinks' => true,
  1823.                 'appendLog' => true,
  1824.                 'enableDebugMode' => true,
  1825.             ];
  1826.         } elseif ($adapter instanceof \Pimcore\Web2Print\Processor\HeadlessChrome) {
  1827.             $params = Config::getWeb2PrintConfig();
  1828.             $params = $params->get('headlessChromeSettings');
  1829.             $params = json_decode($params, true);
  1830.         }
  1832.         $responseOptions = [
  1833.             'Content-Type' => 'application/pdf',
  1834.         ];
  1836.         $pdfData = $adapter->getPdfFromString($html, $params);
  1838.         return new \Symfony\Component\HttpFoundation\Response(
  1839.             $pdfData,
  1840.             200,
  1841.             $responseOptions
  1843.         );
  1844.     }
  1845. }