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

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((string)$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((string)$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.         foreach ($valueArray['general']['valid_language'] as $existingValue) {
  408.             if (!in_array($existingValue, $validLanguages)) {
  409.                 $languageOptions[] = [
  410.                     'language' => $existingValue,
  411.                     'display' => $existingValue,
  412.                 ];
  413.             }
  414.         }
  416.         $response = [
  417.             'values' => $valueArray,
  418.             'config' => [
  419.                 'languages' => $languageOptions,
  420.             ],
  421.         ];
  423.         return $this->adminJson($response);
  424.     }
  426.     /**
  427.      * @Route("/set-system", name="pimcore_admin_settings_setsystem", methods={"PUT"})
  428.      *
  429.      * @param Request $request
  430.      * @param LocaleServiceInterface $localeService
  431.      *
  432.      * @return JsonResponse
  433.      */
  434.     public function setSystemAction(
  435.         LocaleServiceInterface $localeService,
  436.         Request $request,
  437.         KernelInterface $kernel,
  438.         EventDispatcherInterface $eventDispatcher,
  439.         CoreCacheHandler $cache,
  440.         Filesystem $filesystem,
  441.         CacheClearer $symfonyCacheClearer
  442.     ) {
  443.         $this->checkPermission('system_settings');
  445.         $values = $this->decodeJson($request->get('data'));
  447.         $existingValues = [];
  449.         try {
  450.             $file = Config::locateConfigFile('system.yml');
  451.             $existingValues = Config::getConfigInstance($file, true);
  452.         } catch (\Exception $e) {
  453.             // nothing to do
  454.         }
  456.         // localized error pages
  457.         $localizedErrorPages = [];
  459.         // fallback languages
  460.         $fallbackLanguages = [];
  461.         $existingValues['pimcore']['general']['fallback_languages'] = [];
  462.         $languages = explode(',', $values['general.validLanguages']);
  463.         $filteredLanguages = [];
  465.         foreach ($languages as $language) {
  466.             if (isset($values['general.fallbackLanguages.' . $language])) {
  467.                 $fallbackLanguages[$language] = str_replace(' ', '', $values['general.fallbackLanguages.' . $language]);
  468.             }
  470.             // localized error pages
  471.             if (isset($values['documents.error_pages.localized.' . $language])) {
  472.                 $localizedErrorPages[$language] = $values['documents.error_pages.localized.' . $language];
  473.             }
  475.             if ($localeService->isLocale($language)) {
  476.                 $filteredLanguages[] = $language;
  477.             }
  478.         }
  480.         // check if there's a fallback language endless loop
  481.         foreach ($fallbackLanguages as $sourceLang => $targetLang) {
  482.             $this->checkFallbackLanguageLoop($sourceLang, $fallbackLanguages);
  483.         }
  485.         $settings['pimcore'] = [
  486.             'general' => [
  487.                 'domain' => $values['general.domain'],
  488.                 'redirect_to_maindomain' => $values['general.redirect_to_maindomain'],
  489.                 'language' => $values['general.language'],
  490.                 'valid_languages' => implode(',', $filteredLanguages),
  491.                 'fallback_languages' => $fallbackLanguages,
  492.                 'default_language' => $values['general.defaultLanguage'],
  493.                 'debug_admin_translations' => $values['general.debug_admin_translations'],
  494.             ],
  495.             'documents' => [
  496.                 'versions' => [
  497.                     'days' => $values['documents.versions.days'] ?? null,
  498.                     'steps' => $values['documents.versions.steps'] ?? null,
  499.                 ],
  500.                 'error_pages' => [
  501.                     'default' => $values['documents.error_pages.default'],
  502.                     'localized' => $localizedErrorPages,
  503.                 ],
  504.             ],
  505.             'objects' => [
  506.                 'versions' => [
  507.                     'days' => $values['objects.versions.days'] ?? null,
  508.                     'steps' => $values['objects.versions.steps'] ?? null,
  509.                 ],
  510.             ],
  511.             'assets' => [
  512.                 'versions' => [
  513.                     'days' => $values['assets.versions.days'] ?? null,
  514.                     'steps' => $values['assets.versions.steps'] ?? null,
  515.                 ],
  516.                 'hide_edit_image' => $values['assets.hide_edit_image'],
  517.                 'disable_tree_preview' => $values['assets.disable_tree_preview'],
  518.             ],
  519.         ];
  521.         //branding
  522.         $settings['pimcore_admin'] = [
  523.             'branding' =>
  524.                 [
  525.                     'login_screen_invert_colors' => $values['branding.login_screen_invert_colors'],
  526.                     'color_login_screen' => $values['branding.color_login_screen'],
  527.                     'color_admin_interface' => $values['branding.color_admin_interface'],
  528.                     'color_admin_interface_background' => $values['branding.color_admin_interface_background'],
  529.                     'login_screen_custom_image' => str_replace('%', '%%', $values['branding.login_screen_custom_image']),
  530.                 ],
  531.         ];
  533.         if (array_key_exists('email.debug.emailAddresses', $values) && $values['email.debug.emailAddresses']) {
  534.             $settings['pimcore']['email']['debug']['email_addresses'] = $values['email.debug.emailAddresses'];
  535.         }
  537.         $settingsYml = Yaml::dump($settings, 5);
  538.         $configFile = Config::locateConfigFile('system.yml');
  539.         File::put($configFile, $settingsYml);
  541.         // clear all caches
  542.         $this->clearSymfonyCache($request, $kernel, $eventDispatcher, $symfonyCacheClearer);
  543.         $this->stopMessengerWorkers();
  545.         $eventDispatcher->addListener(KernelEvents::TERMINATE, function (TerminateEvent $event) use (
  546.             $cache, $eventDispatcher, $filesystem
  547.         ) {
  548.             // we need to clear the cache with a delay, because the cache is used by messenger:stop-workers
  549.             // to send the stop signal to all worker processes
  550.             sleep(2);
  551.             $this->clearPimcoreCache($cache, $eventDispatcher, $filesystem);
  552.         });
  554.         return $this->adminJson(['success' => true]);
  555.     }
  557.     /**
  558.      * @param string $source
  559.      * @param array $definitions
  560.      * @param array $fallbacks
  561.      *
  562.      * @throws \Exception
  563.      */
  564.     protected function checkFallbackLanguageLoop($source, $definitions, $fallbacks = [])
  565.     {
  566.         if (isset($definitions[$source])) {
  567.             $targets = explode(',', $definitions[$source]);
  568.             foreach ($targets as $l) {
  569.                 $target = trim($l);
  570.                 if ($target) {
  571.                     if (in_array($target, $fallbacks)) {
  572.                         throw new \Exception("Language `$source` | `$target` causes an infinte loop.");
  573.                     }
  574.                     $fallbacks[] = $target;
  576.                     $this->checkFallbackLanguageLoop($target, $definitions, $fallbacks);
  577.                 }
  578.             }
  579.         } else {
  580.             throw new \Exception("Language `$source` doesn't exist");
  581.         }
  582.     }
  584.     /**
  585.      * @Route("/get-web2print", name="pimcore_admin_settings_getweb2print", methods={"GET"})
  586.      *
  587.      * @param Request $request
  588.      *
  589.      * @return JsonResponse
  590.      */
  591.     public function getWeb2printAction(Request $request)
  592.     {
  593.         $this->checkPermission('web2print_settings');
  595.         $values = Config::getWeb2PrintConfig();
  596.         $valueArray = $values->toArray();
  598.         $optionsString = [];
  599.         if ($valueArray['wkhtml2pdfOptions'] ?? false) {
  600.             foreach ($valueArray['wkhtml2pdfOptions'] as $key => $value) {
  601.                 $tmpStr = '--'.$key;
  602.                 if ($value !== null && $value !== '') {
  603.                     $tmpStr .= ' '.$value;
  604.                 }
  605.                 $optionsString[] = $tmpStr;
  606.             }
  607.         }
  608.         $valueArray['wkhtml2pdfOptions'] = implode("\n", $optionsString);
  610.         $response = [
  611.             'values' => $valueArray,
  612.         ];
  614.         return $this->adminJson($response);
  615.     }
  617.     /**
  618.      * @Route("/set-web2print", name="pimcore_admin_settings_setweb2print", methods={"PUT"})
  619.      *
  620.      * @param Request $request
  621.      *
  622.      * @return JsonResponse
  623.      */
  624.     public function setWeb2printAction(Request $request)
  625.     {
  626.         $this->checkPermission('web2print_settings');
  628.         $values = $this->decodeJson($request->get('data'));
  630.         unset($values['documentation']);
  631.         unset($values['additions']);
  632.         unset($values['json_converter']);
  634.         if ($values['wkhtml2pdfOptions']) {
  635.             $optionArray = [];
  636.             $lines = explode("\n", $values['wkhtml2pdfOptions']);
  637.             foreach ($lines as $line) {
  638.                 $parts = explode(' ', substr($line, 2));
  639.                 $key = trim($parts[0]);
  640.                 if ($key) {
  641.                     $value = trim($parts[1] ?? '');
  642.                     $optionArray[$key] = $value;
  643.                 }
  644.             }
  645.             $values['wkhtml2pdfOptions'] = $optionArray;
  646.         }
  648.         \Pimcore\Web2Print\Config::save($values);
  650.         return $this->adminJson(['success' => true]);
  651.     }
  653.     /**
  654.      * @Route("/clear-cache", name="pimcore_admin_settings_clearcache", methods={"DELETE"})
  655.      *
  656.      * @param Request $request
  657.      * @param KernelInterface $kernel
  658.      * @param EventDispatcherInterface $eventDispatcher
  659.      * @param CoreCacheHandler $cache
  660.      * @param Filesystem $filesystem
  661.      * @param CacheClearer $symfonyCacheClearer
  662.      *
  663.      * @return JsonResponse
  664.      */
  665.     public function clearCacheAction(
  666.         Request $request,
  667.         KernelInterface $kernel,
  668.         EventDispatcherInterface $eventDispatcher,
  669.         CoreCacheHandler $cache,
  670.         Filesystem $filesystem,
  671.         CacheClearer $symfonyCacheClearer
  672.     ) {
  673.         $this->checkPermissionsHasOneOf(['clear_cache', 'system_settings']);
  675.         $result = [
  676.             'success' => true,
  677.         ];
  679.         $clearPimcoreCache = !(bool)$request->get('only_symfony_cache');
  680.         $clearSymfonyCache = !(bool)$request->get('only_pimcore_cache');
  682.         if ($clearPimcoreCache) {
  683.             $this->clearPimcoreCache($cache, $eventDispatcher, $filesystem);
  684.         }
  686.         if ($clearSymfonyCache) {
  687.             $this->clearSymfonyCache($request, $kernel, $eventDispatcher, $symfonyCacheClearer);
  688.         }
  690.         $response = new JsonResponse($result);
  692.         if ($clearSymfonyCache) {
  693.             // we send the response directly here and exit to make sure no code depending on the stale container
  694.             // is running after this
  695.             $response->sendHeaders();
  696.             $response->sendContent();
  697.             exit;
  698.         }
  700.         return $response;
  701.     }
  703.     private function clearPimcoreCache(
  704.         CoreCacheHandler $cache,
  705.         EventDispatcherInterface $eventDispatcher,
  706.         Filesystem $filesystem,
  707.     ): void {
  708.         // empty document cache
  709.         $cache->clearAll();
  711.         if ($filesystem->exists(PIMCORE_CACHE_DIRECTORY)) {
  712.             $filesystem->remove(PIMCORE_CACHE_DIRECTORY);
  713.         }
  715.         // PIMCORE-1854 - recreate .dummy file => should remain
  716.         File::put(PIMCORE_CACHE_DIRECTORY . '/.gitkeep', '');
  718.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR);
  719.     }
  721.     private function clearSymfonyCache(
  722.         Request $request,
  723.         KernelInterface $kernel,
  724.         EventDispatcherInterface $eventDispatcher,
  725.         CacheClearer $symfonyCacheClearer,
  726.     ): void {
  727.         // pass one or move env parameters to clear multiple envs
  728.         // if no env is passed it will use the current one
  729.         $environments = $request->get('env', $kernel->getEnvironment());
  731.         if (!is_array($environments)) {
  732.             $environments = trim((string)$environments);
  734.             if (empty($environments)) {
  735.                 $environments = [];
  736.             } else {
  737.                 $environments = [$environments];
  738.             }
  739.         }
  741.         if (empty($environments)) {
  742.             $environments = [$kernel->getEnvironment()];
  743.         }
  745.         $result['environments'] = $environments;
  747.         if (in_array($kernel->getEnvironment(), $environments)) {
  748.             // remove terminate and exception event listeners for the current env as they break with a
  749.             // cleared container - see #2434
  750.             foreach ($eventDispatcher->getListeners(KernelEvents::TERMINATE) as $listener) {
  751.                 $eventDispatcher->removeListener(KernelEvents::TERMINATE, $listener);
  752.             }
  754.             foreach ($eventDispatcher->getListeners(KernelEvents::EXCEPTION) as $listener) {
  755.                 $eventDispatcher->removeListener(KernelEvents::EXCEPTION, $listener);
  756.             }
  757.         }
  759.         foreach ($environments as $environment) {
  760.             try {
  761.                 $symfonyCacheClearer->clear($environment);
  762.             } catch (\Throwable $e) {
  763.                 $errors = $result['errors'] ?? [];
  764.                 $errors[] = $e->getMessage();
  766.                 $result = array_merge($result, [
  767.                     'success' => false,
  768.                     'errors' => $errors,
  769.                 ]);
  770.             }
  771.         }
  772.     }
  774.     /**
  775.      * @Route("/clear-output-cache", name="pimcore_admin_settings_clearoutputcache", methods={"DELETE"})
  776.      *
  777.      * @param EventDispatcherInterface $eventDispatcher
  778.      *
  779.      * @return JsonResponse
  780.      */
  781.     public function clearOutputCacheAction(EventDispatcherInterface $eventDispatcher)
  782.     {
  783.         $this->checkPermission('clear_fullpage_cache');
  785.         // remove "output" out of the ignored tags, if a cache lifetime is specified
  786.         Cache::removeIgnoredTagOnClear('output');
  788.         // empty document cache
  789.         Cache::clearTags(['output', 'output_lifetime']);
  791.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR_FULLPAGE_CACHE);
  793.         return $this->adminJson(['success' => true]);
  794.     }
  796.     /**
  797.      * @Route("/clear-temporary-files", name="pimcore_admin_settings_cleartemporaryfiles", methods={"DELETE"})
  798.      *
  799.      * @param EventDispatcherInterface $eventDispatcher
  800.      *
  801.      * @return JsonResponse
  802.      */
  803.     public function clearTemporaryFilesAction(EventDispatcherInterface $eventDispatcher)
  804.     {
  805.         $this->checkPermission('clear_temp_files');
  807.         // public files
  808.         Tool\Storage::get('thumbnail')->deleteDirectory('/');
  809.         Db::get()->executeQuery('TRUNCATE TABLE assets_image_thumbnail_cache');
  811.         Tool\Storage::get('asset_cache')->deleteDirectory('/');
  813.         // system files
  814.         recursiveDelete(PIMCORE_SYSTEM_TEMP_DIRECTORY, false);
  816.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR_TEMPORARY_FILES);
  818.         return $this->adminJson(['success' => true]);
  819.     }
  821.     /**
  822.      * @Route("/staticroutes", name="pimcore_admin_settings_staticroutes", methods={"POST"})
  823.      *
  824.      * @param Request $request
  825.      *
  826.      * @return JsonResponse
  827.      */
  828.     public function staticroutesAction(Request $request)
  829.     {
  830.         if ($request->get('data')) {
  831.             $this->checkPermission('routes');
  833.             $data = $this->decodeJson($request->get('data'));
  835.             if (is_array($data)) {
  836.                 foreach ($data as &$value) {
  837.                     if (is_string($value)) {
  838.                         $value = trim($value);
  839.                     }
  840.                 }
  841.             }
  843.             if ($request->get('xaction') == 'destroy') {
  844.                 $data = $this->decodeJson($request->get('data'));
  845.                 $id = $data['id'];
  846.                 $route = Staticroute::getById($id);
  847.                 if (!$route->isWriteable()) {
  848.                     throw new ConfigWriteException();
  849.                 }
  850.                 $route->delete();
  852.                 return $this->adminJson(['success' => true, 'data' => []]);
  853.             } elseif ($request->get('xaction') == 'update') {
  854.                 // save routes
  855.                 $route = Staticroute::getById($data['id']);
  856.                 if (!$route->isWriteable()) {
  857.                     throw new ConfigWriteException();
  858.                 }
  860.                 $route->setValues($data);
  862.                 $route->save();
  864.                 return $this->adminJson(['data' => $route->getObjectVars(), 'success' => true]);
  865.             } elseif ($request->get('xaction') == 'create') {
  866.                 if (!(new Staticroute())->isWriteable()) {
  867.                     throw new ConfigWriteException();
  868.                 }
  869.                 unset($data['id']);
  871.                 // save route
  872.                 $route = new Staticroute();
  873.                 $route->setValues($data);
  875.                 $route->save();
  877.                 $responseData = $route->getObjectVars();
  878.                 $responseData['writeable'] = $route->isWriteable();
  880.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  881.             }
  882.         } else {
  883.             // get list of routes
  885.             $list = new Staticroute\Listing();
  887.             if ($filter = $request->get('filter')) {
  888.                 $list->setFilter(function (Staticroute $staticRoute) use ($filter) {
  889.                     foreach ($staticRoute->getObjectVars() as $value) {
  890.                         if (!is_scalar($value)) {
  891.                             continue;
  892.                         }
  893.                         if (stripos((string)$value, $filter) !== false) {
  894.                             return true;
  895.                         }
  896.                     }
  898.                     return false;
  899.                 });
  900.             }
  902.             $routes = [];
  903.             foreach ($list->getRoutes() as $routeFromList) {
  904.                 $route = $routeFromList->getObjectVars();
  905.                 $route['writeable'] = $routeFromList->isWriteable();
  906.                 if (is_array($routeFromList->getSiteId())) {
  907.                     $route['siteId'] = implode(',', $routeFromList->getSiteId());
  908.                 }
  909.                 $routes[] = $route;
  910.             }
  912.             return $this->adminJson(['data' => $routes, 'success' => true, 'total' => $list->getTotalCount()]);
  913.         }
  915.         return $this->adminJson(['success' => false]);
  916.     }
  918.     /**
  919.      * @Route("/get-available-admin-languages", name="pimcore_admin_settings_getavailableadminlanguages", methods={"GET"})
  920.      *
  921.      * @param Request $request
  922.      *
  923.      * @return JsonResponse
  924.      */
  925.     public function getAvailableAdminLanguagesAction(Request $request)
  926.     {
  927.         $langs = [];
  928.         $availableLanguages = Tool\Admin::getLanguages();
  929.         $locales = Tool::getSupportedLocales();
  931.         foreach ($availableLanguages as $lang) {
  932.             if (array_key_exists($lang, $locales)) {
  933.                 $langs[] = [
  934.                     'language' => $lang,
  935.                     'display' => $locales[$lang],
  936.                 ];
  937.             }
  938.         }
  940.         usort($langs, function ($a, $b) {
  941.             return strcmp($a['display'], $b['display']);
  942.         });
  944.         return $this->adminJson($langs);
  945.     }
  947.     /**
  948.      * @Route("/glossary", name="pimcore_admin_settings_glossary", methods={"POST"})
  949.      *
  950.      * @param Request $request
  951.      *
  952.      * @return JsonResponse
  953.      */
  954.     public function glossaryAction(Request $request)
  955.     {
  956.         if ($request->get('data')) {
  957.             $this->checkPermission('glossary');
  959.             Cache::clearTag('glossary');
  961.             if ($request->get('xaction') == 'destroy') {
  962.                 $data = $this->decodeJson($request->get('data'));
  963.                 $id = $data['id'];
  964.                 $glossary = Glossary::getById($id);
  965.                 $glossary->delete();
  967.                 return $this->adminJson(['success' => true, 'data' => []]);
  968.             } elseif ($request->get('xaction') == 'update') {
  969.                 $data = $this->decodeJson($request->get('data'));
  971.                 // save glossary
  972.                 $glossary = Glossary::getById($data['id']);
  974.                 if (!empty($data['link'])) {
  975.                     if ($doc = Document::getByPath($data['link'])) {
  976.                         $data['link'] = $doc->getId();
  977.                     }
  978.                 }
  980.                 $glossary->setValues($data);
  982.                 $glossary->save();
  984.                 if ($link = $glossary->getLink()) {
  985.                     if ((int)$link > 0) {
  986.                         if ($doc = Document::getById((int)$link)) {
  987.                             $glossary->setLink($doc->getRealFullPath());
  988.                         }
  989.                     }
  990.                 }
  992.                 return $this->adminJson(['data' => $glossary, 'success' => true]);
  993.             } elseif ($request->get('xaction') == 'create') {
  994.                 $data = $this->decodeJson($request->get('data'));
  995.                 unset($data['id']);
  997.                 // save glossary
  998.                 $glossary = new Glossary();
  1000.                 if (!empty($data['link'])) {
  1001.                     if ($doc = Document::getByPath($data['link'])) {
  1002.                         $data['link'] = $doc->getId();
  1003.                     }
  1004.                 }
  1006.                 $glossary->setValues($data);
  1008.                 $glossary->save();
  1010.                 if ($link = $glossary->getLink()) {
  1011.                     if ((int)$link > 0) {
  1012.                         if ($doc = Document::getById((int)$link)) {
  1013.                             $glossary->setLink($doc->getRealFullPath());
  1014.                         }
  1015.                     }
  1016.                 }
  1018.                 return $this->adminJson(['data' => $glossary->getObjectVars(), 'success' => true]);
  1019.             }
  1020.         } else {
  1021.             // get list of glossaries
  1023.             $list = new Glossary\Listing();
  1024.             $list->setLimit($request->get('limit'));
  1025.             $list->setOffset($request->get('start'));
  1027.             $sortingSettings = \Pimcore\Bundle\AdminBundle\Helper\QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  1028.             if ($sortingSettings['orderKey']) {
  1029.                 $list->setOrderKey($sortingSettings['orderKey']);
  1030.                 $list->setOrder($sortingSettings['order']);
  1031.             }
  1033.             if ($request->get('filter')) {
  1034.                 $list->setCondition('`text` LIKE ' . $list->quote('%'.$request->get('filter').'%'));
  1035.             }
  1037.             $list->load();
  1039.             $glossaries = [];
  1040.             foreach ($list->getGlossary() as $glossary) {
  1041.                 if ($link = $glossary->getLink()) {
  1042.                     if ((int)$link > 0) {
  1043.                         if ($doc = Document::getById((int)$link)) {
  1044.                             $glossary->setLink($doc->getRealFullPath());
  1045.                         }
  1046.                     }
  1047.                 }
  1049.                 $glossaries[] = $glossary->getObjectVars();
  1050.             }
  1052.             return $this->adminJson(['data' => $glossaries, 'success' => true, 'total' => $list->getTotalCount()]);
  1053.         }
  1055.         return $this->adminJson(['success' => false]);
  1056.     }
  1058.     /**
  1059.      * @Route("/get-available-sites", name="pimcore_admin_settings_getavailablesites", methods={"GET"})
  1060.      *
  1061.      * @param Request $request
  1062.      *
  1063.      * @return JsonResponse
  1064.      */
  1065.     public function getAvailableSitesAction(Request $request)
  1066.     {
  1067.         $excludeMainSite = $request->get('excludeMainSite');
  1069.         $sitesList = new Model\Site\Listing();
  1070.         $sitesObjects = $sitesList->load();
  1071.         $sites = [];
  1072.         if (!$excludeMainSite) {
  1073.             $sites[] = [
  1074.                 'id' => 'default',
  1075.                 'rootId' => 1,
  1076.                 'domains' => '',
  1077.                 'rootPath' => '/',
  1078.                 'domain' => $this->trans('main_site'),
  1079.             ];
  1080.         }
  1082.         foreach ($sitesObjects as $site) {
  1083.             if ($site->getRootDocument()) {
  1084.                 if ($site->getMainDomain()) {
  1085.                     $sites[] = [
  1086.                         'id' => $site->getId(),
  1087.                         'rootId' => $site->getRootId(),
  1088.                         'domains' => implode(',', $site->getDomains()),
  1089.                         'rootPath' => $site->getRootPath(),
  1090.                         'domain' => $site->getMainDomain(),
  1091.                     ];
  1092.                 }
  1093.             } else {
  1094.                 // site is useless, parent doesn't exist anymore
  1095.                 $site->delete();
  1096.             }
  1097.         }
  1099.         return $this->adminJson($sites);
  1100.     }
  1102.     /**
  1103.      * @Route("/get-available-countries", name="pimcore_admin_settings_getavailablecountries", methods={"GET"})
  1104.      *
  1105.      * @param LocaleServiceInterface $localeService
  1106.      *
  1107.      * @return JsonResponse
  1108.      */
  1109.     public function getAvailableCountriesAction(LocaleServiceInterface $localeService)
  1110.     {
  1111.         $countries = $localeService->getDisplayRegions();
  1112.         asort($countries);
  1114.         $options = [];
  1116.         foreach ($countries as $short => $translation) {
  1117.             if (strlen($short) == 2) {
  1118.                 $options[] = [
  1119.                     'key' => $translation . ' (' . $short . ')',
  1120.                     'value' => $short,
  1121.                 ];
  1122.             }
  1123.         }
  1125.         $result = ['data' => $options, 'success' => true, 'total' => count($options)];
  1127.         return $this->adminJson($result);
  1128.     }
  1130.     /**
  1131.      * @Route("/thumbnail-adapter-check", name="pimcore_admin_settings_thumbnailadaptercheck", methods={"GET"})
  1132.      *
  1133.      * @param Request $request
  1134.      *
  1135.      * @return Response
  1136.      */
  1137.     public function thumbnailAdapterCheckAction(Request $request)
  1138.     {
  1139.         $content = '';
  1141.         $instance = \Pimcore\Image::getInstance();
  1142.         if ($instance instanceof \Pimcore\Image\Adapter\GD) {
  1143.             $content = '<span style="color: red; font-weight: bold;padding: 10px;margin:0 0 20px 0;border:1px solid red;display:block;">' .
  1144.                 $this->trans('important_use_imagick_pecl_extensions_for_best_results_gd_is_just_a_fallback_with_less_quality') .
  1145.                 '</span>';
  1146.         }
  1148.         return new Response($content);
  1149.     }
  1151.     /**
  1152.      * @Route("/thumbnail-tree", name="pimcore_admin_settings_thumbnailtree", methods={"GET", "POST"})
  1153.      *
  1154.      * @return JsonResponse
  1155.      */
  1156.     public function thumbnailTreeAction()
  1157.     {
  1158.         $this->checkPermission('thumbnails');
  1160.         $thumbnails = [];
  1162.         $list = new Asset\Image\Thumbnail\Config\Listing();
  1164.         $groups = [];
  1165.         foreach ($list->getThumbnails() as $item) {
  1166.             if ($item->getGroup()) {
  1167.                 if (empty($groups[$item->getGroup()])) {
  1168.                     $groups[$item->getGroup()] = [
  1169.                         'id' => 'group_' . $item->getName(),
  1170.                         'text' => htmlspecialchars($item->getGroup()),
  1171.                         'expandable' => true,
  1172.                         'leaf' => false,
  1173.                         'allowChildren' => true,
  1174.                         'iconCls' => 'pimcore_icon_folder',
  1175.                         'group' => $item->getGroup(),
  1176.                         'children' => [],
  1177.                     ];
  1178.                 }
  1179.                 $groups[$item->getGroup()]['children'][] =
  1180.                     [
  1181.                         'id' => $item->getName(),
  1182.                         'text' => $item->getName(),
  1183.                         'leaf' => true,
  1184.                         'iconCls' => 'pimcore_icon_thumbnails',
  1185.                         'cls' => 'pimcore_treenode_disabled',
  1186.                         'writeable' => $item->isWriteable(),
  1187.                     ];
  1188.             } else {
  1189.                 $thumbnails[] = [
  1190.                     'id' => $item->getName(),
  1191.                     'text' => $item->getName(),
  1192.                     'leaf' => true,
  1193.                     'iconCls' => 'pimcore_icon_thumbnails',
  1194.                     'cls' => 'pimcore_treenode_disabled',
  1195.                     'writeable' => $item->isWriteable(),
  1196.                 ];
  1197.             }
  1198.         }
  1200.         foreach ($groups as $group) {
  1201.             $thumbnails[] = $group;
  1202.         }
  1204.         return $this->adminJson($thumbnails);
  1205.     }
  1207.     /**
  1208.      * @Route("/thumbnail-downloadable", name="pimcore_admin_settings_thumbnaildownloadable", methods={"GET"})
  1209.      *
  1210.      * @return JsonResponse
  1211.      */
  1212.     public function thumbnailDownloadableAction()
  1213.     {
  1214.         $thumbnails = [];
  1216.         $list = new Asset\Image\Thumbnail\Config\Listing();
  1217.         $list->setFilter(function (Asset\Image\Thumbnail\Config $config) {
  1218.             return $config->isDownloadable();
  1219.         });
  1221.         foreach ($list->getThumbnails() as $item) {
  1222.             $thumbnails[] = [
  1223.                 'id' => $item->getName(),
  1224.                 'text' => $item->getName(),
  1225.             ];
  1226.         }
  1228.         return $this->adminJson($thumbnails);
  1229.     }
  1231.     /**
  1232.      * @Route("/thumbnail-add", name="pimcore_admin_settings_thumbnailadd", methods={"POST"})
  1233.      *
  1234.      * @param Request $request
  1235.      *
  1236.      * @return JsonResponse
  1237.      */
  1238.     public function thumbnailAddAction(Request $request)
  1239.     {
  1240.         $this->checkPermission('thumbnails');
  1242.         $success = false;
  1244.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1246.         if (!$pipe) {
  1247.             $pipe = new Asset\Image\Thumbnail\Config();
  1248.             if (!$pipe->isWriteable()) {
  1249.                 throw new ConfigWriteException();
  1250.             }
  1252.             $pipe->setName($request->get('name'));
  1253.             $pipe->save();
  1255.             $success = true;
  1256.         } else {
  1257.             if (!$pipe->isWriteable()) {
  1258.                 throw new ConfigWriteException();
  1259.             }
  1260.         }
  1262.         return $this->adminJson(['success' => $success, 'id' => $pipe->getName()]);
  1263.     }
  1265.     /**
  1266.      * @Route("/thumbnail-delete", name="pimcore_admin_settings_thumbnaildelete", methods={"DELETE"})
  1267.      *
  1268.      * @param Request $request
  1269.      *
  1270.      * @return JsonResponse
  1271.      */
  1272.     public function thumbnailDeleteAction(Request $request)
  1273.     {
  1274.         $this->checkPermission('thumbnails');
  1276.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1278.         if (!$pipe->isWriteable()) {
  1279.             throw new ConfigWriteException();
  1280.         }
  1282.         $pipe->delete();
  1284.         return $this->adminJson(['success' => true]);
  1285.     }
  1287.     /**
  1288.      * @Route("/thumbnail-get", name="pimcore_admin_settings_thumbnailget", methods={"GET"})
  1289.      *
  1290.      * @param Request $request
  1291.      *
  1292.      * @return JsonResponse
  1293.      */
  1294.     public function thumbnailGetAction(Request $request)
  1295.     {
  1296.         $this->checkPermission('thumbnails');
  1298.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1299.         $data = $pipe->getObjectVars();
  1300.         $data['writeable'] = $pipe->isWriteable();
  1302.         return $this->adminJson($data);
  1303.     }
  1305.     /**
  1306.      * @Route("/thumbnail-update", name="pimcore_admin_settings_thumbnailupdate", methods={"PUT"})
  1307.      *
  1308.      * @param Request $request
  1309.      *
  1310.      * @return JsonResponse
  1311.      */
  1312.     public function thumbnailUpdateAction(Request $request)
  1313.     {
  1314.         $this->checkPermission('thumbnails');
  1316.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1318.         if (!$pipe->isWriteable()) {
  1319.             throw new ConfigWriteException();
  1320.         }
  1322.         $settingsData = $this->decodeJson($request->get('settings'));
  1323.         $mediaData = $this->decodeJson($request->get('medias'));
  1324.         $mediaOrder = $this->decodeJson($request->get('mediaOrder'));
  1326.         foreach ($settingsData as $key => $value) {
  1327.             $setter = 'set' . ucfirst($key);
  1328.             if (method_exists($pipe, $setter)) {
  1329.                 $pipe->$setter($value);
  1330.             }
  1331.         }
  1333.         $pipe->resetItems();
  1335.         uksort($mediaData, function ($a, $b) use ($mediaOrder) {
  1336.             if ($a === 'default') {
  1337.                 return -1;
  1338.             }
  1340.             return ($mediaOrder[$a] < $mediaOrder[$b]) ? -1 : 1;
  1341.         });
  1343.         foreach ($mediaData as $mediaName => $items) {
  1344.             if (preg_match('/["<>]/', $mediaName)) {
  1345.                 throw new \Exception('Invalid media query name');
  1346.             }
  1348.             foreach ($items as $item) {
  1349.                 $type = $item['type'];
  1350.                 unset($item['type']);
  1352.                 $pipe->addItem($type, $item, $mediaName);
  1353.             }
  1354.         }
  1356.         $pipe->save();
  1358.         return $this->adminJson(['success' => true]);
  1359.     }
  1361.     /**
  1362.      * @Route("/video-thumbnail-adapter-check", name="pimcore_admin_settings_videothumbnailadaptercheck", methods={"GET"})
  1363.      *
  1364.      * @param Request $request
  1365.      *
  1366.      * @return Response
  1367.      */
  1368.     public function videoThumbnailAdapterCheckAction(Request $request)
  1369.     {
  1370.         $content = '';
  1372.         if (!\Pimcore\Video::isAvailable()) {
  1373.             $content = '<span style="color: red; font-weight: bold;padding: 10px;margin:0 0 20px 0;border:1px solid red;display:block;">' .
  1374.                 $this->trans('php_cli_binary_and_or_ffmpeg_binary_setting_is_missing') .
  1375.                 '</span>';
  1376.         }
  1378.         return new Response($content);
  1379.     }
  1381.     /**
  1382.      * @Route("/video-thumbnail-tree", name="pimcore_admin_settings_videothumbnailtree", methods={"GET", "POST"})
  1383.      *
  1384.      * @return JsonResponse
  1385.      */
  1386.     public function videoThumbnailTreeAction()
  1387.     {
  1388.         $this->checkPermission('thumbnails');
  1390.         $thumbnails = [];
  1392.         $list = new Asset\Video\Thumbnail\Config\Listing();
  1394.         $groups = [];
  1395.         foreach ($list->getThumbnails() as $item) {
  1396.             if ($item->getGroup()) {
  1397.                 if (empty($groups[$item->getGroup()])) {
  1398.                     $groups[$item->getGroup()] = [
  1399.                         'id' => 'group_' . $item->getName(),
  1400.                         'text' => htmlspecialchars($item->getGroup()),
  1401.                         'expandable' => true,
  1402.                         'leaf' => false,
  1403.                         'allowChildren' => true,
  1404.                         'iconCls' => 'pimcore_icon_folder',
  1405.                         'group' => $item->getGroup(),
  1406.                         'children' => [],
  1407.                     ];
  1408.                 }
  1409.                 $groups[$item->getGroup()]['children'][] =
  1410.                     [
  1411.                         'id' => $item->getName(),
  1412.                         'text' => $item->getName(),
  1413.                         'leaf' => true,
  1414.                         'iconCls' => 'pimcore_icon_videothumbnails',
  1415.                         'cls' => 'pimcore_treenode_disabled',
  1416.                         'writeable' => $item->isWriteable(),
  1417.                     ];
  1418.             } else {
  1419.                 $thumbnails[] = [
  1420.                     'id' => $item->getName(),
  1421.                     'text' => $item->getName(),
  1422.                     'leaf' => true,
  1423.                     'iconCls' => 'pimcore_icon_videothumbnails',
  1424.                     'cls' => 'pimcore_treenode_disabled',
  1425.                     'writeable' => $item->isWriteable(),
  1426.                 ];
  1427.             }
  1428.         }
  1430.         foreach ($groups as $group) {
  1431.             $thumbnails[] = $group;
  1432.         }
  1434.         return $this->adminJson($thumbnails);
  1435.     }
  1437.     /**
  1438.      * @Route("/video-thumbnail-add", name="pimcore_admin_settings_videothumbnailadd", methods={"POST"})
  1439.      *
  1440.      * @param Request $request
  1441.      *
  1442.      * @return JsonResponse
  1443.      */
  1444.     public function videoThumbnailAddAction(Request $request)
  1445.     {
  1446.         $this->checkPermission('thumbnails');
  1448.         $success = false;
  1450.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1452.         if (!$pipe) {
  1453.             $pipe = new Asset\Video\Thumbnail\Config();
  1454.             if (!$pipe->isWriteable()) {
  1455.                 throw new ConfigWriteException();
  1456.             }
  1458.             $pipe->setName($request->get('name'));
  1459.             $pipe->save();
  1461.             $success = true;
  1462.         } else {
  1463.             if (!$pipe->isWriteable()) {
  1464.                 throw new ConfigWriteException();
  1465.             }
  1466.         }
  1468.         return $this->adminJson(['success' => $success, 'id' => $pipe->getName()]);
  1469.     }
  1471.     /**
  1472.      * @Route("/video-thumbnail-delete", name="pimcore_admin_settings_videothumbnaildelete", methods={"DELETE"})
  1473.      *
  1474.      * @param Request $request
  1475.      *
  1476.      * @return JsonResponse
  1477.      */
  1478.     public function videoThumbnailDeleteAction(Request $request)
  1479.     {
  1480.         $this->checkPermission('thumbnails');
  1482.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1484.         if (!$pipe->isWriteable()) {
  1485.             throw new ConfigWriteException();
  1486.         }
  1488.         $pipe->delete();
  1490.         return $this->adminJson(['success' => true]);
  1491.     }
  1493.     /**
  1494.      * @Route("/video-thumbnail-get", name="pimcore_admin_settings_videothumbnailget", methods={"GET"})
  1495.      *
  1496.      * @param Request $request
  1497.      *
  1498.      * @return JsonResponse
  1499.      */
  1500.     public function videoThumbnailGetAction(Request $request)
  1501.     {
  1502.         $this->checkPermission('thumbnails');
  1504.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1506.         $data = $pipe->getObjectVars();
  1507.         $data['writeable'] = $pipe->isWriteable();
  1509.         return $this->adminJson($data);
  1510.     }
  1512.     /**
  1513.      * @Route("/video-thumbnail-update", name="pimcore_admin_settings_videothumbnailupdate", methods={"PUT"})
  1514.      *
  1515.      * @param Request $request
  1516.      *
  1517.      * @return JsonResponse
  1518.      */
  1519.     public function videoThumbnailUpdateAction(Request $request)
  1520.     {
  1521.         $this->checkPermission('thumbnails');
  1523.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1525.         if (!$pipe->isWriteable()) {
  1526.             throw new ConfigWriteException();
  1527.         }
  1529.         $settingsData = $this->decodeJson($request->get('settings'));
  1530.         $mediaData = $this->decodeJson($request->get('medias'));
  1531.         $mediaOrder = $this->decodeJson($request->get('mediaOrder'));
  1533.         foreach ($settingsData as $key => $value) {
  1534.             $setter = 'set' . ucfirst($key);
  1535.             if (method_exists($pipe, $setter)) {
  1536.                 $pipe->$setter($value);
  1537.             }
  1538.         }
  1540.         $pipe->resetItems();
  1542.         uksort($mediaData, function ($a, $b) use ($mediaOrder) {
  1543.             if ($a === 'default') {
  1544.                 return -1;
  1545.             }
  1547.             return ($mediaOrder[$a] < $mediaOrder[$b]) ? -1 : 1;
  1548.         });
  1550.         foreach ($mediaData as $mediaName => $items) {
  1551.             foreach ($items as $item) {
  1552.                 $type = $item['type'];
  1553.                 unset($item['type']);
  1555.                 $pipe->addItem($type, $item, htmlspecialchars($mediaName));
  1556.             }
  1557.         }
  1559.         $pipe->save();
  1561.         return $this->adminJson(['success' => true]);
  1562.     }
  1564.     /**
  1565.      * @Route("/robots-txt", name="pimcore_admin_settings_robotstxtget", methods={"GET"})
  1566.      *
  1567.      * @return JsonResponse
  1568.      */
  1569.     public function robotsTxtGetAction()
  1570.     {
  1571.         $this->checkPermission('robots.txt');
  1573.         $config = Config::getRobotsConfig();
  1574.         $config = $config->toArray();
  1576.         return $this->adminJson([
  1577.             'success' => true,
  1578.             'data' => $config,
  1579.             'onFileSystem' => file_exists(PIMCORE_WEB_ROOT . '/robots.txt'),
  1580.         ]);
  1581.     }
  1583.     /**
  1584.      * @Route("/robots-txt", name="pimcore_admin_settings_robotstxtput", methods={"PUT"})
  1585.      *
  1586.      * @param Request $request
  1587.      *
  1588.      * @return JsonResponse
  1589.      */
  1590.     public function robotsTxtPutAction(Request $request)
  1591.     {
  1592.         $this->checkPermission('robots.txt');
  1594.         $values = $request->get('data');
  1595.         if (!is_array($values)) {
  1596.             $values = [];
  1597.         }
  1599.         foreach ($values as $siteId => $robotsContent) {
  1600.             SettingsStore::set('robots.txt-' . $siteId, $robotsContent, 'string', 'robots.txt');
  1601.         }
  1603.         return $this->adminJson([
  1604.             'success' => true,
  1605.         ]);
  1606.     }
  1608.     /**
  1609.      * @Route("/website-settings", name="pimcore_admin_settings_websitesettings", methods={"POST"})
  1610.      *
  1611.      * @param Request $request
  1612.      *
  1613.      * @return JsonResponse
  1614.      *
  1615.      * @throws \Exception
  1616.      */
  1617.     public function websiteSettingsAction(Request $request)
  1618.     {
  1619.         $this->checkPermission('website_settings');
  1621.         if ($request->get('data')) {
  1622.             $data = $this->decodeJson($request->get('data'));
  1624.             if (is_array($data)) {
  1625.                 foreach ($data as &$value) {
  1626.                     $value = trim($value);
  1627.                 }
  1628.             }
  1630.             if ($request->get('xaction') == 'destroy') {
  1631.                 $id = $data['id'];
  1632.                 $setting = WebsiteSetting::getById($id);
  1633.                 if ($setting instanceof WebsiteSetting) {
  1634.                     $setting->delete();
  1636.                     return $this->adminJson(['success' => true, 'data' => []]);
  1637.                 }
  1638.             } elseif ($request->get('xaction') == 'update') {
  1639.                 // save routes
  1640.                 $setting = WebsiteSetting::getById($data['id']);
  1641.                 if ($setting instanceof WebsiteSetting) {
  1642.                     switch ($setting->getType()) {
  1643.                         case 'document':
  1644.                         case 'asset':
  1645.                         case 'object':
  1646.                             if (isset($data['data'])) {
  1647.                                 $element = Element\Service::getElementByPath($setting->getType(), $data['data']);
  1648.                                 $data['data'] = $element;
  1649.                             }
  1651.                             break;
  1652.                     }
  1654.                     $setting->setValues($data);
  1655.                     $setting->save();
  1657.                     $data = $this->getWebsiteSettingForEditMode($setting);
  1659.                     return $this->adminJson(['data' => $data, 'success' => true]);
  1660.                 }
  1661.             } elseif ($request->get('xaction') == 'create') {
  1662.                 unset($data['id']);
  1664.                 // save route
  1665.                 $setting = new WebsiteSetting();
  1666.                 $setting->setValues($data);
  1668.                 $setting->save();
  1670.                 return $this->adminJson(['data' => $setting->getObjectVars(), 'success' => true]);
  1671.             }
  1672.         } else {
  1673.             $list = new WebsiteSetting\Listing();
  1675.             $list->setLimit($request->get('limit'));
  1676.             $list->setOffset($request->get('start'));
  1678.             $sortingSettings = \Pimcore\Bundle\AdminBundle\Helper\QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  1679.             if ($sortingSettings['orderKey']) {
  1680.                 $list->setOrderKey($sortingSettings['orderKey']);
  1681.                 $list->setOrder($sortingSettings['order']);
  1682.             } else {
  1683.                 $list->setOrderKey('name');
  1684.                 $list->setOrder('asc');
  1685.             }
  1687.             if ($request->get('filter')) {
  1688.                 $list->setCondition('`name` LIKE ' . $list->quote('%'.$request->get('filter').'%'));
  1689.             }
  1691.             $totalCount = $list->getTotalCount();
  1692.             $list = $list->load();
  1694.             $settings = [];
  1695.             foreach ($list as $item) {
  1696.                 $resultItem = $this->getWebsiteSettingForEditMode($item);
  1697.                 $settings[] = $resultItem;
  1698.             }
  1700.             return $this->adminJson(['data' => $settings, 'success' => true, 'total' => $totalCount]);
  1701.         }
  1703.         return $this->adminJson(['success' => false]);
  1704.     }
  1706.     /**
  1707.      * @param WebsiteSetting $item
  1708.      *
  1709.      * @return array
  1710.      */
  1711.     private function getWebsiteSettingForEditMode($item)
  1712.     {
  1713.         $resultItem = [
  1714.             'id' => $item->getId(),
  1715.             'name' => $item->getName(),
  1716.             'language' => $item->getLanguage(),
  1717.             'type' => $item->getType(),
  1718.             'data' => null,
  1719.             'siteId' => $item->getSiteId(),
  1720.             'creationDate' => $item->getCreationDate(),
  1721.             'modificationDate' => $item->getModificationDate(),
  1722.         ];
  1724.         switch ($item->getType()) {
  1725.             case 'document':
  1726.             case 'asset':
  1727.             case 'object':
  1728.                 $element = $item->getData();
  1729.                 if ($element) {
  1730.                     $resultItem['data'] = $element->getRealFullPath();
  1731.                 }
  1733.                 break;
  1734.             default:
  1735.                 $resultItem['data'] = $item->getData();
  1737.                 break;
  1738.         }
  1740.         return $resultItem;
  1741.     }
  1743.     /**
  1744.      * @Route("/get-available-algorithms", name="pimcore_admin_settings_getavailablealgorithms", methods={"GET"})
  1745.      *
  1746.      * @param Request $request
  1747.      *
  1748.      * @return JsonResponse
  1749.      */
  1750.     public function getAvailableAlgorithmsAction(Request $request)
  1751.     {
  1752.         $options = [
  1753.             [
  1754.                 'key' => 'password_hash',
  1755.                 'value' => 'password_hash',
  1756.             ],
  1757.         ];
  1759.         $algorithms = hash_algos();
  1760.         foreach ($algorithms as $algorithm) {
  1761.             $options[] = [
  1762.                 'key' => $algorithm,
  1763.                 'value' => $algorithm,
  1764.             ];
  1765.         }
  1767.         $result = ['data' => $options, 'success' => true, 'total' => count($options)];
  1769.         return $this->adminJson($result);
  1770.     }
  1772.     /**
  1773.      * deleteViews
  1774.      * delete views for localized fields when languages are removed to
  1775.      * prevent mysql errors
  1776.      *
  1777.      * @param string $language
  1778.      * @param string $dbName
  1779.      */
  1780.     protected function deleteViews($language, $dbName)
  1781.     {
  1782.         $db = \Pimcore\Db::get();
  1783.         $views = $db->fetchAllAssociative('SHOW FULL TABLES IN ' . $db->quoteIdentifier($dbName) . " WHERE TABLE_TYPE LIKE 'VIEW'");
  1785.         foreach ($views as $view) {
  1786.             if (preg_match('/^object_localized_[0-9]+_' . $language . '$/', $view['Tables_in_' . $dbName])) {
  1787.                 $sql = 'DROP VIEW ' . $db->quoteIdentifier($view['Tables_in_' . $dbName]);
  1788.                 $db->executeQuery($sql);
  1789.             }
  1790.         }
  1791.     }
  1793.     /**
  1794.      * @Route("/test-web2print", name="pimcore_admin_settings_testweb2print", methods={"GET"})
  1795.      *
  1796.      * @param Request $request
  1797.      *
  1798.      * @return Response
  1799.      */
  1800.     public function testWeb2printAction(Request $request)
  1801.     {
  1802.         $this->checkPermission('web2print_settings');
  1804.         $response = $this->render('@PimcoreAdmin/Admin/Settings/testWeb2print.html.twig');
  1805.         $html = $response->getContent();
  1807.         $adapter = \Pimcore\Web2Print\Processor::getInstance();
  1808.         $params = [];
  1810.         if ($adapter instanceof \Pimcore\Web2Print\Processor\WkHtmlToPdf) {
  1811.             $params['adapterConfig'] = '-O landscape';
  1812.         } elseif ($adapter instanceof \Pimcore\Web2Print\Processor\PdfReactor) {
  1813.             $params['adapterConfig'] = [
  1814.                 'javaScriptMode' => 0,
  1815.                 'addLinks' => true,
  1816.                 'appendLog' => true,
  1817.                 'enableDebugMode' => true,
  1818.             ];
  1819.         } elseif ($adapter instanceof \Pimcore\Web2Print\Processor\HeadlessChrome) {
  1820.             $params = Config::getWeb2PrintConfig();
  1821.             $params = $params->get('headlessChromeSettings');
  1822.             $params = json_decode($params, true);
  1823.         }
  1825.         $responseOptions = [
  1826.             'Content-Type' => 'application/pdf',
  1827.         ];
  1829.         $pdfData = $adapter->getPdfFromString($html, $params);
  1831.         return new \Symfony\Component\HttpFoundation\Response(
  1832.             $pdfData,
  1833.             200,
  1834.             $responseOptions
  1836.         );
  1837.     }
  1838. }