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

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\Event\SystemEvents;
  24. use Pimcore\File;
  25. use Pimcore\Helper\StopMessengerWorkersTrait;
  26. use Pimcore\Localization\LocaleServiceInterface;
  27. use Pimcore\Model;
  28. use Pimcore\Model\Asset;
  29. use Pimcore\Model\Document;
  30. use Pimcore\Model\Element;
  31. use Pimcore\Model\Exception\ConfigWriteException;
  32. use Pimcore\Model\Glossary;
  33. use Pimcore\Model\Metadata;
  34. use Pimcore\Model\Property;
  35. use Pimcore\Model\Staticroute;
  36. use Pimcore\Model\Tool\SettingsStore;
  37. use Pimcore\Model\WebsiteSetting;
  38. use Pimcore\Tool;
  39. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  40. use Symfony\Component\EventDispatcher\GenericEvent;
  41. use Symfony\Component\Filesystem\Filesystem;
  42. use Symfony\Component\HttpFoundation\File\UploadedFile;
  43. use Symfony\Component\HttpFoundation\JsonResponse;
  44. use Symfony\Component\HttpFoundation\Request;
  45. use Symfony\Component\HttpFoundation\Response;
  46. use Symfony\Component\HttpFoundation\StreamedResponse;
  47. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  48. use Symfony\Component\HttpKernel\KernelEvents;
  49. use Symfony\Component\HttpKernel\KernelInterface;
  50. use Symfony\Component\Routing\Annotation\Route;
  51. use Symfony\Component\Yaml\Yaml;
  53. /**
  54.  * @Route("/settings")
  55.  *
  56.  * @internal
  57.  */
  58. class SettingsController extends AdminController
  59. {
  60.     use StopMessengerWorkersTrait;
  62.     private const CUSTOM_LOGO_PATH = 'custom-logo.image';
  64.     /**
  65.      * @Route("/display-custom-logo", name="pimcore_settings_display_custom_logo", methods={"GET"})
  66.      *
  67.      * @param Request $request
  68.      *
  69.      * @return StreamedResponse
  70.      */
  71.     public function displayCustomLogoAction(Request $request)
  72.     {
  73.         $mime = 'image/svg+xml';
  74.         if ($request->get('white')) {
  75.             $logo = PIMCORE_WEB_ROOT . '/bundles/pimcoreadmin/img/logo-claim-white.svg';
  76.         } else {
  77.             $logo = PIMCORE_WEB_ROOT . '/bundles/pimcoreadmin/img/logo-claim-gray.svg';
  78.         }
  80.         $stream = fopen($logo, 'rb');
  82.         $storage = Tool\Storage::get('admin');
  83.         if ($storage->fileExists(self::CUSTOM_LOGO_PATH)) {
  84.             try {
  85.                 $mime = $storage->mimeType(self::CUSTOM_LOGO_PATH);
  86.                 $stream = $storage->readStream(self::CUSTOM_LOGO_PATH);
  87.             } catch (\Exception $e) {
  88.                 // do nothing
  89.             }
  90.         }
  92.         return new StreamedResponse(function () use ($stream) {
  93.             fpassthru($stream);
  94.         }, 200, [
  95.             'Content-Type' => $mime,
  96.             'Content-Security-Policy' => "script-src 'none'",
  97.         ]);
  98.     }
  100.     /**
  101.      * @Route("/upload-custom-logo", name="pimcore_admin_settings_uploadcustomlogo", methods={"POST"})
  102.      *
  103.      * @param Request $request
  104.      *
  105.      * @return JsonResponse
  106.      *
  107.      * @throws \Exception
  108.      */
  109.     public function uploadCustomLogoAction(Request $request)
  110.     {
  111.         $logoFile = $request->files->get('Filedata');
  113.         if (!$logoFile instanceof UploadedFile
  114.             || !in_array($logoFile->guessExtension(), ['svg', 'png', 'jpg'])
  115.         ) {
  116.             throw new \Exception('Unsupported file format.');
  117.         }
  119.         $storage = Tool\Storage::get('admin');
  120.         $storage->writeStream(self::CUSTOM_LOGO_PATH, fopen($logoFile->getPathname(), 'rb'));
  122.         // set content-type to text/html, otherwise (when application/json is sent) chrome will complain in
  123.         // Ext.form.Action.Submit and mark the submission as failed
  125.         $response = $this->adminJson(['success' => true]);
  126.         $response->headers->set('Content-Type', 'text/html');
  128.         return $response;
  129.     }
  131.     /**
  132.      * @Route("/delete-custom-logo", name="pimcore_admin_settings_deletecustomlogo", methods={"DELETE"})
  133.      *
  134.      * @param Request $request
  135.      *
  136.      * @return JsonResponse
  137.      */
  138.     public function deleteCustomLogoAction(Request $request)
  139.     {
  140.         if (Tool\Storage::get('admin')->fileExists(self::CUSTOM_LOGO_PATH)) {
  141.             Tool\Storage::get('admin')->delete(self::CUSTOM_LOGO_PATH);
  142.         }
  144.         return $this->adminJson(['success' => true]);
  145.     }
  147.     /**
  148.      * Used by the predefined metadata grid
  149.      *
  150.      * @Route("/predefined-metadata", name="pimcore_admin_settings_metadata", methods={"POST"})
  151.      *
  152.      * @param Request $request
  153.      *
  154.      * @return JsonResponse
  155.      */
  156.     public function metadataAction(Request $request)
  157.     {
  158.         $this->checkPermission('asset_metadata');
  160.         if ($request->get('data')) {
  161.             if ($request->get('xaction') == 'destroy') {
  162.                 $data = $this->decodeJson($request->get('data'));
  163.                 $id = $data['id'];
  164.                 $metadata = Metadata\Predefined::getById($id);
  165.                 if (!$metadata->isWriteable()) {
  166.                     throw new ConfigWriteException();
  167.                 }
  168.                 $metadata->delete();
  170.                 return $this->adminJson(['success' => true, 'data' => []]);
  171.             } elseif ($request->get('xaction') == 'update') {
  172.                 $data = $this->decodeJson($request->get('data'));
  174.                 // save type
  175.                 $metadata = Metadata\Predefined::getById($data['id']);
  176.                 if (!$metadata->isWriteable()) {
  177.                     throw new ConfigWriteException();
  178.                 }
  179.                 $metadata->setValues($data);
  181.                 $existingItem = Metadata\Predefined\Listing::getByKeyAndLanguage($metadata->getName(), $metadata->getLanguage(), $metadata->getTargetSubtype());
  182.                 if ($existingItem && $existingItem->getId() != $metadata->getId()) {
  183.                     return $this->adminJson(['message' => 'rule_violation', 'success' => false]);
  184.                 }
  186.                 $metadata->minimize();
  187.                 $metadata->save();
  188.                 $metadata->expand();
  190.                 $responseData = $metadata->getObjectVars();
  191.                 $responseData['writeable'] = $metadata->isWriteable();
  193.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  194.             } elseif ($request->get('xaction') == 'create') {
  195.                 if (!(new Metadata\Predefined())->isWriteable()) {
  196.                     throw new ConfigWriteException();
  197.                 }
  198.                 $data = $this->decodeJson($request->get('data'));
  199.                 unset($data['id']);
  201.                 // save type
  202.                 $metadata = Metadata\Predefined::create();
  204.                 $metadata->setValues($data);
  206.                 $existingItem = Metadata\Predefined\Listing::getByKeyAndLanguage($metadata->getName(), $metadata->getLanguage(), $metadata->getTargetSubtype());
  207.                 if ($existingItem) {
  208.                     return $this->adminJson(['message' => 'rule_violation', 'success' => false]);
  209.                 }
  211.                 $metadata->save();
  213.                 $responseData = $metadata->getObjectVars();
  214.                 $responseData['writeable'] = $metadata->isWriteable();
  216.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  217.             }
  218.         } else {
  219.             // get list of types
  220.             $list = new Metadata\Predefined\Listing();
  222.             if ($filter = $request->get('filter')) {
  223.                 $list->setFilter(function (Metadata\Predefined $predefined) use ($filter) {
  224.                     foreach ($predefined->getObjectVars() as $value) {
  225.                         if (stripos($value, $filter) !== false) {
  226.                             return true;
  227.                         }
  228.                     }
  230.                     return false;
  231.                 });
  232.             }
  234.             $properties = [];
  235.             foreach ($list->getDefinitions() as $metadata) {
  236.                 $data = $metadata->getObjectVars();
  237.                 $data['writeable'] = $metadata->isWriteable();
  238.                 $properties[] = $data;
  239.             }
  241.             return $this->adminJson(['data' => $properties, 'success' => true, 'total' => $list->getTotalCount()]);
  242.         }
  244.         return $this->adminJson(['success' => false]);
  245.     }
  247.     /**
  248.      * @Route("/get-predefined-metadata", name="pimcore_admin_settings_getpredefinedmetadata", methods={"GET"})
  249.      *
  250.      * @param Request $request
  251.      *
  252.      * @return JsonResponse
  253.      */
  254.     public function getPredefinedMetadataAction(Request $request)
  255.     {
  256.         $type = $request->get('type');
  257.         $subType = $request->get('subType');
  258.         $group = $request->get('group');
  259.         $list = Metadata\Predefined\Listing::getByTargetType($type, [$subType]);
  260.         $result = [];
  261.         foreach ($list as $item) {
  262.             $itemGroup = $item->getGroup() ?? '';
  263.             if ($group === 'default' || $group === $itemGroup) {
  264.                 $item->expand();
  265.                 $data = $item->getObjectVars();
  266.                 $data['writeable'] = $item->isWriteable();
  267.                 $result[] = $data;
  268.             }
  269.         }
  271.         return $this->adminJson(['data' => $result, 'success' => true]);
  272.     }
  274.     /**
  275.      * @Route("/properties", name="pimcore_admin_settings_properties", methods={"POST"})
  276.      *
  277.      * @param Request $request
  278.      *
  279.      * @return JsonResponse
  280.      */
  281.     public function propertiesAction(Request $request)
  282.     {
  283.         if ($request->get('data')) {
  284.             $this->checkPermission('predefined_properties');
  286.             if ($request->get('xaction') == 'destroy') {
  287.                 $data = $this->decodeJson($request->get('data'));
  288.                 $id = $data['id'];
  289.                 $property = Property\Predefined::getById($id);
  290.                 if (!$property->isWriteable()) {
  291.                     throw new ConfigWriteException();
  292.                 }
  293.                 $property->delete();
  295.                 return $this->adminJson(['success' => true, 'data' => []]);
  296.             } elseif ($request->get('xaction') == 'update') {
  297.                 $data = $this->decodeJson($request->get('data'));
  299.                 // save type
  300.                 $property = Property\Predefined::getById($data['id']);
  301.                 if (!$property->isWriteable()) {
  302.                     throw new ConfigWriteException();
  303.                 }
  304.                 if (is_array($data['ctype'])) {
  305.                     $data['ctype'] = implode(',', $data['ctype']);
  306.                 }
  307.                 $property->setValues($data);
  309.                 $property->save();
  311.                 $responseData = $property->getObjectVars();
  312.                 $responseData['writeable'] = $property->isWriteable();
  314.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  315.             } elseif ($request->get('xaction') == 'create') {
  316.                 if (!(new Property\Predefined())->isWriteable()) {
  317.                     throw new ConfigWriteException();
  318.                 }
  319.                 $data = $this->decodeJson($request->get('data'));
  320.                 unset($data['id']);
  322.                 // save type
  323.                 $property = Property\Predefined::create();
  324.                 $property->setValues($data);
  326.                 $property->save();
  328.                 $responseData = $property->getObjectVars();
  329.                 $responseData['writeable'] = $property->isWriteable();
  331.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  332.             }
  333.         } else {
  334.             // get list of types
  335.             $list = new Property\Predefined\Listing();
  337.             if ($filter = $request->get('filter')) {
  338.                 $list->setFilter(function (Property\Predefined $predefined) use ($filter) {
  339.                     foreach ($predefined->getObjectVars() as $value) {
  340.                         if ($value) {
  341.                             $cellValues = is_array($value) ? $value : [$value];
  343.                             foreach ($cellValues as $cellValue) {
  344.                                 if (stripos($cellValue, $filter) !== false) {
  345.                                     return true;
  346.                                 }
  347.                             }
  348.                         }
  349.                     }
  351.                     return false;
  352.                 });
  353.             }
  355.             $properties = [];
  356.             foreach ($list->getProperties() as $property) {
  357.                 $data = $property->getObjectVars();
  358.                 $data['writeable'] = $property->isWriteable();
  359.                 $properties[] = $data;
  360.             }
  362.             return $this->adminJson(['data' => $properties, 'success' => true, 'total' => $list->getTotalCount()]);
  363.         }
  365.         return $this->adminJson(['success' => false]);
  366.     }
  368.     /**
  369.      * @Route("/get-system", name="pimcore_admin_settings_getsystem", methods={"GET"})
  370.      *
  371.      * @param Request $request
  372.      * @param Config $config
  373.      *
  374.      * @return JsonResponse
  375.      */
  376.     public function getSystemAction(Request $request, Config $config)
  377.     {
  378.         $this->checkPermission('system_settings');
  380.         $valueArray = [
  381.             'general' => $config['general'],
  382.             'documents' => $config['documents'],
  383.             'assets' => $config['assets'],
  384.             'objects' => $config['objects'],
  385.             'branding' => $config['branding'],
  386.             'email' => $config['email'],
  387.         ];
  389.         $locales = Tool::getSupportedLocales();
  390.         $languageOptions = [];
  391.         $validLanguages = [];
  392.         foreach ($locales as $short => $translation) {
  393.             if (!empty($short)) {
  394.                 $languageOptions[] = [
  395.                     'language' => $short,
  396.                     'display' => $translation . " ($short)",
  397.                 ];
  398.                 $validLanguages[] = $short;
  399.             }
  400.         }
  402.         $valueArray['general']['valid_language'] = explode(',', $valueArray['general']['valid_languages']);
  404.         //for "wrong" legacy values
  405.         if (is_array($valueArray['general']['valid_language'])) {
  406.             foreach ($valueArray['general']['valid_language'] as $existingValue) {
  407.                 if (!in_array($existingValue, $validLanguages)) {
  408.                     $languageOptions[] = [
  409.                         'language' => $existingValue,
  410.                         'display' => $existingValue,
  411.                     ];
  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' => $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.         Tool\Storage::get('asset_cache')->deleteDirectory('/');
  811.         // system files
  812.         recursiveDelete(PIMCORE_SYSTEM_TEMP_DIRECTORY, false);
  814.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR_TEMPORARY_FILES);
  816.         return $this->adminJson(['success' => true]);
  817.     }
  819.     /**
  820.      * @Route("/staticroutes", name="pimcore_admin_settings_staticroutes", methods={"POST"})
  821.      *
  822.      * @param Request $request
  823.      *
  824.      * @return JsonResponse
  825.      */
  826.     public function staticroutesAction(Request $request)
  827.     {
  828.         if ($request->get('data')) {
  829.             $this->checkPermission('routes');
  831.             $data = $this->decodeJson($request->get('data'));
  833.             if (is_array($data)) {
  834.                 foreach ($data as &$value) {
  835.                     if (is_string($value)) {
  836.                         $value = trim($value);
  837.                     }
  838.                 }
  839.             }
  841.             if ($request->get('xaction') == 'destroy') {
  842.                 $data = $this->decodeJson($request->get('data'));
  843.                 $id = $data['id'];
  844.                 $route = Staticroute::getById($id);
  845.                 if (!$route->isWriteable()) {
  846.                     throw new ConfigWriteException();
  847.                 }
  848.                 $route->delete();
  850.                 return $this->adminJson(['success' => true, 'data' => []]);
  851.             } elseif ($request->get('xaction') == 'update') {
  852.                 // save routes
  853.                 $route = Staticroute::getById($data['id']);
  854.                 if (!$route->isWriteable()) {
  855.                     throw new ConfigWriteException();
  856.                 }
  858.                 $route->setValues($data);
  860.                 $route->save();
  862.                 return $this->adminJson(['data' => $route->getObjectVars(), 'success' => true]);
  863.             } elseif ($request->get('xaction') == 'create') {
  864.                 if (!(new Staticroute())->isWriteable()) {
  865.                     throw new ConfigWriteException();
  866.                 }
  867.                 unset($data['id']);
  869.                 // save route
  870.                 $route = new Staticroute();
  871.                 $route->setValues($data);
  873.                 $route->save();
  875.                 $responseData = $route->getObjectVars();
  876.                 $responseData['writeable'] = $route->isWriteable();
  878.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  879.             }
  880.         } else {
  881.             // get list of routes
  883.             $list = new Staticroute\Listing();
  885.             if ($filter = $request->get('filter')) {
  886.                 $list->setFilter(function (Staticroute $staticRoute) use ($filter) {
  887.                     foreach ($staticRoute->getObjectVars() as $value) {
  888.                         if (!is_scalar($value)) {
  889.                             continue;
  890.                         }
  891.                         if (stripos((string)$value, $filter) !== false) {
  892.                             return true;
  893.                         }
  894.                     }
  896.                     return false;
  897.                 });
  898.             }
  900.             $routes = [];
  901.             foreach ($list->getRoutes() as $routeFromList) {
  902.                 $route = $routeFromList->getObjectVars();
  903.                 $route['writeable'] = $routeFromList->isWriteable();
  904.                 if (is_array($routeFromList->getSiteId())) {
  905.                     $route['siteId'] = implode(',', $routeFromList->getSiteId());
  906.                 }
  907.                 $routes[] = $route;
  908.             }
  910.             return $this->adminJson(['data' => $routes, 'success' => true, 'total' => $list->getTotalCount()]);
  911.         }
  913.         return $this->adminJson(['success' => false]);
  914.     }
  916.     /**
  917.      * @Route("/get-available-admin-languages", name="pimcore_admin_settings_getavailableadminlanguages", methods={"GET"})
  918.      *
  919.      * @param Request $request
  920.      *
  921.      * @return JsonResponse
  922.      */
  923.     public function getAvailableAdminLanguagesAction(Request $request)
  924.     {
  925.         $langs = [];
  926.         $availableLanguages = Tool\Admin::getLanguages();
  927.         $locales = Tool::getSupportedLocales();
  929.         foreach ($availableLanguages as $lang) {
  930.             if (array_key_exists($lang, $locales)) {
  931.                 $langs[] = [
  932.                     'language' => $lang,
  933.                     'display' => $locales[$lang],
  934.                 ];
  935.             }
  936.         }
  938.         usort($langs, function ($a, $b) {
  939.             return strcmp($a['display'], $b['display']);
  940.         });
  942.         return $this->adminJson($langs);
  943.     }
  945.     /**
  946.      * @Route("/glossary", name="pimcore_admin_settings_glossary", methods={"POST"})
  947.      *
  948.      * @param Request $request
  949.      *
  950.      * @return JsonResponse
  951.      */
  952.     public function glossaryAction(Request $request)
  953.     {
  954.         if ($request->get('data')) {
  955.             $this->checkPermission('glossary');
  957.             Cache::clearTag('glossary');
  959.             if ($request->get('xaction') == 'destroy') {
  960.                 $data = $this->decodeJson($request->get('data'));
  961.                 $id = $data['id'];
  962.                 $glossary = Glossary::getById($id);
  963.                 $glossary->delete();
  965.                 return $this->adminJson(['success' => true, 'data' => []]);
  966.             } elseif ($request->get('xaction') == 'update') {
  967.                 $data = $this->decodeJson($request->get('data'));
  969.                 // save glossary
  970.                 $glossary = Glossary::getById($data['id']);
  972.                 if (!empty($data['link'])) {
  973.                     if ($doc = Document::getByPath($data['link'])) {
  974.                         $data['link'] = $doc->getId();
  975.                     }
  976.                 }
  978.                 $glossary->setValues($data);
  980.                 $glossary->save();
  982.                 if ($link = $glossary->getLink()) {
  983.                     if ((int)$link > 0) {
  984.                         if ($doc = Document::getById((int)$link)) {
  985.                             $glossary->setLink($doc->getRealFullPath());
  986.                         }
  987.                     }
  988.                 }
  990.                 return $this->adminJson(['data' => $glossary, 'success' => true]);
  991.             } elseif ($request->get('xaction') == 'create') {
  992.                 $data = $this->decodeJson($request->get('data'));
  993.                 unset($data['id']);
  995.                 // save glossary
  996.                 $glossary = new Glossary();
  998.                 if (!empty($data['link'])) {
  999.                     if ($doc = Document::getByPath($data['link'])) {
  1000.                         $data['link'] = $doc->getId();
  1001.                     }
  1002.                 }
  1004.                 $glossary->setValues($data);
  1006.                 $glossary->save();
  1008.                 if ($link = $glossary->getLink()) {
  1009.                     if ((int)$link > 0) {
  1010.                         if ($doc = Document::getById((int)$link)) {
  1011.                             $glossary->setLink($doc->getRealFullPath());
  1012.                         }
  1013.                     }
  1014.                 }
  1016.                 return $this->adminJson(['data' => $glossary->getObjectVars(), 'success' => true]);
  1017.             }
  1018.         } else {
  1019.             // get list of glossaries
  1021.             $list = new Glossary\Listing();
  1022.             $list->setLimit($request->get('limit'));
  1023.             $list->setOffset($request->get('start'));
  1025.             $sortingSettings = \Pimcore\Bundle\AdminBundle\Helper\QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  1026.             if ($sortingSettings['orderKey']) {
  1027.                 $list->setOrderKey($sortingSettings['orderKey']);
  1028.                 $list->setOrder($sortingSettings['order']);
  1029.             }
  1031.             if ($request->get('filter')) {
  1032.                 $list->setCondition('`text` LIKE ' . $list->quote('%'.$request->get('filter').'%'));
  1033.             }
  1035.             $list->load();
  1037.             $glossaries = [];
  1038.             foreach ($list->getGlossary() as $glossary) {
  1039.                 if ($link = $glossary->getLink()) {
  1040.                     if ((int)$link > 0) {
  1041.                         if ($doc = Document::getById((int)$link)) {
  1042.                             $glossary->setLink($doc->getRealFullPath());
  1043.                         }
  1044.                     }
  1045.                 }
  1047.                 $glossaries[] = $glossary->getObjectVars();
  1048.             }
  1050.             return $this->adminJson(['data' => $glossaries, 'success' => true, 'total' => $list->getTotalCount()]);
  1051.         }
  1053.         return $this->adminJson(['success' => false]);
  1054.     }
  1056.     /**
  1057.      * @Route("/get-available-sites", name="pimcore_admin_settings_getavailablesites", methods={"GET"})
  1058.      *
  1059.      * @param Request $request
  1060.      *
  1061.      * @return JsonResponse
  1062.      */
  1063.     public function getAvailableSitesAction(Request $request)
  1064.     {
  1065.         $excludeMainSite = $request->get('excludeMainSite');
  1067.         $sitesList = new Model\Site\Listing();
  1068.         $sitesObjects = $sitesList->load();
  1069.         $sites = [];
  1070.         if (!$excludeMainSite) {
  1071.             $sites[] = [
  1072.                 'id' => 'default',
  1073.                 'rootId' => 1,
  1074.                 'domains' => '',
  1075.                 'rootPath' => '/',
  1076.                 'domain' => $this->trans('main_site'),
  1077.             ];
  1078.         }
  1080.         foreach ($sitesObjects as $site) {
  1081.             if ($site->getRootDocument()) {
  1082.                 if ($site->getMainDomain()) {
  1083.                     $sites[] = [
  1084.                         'id' => $site->getId(),
  1085.                         'rootId' => $site->getRootId(),
  1086.                         'domains' => implode(',', $site->getDomains()),
  1087.                         'rootPath' => $site->getRootPath(),
  1088.                         'domain' => $site->getMainDomain(),
  1089.                     ];
  1090.                 }
  1091.             } else {
  1092.                 // site is useless, parent doesn't exist anymore
  1093.                 $site->delete();
  1094.             }
  1095.         }
  1097.         return $this->adminJson($sites);
  1098.     }
  1100.     /**
  1101.      * @Route("/get-available-countries", name="pimcore_admin_settings_getavailablecountries", methods={"GET"})
  1102.      *
  1103.      * @param LocaleServiceInterface $localeService
  1104.      *
  1105.      * @return JsonResponse
  1106.      */
  1107.     public function getAvailableCountriesAction(LocaleServiceInterface $localeService)
  1108.     {
  1109.         $countries = $localeService->getDisplayRegions();
  1110.         asort($countries);
  1112.         $options = [];
  1114.         foreach ($countries as $short => $translation) {
  1115.             if (strlen($short) == 2) {
  1116.                 $options[] = [
  1117.                     'key' => $translation . ' (' . $short . ')',
  1118.                     'value' => $short,
  1119.                 ];
  1120.             }
  1121.         }
  1123.         $result = ['data' => $options, 'success' => true, 'total' => count($options)];
  1125.         return $this->adminJson($result);
  1126.     }
  1128.     /**
  1129.      * @Route("/thumbnail-adapter-check", name="pimcore_admin_settings_thumbnailadaptercheck", methods={"GET"})
  1130.      *
  1131.      * @param Request $request
  1132.      *
  1133.      * @return Response
  1134.      */
  1135.     public function thumbnailAdapterCheckAction(Request $request)
  1136.     {
  1137.         $content = '';
  1139.         $instance = \Pimcore\Image::getInstance();
  1140.         if ($instance instanceof \Pimcore\Image\Adapter\GD) {
  1141.             $content = '<span style="color: red; font-weight: bold;padding: 10px;margin:0 0 20px 0;border:1px solid red;display:block;">' .
  1142.                 $this->trans('important_use_imagick_pecl_extensions_for_best_results_gd_is_just_a_fallback_with_less_quality') .
  1143.                 '</span>';
  1144.         }
  1146.         return new Response($content);
  1147.     }
  1149.     /**
  1150.      * @Route("/thumbnail-tree", name="pimcore_admin_settings_thumbnailtree", methods={"GET", "POST"})
  1151.      *
  1152.      * @return JsonResponse
  1153.      */
  1154.     public function thumbnailTreeAction()
  1155.     {
  1156.         $this->checkPermission('thumbnails');
  1158.         $thumbnails = [];
  1160.         $list = new Asset\Image\Thumbnail\Config\Listing();
  1162.         $groups = [];
  1163.         foreach ($list->getThumbnails() as $item) {
  1164.             if ($item->getGroup()) {
  1165.                 if (empty($groups[$item->getGroup()])) {
  1166.                     $groups[$item->getGroup()] = [
  1167.                         'id' => 'group_' . $item->getName(),
  1168.                         'text' => htmlspecialchars($item->getGroup()),
  1169.                         'expandable' => true,
  1170.                         'leaf' => false,
  1171.                         'allowChildren' => true,
  1172.                         'iconCls' => 'pimcore_icon_folder',
  1173.                         'group' => $item->getGroup(),
  1174.                         'children' => [],
  1175.                     ];
  1176.                 }
  1177.                 $groups[$item->getGroup()]['children'][] =
  1178.                     [
  1179.                         'id' => $item->getName(),
  1180.                         'text' => $item->getName(),
  1181.                         'leaf' => true,
  1182.                         'iconCls' => 'pimcore_icon_thumbnails',
  1183.                         'cls' => 'pimcore_treenode_disabled',
  1184.                         'writeable' => $item->isWriteable(),
  1185.                     ];
  1186.             } else {
  1187.                 $thumbnails[] = [
  1188.                     'id' => $item->getName(),
  1189.                     'text' => $item->getName(),
  1190.                     'leaf' => true,
  1191.                     'iconCls' => 'pimcore_icon_thumbnails',
  1192.                     'cls' => 'pimcore_treenode_disabled',
  1193.                     'writeable' => $item->isWriteable(),
  1194.                 ];
  1195.             }
  1196.         }
  1198.         foreach ($groups as $group) {
  1199.             $thumbnails[] = $group;
  1200.         }
  1202.         return $this->adminJson($thumbnails);
  1203.     }
  1205.     /**
  1206.      * @Route("/thumbnail-downloadable", name="pimcore_admin_settings_thumbnaildownloadable", methods={"GET"})
  1207.      *
  1208.      * @return JsonResponse
  1209.      */
  1210.     public function thumbnailDownloadableAction()
  1211.     {
  1212.         $thumbnails = [];
  1214.         $list = new Asset\Image\Thumbnail\Config\Listing();
  1215.         $list->setFilter(function (Asset\Image\Thumbnail\Config $config) {
  1216.             return $config->isDownloadable();
  1217.         });
  1219.         foreach ($list->getThumbnails() as $item) {
  1220.             $thumbnails[] = [
  1221.                 'id' => $item->getName(),
  1222.                 'text' => $item->getName(),
  1223.             ];
  1224.         }
  1226.         return $this->adminJson($thumbnails);
  1227.     }
  1229.     /**
  1230.      * @Route("/thumbnail-add", name="pimcore_admin_settings_thumbnailadd", methods={"POST"})
  1231.      *
  1232.      * @param Request $request
  1233.      *
  1234.      * @return JsonResponse
  1235.      */
  1236.     public function thumbnailAddAction(Request $request)
  1237.     {
  1238.         $this->checkPermission('thumbnails');
  1240.         $success = false;
  1242.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1244.         if (!$pipe) {
  1245.             $pipe = new Asset\Image\Thumbnail\Config();
  1246.             if (!$pipe->isWriteable()) {
  1247.                 throw new ConfigWriteException();
  1248.             }
  1250.             $pipe->setName($request->get('name'));
  1251.             $pipe->save();
  1253.             $success = true;
  1254.         } else {
  1255.             if (!$pipe->isWriteable()) {
  1256.                 throw new ConfigWriteException();
  1257.             }
  1258.         }
  1260.         return $this->adminJson(['success' => $success, 'id' => $pipe->getName()]);
  1261.     }
  1263.     /**
  1264.      * @Route("/thumbnail-delete", name="pimcore_admin_settings_thumbnaildelete", methods={"DELETE"})
  1265.      *
  1266.      * @param Request $request
  1267.      *
  1268.      * @return JsonResponse
  1269.      */
  1270.     public function thumbnailDeleteAction(Request $request)
  1271.     {
  1272.         $this->checkPermission('thumbnails');
  1274.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1276.         if (!$pipe->isWriteable()) {
  1277.             throw new ConfigWriteException();
  1278.         }
  1280.         $pipe->delete();
  1282.         return $this->adminJson(['success' => true]);
  1283.     }
  1285.     /**
  1286.      * @Route("/thumbnail-get", name="pimcore_admin_settings_thumbnailget", methods={"GET"})
  1287.      *
  1288.      * @param Request $request
  1289.      *
  1290.      * @return JsonResponse
  1291.      */
  1292.     public function thumbnailGetAction(Request $request)
  1293.     {
  1294.         $this->checkPermission('thumbnails');
  1296.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1297.         $data = $pipe->getObjectVars();
  1298.         $data['writeable'] = $pipe->isWriteable();
  1300.         return $this->adminJson($data);
  1301.     }
  1303.     /**
  1304.      * @Route("/thumbnail-update", name="pimcore_admin_settings_thumbnailupdate", methods={"PUT"})
  1305.      *
  1306.      * @param Request $request
  1307.      *
  1308.      * @return JsonResponse
  1309.      */
  1310.     public function thumbnailUpdateAction(Request $request)
  1311.     {
  1312.         $this->checkPermission('thumbnails');
  1314.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1316.         if (!$pipe->isWriteable()) {
  1317.             throw new ConfigWriteException();
  1318.         }
  1320.         $settingsData = $this->decodeJson($request->get('settings'));
  1321.         $mediaData = $this->decodeJson($request->get('medias'));
  1322.         $mediaOrder = $this->decodeJson($request->get('mediaOrder'));
  1324.         foreach ($settingsData as $key => $value) {
  1325.             $setter = 'set' . ucfirst($key);
  1326.             if (method_exists($pipe, $setter)) {
  1327.                 $pipe->$setter($value);
  1328.             }
  1329.         }
  1331.         $pipe->resetItems();
  1333.         uksort($mediaData, function ($a, $b) use ($mediaOrder) {
  1334.             if ($a === 'default') {
  1335.                 return -1;
  1336.             }
  1338.             return ($mediaOrder[$a] < $mediaOrder[$b]) ? -1 : 1;
  1339.         });
  1341.         foreach ($mediaData as $mediaName => $items) {
  1342.             if (preg_match('/["<>]/', $mediaName)) {
  1343.                 throw new \Exception('Invalid media query name');
  1344.             }
  1346.             foreach ($items as $item) {
  1347.                 $type = $item['type'];
  1348.                 unset($item['type']);
  1350.                 $pipe->addItem($type, $item, $mediaName);
  1351.             }
  1352.         }
  1354.         $pipe->save();
  1356.         return $this->adminJson(['success' => true]);
  1357.     }
  1359.     /**
  1360.      * @Route("/video-thumbnail-adapter-check", name="pimcore_admin_settings_videothumbnailadaptercheck", methods={"GET"})
  1361.      *
  1362.      * @param Request $request
  1363.      *
  1364.      * @return Response
  1365.      */
  1366.     public function videoThumbnailAdapterCheckAction(Request $request)
  1367.     {
  1368.         $content = '';
  1370.         if (!\Pimcore\Video::isAvailable()) {
  1371.             $content = '<span style="color: red; font-weight: bold;padding: 10px;margin:0 0 20px 0;border:1px solid red;display:block;">' .
  1372.                 $this->trans('php_cli_binary_and_or_ffmpeg_binary_setting_is_missing') .
  1373.                 '</span>';
  1374.         }
  1376.         return new Response($content);
  1377.     }
  1379.     /**
  1380.      * @Route("/video-thumbnail-tree", name="pimcore_admin_settings_videothumbnailtree", methods={"GET", "POST"})
  1381.      *
  1382.      * @return JsonResponse
  1383.      */
  1384.     public function videoThumbnailTreeAction()
  1385.     {
  1386.         $this->checkPermission('thumbnails');
  1388.         $thumbnails = [];
  1390.         $list = new Asset\Video\Thumbnail\Config\Listing();
  1392.         $groups = [];
  1393.         foreach ($list->getThumbnails() as $item) {
  1394.             if ($item->getGroup()) {
  1395.                 if (empty($groups[$item->getGroup()])) {
  1396.                     $groups[$item->getGroup()] = [
  1397.                         'id' => 'group_' . $item->getName(),
  1398.                         'text' => htmlspecialchars($item->getGroup()),
  1399.                         'expandable' => true,
  1400.                         'leaf' => false,
  1401.                         'allowChildren' => true,
  1402.                         'iconCls' => 'pimcore_icon_folder',
  1403.                         'group' => $item->getGroup(),
  1404.                         'children' => [],
  1405.                     ];
  1406.                 }
  1407.                 $groups[$item->getGroup()]['children'][] =
  1408.                     [
  1409.                         'id' => $item->getName(),
  1410.                         'text' => $item->getName(),
  1411.                         'leaf' => true,
  1412.                         'iconCls' => 'pimcore_icon_videothumbnails',
  1413.                         'cls' => 'pimcore_treenode_disabled',
  1414.                         'writeable' => $item->isWriteable(),
  1415.                     ];
  1416.             } else {
  1417.                 $thumbnails[] = [
  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.             }
  1426.         }
  1428.         foreach ($groups as $group) {
  1429.             $thumbnails[] = $group;
  1430.         }
  1432.         return $this->adminJson($thumbnails);
  1433.     }
  1435.     /**
  1436.      * @Route("/video-thumbnail-add", name="pimcore_admin_settings_videothumbnailadd", methods={"POST"})
  1437.      *
  1438.      * @param Request $request
  1439.      *
  1440.      * @return JsonResponse
  1441.      */
  1442.     public function videoThumbnailAddAction(Request $request)
  1443.     {
  1444.         $this->checkPermission('thumbnails');
  1446.         $success = false;
  1448.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1450.         if (!$pipe) {
  1451.             $pipe = new Asset\Video\Thumbnail\Config();
  1452.             if (!$pipe->isWriteable()) {
  1453.                 throw new ConfigWriteException();
  1454.             }
  1456.             $pipe->setName($request->get('name'));
  1457.             $pipe->save();
  1459.             $success = true;
  1460.         } else {
  1461.             if (!$pipe->isWriteable()) {
  1462.                 throw new ConfigWriteException();
  1463.             }
  1464.         }
  1466.         return $this->adminJson(['success' => $success, 'id' => $pipe->getName()]);
  1467.     }
  1469.     /**
  1470.      * @Route("/video-thumbnail-delete", name="pimcore_admin_settings_videothumbnaildelete", methods={"DELETE"})
  1471.      *
  1472.      * @param Request $request
  1473.      *
  1474.      * @return JsonResponse
  1475.      */
  1476.     public function videoThumbnailDeleteAction(Request $request)
  1477.     {
  1478.         $this->checkPermission('thumbnails');
  1480.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1482.         if (!$pipe->isWriteable()) {
  1483.             throw new ConfigWriteException();
  1484.         }
  1486.         $pipe->delete();
  1488.         return $this->adminJson(['success' => true]);
  1489.     }
  1491.     /**
  1492.      * @Route("/video-thumbnail-get", name="pimcore_admin_settings_videothumbnailget", methods={"GET"})
  1493.      *
  1494.      * @param Request $request
  1495.      *
  1496.      * @return JsonResponse
  1497.      */
  1498.     public function videoThumbnailGetAction(Request $request)
  1499.     {
  1500.         $this->checkPermission('thumbnails');
  1502.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1504.         $data = $pipe->getObjectVars();
  1505.         $data['writeable'] = $pipe->isWriteable();
  1507.         return $this->adminJson($data);
  1508.     }
  1510.     /**
  1511.      * @Route("/video-thumbnail-update", name="pimcore_admin_settings_videothumbnailupdate", methods={"PUT"})
  1512.      *
  1513.      * @param Request $request
  1514.      *
  1515.      * @return JsonResponse
  1516.      */
  1517.     public function videoThumbnailUpdateAction(Request $request)
  1518.     {
  1519.         $this->checkPermission('thumbnails');
  1521.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1523.         if (!$pipe->isWriteable()) {
  1524.             throw new ConfigWriteException();
  1525.         }
  1527.         $settingsData = $this->decodeJson($request->get('settings'));
  1528.         $mediaData = $this->decodeJson($request->get('medias'));
  1529.         $mediaOrder = $this->decodeJson($request->get('mediaOrder'));
  1531.         foreach ($settingsData as $key => $value) {
  1532.             $setter = 'set' . ucfirst($key);
  1533.             if (method_exists($pipe, $setter)) {
  1534.                 $pipe->$setter($value);
  1535.             }
  1536.         }
  1538.         $pipe->resetItems();
  1540.         uksort($mediaData, function ($a, $b) use ($mediaOrder) {
  1541.             if ($a === 'default') {
  1542.                 return -1;
  1543.             }
  1545.             return ($mediaOrder[$a] < $mediaOrder[$b]) ? -1 : 1;
  1546.         });
  1548.         foreach ($mediaData as $mediaName => $items) {
  1549.             foreach ($items as $item) {
  1550.                 $type = $item['type'];
  1551.                 unset($item['type']);
  1553.                 $pipe->addItem($type, $item, $mediaName);
  1554.             }
  1555.         }
  1557.         $pipe->save();
  1559.         return $this->adminJson(['success' => true]);
  1560.     }
  1562.     /**
  1563.      * @Route("/robots-txt", name="pimcore_admin_settings_robotstxtget", methods={"GET"})
  1564.      *
  1565.      * @return JsonResponse
  1566.      */
  1567.     public function robotsTxtGetAction()
  1568.     {
  1569.         $this->checkPermission('robots.txt');
  1571.         $config = Config::getRobotsConfig();
  1572.         $config = $config->toArray();
  1574.         return $this->adminJson([
  1575.             'success' => true,
  1576.             'data' => $config,
  1577.             'onFileSystem' => file_exists(PIMCORE_WEB_ROOT . '/robots.txt'),
  1578.         ]);
  1579.     }
  1581.     /**
  1582.      * @Route("/robots-txt", name="pimcore_admin_settings_robotstxtput", methods={"PUT"})
  1583.      *
  1584.      * @param Request $request
  1585.      *
  1586.      * @return JsonResponse
  1587.      */
  1588.     public function robotsTxtPutAction(Request $request)
  1589.     {
  1590.         $this->checkPermission('robots.txt');
  1592.         $values = $request->get('data');
  1593.         if (!is_array($values)) {
  1594.             $values = [];
  1595.         }
  1597.         foreach ($values as $siteId => $robotsContent) {
  1598.             SettingsStore::set('robots.txt-' . $siteId, $robotsContent, 'string', 'robots.txt');
  1599.         }
  1601.         return $this->adminJson([
  1602.             'success' => true,
  1603.         ]);
  1604.     }
  1606.     /**
  1607.      * @Route("/website-settings", name="pimcore_admin_settings_websitesettings", methods={"POST"})
  1608.      *
  1609.      * @param Request $request
  1610.      *
  1611.      * @return JsonResponse
  1612.      *
  1613.      * @throws \Exception
  1614.      */
  1615.     public function websiteSettingsAction(Request $request)
  1616.     {
  1617.         $this->checkPermission('website_settings');
  1619.         if ($request->get('data')) {
  1620.             $data = $this->decodeJson($request->get('data'));
  1622.             if (is_array($data)) {
  1623.                 foreach ($data as &$value) {
  1624.                     $value = trim($value);
  1625.                 }
  1626.             }
  1628.             if ($request->get('xaction') == 'destroy') {
  1629.                 $id = $data['id'];
  1630.                 $setting = WebsiteSetting::getById($id);
  1631.                 if ($setting instanceof WebsiteSetting) {
  1632.                     $setting->delete();
  1634.                     return $this->adminJson(['success' => true, 'data' => []]);
  1635.                 }
  1636.             } elseif ($request->get('xaction') == 'update') {
  1637.                 // save routes
  1638.                 $setting = WebsiteSetting::getById($data['id']);
  1639.                 if ($setting instanceof WebsiteSetting) {
  1640.                     switch ($setting->getType()) {
  1641.                         case 'document':
  1642.                         case 'asset':
  1643.                         case 'object':
  1644.                             if (isset($data['data'])) {
  1645.                                 $element = Element\Service::getElementByPath($setting->getType(), $data['data']);
  1646.                                 $data['data'] = $element;
  1647.                             }
  1649.                             break;
  1650.                     }
  1652.                     $setting->setValues($data);
  1653.                     $setting->save();
  1655.                     $data = $this->getWebsiteSettingForEditMode($setting);
  1657.                     return $this->adminJson(['data' => $data, 'success' => true]);
  1658.                 }
  1659.             } elseif ($request->get('xaction') == 'create') {
  1660.                 unset($data['id']);
  1662.                 // save route
  1663.                 $setting = new WebsiteSetting();
  1664.                 $setting->setValues($data);
  1666.                 $setting->save();
  1668.                 return $this->adminJson(['data' => $setting->getObjectVars(), 'success' => true]);
  1669.             }
  1670.         } else {
  1671.             $list = new WebsiteSetting\Listing();
  1673.             $list->setLimit($request->get('limit'));
  1674.             $list->setOffset($request->get('start'));
  1676.             $sortingSettings = \Pimcore\Bundle\AdminBundle\Helper\QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  1677.             if ($sortingSettings['orderKey']) {
  1678.                 $list->setOrderKey($sortingSettings['orderKey']);
  1679.                 $list->setOrder($sortingSettings['order']);
  1680.             } else {
  1681.                 $list->setOrderKey('name');
  1682.                 $list->setOrder('asc');
  1683.             }
  1685.             if ($request->get('filter')) {
  1686.                 $list->setCondition('`name` LIKE ' . $list->quote('%'.$request->get('filter').'%'));
  1687.             }
  1689.             $totalCount = $list->getTotalCount();
  1690.             $list = $list->load();
  1692.             $settings = [];
  1693.             foreach ($list as $item) {
  1694.                 $resultItem = $this->getWebsiteSettingForEditMode($item);
  1695.                 $settings[] = $resultItem;
  1696.             }
  1698.             return $this->adminJson(['data' => $settings, 'success' => true, 'total' => $totalCount]);
  1699.         }
  1701.         return $this->adminJson(['success' => false]);
  1702.     }
  1704.     /**
  1705.      * @param WebsiteSetting $item
  1706.      *
  1707.      * @return array
  1708.      */
  1709.     private function getWebsiteSettingForEditMode($item)
  1710.     {
  1711.         $resultItem = [
  1712.             'id' => $item->getId(),
  1713.             'name' => $item->getName(),
  1714.             'language' => $item->getLanguage(),
  1715.             'type' => $item->getType(),
  1716.             'data' => null,
  1717.             'siteId' => $item->getSiteId(),
  1718.             'creationDate' => $item->getCreationDate(),
  1719.             'modificationDate' => $item->getModificationDate(),
  1720.         ];
  1722.         switch ($item->getType()) {
  1723.             case 'document':
  1724.             case 'asset':
  1725.             case 'object':
  1726.                 $element = $item->getData();
  1727.                 if ($element) {
  1728.                     $resultItem['data'] = $element->getRealFullPath();
  1729.                 }
  1731.                 break;
  1732.             default:
  1733.                 $resultItem['data'] = $item->getData();
  1735.                 break;
  1736.         }
  1738.         return $resultItem;
  1739.     }
  1741.     /**
  1742.      * @Route("/get-available-algorithms", name="pimcore_admin_settings_getavailablealgorithms", methods={"GET"})
  1743.      *
  1744.      * @param Request $request
  1745.      *
  1746.      * @return JsonResponse
  1747.      */
  1748.     public function getAvailableAlgorithmsAction(Request $request)
  1749.     {
  1750.         $options = [
  1751.             [
  1752.                 'key' => 'password_hash',
  1753.                 'value' => 'password_hash',
  1754.             ],
  1755.         ];
  1757.         $algorithms = hash_algos();
  1758.         foreach ($algorithms as $algorithm) {
  1759.             $options[] = [
  1760.                 'key' => $algorithm,
  1761.                 'value' => $algorithm,
  1762.             ];
  1763.         }
  1765.         $result = ['data' => $options, 'success' => true, 'total' => count($options)];
  1767.         return $this->adminJson($result);
  1768.     }
  1770.     /**
  1771.      * deleteViews
  1772.      * delete views for localized fields when languages are removed to
  1773.      * prevent mysql errors
  1774.      *
  1775.      * @param string $language
  1776.      * @param string $dbName
  1777.      */
  1778.     protected function deleteViews($language, $dbName)
  1779.     {
  1780.         $db = \Pimcore\Db::get();
  1781.         $views = $db->fetchAll('SHOW FULL TABLES IN ' . $db->quoteIdentifier($dbName) . " WHERE TABLE_TYPE LIKE 'VIEW'");
  1783.         foreach ($views as $view) {
  1784.             if (preg_match('/^object_localized_[0-9]+_' . $language . '$/', $view['Tables_in_' . $dbName])) {
  1785.                 $sql = 'DROP VIEW ' . $db->quoteIdentifier($view['Tables_in_' . $dbName]);
  1786.                 $db->query($sql);
  1787.             }
  1788.         }
  1789.     }
  1791.     /**
  1792.      * @Route("/test-web2print", name="pimcore_admin_settings_testweb2print", methods={"GET"})
  1793.      *
  1794.      * @param Request $request
  1795.      *
  1796.      * @return Response
  1797.      */
  1798.     public function testWeb2printAction(Request $request)
  1799.     {
  1800.         $this->checkPermission('web2print_settings');
  1802.         $response = $this->render('@PimcoreAdmin/Admin/Settings/testWeb2print.html.twig');
  1803.         $html = $response->getContent();
  1805.         $adapter = \Pimcore\Web2Print\Processor::getInstance();
  1806.         $params = [];
  1808.         if ($adapter instanceof \Pimcore\Web2Print\Processor\WkHtmlToPdf) {
  1809.             $params['adapterConfig'] = '-O landscape';
  1810.         } elseif ($adapter instanceof \Pimcore\Web2Print\Processor\PdfReactor) {
  1811.             $params['adapterConfig'] = [
  1812.                 'javaScriptMode' => 0,
  1813.                 'addLinks' => true,
  1814.                 'appendLog' => true,
  1815.                 'enableDebugMode' => true,
  1816.             ];
  1817.         }
  1819.         $responseOptions = [
  1820.             'Content-Type' => 'application/pdf',
  1821.         ];
  1823.         $pdfData = $adapter->getPdfFromString($html, $params);
  1825.         return new \Symfony\Component\HttpFoundation\Response(
  1826.             $pdfData,
  1827.             200,
  1828.             $responseOptions
  1830.         );
  1831.     }
  1832. }