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

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\JsonResponse;
  43. use Symfony\Component\HttpFoundation\Request;
  44. use Symfony\Component\HttpFoundation\Response;
  45. use Symfony\Component\HttpFoundation\StreamedResponse;
  46. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  47. use Symfony\Component\HttpKernel\KernelEvents;
  48. use Symfony\Component\HttpKernel\KernelInterface;
  49. use Symfony\Component\Routing\Annotation\Route;
  50. use Symfony\Component\Yaml\Yaml;
  52. /**
  53.  * @Route("/settings")
  54.  *
  55.  * @internal
  56.  */
  57. class SettingsController extends AdminController
  58. {
  59.     use StopMessengerWorkersTrait;
  61.     private const CUSTOM_LOGO_PATH = 'custom-logo.image';
  63.     /**
  64.      * @Route("/display-custom-logo", name="pimcore_settings_display_custom_logo", methods={"GET"})
  65.      *
  66.      * @param Request $request
  67.      *
  68.      * @return StreamedResponse
  69.      */
  70.     public function displayCustomLogoAction(Request $request)
  71.     {
  72.         $mime = 'image/svg+xml';
  73.         if ($request->get('white')) {
  74.             $logo = PIMCORE_WEB_ROOT . '/bundles/pimcoreadmin/img/logo-claim-white.svg';
  75.         } else {
  76.             $logo = PIMCORE_WEB_ROOT . '/bundles/pimcoreadmin/img/logo-claim-gray.svg';
  77.         }
  79.         $stream = fopen($logo, 'rb');
  81.         $storage = Tool\Storage::get('admin');
  82.         if ($storage->fileExists(self::CUSTOM_LOGO_PATH)) {
  83.             try {
  84.                 $mime = $storage->mimeType(self::CUSTOM_LOGO_PATH);
  85.                 $stream = $storage->readStream(self::CUSTOM_LOGO_PATH);
  86.             } catch (\Exception $e) {
  87.                 // do nothing
  88.             }
  89.         }
  91.         return new StreamedResponse(function () use ($stream) {
  92.             fpassthru($stream);
  93.         }, 200, ['Content-Type' => $mime]);
  94.     }
  96.     /**
  97.      * @Route("/upload-custom-logo", name="pimcore_admin_settings_uploadcustomlogo", methods={"POST"})
  98.      *
  99.      * @param Request $request
  100.      *
  101.      * @return JsonResponse
  102.      *
  103.      * @throws \Exception
  104.      */
  105.     public function uploadCustomLogoAction(Request $request)
  106.     {
  107.         $fileExt = File::getFileExtension($_FILES['Filedata']['name']);
  108.         if (!in_array($fileExt, ['svg', 'png', 'jpg'])) {
  109.             throw new \Exception('Unsupported file format');
  110.         }
  112.         if ($fileExt === 'svg' && stripos(file_get_contents($_FILES['Filedata']['tmp_name']), '<script')) {
  113.             throw new \Exception('Scripts in SVG files are not supported');
  114.         }
  116.         $storage = Tool\Storage::get('admin');
  117.         $storage->writeStream(self::CUSTOM_LOGO_PATH, fopen($_FILES['Filedata']['tmp_name'], 'rb'));
  119.         // set content-type to text/html, otherwise (when application/json is sent) chrome will complain in
  120.         // Ext.form.Action.Submit and mark the submission as failed
  122.         $response = $this->adminJson(['success' => true]);
  123.         $response->headers->set('Content-Type', 'text/html');
  125.         return $response;
  126.     }
  128.     /**
  129.      * @Route("/delete-custom-logo", name="pimcore_admin_settings_deletecustomlogo", methods={"DELETE"})
  130.      *
  131.      * @param Request $request
  132.      *
  133.      * @return JsonResponse
  134.      */
  135.     public function deleteCustomLogoAction(Request $request)
  136.     {
  137.         if (Tool\Storage::get('admin')->fileExists(self::CUSTOM_LOGO_PATH)) {
  138.             Tool\Storage::get('admin')->delete(self::CUSTOM_LOGO_PATH);
  139.         }
  141.         return $this->adminJson(['success' => true]);
  142.     }
  144.     /**
  145.      * Used by the predefined metadata grid
  146.      *
  147.      * @Route("/predefined-metadata", name="pimcore_admin_settings_metadata", methods={"POST"})
  148.      *
  149.      * @param Request $request
  150.      *
  151.      * @return JsonResponse
  152.      */
  153.     public function metadataAction(Request $request)
  154.     {
  155.         $this->checkPermission('asset_metadata');
  157.         if ($request->get('data')) {
  158.             if ($request->get('xaction') == 'destroy') {
  159.                 $data = $this->decodeJson($request->get('data'));
  160.                 $id = $data['id'];
  161.                 $metadata = Metadata\Predefined::getById($id);
  162.                 if (!$metadata->isWriteable()) {
  163.                     throw new ConfigWriteException();
  164.                 }
  165.                 $metadata->delete();
  167.                 return $this->adminJson(['success' => true, 'data' => []]);
  168.             } elseif ($request->get('xaction') == 'update') {
  169.                 $data = $this->decodeJson($request->get('data'));
  171.                 // save type
  172.                 $metadata = Metadata\Predefined::getById($data['id']);
  173.                 if (!$metadata->isWriteable()) {
  174.                     throw new ConfigWriteException();
  175.                 }
  176.                 $metadata->setValues($data);
  178.                 $existingItem = Metadata\Predefined\Listing::getByKeyAndLanguage($metadata->getName(), $metadata->getLanguage(), $metadata->getTargetSubtype());
  179.                 if ($existingItem && $existingItem->getId() != $metadata->getId()) {
  180.                     return $this->adminJson(['message' => 'rule_violation', 'success' => false]);
  181.                 }
  183.                 $metadata->minimize();
  184.                 $metadata->save();
  185.                 $metadata->expand();
  187.                 $responseData = $metadata->getObjectVars();
  188.                 $responseData['writeable'] = $metadata->isWriteable();
  190.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  191.             } elseif ($request->get('xaction') == 'create') {
  192.                 if (!(new Metadata\Predefined())->isWriteable()) {
  193.                     throw new ConfigWriteException();
  194.                 }
  195.                 $data = $this->decodeJson($request->get('data'));
  196.                 unset($data['id']);
  198.                 // save type
  199.                 $metadata = Metadata\Predefined::create();
  201.                 $metadata->setValues($data);
  203.                 $existingItem = Metadata\Predefined\Listing::getByKeyAndLanguage($metadata->getName(), $metadata->getLanguage(), $metadata->getTargetSubtype());
  204.                 if ($existingItem) {
  205.                     return $this->adminJson(['message' => 'rule_violation', 'success' => false]);
  206.                 }
  208.                 $metadata->save();
  210.                 $responseData = $metadata->getObjectVars();
  211.                 $responseData['writeable'] = $metadata->isWriteable();
  213.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  214.             }
  215.         } else {
  216.             // get list of types
  217.             $list = new Metadata\Predefined\Listing();
  219.             if ($filter = $request->get('filter')) {
  220.                 $list->setFilter(function (Metadata\Predefined $predefined) use ($filter) {
  221.                     foreach ($predefined->getObjectVars() as $value) {
  222.                         if (stripos($value, $filter) !== false) {
  223.                             return true;
  224.                         }
  225.                     }
  227.                     return false;
  228.                 });
  229.             }
  231.             $properties = [];
  232.             foreach ($list->getDefinitions() as $metadata) {
  233.                 $data = $metadata->getObjectVars();
  234.                 $data['writeable'] = $metadata->isWriteable();
  235.                 $properties[] = $data;
  236.             }
  238.             return $this->adminJson(['data' => $properties, 'success' => true, 'total' => $list->getTotalCount()]);
  239.         }
  241.         return $this->adminJson(['success' => false]);
  242.     }
  244.     /**
  245.      * @Route("/get-predefined-metadata", name="pimcore_admin_settings_getpredefinedmetadata", methods={"GET"})
  246.      *
  247.      * @param Request $request
  248.      *
  249.      * @return JsonResponse
  250.      */
  251.     public function getPredefinedMetadataAction(Request $request)
  252.     {
  253.         $type = $request->get('type');
  254.         $subType = $request->get('subType');
  255.         $group = $request->get('group');
  256.         $list = Metadata\Predefined\Listing::getByTargetType($type, [$subType]);
  257.         $result = [];
  258.         foreach ($list as $item) {
  259.             $itemGroup = $item->getGroup() ?? '';
  260.             if ($group === 'default' || $group === $itemGroup) {
  261.                 $item->expand();
  262.                 $data = $item->getObjectVars();
  263.                 $data['writeable'] = $item->isWriteable();
  264.                 $result[] = $data;
  265.             }
  266.         }
  268.         return $this->adminJson(['data' => $result, 'success' => true]);
  269.     }
  271.     /**
  272.      * @Route("/properties", name="pimcore_admin_settings_properties", methods={"POST"})
  273.      *
  274.      * @param Request $request
  275.      *
  276.      * @return JsonResponse
  277.      */
  278.     public function propertiesAction(Request $request)
  279.     {
  280.         if ($request->get('data')) {
  281.             $this->checkPermission('predefined_properties');
  283.             if ($request->get('xaction') == 'destroy') {
  284.                 $data = $this->decodeJson($request->get('data'));
  285.                 $id = $data['id'];
  286.                 $property = Property\Predefined::getById($id);
  287.                 if (!$property->isWriteable()) {
  288.                     throw new ConfigWriteException();
  289.                 }
  290.                 $property->delete();
  292.                 return $this->adminJson(['success' => true, 'data' => []]);
  293.             } elseif ($request->get('xaction') == 'update') {
  294.                 $data = $this->decodeJson($request->get('data'));
  296.                 // save type
  297.                 $property = Property\Predefined::getById($data['id']);
  298.                 if (!$property->isWriteable()) {
  299.                     throw new ConfigWriteException();
  300.                 }
  301.                 if (is_array($data['ctype'])) {
  302.                     $data['ctype'] = implode(',', $data['ctype']);
  303.                 }
  304.                 $property->setValues($data);
  306.                 $property->save();
  308.                 $responseData = $property->getObjectVars();
  309.                 $responseData['writeable'] = $property->isWriteable();
  311.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  312.             } elseif ($request->get('xaction') == 'create') {
  313.                 if (!(new Property\Predefined())->isWriteable()) {
  314.                     throw new ConfigWriteException();
  315.                 }
  316.                 $data = $this->decodeJson($request->get('data'));
  317.                 unset($data['id']);
  319.                 // save type
  320.                 $property = Property\Predefined::create();
  321.                 $property->setValues($data);
  323.                 $property->save();
  325.                 $responseData = $property->getObjectVars();
  326.                 $responseData['writeable'] = $property->isWriteable();
  328.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  329.             }
  330.         } else {
  331.             // get list of types
  332.             $list = new Property\Predefined\Listing();
  334.             if ($filter = $request->get('filter')) {
  335.                 $list->setFilter(function (Property\Predefined $predefined) use ($filter) {
  336.                     foreach ($predefined->getObjectVars() as $value) {
  337.                         if ($value) {
  338.                             $cellValues = is_array($value) ? $value : [$value];
  340.                             foreach ($cellValues as $cellValue) {
  341.                                 if (stripos($cellValue, $filter) !== false) {
  342.                                     return true;
  343.                                 }
  344.                             }
  345.                         }
  346.                     }
  348.                     return false;
  349.                 });
  350.             }
  352.             $properties = [];
  353.             foreach ($list->getProperties() as $property) {
  354.                 $data = $property->getObjectVars();
  355.                 $data['writeable'] = $property->isWriteable();
  356.                 $properties[] = $data;
  357.             }
  359.             return $this->adminJson(['data' => $properties, 'success' => true, 'total' => $list->getTotalCount()]);
  360.         }
  362.         return $this->adminJson(['success' => false]);
  363.     }
  365.     /**
  366.      * @Route("/get-system", name="pimcore_admin_settings_getsystem", methods={"GET"})
  367.      *
  368.      * @param Request $request
  369.      * @param Config $config
  370.      *
  371.      * @return JsonResponse
  372.      */
  373.     public function getSystemAction(Request $request, Config $config)
  374.     {
  375.         $this->checkPermission('system_settings');
  377.         $valueArray = [
  378.             'general' => $config['general'],
  379.             'documents' => $config['documents'],
  380.             'assets' => $config['assets'],
  381.             'objects' => $config['objects'],
  382.             'branding' => $config['branding'],
  383.             'email' => $config['email'],
  384.         ];
  386.         $locales = Tool::getSupportedLocales();
  387.         $languageOptions = [];
  388.         $validLanguages = [];
  389.         foreach ($locales as $short => $translation) {
  390.             if (!empty($short)) {
  391.                 $languageOptions[] = [
  392.                     'language' => $short,
  393.                     'display' => $translation . " ($short)",
  394.                 ];
  395.                 $validLanguages[] = $short;
  396.             }
  397.         }
  399.         $valueArray['general']['valid_language'] = explode(',', $valueArray['general']['valid_languages']);
  401.         //for "wrong" legacy values
  402.         if (is_array($valueArray['general']['valid_language'])) {
  403.             foreach ($valueArray['general']['valid_language'] as $existingValue) {
  404.                 if (!in_array($existingValue, $validLanguages)) {
  405.                     $languageOptions[] = [
  406.                         'language' => $existingValue,
  407.                         'display' => $existingValue,
  408.                     ];
  409.                 }
  410.             }
  411.         }
  413.         $response = [
  414.             'values' => $valueArray,
  415.             'config' => [
  416.                 'languages' => $languageOptions,
  417.             ],
  418.         ];
  420.         return $this->adminJson($response);
  421.     }
  423.     /**
  424.      * @Route("/set-system", name="pimcore_admin_settings_setsystem", methods={"PUT"})
  425.      *
  426.      * @param Request $request
  427.      * @param LocaleServiceInterface $localeService
  428.      *
  429.      * @return JsonResponse
  430.      */
  431.     public function setSystemAction(
  432.         LocaleServiceInterface $localeService,
  433.         Request $request,
  434.         KernelInterface $kernel,
  435.         EventDispatcherInterface $eventDispatcher,
  436.         CoreCacheHandler $cache,
  437.         Filesystem $filesystem,
  438.         CacheClearer $symfonyCacheClearer
  439.     ) {
  440.         $this->checkPermission('system_settings');
  442.         $values = $this->decodeJson($request->get('data'));
  444.         $existingValues = [];
  446.         try {
  447.             $file = Config::locateConfigFile('system.yml');
  448.             $existingValues = Config::getConfigInstance($file, true);
  449.         } catch (\Exception $e) {
  450.             // nothing to do
  451.         }
  453.         // localized error pages
  454.         $localizedErrorPages = [];
  456.         // fallback languages
  457.         $fallbackLanguages = [];
  458.         $existingValues['pimcore']['general']['fallback_languages'] = [];
  459.         $languages = explode(',', $values['general.validLanguages']);
  460.         $filteredLanguages = [];
  462.         foreach ($languages as $language) {
  463.             if (isset($values['general.fallbackLanguages.' . $language])) {
  464.                 $fallbackLanguages[$language] = str_replace(' ', '', $values['general.fallbackLanguages.' . $language]);
  465.             }
  467.             // localized error pages
  468.             if (isset($values['documents.error_pages.localized.' . $language])) {
  469.                 $localizedErrorPages[$language] = $values['documents.error_pages.localized.' . $language];
  470.             }
  472.             if ($localeService->isLocale($language)) {
  473.                 $filteredLanguages[] = $language;
  474.             }
  475.         }
  477.         // check if there's a fallback language endless loop
  478.         foreach ($fallbackLanguages as $sourceLang => $targetLang) {
  479.             $this->checkFallbackLanguageLoop($sourceLang, $fallbackLanguages);
  480.         }
  482.         $settings['pimcore'] = [
  483.             'general' => [
  484.                 'domain' => $values['general.domain'],
  485.                 'redirect_to_maindomain' => $values['general.redirect_to_maindomain'],
  486.                 'language' => $values['general.language'],
  487.                 'valid_languages' => implode(',', $filteredLanguages),
  488.                 'fallback_languages' => $fallbackLanguages,
  489.                 'default_language' => $values['general.defaultLanguage'],
  490.                 'debug_admin_translations' => $values['general.debug_admin_translations'],
  491.             ],
  492.             'documents' => [
  493.                 'versions' => [
  494.                     'days' => $values['documents.versions.days'] ?? null,
  495.                     'steps' => $values['documents.versions.steps'] ?? null,
  496.                 ],
  497.                 'error_pages' => [
  498.                     'default' => $values['documents.error_pages.default'],
  499.                     'localized' => $localizedErrorPages,
  500.                 ],
  501.             ],
  502.             'objects' => [
  503.                 'versions' => [
  504.                     'days' => $values['objects.versions.days'] ?? null,
  505.                     'steps' => $values['objects.versions.steps'] ?? null,
  506.                 ],
  507.             ],
  508.             'assets' => [
  509.                 'versions' => [
  510.                     'days' => $values['assets.versions.days'] ?? null,
  511.                     'steps' => $values['assets.versions.steps'] ?? null,
  512.                 ],
  513.                 'hide_edit_image' => $values['assets.hide_edit_image'],
  514.                 'disable_tree_preview' => $values['assets.disable_tree_preview'],
  515.             ],
  516.         ];
  518.         //branding
  519.         $settings['pimcore_admin'] = [
  520.             'branding' =>
  521.                 [
  522.                     'login_screen_invert_colors' => $values['branding.login_screen_invert_colors'],
  523.                     'color_login_screen' => $values['branding.color_login_screen'],
  524.                     'color_admin_interface' => $values['branding.color_admin_interface'],
  525.                     'login_screen_custom_image' => $values['branding.login_screen_custom_image'],
  526.                 ],
  527.         ];
  529.         if (array_key_exists('email.debug.emailAddresses', $values) && $values['email.debug.emailAddresses']) {
  530.             $settings['pimcore']['email']['debug']['email_addresses'] = $values['email.debug.emailAddresses'];
  531.         }
  533.         $settingsYml = Yaml::dump($settings, 5);
  534.         $configFile = Config::locateConfigFile('system.yml');
  535.         File::put($configFile, $settingsYml);
  537.         // clear all caches
  538.         $this->clearSymfonyCache($request, $kernel, $eventDispatcher, $symfonyCacheClearer);
  539.         $this->stopMessengerWorkers();
  541.         $eventDispatcher->addListener(KernelEvents::TERMINATE, function (TerminateEvent $event) use (
  542.             $cache, $eventDispatcher, $filesystem
  543.         ) {
  544.             // we need to clear the cache with a delay, because the cache is used by messenger:stop-workers
  545.             // to send the stop signal to all worker processes
  546.             sleep(2);
  547.             $this->clearPimcoreCache($cache, $eventDispatcher, $filesystem);
  548.         });
  550.         return $this->adminJson(['success' => true]);
  551.     }
  553.     /**
  554.      * @param string $source
  555.      * @param array $definitions
  556.      * @param array $fallbacks
  557.      *
  558.      * @throws \Exception
  559.      */
  560.     protected function checkFallbackLanguageLoop($source, $definitions, $fallbacks = [])
  561.     {
  562.         if (isset($definitions[$source])) {
  563.             $targets = explode(',', $definitions[$source]);
  564.             foreach ($targets as $l) {
  565.                 $target = trim($l);
  566.                 if ($target) {
  567.                     if (in_array($target, $fallbacks)) {
  568.                         throw new \Exception("Language `$source` | `$target` causes an infinte loop.");
  569.                     }
  570.                     $fallbacks[] = $target;
  572.                     $this->checkFallbackLanguageLoop($target, $definitions, $fallbacks);
  573.                 }
  574.             }
  575.         } else {
  576.             throw new \Exception("Language `$source` doesn't exist");
  577.         }
  578.     }
  580.     /**
  581.      * @Route("/get-web2print", name="pimcore_admin_settings_getweb2print", methods={"GET"})
  582.      *
  583.      * @param Request $request
  584.      *
  585.      * @return JsonResponse
  586.      */
  587.     public function getWeb2printAction(Request $request)
  588.     {
  589.         $this->checkPermission('web2print_settings');
  591.         $values = Config::getWeb2PrintConfig();
  592.         $valueArray = $values->toArray();
  594.         $optionsString = [];
  595.         if ($valueArray['wkhtml2pdfOptions'] ?? false) {
  596.             foreach ($valueArray['wkhtml2pdfOptions'] as $key => $value) {
  597.                 $tmpStr = '--'.$key;
  598.                 if ($value !== null && $value !== '') {
  599.                     $tmpStr .= ' '.$value;
  600.                 }
  601.                 $optionsString[] = $tmpStr;
  602.             }
  603.         }
  604.         $valueArray['wkhtml2pdfOptions'] = implode("\n", $optionsString);
  606.         $response = [
  607.             'values' => $valueArray,
  608.         ];
  610.         return $this->adminJson($response);
  611.     }
  613.     /**
  614.      * @Route("/set-web2print", name="pimcore_admin_settings_setweb2print", methods={"PUT"})
  615.      *
  616.      * @param Request $request
  617.      *
  618.      * @return JsonResponse
  619.      */
  620.     public function setWeb2printAction(Request $request)
  621.     {
  622.         $this->checkPermission('web2print_settings');
  624.         $values = $this->decodeJson($request->get('data'));
  626.         unset($values['documentation']);
  627.         unset($values['additions']);
  628.         unset($values['json_converter']);
  630.         if ($values['wkhtml2pdfOptions']) {
  631.             $optionArray = [];
  632.             $lines = explode("\n", $values['wkhtml2pdfOptions']);
  633.             foreach ($lines as $line) {
  634.                 $parts = explode(' ', substr($line, 2));
  635.                 $key = trim($parts[0]);
  636.                 if ($key) {
  637.                     $value = trim($parts[1] ?? '');
  638.                     $optionArray[$key] = $value;
  639.                 }
  640.             }
  641.             $values['wkhtml2pdfOptions'] = $optionArray;
  642.         }
  644.         \Pimcore\Web2Print\Config::save($values);
  646.         return $this->adminJson(['success' => true]);
  647.     }
  649.     /**
  650.      * @Route("/clear-cache", name="pimcore_admin_settings_clearcache", methods={"DELETE"})
  651.      *
  652.      * @param Request $request
  653.      * @param KernelInterface $kernel
  654.      * @param EventDispatcherInterface $eventDispatcher
  655.      * @param CoreCacheHandler $cache
  656.      * @param Filesystem $filesystem
  657.      * @param CacheClearer $symfonyCacheClearer
  658.      *
  659.      * @return JsonResponse
  660.      */
  661.     public function clearCacheAction(
  662.         Request $request,
  663.         KernelInterface $kernel,
  664.         EventDispatcherInterface $eventDispatcher,
  665.         CoreCacheHandler $cache,
  666.         Filesystem $filesystem,
  667.         CacheClearer $symfonyCacheClearer
  668.     ) {
  669.         $this->checkPermissionsHasOneOf(['clear_cache', 'system_settings']);
  671.         $result = [
  672.             'success' => true,
  673.         ];
  675.         $clearPimcoreCache = !(bool)$request->get('only_symfony_cache');
  676.         $clearSymfonyCache = !(bool)$request->get('only_pimcore_cache');
  678.         if ($clearPimcoreCache) {
  679.             $this->clearPimcoreCache($cache, $eventDispatcher, $filesystem);
  680.         }
  682.         if ($clearSymfonyCache) {
  683.             $this->clearSymfonyCache($request, $kernel, $eventDispatcher, $symfonyCacheClearer);
  684.         }
  686.         $response = new JsonResponse($result);
  688.         if ($clearSymfonyCache) {
  689.             // we send the response directly here and exit to make sure no code depending on the stale container
  690.             // is running after this
  691.             $response->sendHeaders();
  692.             $response->sendContent();
  693.             exit;
  694.         }
  696.         return $response;
  697.     }
  699.     private function clearPimcoreCache(
  700.         CoreCacheHandler $cache,
  701.         EventDispatcherInterface $eventDispatcher,
  702.         Filesystem $filesystem,
  703.     ): void {
  704.         // empty document cache
  705.         $cache->clearAll();
  707.         if ($filesystem->exists(PIMCORE_CACHE_DIRECTORY)) {
  708.             $filesystem->remove(PIMCORE_CACHE_DIRECTORY);
  709.         }
  711.         // PIMCORE-1854 - recreate .dummy file => should remain
  712.         File::put(PIMCORE_CACHE_DIRECTORY . '/.gitkeep', '');
  714.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR);
  715.     }
  717.     private function clearSymfonyCache(
  718.         Request $request,
  719.         KernelInterface $kernel,
  720.         EventDispatcherInterface $eventDispatcher,
  721.         CacheClearer $symfonyCacheClearer,
  722.     ): void {
  723.         // pass one or move env parameters to clear multiple envs
  724.         // if no env is passed it will use the current one
  725.         $environments = $request->get('env', $kernel->getEnvironment());
  727.         if (!is_array($environments)) {
  728.             $environments = trim((string)$environments);
  730.             if (empty($environments)) {
  731.                 $environments = [];
  732.             } else {
  733.                 $environments = [$environments];
  734.             }
  735.         }
  737.         if (empty($environments)) {
  738.             $environments = [$kernel->getEnvironment()];
  739.         }
  741.         $result['environments'] = $environments;
  743.         if (in_array($kernel->getEnvironment(), $environments)) {
  744.             // remove terminate and exception event listeners for the current env as they break with a
  745.             // cleared container - see #2434
  746.             foreach ($eventDispatcher->getListeners(KernelEvents::TERMINATE) as $listener) {
  747.                 $eventDispatcher->removeListener(KernelEvents::TERMINATE, $listener);
  748.             }
  750.             foreach ($eventDispatcher->getListeners(KernelEvents::EXCEPTION) as $listener) {
  751.                 $eventDispatcher->removeListener(KernelEvents::EXCEPTION, $listener);
  752.             }
  753.         }
  755.         foreach ($environments as $environment) {
  756.             try {
  757.                 $symfonyCacheClearer->clear($environment);
  758.             } catch (\Throwable $e) {
  759.                 $errors = $result['errors'] ?? [];
  760.                 $errors[] = $e->getMessage();
  762.                 $result = array_merge($result, [
  763.                     'success' => false,
  764.                     'errors' => $errors,
  765.                 ]);
  766.             }
  767.         }
  768.     }
  770.     /**
  771.      * @Route("/clear-output-cache", name="pimcore_admin_settings_clearoutputcache", methods={"DELETE"})
  772.      *
  773.      * @param EventDispatcherInterface $eventDispatcher
  774.      *
  775.      * @return JsonResponse
  776.      */
  777.     public function clearOutputCacheAction(EventDispatcherInterface $eventDispatcher)
  778.     {
  779.         $this->checkPermission('clear_fullpage_cache');
  781.         // remove "output" out of the ignored tags, if a cache lifetime is specified
  782.         Cache::removeIgnoredTagOnClear('output');
  784.         // empty document cache
  785.         Cache::clearTags(['output', 'output_lifetime']);
  787.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR_FULLPAGE_CACHE);
  789.         return $this->adminJson(['success' => true]);
  790.     }
  792.     /**
  793.      * @Route("/clear-temporary-files", name="pimcore_admin_settings_cleartemporaryfiles", methods={"DELETE"})
  794.      *
  795.      * @param EventDispatcherInterface $eventDispatcher
  796.      *
  797.      * @return JsonResponse
  798.      */
  799.     public function clearTemporaryFilesAction(EventDispatcherInterface $eventDispatcher)
  800.     {
  801.         $this->checkPermission('clear_temp_files');
  803.         // public files
  804.         Tool\Storage::get('thumbnail')->deleteDirectory('/');
  805.         Tool\Storage::get('asset_cache')->deleteDirectory('/');
  807.         // system files
  808.         recursiveDelete(PIMCORE_SYSTEM_TEMP_DIRECTORY, false);
  810.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR_TEMPORARY_FILES);
  812.         return $this->adminJson(['success' => true]);
  813.     }
  815.     /**
  816.      * @Route("/staticroutes", name="pimcore_admin_settings_staticroutes", methods={"POST"})
  817.      *
  818.      * @param Request $request
  819.      *
  820.      * @return JsonResponse
  821.      */
  822.     public function staticroutesAction(Request $request)
  823.     {
  824.         if ($request->get('data')) {
  825.             $this->checkPermission('routes');
  827.             $data = $this->decodeJson($request->get('data'));
  829.             if (is_array($data)) {
  830.                 foreach ($data as &$value) {
  831.                     if (is_string($value)) {
  832.                         $value = trim($value);
  833.                     }
  834.                 }
  835.             }
  837.             if ($request->get('xaction') == 'destroy') {
  838.                 $data = $this->decodeJson($request->get('data'));
  839.                 $id = $data['id'];
  840.                 $route = Staticroute::getById($id);
  841.                 if (!$route->isWriteable()) {
  842.                     throw new ConfigWriteException();
  843.                 }
  844.                 $route->delete();
  846.                 return $this->adminJson(['success' => true, 'data' => []]);
  847.             } elseif ($request->get('xaction') == 'update') {
  848.                 // save routes
  849.                 $route = Staticroute::getById($data['id']);
  850.                 if (!$route->isWriteable()) {
  851.                     throw new ConfigWriteException();
  852.                 }
  854.                 $route->setValues($data);
  856.                 $route->save();
  858.                 return $this->adminJson(['data' => $route->getObjectVars(), 'success' => true]);
  859.             } elseif ($request->get('xaction') == 'create') {
  860.                 if (!(new Staticroute())->isWriteable()) {
  861.                     throw new ConfigWriteException();
  862.                 }
  863.                 unset($data['id']);
  865.                 // save route
  866.                 $route = new Staticroute();
  867.                 $route->setValues($data);
  869.                 $route->save();
  871.                 $responseData = $route->getObjectVars();
  872.                 $responseData['writeable'] = $route->isWriteable();
  874.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  875.             }
  876.         } else {
  877.             // get list of routes
  879.             $list = new Staticroute\Listing();
  881.             if ($filter = $request->get('filter')) {
  882.                 $list->setFilter(function (Staticroute $staticRoute) use ($filter) {
  883.                     foreach ($staticRoute->getObjectVars() as $value) {
  884.                         if (!is_scalar($value)) {
  885.                             continue;
  886.                         }
  887.                         if (stripos((string)$value, $filter) !== false) {
  888.                             return true;
  889.                         }
  890.                     }
  892.                     return false;
  893.                 });
  894.             }
  896.             $routes = [];
  897.             foreach ($list->getRoutes() as $routeFromList) {
  898.                 $route = $routeFromList->getObjectVars();
  899.                 $route['writeable'] = $routeFromList->isWriteable();
  900.                 if (is_array($routeFromList->getSiteId())) {
  901.                     $route['siteId'] = implode(',', $routeFromList->getSiteId());
  902.                 }
  903.                 $routes[] = $route;
  904.             }
  906.             return $this->adminJson(['data' => $routes, 'success' => true, 'total' => $list->getTotalCount()]);
  907.         }
  909.         return $this->adminJson(['success' => false]);
  910.     }
  912.     /**
  913.      * @Route("/get-available-admin-languages", name="pimcore_admin_settings_getavailableadminlanguages", methods={"GET"})
  914.      *
  915.      * @param Request $request
  916.      *
  917.      * @return JsonResponse
  918.      */
  919.     public function getAvailableAdminLanguagesAction(Request $request)
  920.     {
  921.         $langs = [];
  922.         $availableLanguages = Tool\Admin::getLanguages();
  923.         $locales = Tool::getSupportedLocales();
  925.         foreach ($availableLanguages as $lang) {
  926.             if (array_key_exists($lang, $locales)) {
  927.                 $langs[] = [
  928.                     'language' => $lang,
  929.                     'display' => $locales[$lang],
  930.                 ];
  931.             }
  932.         }
  934.         usort($langs, function ($a, $b) {
  935.             return strcmp($a['display'], $b['display']);
  936.         });
  938.         return $this->adminJson($langs);
  939.     }
  941.     /**
  942.      * @Route("/glossary", name="pimcore_admin_settings_glossary", methods={"POST"})
  943.      *
  944.      * @param Request $request
  945.      *
  946.      * @return JsonResponse
  947.      */
  948.     public function glossaryAction(Request $request)
  949.     {
  950.         if ($request->get('data')) {
  951.             $this->checkPermission('glossary');
  953.             Cache::clearTag('glossary');
  955.             if ($request->get('xaction') == 'destroy') {
  956.                 $data = $this->decodeJson($request->get('data'));
  957.                 $id = $data['id'];
  958.                 $glossary = Glossary::getById($id);
  959.                 $glossary->delete();
  961.                 return $this->adminJson(['success' => true, 'data' => []]);
  962.             } elseif ($request->get('xaction') == 'update') {
  963.                 $data = $this->decodeJson($request->get('data'));
  965.                 // save glossary
  966.                 $glossary = Glossary::getById($data['id']);
  968.                 if (!empty($data['link'])) {
  969.                     if ($doc = Document::getByPath($data['link'])) {
  970.                         $data['link'] = $doc->getId();
  971.                     }
  972.                 }
  974.                 $glossary->setValues($data);
  976.                 $glossary->save();
  978.                 if ($link = $glossary->getLink()) {
  979.                     if ((int)$link > 0) {
  980.                         if ($doc = Document::getById((int)$link)) {
  981.                             $glossary->setLink($doc->getRealFullPath());
  982.                         }
  983.                     }
  984.                 }
  986.                 return $this->adminJson(['data' => $glossary, 'success' => true]);
  987.             } elseif ($request->get('xaction') == 'create') {
  988.                 $data = $this->decodeJson($request->get('data'));
  989.                 unset($data['id']);
  991.                 // save glossary
  992.                 $glossary = new Glossary();
  994.                 if (!empty($data['link'])) {
  995.                     if ($doc = Document::getByPath($data['link'])) {
  996.                         $data['link'] = $doc->getId();
  997.                     }
  998.                 }
  1000.                 $glossary->setValues($data);
  1002.                 $glossary->save();
  1004.                 if ($link = $glossary->getLink()) {
  1005.                     if ((int)$link > 0) {
  1006.                         if ($doc = Document::getById((int)$link)) {
  1007.                             $glossary->setLink($doc->getRealFullPath());
  1008.                         }
  1009.                     }
  1010.                 }
  1012.                 return $this->adminJson(['data' => $glossary->getObjectVars(), 'success' => true]);
  1013.             }
  1014.         } else {
  1015.             // get list of glossaries
  1017.             $list = new Glossary\Listing();
  1018.             $list->setLimit($request->get('limit'));
  1019.             $list->setOffset($request->get('start'));
  1021.             $sortingSettings = \Pimcore\Bundle\AdminBundle\Helper\QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  1022.             if ($sortingSettings['orderKey']) {
  1023.                 $list->setOrderKey($sortingSettings['orderKey']);
  1024.                 $list->setOrder($sortingSettings['order']);
  1025.             }
  1027.             if ($request->get('filter')) {
  1028.                 $list->setCondition('`text` LIKE ' . $list->quote('%'.$request->get('filter').'%'));
  1029.             }
  1031.             $list->load();
  1033.             $glossaries = [];
  1034.             foreach ($list->getGlossary() as $glossary) {
  1035.                 if ($link = $glossary->getLink()) {
  1036.                     if ((int)$link > 0) {
  1037.                         if ($doc = Document::getById((int)$link)) {
  1038.                             $glossary->setLink($doc->getRealFullPath());
  1039.                         }
  1040.                     }
  1041.                 }
  1043.                 $glossaries[] = $glossary->getObjectVars();
  1044.             }
  1046.             return $this->adminJson(['data' => $glossaries, 'success' => true, 'total' => $list->getTotalCount()]);
  1047.         }
  1049.         return $this->adminJson(['success' => false]);
  1050.     }
  1052.     /**
  1053.      * @Route("/get-available-sites", name="pimcore_admin_settings_getavailablesites", methods={"GET"})
  1054.      *
  1055.      * @param Request $request
  1056.      *
  1057.      * @return JsonResponse
  1058.      */
  1059.     public function getAvailableSitesAction(Request $request)
  1060.     {
  1061.         $excludeMainSite = $request->get('excludeMainSite');
  1063.         $sitesList = new Model\Site\Listing();
  1064.         $sitesObjects = $sitesList->load();
  1065.         $sites = [];
  1066.         if (!$excludeMainSite) {
  1067.             $sites[] = [
  1068.                 'id' => 'default',
  1069.                 'rootId' => 1,
  1070.                 'domains' => '',
  1071.                 'rootPath' => '/',
  1072.                 'domain' => $this->trans('main_site'),
  1073.             ];
  1074.         }
  1076.         foreach ($sitesObjects as $site) {
  1077.             if ($site->getRootDocument()) {
  1078.                 if ($site->getMainDomain()) {
  1079.                     $sites[] = [
  1080.                         'id' => $site->getId(),
  1081.                         'rootId' => $site->getRootId(),
  1082.                         'domains' => implode(',', $site->getDomains()),
  1083.                         'rootPath' => $site->getRootPath(),
  1084.                         'domain' => $site->getMainDomain(),
  1085.                     ];
  1086.                 }
  1087.             } else {
  1088.                 // site is useless, parent doesn't exist anymore
  1089.                 $site->delete();
  1090.             }
  1091.         }
  1093.         return $this->adminJson($sites);
  1094.     }
  1096.     /**
  1097.      * @Route("/get-available-countries", name="pimcore_admin_settings_getavailablecountries", methods={"GET"})
  1098.      *
  1099.      * @param LocaleServiceInterface $localeService
  1100.      *
  1101.      * @return JsonResponse
  1102.      */
  1103.     public function getAvailableCountriesAction(LocaleServiceInterface $localeService)
  1104.     {
  1105.         $countries = $localeService->getDisplayRegions();
  1106.         asort($countries);
  1108.         $options = [];
  1110.         foreach ($countries as $short => $translation) {
  1111.             if (strlen($short) == 2) {
  1112.                 $options[] = [
  1113.                     'key' => $translation . ' (' . $short . ')',
  1114.                     'value' => $short,
  1115.                 ];
  1116.             }
  1117.         }
  1119.         $result = ['data' => $options, 'success' => true, 'total' => count($options)];
  1121.         return $this->adminJson($result);
  1122.     }
  1124.     /**
  1125.      * @Route("/thumbnail-adapter-check", name="pimcore_admin_settings_thumbnailadaptercheck", methods={"GET"})
  1126.      *
  1127.      * @param Request $request
  1128.      *
  1129.      * @return Response
  1130.      */
  1131.     public function thumbnailAdapterCheckAction(Request $request)
  1132.     {
  1133.         $content = '';
  1135.         $instance = \Pimcore\Image::getInstance();
  1136.         if ($instance instanceof \Pimcore\Image\Adapter\GD) {
  1137.             $content = '<span style="color: red; font-weight: bold;padding: 10px;margin:0 0 20px 0;border:1px solid red;display:block;">' .
  1138.                 $this->trans('important_use_imagick_pecl_extensions_for_best_results_gd_is_just_a_fallback_with_less_quality') .
  1139.                 '</span>';
  1140.         }
  1142.         return new Response($content);
  1143.     }
  1145.     /**
  1146.      * @Route("/thumbnail-tree", name="pimcore_admin_settings_thumbnailtree", methods={"GET", "POST"})
  1147.      *
  1148.      * @return JsonResponse
  1149.      */
  1150.     public function thumbnailTreeAction()
  1151.     {
  1152.         $this->checkPermission('thumbnails');
  1154.         $thumbnails = [];
  1156.         $list = new Asset\Image\Thumbnail\Config\Listing();
  1158.         $groups = [];
  1159.         foreach ($list->getThumbnails() as $item) {
  1160.             if ($item->getGroup()) {
  1161.                 if (empty($groups[$item->getGroup()])) {
  1162.                     $groups[$item->getGroup()] = [
  1163.                         'id' => 'group_' . $item->getName(),
  1164.                         'text' => htmlspecialchars($item->getGroup()),
  1165.                         'expandable' => true,
  1166.                         'leaf' => false,
  1167.                         'allowChildren' => true,
  1168.                         'iconCls' => 'pimcore_icon_folder',
  1169.                         'group' => $item->getGroup(),
  1170.                         'children' => [],
  1171.                     ];
  1172.                 }
  1173.                 $groups[$item->getGroup()]['children'][] =
  1174.                     [
  1175.                         'id' => $item->getName(),
  1176.                         'text' => $item->getName(),
  1177.                         'leaf' => true,
  1178.                         'iconCls' => 'pimcore_icon_thumbnails',
  1179.                         'cls' => 'pimcore_treenode_disabled',
  1180.                         'writeable' => $item->isWriteable(),
  1181.                     ];
  1182.             } else {
  1183.                 $thumbnails[] = [
  1184.                     'id' => $item->getName(),
  1185.                     'text' => $item->getName(),
  1186.                     'leaf' => true,
  1187.                     'iconCls' => 'pimcore_icon_thumbnails',
  1188.                     'cls' => 'pimcore_treenode_disabled',
  1189.                     'writeable' => $item->isWriteable(),
  1190.                 ];
  1191.             }
  1192.         }
  1194.         foreach ($groups as $group) {
  1195.             $thumbnails[] = $group;
  1196.         }
  1198.         return $this->adminJson($thumbnails);
  1199.     }
  1201.     /**
  1202.      * @Route("/thumbnail-downloadable", name="pimcore_admin_settings_thumbnaildownloadable", methods={"GET"})
  1203.      *
  1204.      * @return JsonResponse
  1205.      */
  1206.     public function thumbnailDownloadableAction()
  1207.     {
  1208.         $thumbnails = [];
  1210.         $list = new Asset\Image\Thumbnail\Config\Listing();
  1211.         $list->setFilter(function (Asset\Image\Thumbnail\Config $config) {
  1212.             return $config->isDownloadable();
  1213.         });
  1215.         foreach ($list->getThumbnails() as $item) {
  1216.             $thumbnails[] = [
  1217.                 'id' => $item->getName(),
  1218.                 'text' => $item->getName(),
  1219.             ];
  1220.         }
  1222.         return $this->adminJson($thumbnails);
  1223.     }
  1225.     /**
  1226.      * @Route("/thumbnail-add", name="pimcore_admin_settings_thumbnailadd", methods={"POST"})
  1227.      *
  1228.      * @param Request $request
  1229.      *
  1230.      * @return JsonResponse
  1231.      */
  1232.     public function thumbnailAddAction(Request $request)
  1233.     {
  1234.         $this->checkPermission('thumbnails');
  1236.         $success = false;
  1238.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1240.         if (!$pipe) {
  1241.             $pipe = new Asset\Image\Thumbnail\Config();
  1242.             if (!$pipe->isWriteable()) {
  1243.                 throw new ConfigWriteException();
  1244.             }
  1246.             $pipe->setName($request->get('name'));
  1247.             $pipe->save();
  1249.             $success = true;
  1250.         } else {
  1251.             if (!$pipe->isWriteable()) {
  1252.                 throw new ConfigWriteException();
  1253.             }
  1254.         }
  1256.         return $this->adminJson(['success' => $success, 'id' => $pipe->getName()]);
  1257.     }
  1259.     /**
  1260.      * @Route("/thumbnail-delete", name="pimcore_admin_settings_thumbnaildelete", methods={"DELETE"})
  1261.      *
  1262.      * @param Request $request
  1263.      *
  1264.      * @return JsonResponse
  1265.      */
  1266.     public function thumbnailDeleteAction(Request $request)
  1267.     {
  1268.         $this->checkPermission('thumbnails');
  1270.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1272.         if (!$pipe->isWriteable()) {
  1273.             throw new ConfigWriteException();
  1274.         }
  1276.         $pipe->delete();
  1278.         return $this->adminJson(['success' => true]);
  1279.     }
  1281.     /**
  1282.      * @Route("/thumbnail-get", name="pimcore_admin_settings_thumbnailget", methods={"GET"})
  1283.      *
  1284.      * @param Request $request
  1285.      *
  1286.      * @return JsonResponse
  1287.      */
  1288.     public function thumbnailGetAction(Request $request)
  1289.     {
  1290.         $this->checkPermission('thumbnails');
  1292.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1293.         $data = $pipe->getObjectVars();
  1294.         $data['writeable'] = $pipe->isWriteable();
  1296.         return $this->adminJson($data);
  1297.     }
  1299.     /**
  1300.      * @Route("/thumbnail-update", name="pimcore_admin_settings_thumbnailupdate", methods={"PUT"})
  1301.      *
  1302.      * @param Request $request
  1303.      *
  1304.      * @return JsonResponse
  1305.      */
  1306.     public function thumbnailUpdateAction(Request $request)
  1307.     {
  1308.         $this->checkPermission('thumbnails');
  1310.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1312.         if (!$pipe->isWriteable()) {
  1313.             throw new ConfigWriteException();
  1314.         }
  1316.         $settingsData = $this->decodeJson($request->get('settings'));
  1317.         $mediaData = $this->decodeJson($request->get('medias'));
  1318.         $mediaOrder = $this->decodeJson($request->get('mediaOrder'));
  1320.         foreach ($settingsData as $key => $value) {
  1321.             $setter = 'set' . ucfirst($key);
  1322.             if (method_exists($pipe, $setter)) {
  1323.                 $pipe->$setter($value);
  1324.             }
  1325.         }
  1327.         $pipe->resetItems();
  1329.         uksort($mediaData, function ($a, $b) use ($mediaOrder) {
  1330.             if ($a === 'default') {
  1331.                 return -1;
  1332.             }
  1334.             return ($mediaOrder[$a] < $mediaOrder[$b]) ? -1 : 1;
  1335.         });
  1337.         foreach ($mediaData as $mediaName => $items) {
  1338.             if (preg_match('/["<>]/', $mediaName)) {
  1339.                 throw new \Exception('Invalid media query name');
  1340.             }
  1342.             foreach ($items as $item) {
  1343.                 $type = $item['type'];
  1344.                 unset($item['type']);
  1346.                 $pipe->addItem($type, $item, $mediaName);
  1347.             }
  1348.         }
  1350.         $pipe->save();
  1352.         return $this->adminJson(['success' => true]);
  1353.     }
  1355.     /**
  1356.      * @Route("/video-thumbnail-adapter-check", name="pimcore_admin_settings_videothumbnailadaptercheck", methods={"GET"})
  1357.      *
  1358.      * @param Request $request
  1359.      *
  1360.      * @return Response
  1361.      */
  1362.     public function videoThumbnailAdapterCheckAction(Request $request)
  1363.     {
  1364.         $content = '';
  1366.         if (!\Pimcore\Video::isAvailable()) {
  1367.             $content = '<span style="color: red; font-weight: bold;padding: 10px;margin:0 0 20px 0;border:1px solid red;display:block;">' .
  1368.                 $this->trans('php_cli_binary_and_or_ffmpeg_binary_setting_is_missing') .
  1369.                 '</span>';
  1370.         }
  1372.         return new Response($content);
  1373.     }
  1375.     /**
  1376.      * @Route("/video-thumbnail-tree", name="pimcore_admin_settings_videothumbnailtree", methods={"GET", "POST"})
  1377.      *
  1378.      * @return JsonResponse
  1379.      */
  1380.     public function videoThumbnailTreeAction()
  1381.     {
  1382.         $this->checkPermission('thumbnails');
  1384.         $thumbnails = [];
  1386.         $list = new Asset\Video\Thumbnail\Config\Listing();
  1388.         $groups = [];
  1389.         foreach ($list->getThumbnails() as $item) {
  1390.             if ($item->getGroup()) {
  1391.                 if (empty($groups[$item->getGroup()])) {
  1392.                     $groups[$item->getGroup()] = [
  1393.                         'id' => 'group_' . $item->getName(),
  1394.                         'text' => htmlspecialchars($item->getGroup()),
  1395.                         'expandable' => true,
  1396.                         'leaf' => false,
  1397.                         'allowChildren' => true,
  1398.                         'iconCls' => 'pimcore_icon_folder',
  1399.                         'group' => $item->getGroup(),
  1400.                         'children' => [],
  1401.                     ];
  1402.                 }
  1403.                 $groups[$item->getGroup()]['children'][] =
  1404.                     [
  1405.                         'id' => $item->getName(),
  1406.                         'text' => $item->getName(),
  1407.                         'leaf' => true,
  1408.                         'iconCls' => 'pimcore_icon_videothumbnails',
  1409.                         'cls' => 'pimcore_treenode_disabled',
  1410.                         'writeable' => $item->isWriteable(),
  1411.                     ];
  1412.             } else {
  1413.                 $thumbnails[] = [
  1414.                     'id' => $item->getName(),
  1415.                     'text' => $item->getName(),
  1416.                     'leaf' => true,
  1417.                     'iconCls' => 'pimcore_icon_videothumbnails',
  1418.                     'cls' => 'pimcore_treenode_disabled',
  1419.                     'writeable' => $item->isWriteable(),
  1420.                 ];
  1421.             }
  1422.         }
  1424.         foreach ($groups as $group) {
  1425.             $thumbnails[] = $group;
  1426.         }
  1428.         return $this->adminJson($thumbnails);
  1429.     }
  1431.     /**
  1432.      * @Route("/video-thumbnail-add", name="pimcore_admin_settings_videothumbnailadd", methods={"POST"})
  1433.      *
  1434.      * @param Request $request
  1435.      *
  1436.      * @return JsonResponse
  1437.      */
  1438.     public function videoThumbnailAddAction(Request $request)
  1439.     {
  1440.         $this->checkPermission('thumbnails');
  1442.         $success = false;
  1444.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1446.         if (!$pipe) {
  1447.             $pipe = new Asset\Video\Thumbnail\Config();
  1448.             if (!$pipe->isWriteable()) {
  1449.                 throw new ConfigWriteException();
  1450.             }
  1452.             $pipe->setName($request->get('name'));
  1453.             $pipe->save();
  1455.             $success = true;
  1456.         } else {
  1457.             if (!$pipe->isWriteable()) {
  1458.                 throw new ConfigWriteException();
  1459.             }
  1460.         }
  1462.         return $this->adminJson(['success' => $success, 'id' => $pipe->getName()]);
  1463.     }
  1465.     /**
  1466.      * @Route("/video-thumbnail-delete", name="pimcore_admin_settings_videothumbnaildelete", methods={"DELETE"})
  1467.      *
  1468.      * @param Request $request
  1469.      *
  1470.      * @return JsonResponse
  1471.      */
  1472.     public function videoThumbnailDeleteAction(Request $request)
  1473.     {
  1474.         $this->checkPermission('thumbnails');
  1476.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1478.         if (!$pipe->isWriteable()) {
  1479.             throw new ConfigWriteException();
  1480.         }
  1482.         $pipe->delete();
  1484.         return $this->adminJson(['success' => true]);
  1485.     }
  1487.     /**
  1488.      * @Route("/video-thumbnail-get", name="pimcore_admin_settings_videothumbnailget", methods={"GET"})
  1489.      *
  1490.      * @param Request $request
  1491.      *
  1492.      * @return JsonResponse
  1493.      */
  1494.     public function videoThumbnailGetAction(Request $request)
  1495.     {
  1496.         $this->checkPermission('thumbnails');
  1498.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1500.         $data = $pipe->getObjectVars();
  1501.         $data['writeable'] = $pipe->isWriteable();
  1503.         return $this->adminJson($data);
  1504.     }
  1506.     /**
  1507.      * @Route("/video-thumbnail-update", name="pimcore_admin_settings_videothumbnailupdate", methods={"PUT"})
  1508.      *
  1509.      * @param Request $request
  1510.      *
  1511.      * @return JsonResponse
  1512.      */
  1513.     public function videoThumbnailUpdateAction(Request $request)
  1514.     {
  1515.         $this->checkPermission('thumbnails');
  1517.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1519.         if (!$pipe->isWriteable()) {
  1520.             throw new ConfigWriteException();
  1521.         }
  1523.         $settingsData = $this->decodeJson($request->get('settings'));
  1524.         $mediaData = $this->decodeJson($request->get('medias'));
  1525.         $mediaOrder = $this->decodeJson($request->get('mediaOrder'));
  1527.         foreach ($settingsData as $key => $value) {
  1528.             $setter = 'set' . ucfirst($key);
  1529.             if (method_exists($pipe, $setter)) {
  1530.                 $pipe->$setter($value);
  1531.             }
  1532.         }
  1534.         $pipe->resetItems();
  1536.         uksort($mediaData, function ($a, $b) use ($mediaOrder) {
  1537.             if ($a === 'default') {
  1538.                 return -1;
  1539.             }
  1541.             return ($mediaOrder[$a] < $mediaOrder[$b]) ? -1 : 1;
  1542.         });
  1544.         foreach ($mediaData as $mediaName => $items) {
  1545.             foreach ($items as $item) {
  1546.                 $type = $item['type'];
  1547.                 unset($item['type']);
  1549.                 $pipe->addItem($type, $item, $mediaName);
  1550.             }
  1551.         }
  1553.         $pipe->save();
  1555.         return $this->adminJson(['success' => true]);
  1556.     }
  1558.     /**
  1559.      * @Route("/robots-txt", name="pimcore_admin_settings_robotstxtget", methods={"GET"})
  1560.      *
  1561.      * @return JsonResponse
  1562.      */
  1563.     public function robotsTxtGetAction()
  1564.     {
  1565.         $this->checkPermission('robots.txt');
  1567.         $config = Config::getRobotsConfig();
  1568.         $config = $config->toArray();
  1570.         return $this->adminJson([
  1571.             'success' => true,
  1572.             'data' => $config,
  1573.             'onFileSystem' => file_exists(PIMCORE_WEB_ROOT . '/robots.txt'),
  1574.         ]);
  1575.     }
  1577.     /**
  1578.      * @Route("/robots-txt", name="pimcore_admin_settings_robotstxtput", methods={"PUT"})
  1579.      *
  1580.      * @param Request $request
  1581.      *
  1582.      * @return JsonResponse
  1583.      */
  1584.     public function robotsTxtPutAction(Request $request)
  1585.     {
  1586.         $this->checkPermission('robots.txt');
  1588.         $values = $request->get('data');
  1589.         if (!is_array($values)) {
  1590.             $values = [];
  1591.         }
  1593.         foreach ($values as $siteId => $robotsContent) {
  1594.             SettingsStore::set('robots.txt-' . $siteId, $robotsContent, 'string', 'robots.txt');
  1595.         }
  1597.         return $this->adminJson([
  1598.             'success' => true,
  1599.         ]);
  1600.     }
  1602.     /**
  1603.      * @Route("/website-settings", name="pimcore_admin_settings_websitesettings", methods={"POST"})
  1604.      *
  1605.      * @param Request $request
  1606.      *
  1607.      * @return JsonResponse
  1608.      *
  1609.      * @throws \Exception
  1610.      */
  1611.     public function websiteSettingsAction(Request $request)
  1612.     {
  1613.         $this->checkPermission('website_settings');
  1615.         if ($request->get('data')) {
  1616.             $data = $this->decodeJson($request->get('data'));
  1618.             if (is_array($data)) {
  1619.                 foreach ($data as &$value) {
  1620.                     $value = trim($value);
  1621.                 }
  1622.             }
  1624.             if ($request->get('xaction') == 'destroy') {
  1625.                 $id = $data['id'];
  1626.                 $setting = WebsiteSetting::getById($id);
  1627.                 if ($setting instanceof WebsiteSetting) {
  1628.                     $setting->delete();
  1630.                     return $this->adminJson(['success' => true, 'data' => []]);
  1631.                 }
  1632.             } elseif ($request->get('xaction') == 'update') {
  1633.                 // save routes
  1634.                 $setting = WebsiteSetting::getById($data['id']);
  1635.                 if ($setting instanceof WebsiteSetting) {
  1636.                     switch ($setting->getType()) {
  1637.                         case 'document':
  1638.                         case 'asset':
  1639.                         case 'object':
  1640.                             if (isset($data['data'])) {
  1641.                                 $element = Element\Service::getElementByPath($setting->getType(), $data['data']);
  1642.                                 $data['data'] = $element;
  1643.                             }
  1645.                             break;
  1646.                     }
  1648.                     $setting->setValues($data);
  1649.                     $setting->save();
  1651.                     $data = $this->getWebsiteSettingForEditMode($setting);
  1653.                     return $this->adminJson(['data' => $data, 'success' => true]);
  1654.                 }
  1655.             } elseif ($request->get('xaction') == 'create') {
  1656.                 unset($data['id']);
  1658.                 // save route
  1659.                 $setting = new WebsiteSetting();
  1660.                 $setting->setValues($data);
  1662.                 $setting->save();
  1664.                 return $this->adminJson(['data' => $setting->getObjectVars(), 'success' => true]);
  1665.             }
  1666.         } else {
  1667.             $list = new WebsiteSetting\Listing();
  1669.             $list->setLimit($request->get('limit'));
  1670.             $list->setOffset($request->get('start'));
  1672.             $sortingSettings = \Pimcore\Bundle\AdminBundle\Helper\QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  1673.             if ($sortingSettings['orderKey']) {
  1674.                 $list->setOrderKey($sortingSettings['orderKey']);
  1675.                 $list->setOrder($sortingSettings['order']);
  1676.             } else {
  1677.                 $list->setOrderKey('name');
  1678.                 $list->setOrder('asc');
  1679.             }
  1681.             if ($request->get('filter')) {
  1682.                 $list->setCondition('`name` LIKE ' . $list->quote('%'.$request->get('filter').'%'));
  1683.             }
  1685.             $totalCount = $list->getTotalCount();
  1686.             $list = $list->load();
  1688.             $settings = [];
  1689.             foreach ($list as $item) {
  1690.                 $resultItem = $this->getWebsiteSettingForEditMode($item);
  1691.                 $settings[] = $resultItem;
  1692.             }
  1694.             return $this->adminJson(['data' => $settings, 'success' => true, 'total' => $totalCount]);
  1695.         }
  1697.         return $this->adminJson(['success' => false]);
  1698.     }
  1700.     /**
  1701.      * @param WebsiteSetting $item
  1702.      *
  1703.      * @return array
  1704.      */
  1705.     private function getWebsiteSettingForEditMode($item)
  1706.     {
  1707.         $resultItem = [
  1708.             'id' => $item->getId(),
  1709.             'name' => $item->getName(),
  1710.             'language' => $item->getLanguage(),
  1711.             'type' => $item->getType(),
  1712.             'data' => null,
  1713.             'siteId' => $item->getSiteId(),
  1714.             'creationDate' => $item->getCreationDate(),
  1715.             'modificationDate' => $item->getModificationDate(),
  1716.         ];
  1718.         switch ($item->getType()) {
  1719.             case 'document':
  1720.             case 'asset':
  1721.             case 'object':
  1722.                 $element = $item->getData();
  1723.                 if ($element) {
  1724.                     $resultItem['data'] = $element->getRealFullPath();
  1725.                 }
  1727.                 break;
  1728.             default:
  1729.                 $resultItem['data'] = $item->getData();
  1731.                 break;
  1732.         }
  1734.         return $resultItem;
  1735.     }
  1737.     /**
  1738.      * @Route("/get-available-algorithms", name="pimcore_admin_settings_getavailablealgorithms", methods={"GET"})
  1739.      *
  1740.      * @param Request $request
  1741.      *
  1742.      * @return JsonResponse
  1743.      */
  1744.     public function getAvailableAlgorithmsAction(Request $request)
  1745.     {
  1746.         $options = [
  1747.             [
  1748.                 'key' => 'password_hash',
  1749.                 'value' => 'password_hash',
  1750.             ],
  1751.         ];
  1753.         $algorithms = hash_algos();
  1754.         foreach ($algorithms as $algorithm) {
  1755.             $options[] = [
  1756.                 'key' => $algorithm,
  1757.                 'value' => $algorithm,
  1758.             ];
  1759.         }
  1761.         $result = ['data' => $options, 'success' => true, 'total' => count($options)];
  1763.         return $this->adminJson($result);
  1764.     }
  1766.     /**
  1767.      * deleteViews
  1768.      * delete views for localized fields when languages are removed to
  1769.      * prevent mysql errors
  1770.      *
  1771.      * @param string $language
  1772.      * @param string $dbName
  1773.      */
  1774.     protected function deleteViews($language, $dbName)
  1775.     {
  1776.         $db = \Pimcore\Db::get();
  1777.         $views = $db->fetchAll('SHOW FULL TABLES IN ' . $db->quoteIdentifier($dbName) . " WHERE TABLE_TYPE LIKE 'VIEW'");
  1779.         foreach ($views as $view) {
  1780.             if (preg_match('/^object_localized_[0-9]+_' . $language . '$/', $view['Tables_in_' . $dbName])) {
  1781.                 $sql = 'DROP VIEW ' . $db->quoteIdentifier($view['Tables_in_' . $dbName]);
  1782.                 $db->query($sql);
  1783.             }
  1784.         }
  1785.     }
  1787.     /**
  1788.      * @Route("/test-web2print", name="pimcore_admin_settings_testweb2print", methods={"GET"})
  1789.      *
  1790.      * @param Request $request
  1791.      *
  1792.      * @return Response
  1793.      */
  1794.     public function testWeb2printAction(Request $request)
  1795.     {
  1796.         $this->checkPermission('web2print_settings');
  1798.         $response = $this->render('@PimcoreAdmin/Admin/Settings/testWeb2print.html.twig');
  1799.         $html = $response->getContent();
  1801.         $adapter = \Pimcore\Web2Print\Processor::getInstance();
  1802.         $params = [];
  1804.         if ($adapter instanceof \Pimcore\Web2Print\Processor\WkHtmlToPdf) {
  1805.             $params['adapterConfig'] = '-O landscape';
  1806.         } elseif ($adapter instanceof \Pimcore\Web2Print\Processor\PdfReactor) {
  1807.             $params['adapterConfig'] = [
  1808.                 'javaScriptMode' => 0,
  1809.                 'addLinks' => true,
  1810.                 'appendLog' => true,
  1811.                 'enableDebugMode' => true,
  1812.             ];
  1813.         }
  1815.         $responseOptions = [
  1816.             'Content-Type' => 'application/pdf',
  1817.         ];
  1819.         $pdfData = $adapter->getPdfFromString($html, $params);
  1821.         return new \Symfony\Component\HttpFoundation\Response(
  1822.             $pdfData,
  1823.             200,
  1824.             $responseOptions
  1826.         );
  1827.     }
  1828. }