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.         $storage = Tool\Storage::get('admin');
  113.         $storage->writeStream(self::CUSTOM_LOGO_PATH, fopen($_FILES['Filedata']['tmp_name'], 'rb'));
  115.         // set content-type to text/html, otherwise (when application/json is sent) chrome will complain in
  116.         // Ext.form.Action.Submit and mark the submission as failed
  118.         $response = $this->adminJson(['success' => true]);
  119.         $response->headers->set('Content-Type', 'text/html');
  121.         return $response;
  122.     }
  124.     /**
  125.      * @Route("/delete-custom-logo", name="pimcore_admin_settings_deletecustomlogo", methods={"DELETE"})
  126.      *
  127.      * @param Request $request
  128.      *
  129.      * @return JsonResponse
  130.      */
  131.     public function deleteCustomLogoAction(Request $request)
  132.     {
  133.         if (Tool\Storage::get('admin')->fileExists(self::CUSTOM_LOGO_PATH)) {
  134.             Tool\Storage::get('admin')->delete(self::CUSTOM_LOGO_PATH);
  135.         }
  137.         return $this->adminJson(['success' => true]);
  138.     }
  140.     /**
  141.      * Used by the predefined metadata grid
  142.      *
  143.      * @Route("/predefined-metadata", name="pimcore_admin_settings_metadata", methods={"POST"})
  144.      *
  145.      * @param Request $request
  146.      *
  147.      * @return JsonResponse
  148.      */
  149.     public function metadataAction(Request $request)
  150.     {
  151.         $this->checkPermission('asset_metadata');
  153.         if ($request->get('data')) {
  154.             if ($request->get('xaction') == 'destroy') {
  155.                 $data = $this->decodeJson($request->get('data'));
  156.                 $id = $data['id'];
  157.                 $metadata = Metadata\Predefined::getById($id);
  158.                 if (!$metadata->isWriteable()) {
  159.                     throw new ConfigWriteException();
  160.                 }
  161.                 $metadata->delete();
  163.                 return $this->adminJson(['success' => true, 'data' => []]);
  164.             } elseif ($request->get('xaction') == 'update') {
  165.                 $data = $this->decodeJson($request->get('data'));
  167.                 // save type
  168.                 $metadata = Metadata\Predefined::getById($data['id']);
  169.                 if (!$metadata->isWriteable()) {
  170.                     throw new ConfigWriteException();
  171.                 }
  172.                 $metadata->setValues($data);
  174.                 $existingItem = Metadata\Predefined\Listing::getByKeyAndLanguage($metadata->getName(), $metadata->getLanguage(), $metadata->getTargetSubtype());
  175.                 if ($existingItem && $existingItem->getId() != $metadata->getId()) {
  176.                     return $this->adminJson(['message' => 'rule_violation', 'success' => false]);
  177.                 }
  179.                 $metadata->minimize();
  180.                 $metadata->save();
  181.                 $metadata->expand();
  183.                 $responseData = $metadata->getObjectVars();
  184.                 $responseData['writeable'] = $metadata->isWriteable();
  186.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  187.             } elseif ($request->get('xaction') == 'create') {
  188.                 if (!(new Metadata\Predefined())->isWriteable()) {
  189.                     throw new ConfigWriteException();
  190.                 }
  191.                 $data = $this->decodeJson($request->get('data'));
  192.                 unset($data['id']);
  194.                 // save type
  195.                 $metadata = Metadata\Predefined::create();
  197.                 $metadata->setValues($data);
  199.                 $existingItem = Metadata\Predefined\Listing::getByKeyAndLanguage($metadata->getName(), $metadata->getLanguage(), $metadata->getTargetSubtype());
  200.                 if ($existingItem) {
  201.                     return $this->adminJson(['message' => 'rule_violation', 'success' => false]);
  202.                 }
  204.                 $metadata->save();
  206.                 $responseData = $metadata->getObjectVars();
  207.                 $responseData['writeable'] = $metadata->isWriteable();
  209.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  210.             }
  211.         } else {
  212.             // get list of types
  214.             $list = new Metadata\Predefined\Listing();
  216.             if ($request->get('filter')) {
  217.                 $filter = $request->get('filter');
  218.                 $list->setFilter(function ($row) use ($filter) {
  219.                     foreach ($row as $value) {
  220.                         if (strpos($value, $filter) !== false) {
  221.                             return true;
  222.                         }
  223.                     }
  225.                     return false;
  226.                 });
  227.             }
  229.             $list->load();
  231.             $properties = [];
  232.             if (is_array($list->getDefinitions())) {
  233.                 foreach ($list->getDefinitions() as $metadata) {
  234.                     $data = $metadata->getObjectVars();
  235.                     $data['writeable'] = $metadata->isWriteable();
  236.                     $properties[] = $data;
  237.                 }
  238.             }
  240.             return $this->adminJson(['data' => $properties, 'success' => true, 'total' => $list->getTotalCount()]);
  241.         }
  243.         return $this->adminJson(['success' => false]);
  244.     }
  246.     /**
  247.      * @Route("/get-predefined-metadata", name="pimcore_admin_settings_getpredefinedmetadata", methods={"GET"})
  248.      *
  249.      * @param Request $request
  250.      *
  251.      * @return JsonResponse
  252.      */
  253.     public function getPredefinedMetadataAction(Request $request)
  254.     {
  255.         $type = $request->get('type');
  256.         $subType = $request->get('subType');
  257.         $group = $request->get('group');
  258.         $list = Metadata\Predefined\Listing::getByTargetType($type, [$subType]);
  259.         $result = [];
  260.         foreach ($list as $item) {
  261.             $itemGroup = $item->getGroup() ?? '';
  262.             if ($group === 'default' || $group === $itemGroup) {
  263.                 $item->expand();
  264.                 $data = $item->getObjectVars();
  265.                 $data['writeable'] = $item->isWriteable();
  266.                 $result[] = $data;
  267.             }
  268.         }
  270.         return $this->adminJson(['data' => $result, 'success' => true]);
  271.     }
  273.     /**
  274.      * @Route("/properties", name="pimcore_admin_settings_properties", methods={"POST"})
  275.      *
  276.      * @param Request $request
  277.      *
  278.      * @return JsonResponse
  279.      */
  280.     public function propertiesAction(Request $request)
  281.     {
  282.         if ($request->get('data')) {
  283.             $this->checkPermission('predefined_properties');
  285.             if ($request->get('xaction') == 'destroy') {
  286.                 $data = $this->decodeJson($request->get('data'));
  287.                 $id = $data['id'];
  288.                 $property = Property\Predefined::getById($id);
  289.                 if (!$property->isWriteable()) {
  290.                     throw new ConfigWriteException();
  291.                 }
  292.                 $property->delete();
  294.                 return $this->adminJson(['success' => true, 'data' => []]);
  295.             } elseif ($request->get('xaction') == 'update') {
  296.                 $data = $this->decodeJson($request->get('data'));
  298.                 // save type
  299.                 $property = Property\Predefined::getById($data['id']);
  300.                 if (!$property->isWriteable()) {
  301.                     throw new ConfigWriteException();
  302.                 }
  303.                 if (is_array($data['ctype'])) {
  304.                     $data['ctype'] = implode(',', $data['ctype']);
  305.                 }
  306.                 $property->setValues($data);
  308.                 $property->save();
  310.                 $responseData = $property->getObjectVars();
  311.                 $responseData['writeable'] = $property->isWriteable();
  313.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  314.             } elseif ($request->get('xaction') == 'create') {
  315.                 if (!(new Property\Predefined())->isWriteable()) {
  316.                     throw new ConfigWriteException();
  317.                 }
  318.                 $data = $this->decodeJson($request->get('data'));
  319.                 unset($data['id']);
  321.                 // save type
  322.                 $property = Property\Predefined::create();
  323.                 $property->setValues($data);
  325.                 $property->save();
  327.                 $responseData = $property->getObjectVars();
  328.                 $responseData['writeable'] = $property->isWriteable();
  330.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  331.             }
  332.         } else {
  333.             // get list of types
  334.             $list = new Property\Predefined\Listing();
  336.             if ($request->get('filter')) {
  337.                 $filter = $request->get('filter');
  338.                 $list->setFilter(function ($row) use ($filter) {
  339.                     foreach ($row as $value) {
  340.                         if ($value) {
  341.                             $cellValues = is_array($value) ? $value : [$value];
  343.                             foreach ($cellValues as $cellValue) {
  344.                                 if (strpos($cellValue, $filter) !== false) {
  345.                                     return true;
  346.                                 }
  347.                             }
  348.                         }
  349.                     }
  351.                     return false;
  352.                 });
  353.             }
  355.             $list->load();
  357.             $properties = [];
  358.             if (is_array($list->getProperties())) {
  359.                 foreach ($list->getProperties() as $property) {
  360.                     $data = $property->getObjectVars();
  361.                     $data['writeable'] = $property->isWriteable();
  362.                     $properties[] = $data;
  363.                 }
  364.             }
  366.             return $this->adminJson(['data' => $properties, 'success' => true, 'total' => $list->getTotalCount()]);
  367.         }
  369.         return $this->adminJson(['success' => false]);
  370.     }
  372.     /**
  373.      * @Route("/get-system", name="pimcore_admin_settings_getsystem", methods={"GET"})
  374.      *
  375.      * @param Request $request
  376.      * @param Config $config
  377.      *
  378.      * @return JsonResponse
  379.      */
  380.     public function getSystemAction(Request $request, Config $config)
  381.     {
  382.         $this->checkPermission('system_settings');
  384.         $valueArray = [
  385.             'general' => $config['general'],
  386.             'documents' => $config['documents'],
  387.             'assets' => $config['assets'],
  388.             'objects' => $config['objects'],
  389.             'branding' => $config['branding'],
  390.             'email' => $config['email'],
  391.         ];
  393.         $locales = Tool::getSupportedLocales();
  394.         $languageOptions = [];
  395.         $validLanguages = [];
  396.         foreach ($locales as $short => $translation) {
  397.             if (!empty($short)) {
  398.                 $languageOptions[] = [
  399.                     'language' => $short,
  400.                     'display' => $translation . " ($short)",
  401.                 ];
  402.                 $validLanguages[] = $short;
  403.             }
  404.         }
  406.         $valueArray['general']['valid_language'] = explode(',', $valueArray['general']['valid_languages']);
  408.         //for "wrong" legacy values
  409.         if (is_array($valueArray['general']['valid_language'])) {
  410.             foreach ($valueArray['general']['valid_language'] as $existingValue) {
  411.                 if (!in_array($existingValue, $validLanguages)) {
  412.                     $languageOptions[] = [
  413.                         'language' => $existingValue,
  414.                         'display' => $existingValue,
  415.                     ];
  416.                 }
  417.             }
  418.         }
  420.         $response = [
  421.             'values' => $valueArray,
  422.             'config' => [
  423.                 'languages' => $languageOptions,
  424.             ],
  425.         ];
  427.         return $this->adminJson($response);
  428.     }
  430.     /**
  431.      * @Route("/set-system", name="pimcore_admin_settings_setsystem", methods={"PUT"})
  432.      *
  433.      * @param Request $request
  434.      * @param LocaleServiceInterface $localeService
  435.      *
  436.      * @return JsonResponse
  437.      */
  438.     public function setSystemAction(
  439.         LocaleServiceInterface $localeService,
  440.         Request $request,
  441.         KernelInterface $kernel,
  442.         EventDispatcherInterface $eventDispatcher,
  443.         CoreCacheHandler $cache,
  444.         Filesystem $filesystem,
  445.         CacheClearer $symfonyCacheClearer
  446.     ) {
  447.         $this->checkPermission('system_settings');
  449.         $values = $this->decodeJson($request->get('data'));
  451.         $existingValues = [];
  453.         try {
  454.             $file = Config::locateConfigFile('system.yml');
  455.             $existingValues = Config::getConfigInstance($file, true);
  456.         } catch (\Exception $e) {
  457.             // nothing to do
  458.         }
  460.         // localized error pages
  461.         $localizedErrorPages = [];
  463.         // fallback languages
  464.         $fallbackLanguages = [];
  465.         $existingValues['pimcore']['general']['fallback_languages'] = [];
  466.         $languages = explode(',', $values['general.validLanguages']);
  467.         $filteredLanguages = [];
  469.         foreach ($languages as $language) {
  470.             if (isset($values['general.fallbackLanguages.' . $language])) {
  471.                 $fallbackLanguages[$language] = str_replace(' ', '', $values['general.fallbackLanguages.' . $language]);
  472.             }
  474.             // localized error pages
  475.             if (isset($values['documents.error_pages.localized.' . $language])) {
  476.                 $localizedErrorPages[$language] = $values['documents.error_pages.localized.' . $language];
  477.             }
  479.             if ($localeService->isLocale($language)) {
  480.                 $filteredLanguages[] = $language;
  481.             }
  482.         }
  484.         // check if there's a fallback language endless loop
  485.         foreach ($fallbackLanguages as $sourceLang => $targetLang) {
  486.             $this->checkFallbackLanguageLoop($sourceLang, $fallbackLanguages);
  487.         }
  489.         $settings['pimcore'] = [
  490.             'general' => [
  491.                 'domain' => $values['general.domain'],
  492.                 'redirect_to_maindomain' => $values['general.redirect_to_maindomain'],
  493.                 'language' => $values['general.language'],
  494.                 'valid_languages' => implode(',', $filteredLanguages),
  495.                 'fallback_languages' => $fallbackLanguages,
  496.                 'default_language' => $values['general.defaultLanguage'],
  497.                 'debug_admin_translations' => $values['general.debug_admin_translations'],
  498.             ],
  499.             'documents' => [
  500.                 'versions' => [
  501.                     'days' => $values['documents.versions.days'] ?? null,
  502.                     'steps' => $values['documents.versions.steps'] ?? null,
  503.                 ],
  504.                 'error_pages' => [
  505.                     'default' => $values['documents.error_pages.default'],
  506.                     'localized' => $localizedErrorPages,
  507.                 ],
  508.             ],
  509.             'objects' => [
  510.                 'versions' => [
  511.                     'days' => $values['objects.versions.days'] ?? null,
  512.                     'steps' => $values['objects.versions.steps'] ?? null,
  513.                 ],
  514.             ],
  515.             'assets' => [
  516.                 'versions' => [
  517.                     'days' => $values['assets.versions.days'] ?? null,
  518.                     'steps' => $values['assets.versions.steps'] ?? null,
  519.                 ],
  520.                 'hide_edit_image' => $values['assets.hide_edit_image'],
  521.                 'disable_tree_preview' => $values['assets.disable_tree_preview'],
  522.             ],
  523.         ];
  525.         //branding
  526.         $settings['pimcore_admin'] = [
  527.             'branding' =>
  528.                 [
  529.                     'login_screen_invert_colors' => $values['branding.login_screen_invert_colors'],
  530.                     'color_login_screen' => $values['branding.color_login_screen'],
  531.                     'color_admin_interface' => $values['branding.color_admin_interface'],
  532.                     'login_screen_custom_image' => $values['branding.login_screen_custom_image'],
  533.                 ],
  534.         ];
  536.         if (array_key_exists('email.debug.emailAddresses', $values) && $values['email.debug.emailAddresses']) {
  537.             $settings['pimcore']['email']['debug']['email_addresses'] = $values['email.debug.emailAddresses'];
  538.         }
  540.         $settingsYml = Yaml::dump($settings, 5);
  541.         $configFile = Config::locateConfigFile('system.yml');
  542.         File::put($configFile, $settingsYml);
  544.         // clear all caches
  545.         $this->clearSymfonyCache($request, $kernel, $eventDispatcher, $symfonyCacheClearer);
  546.         $this->stopMessengerWorkers();
  548.         $eventDispatcher->addListener(KernelEvents::TERMINATE, function (TerminateEvent $event) use (
  549.             $cache, $eventDispatcher, $filesystem
  550.         ) {
  551.             // we need to clear the cache with a delay, because the cache is used by messenger:stop-workers
  552.             // to send the stop signal to all worker processes
  553.             sleep(2);
  554.             $this->clearPimcoreCache($cache, $eventDispatcher, $filesystem);
  555.         });
  557.         return $this->adminJson(['success' => true]);
  558.     }
  560.     /**
  561.      * @param string $source
  562.      * @param array $definitions
  563.      * @param array $fallbacks
  564.      *
  565.      * @throws \Exception
  566.      */
  567.     protected function checkFallbackLanguageLoop($source, $definitions, $fallbacks = [])
  568.     {
  569.         if (isset($definitions[$source])) {
  570.             $targets = explode(',', $definitions[$source]);
  571.             foreach ($targets as $l) {
  572.                 $target = trim($l);
  573.                 if ($target) {
  574.                     if (in_array($target, $fallbacks)) {
  575.                         throw new \Exception("Language `$source` | `$target` causes an infinte loop.");
  576.                     }
  577.                     $fallbacks[] = $target;
  579.                     $this->checkFallbackLanguageLoop($target, $definitions, $fallbacks);
  580.                 }
  581.             }
  582.         } else {
  583.             throw new \Exception("Language `$source` doesn't exist");
  584.         }
  585.     }
  587.     /**
  588.      * @Route("/get-web2print", name="pimcore_admin_settings_getweb2print", methods={"GET"})
  589.      *
  590.      * @param Request $request
  591.      *
  592.      * @return JsonResponse
  593.      */
  594.     public function getWeb2printAction(Request $request)
  595.     {
  596.         $this->checkPermission('web2print_settings');
  598.         $values = Config::getWeb2PrintConfig();
  599.         $valueArray = $values->toArray();
  601.         $optionsString = [];
  602.         if ($valueArray['wkhtml2pdfOptions'] ?? false) {
  603.             foreach ($valueArray['wkhtml2pdfOptions'] as $key => $value) {
  604.                 $tmpStr = '--'.$key;
  605.                 if ($value !== null && $value !== '') {
  606.                     $tmpStr .= ' '.$value;
  607.                 }
  608.                 $optionsString[] = $tmpStr;
  609.             }
  610.         }
  611.         $valueArray['wkhtml2pdfOptions'] = implode("\n", $optionsString);
  613.         $response = [
  614.             'values' => $valueArray,
  615.         ];
  617.         return $this->adminJson($response);
  618.     }
  620.     /**
  621.      * @Route("/set-web2print", name="pimcore_admin_settings_setweb2print", methods={"PUT"})
  622.      *
  623.      * @param Request $request
  624.      *
  625.      * @return JsonResponse
  626.      */
  627.     public function setWeb2printAction(Request $request)
  628.     {
  629.         $this->checkPermission('web2print_settings');
  631.         $values = $this->decodeJson($request->get('data'));
  633.         unset($values['documentation']);
  634.         unset($values['additions']);
  635.         unset($values['json_converter']);
  637.         if ($values['wkhtml2pdfOptions']) {
  638.             $optionArray = [];
  639.             $lines = explode("\n", $values['wkhtml2pdfOptions']);
  640.             foreach ($lines as $line) {
  641.                 $parts = explode(' ', substr($line, 2));
  642.                 $key = trim($parts[0]);
  643.                 if ($key) {
  644.                     $value = trim($parts[1] ?? '');
  645.                     $optionArray[$key] = $value;
  646.                 }
  647.             }
  648.             $values['wkhtml2pdfOptions'] = $optionArray;
  649.         }
  651.         \Pimcore\Web2Print\Config::save($values);
  653.         return $this->adminJson(['success' => true]);
  654.     }
  656.     /**
  657.      * @Route("/clear-cache", name="pimcore_admin_settings_clearcache", methods={"DELETE"})
  658.      *
  659.      * @param Request $request
  660.      * @param KernelInterface $kernel
  661.      * @param EventDispatcherInterface $eventDispatcher
  662.      * @param CoreCacheHandler $cache
  663.      * @param Filesystem $filesystem
  664.      * @param CacheClearer $symfonyCacheClearer
  665.      *
  666.      * @return JsonResponse
  667.      */
  668.     public function clearCacheAction(
  669.         Request $request,
  670.         KernelInterface $kernel,
  671.         EventDispatcherInterface $eventDispatcher,
  672.         CoreCacheHandler $cache,
  673.         Filesystem $filesystem,
  674.         CacheClearer $symfonyCacheClearer
  675.     ) {
  676.         $this->checkPermissionsHasOneOf(['clear_cache', 'system_settings']);
  678.         $result = [
  679.             'success' => true,
  680.         ];
  682.         $clearPimcoreCache = !(bool)$request->get('only_symfony_cache');
  683.         $clearSymfonyCache = !(bool)$request->get('only_pimcore_cache');
  685.         if ($clearPimcoreCache) {
  686.             $this->clearPimcoreCache($cache, $eventDispatcher, $filesystem);
  687.         }
  689.         if ($clearSymfonyCache) {
  690.             $this->clearSymfonyCache($request, $kernel, $eventDispatcher, $symfonyCacheClearer);
  691.         }
  693.         $response = new JsonResponse($result);
  695.         if ($clearSymfonyCache) {
  696.             // we send the response directly here and exit to make sure no code depending on the stale container
  697.             // is running after this
  698.             $response->sendHeaders();
  699.             $response->sendContent();
  700.             exit;
  701.         }
  703.         return $response;
  704.     }
  706.     private function clearPimcoreCache(
  707.         CoreCacheHandler $cache,
  708.         EventDispatcherInterface $eventDispatcher,
  709.         Filesystem $filesystem,
  710.     ): void {
  711.         // empty document cache
  712.         $cache->clearAll();
  714.         if ($filesystem->exists(PIMCORE_CACHE_DIRECTORY)) {
  715.             $filesystem->remove(PIMCORE_CACHE_DIRECTORY);
  716.         }
  718.         // PIMCORE-1854 - recreate .dummy file => should remain
  719.         File::put(PIMCORE_CACHE_DIRECTORY . '/.gitkeep', '');
  721.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR);
  722.     }
  724.     private function clearSymfonyCache(
  725.         Request $request,
  726.         KernelInterface $kernel,
  727.         EventDispatcherInterface $eventDispatcher,
  728.         CacheClearer $symfonyCacheClearer,
  729.     ): void {
  730.         // pass one or move env parameters to clear multiple envs
  731.         // if no env is passed it will use the current one
  732.         $environments = $request->get('env', $kernel->getEnvironment());
  734.         if (!is_array($environments)) {
  735.             $environments = trim((string)$environments);
  737.             if (empty($environments)) {
  738.                 $environments = [];
  739.             } else {
  740.                 $environments = [$environments];
  741.             }
  742.         }
  744.         if (empty($environments)) {
  745.             $environments = [$kernel->getEnvironment()];
  746.         }
  748.         $result['environments'] = $environments;
  750.         if (in_array($kernel->getEnvironment(), $environments)) {
  751.             // remove terminate and exception event listeners for the current env as they break with a
  752.             // cleared container - see #2434
  753.             foreach ($eventDispatcher->getListeners(KernelEvents::TERMINATE) as $listener) {
  754.                 $eventDispatcher->removeListener(KernelEvents::TERMINATE, $listener);
  755.             }
  757.             foreach ($eventDispatcher->getListeners(KernelEvents::EXCEPTION) as $listener) {
  758.                 $eventDispatcher->removeListener(KernelEvents::EXCEPTION, $listener);
  759.             }
  760.         }
  762.         foreach ($environments as $environment) {
  763.             try {
  764.                 $symfonyCacheClearer->clear($environment);
  765.             } catch (\Throwable $e) {
  766.                 $errors = $result['errors'] ?? [];
  767.                 $errors[] = $e->getMessage();
  769.                 $result = array_merge($result, [
  770.                     'success' => false,
  771.                     'errors' => $errors,
  772.                 ]);
  773.             }
  774.         }
  775.     }
  777.     /**
  778.      * @Route("/clear-output-cache", name="pimcore_admin_settings_clearoutputcache", methods={"DELETE"})
  779.      *
  780.      * @param EventDispatcherInterface $eventDispatcher
  781.      *
  782.      * @return JsonResponse
  783.      */
  784.     public function clearOutputCacheAction(EventDispatcherInterface $eventDispatcher)
  785.     {
  786.         $this->checkPermission('clear_fullpage_cache');
  788.         // remove "output" out of the ignored tags, if a cache lifetime is specified
  789.         Cache::removeIgnoredTagOnClear('output');
  791.         // empty document cache
  792.         Cache::clearTags(['output', 'output_lifetime']);
  794.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR_FULLPAGE_CACHE);
  796.         return $this->adminJson(['success' => true]);
  797.     }
  799.     /**
  800.      * @Route("/clear-temporary-files", name="pimcore_admin_settings_cleartemporaryfiles", methods={"DELETE"})
  801.      *
  802.      * @param EventDispatcherInterface $eventDispatcher
  803.      *
  804.      * @return JsonResponse
  805.      */
  806.     public function clearTemporaryFilesAction(EventDispatcherInterface $eventDispatcher)
  807.     {
  808.         $this->checkPermission('clear_temp_files');
  810.         // public files
  811.         Tool\Storage::get('thumbnail')->deleteDirectory('/');
  812.         Tool\Storage::get('asset_cache')->deleteDirectory('/');
  814.         // system files
  815.         recursiveDelete(PIMCORE_SYSTEM_TEMP_DIRECTORY, false);
  817.         $eventDispatcher->dispatch(new GenericEvent(), SystemEvents::CACHE_CLEAR_TEMPORARY_FILES);
  819.         return $this->adminJson(['success' => true]);
  820.     }
  822.     /**
  823.      * @Route("/staticroutes", name="pimcore_admin_settings_staticroutes", methods={"POST"})
  824.      *
  825.      * @param Request $request
  826.      *
  827.      * @return JsonResponse
  828.      */
  829.     public function staticroutesAction(Request $request)
  830.     {
  831.         if ($request->get('data')) {
  832.             $this->checkPermission('routes');
  834.             $data = $this->decodeJson($request->get('data'));
  836.             if (is_array($data)) {
  837.                 foreach ($data as &$value) {
  838.                     if (is_string($value)) {
  839.                         $value = trim($value);
  840.                     }
  841.                 }
  842.             }
  844.             if ($request->get('xaction') == 'destroy') {
  845.                 $data = $this->decodeJson($request->get('data'));
  846.                 $id = $data['id'];
  847.                 $route = Staticroute::getById($id);
  848.                 if (!$route->isWriteable()) {
  849.                     throw new ConfigWriteException();
  850.                 }
  851.                 $route->delete();
  853.                 return $this->adminJson(['success' => true, 'data' => []]);
  854.             } elseif ($request->get('xaction') == 'update') {
  855.                 // save routes
  856.                 $route = Staticroute::getById($data['id']);
  857.                 if (!$route->isWriteable()) {
  858.                     throw new ConfigWriteException();
  859.                 }
  861.                 $route->setValues($data);
  863.                 $route->save();
  865.                 return $this->adminJson(['data' => $route->getObjectVars(), 'success' => true]);
  866.             } elseif ($request->get('xaction') == 'create') {
  867.                 if (!(new Staticroute())->isWriteable()) {
  868.                     throw new ConfigWriteException();
  869.                 }
  870.                 unset($data['id']);
  872.                 // save route
  873.                 $route = new Staticroute();
  874.                 $route->setValues($data);
  876.                 $route->save();
  878.                 $responseData = $route->getObjectVars();
  879.                 $responseData['writeable'] = $route->isWriteable();
  881.                 return $this->adminJson(['data' => $responseData, 'success' => true]);
  882.             }
  883.         } else {
  884.             // get list of routes
  886.             $list = new Staticroute\Listing();
  888.             if ($request->get('filter')) {
  889.                 $filter = $request->get('filter');
  890.                 $list->setFilter(function ($staticRoute) use ($filter) {
  891.                     $vars = $staticRoute->getObjectVars();
  892.                     foreach ($vars as $value) {
  893.                         if (! is_scalar($value)) {
  894.                             continue;
  895.                         }
  896.                         if (strpos((string)$value, $filter) !== false) {
  897.                             return true;
  898.                         }
  899.                     }
  901.                     return false;
  902.                 });
  903.             }
  905.             $list->load();
  907.             $routes = [];
  908.             /** @var Staticroute $routeFromList */
  909.             foreach ($list->getRoutes() as $routeFromList) {
  910.                 $route = $routeFromList->getObjectVars();
  911.                 $route['writeable'] = $routeFromList->isWriteable();
  912.                 if (is_array($routeFromList->getSiteId())) {
  913.                     $route['siteId'] = implode(',', $routeFromList->getSiteId());
  914.                 }
  915.                 $routes[] = $route;
  916.             }
  918.             return $this->adminJson(['data' => $routes, 'success' => true, 'total' => $list->getTotalCount()]);
  919.         }
  921.         return $this->adminJson(['success' => false]);
  922.     }
  924.     /**
  925.      * @Route("/get-available-admin-languages", name="pimcore_admin_settings_getavailableadminlanguages", methods={"GET"})
  926.      *
  927.      * @param Request $request
  928.      *
  929.      * @return JsonResponse
  930.      */
  931.     public function getAvailableAdminLanguagesAction(Request $request)
  932.     {
  933.         $langs = [];
  934.         $availableLanguages = Tool\Admin::getLanguages();
  935.         $locales = Tool::getSupportedLocales();
  937.         foreach ($availableLanguages as $lang) {
  938.             if (array_key_exists($lang, $locales)) {
  939.                 $langs[] = [
  940.                     'language' => $lang,
  941.                     'display' => $locales[$lang],
  942.                 ];
  943.             }
  944.         }
  946.         usort($langs, function ($a, $b) {
  947.             return strcmp($a['display'], $b['display']);
  948.         });
  950.         return $this->adminJson($langs);
  951.     }
  953.     /**
  954.      * @Route("/glossary", name="pimcore_admin_settings_glossary", methods={"POST"})
  955.      *
  956.      * @param Request $request
  957.      *
  958.      * @return JsonResponse
  959.      */
  960.     public function glossaryAction(Request $request)
  961.     {
  962.         if ($request->get('data')) {
  963.             $this->checkPermission('glossary');
  965.             Cache::clearTag('glossary');
  967.             if ($request->get('xaction') == 'destroy') {
  968.                 $data = $this->decodeJson($request->get('data'));
  969.                 $id = $data['id'];
  970.                 $glossary = Glossary::getById($id);
  971.                 $glossary->delete();
  973.                 return $this->adminJson(['success' => true, 'data' => []]);
  974.             } elseif ($request->get('xaction') == 'update') {
  975.                 $data = $this->decodeJson($request->get('data'));
  977.                 // save glossary
  978.                 $glossary = Glossary::getById($data['id']);
  980.                 if (!empty($data['link'])) {
  981.                     if ($doc = Document::getByPath($data['link'])) {
  982.                         $data['link'] = $doc->getId();
  983.                     }
  984.                 }
  986.                 $glossary->setValues($data);
  988.                 $glossary->save();
  990.                 if ($link = $glossary->getLink()) {
  991.                     if ((int)$link > 0) {
  992.                         if ($doc = Document::getById((int)$link)) {
  993.                             $glossary->setLink($doc->getRealFullPath());
  994.                         }
  995.                     }
  996.                 }
  998.                 return $this->adminJson(['data' => $glossary, 'success' => true]);
  999.             } elseif ($request->get('xaction') == 'create') {
  1000.                 $data = $this->decodeJson($request->get('data'));
  1001.                 unset($data['id']);
  1003.                 // save glossary
  1004.                 $glossary = new Glossary();
  1006.                 if (!empty($data['link'])) {
  1007.                     if ($doc = Document::getByPath($data['link'])) {
  1008.                         $data['link'] = $doc->getId();
  1009.                     }
  1010.                 }
  1012.                 $glossary->setValues($data);
  1014.                 $glossary->save();
  1016.                 if ($link = $glossary->getLink()) {
  1017.                     if ((int)$link > 0) {
  1018.                         if ($doc = Document::getById((int)$link)) {
  1019.                             $glossary->setLink($doc->getRealFullPath());
  1020.                         }
  1021.                     }
  1022.                 }
  1024.                 return $this->adminJson(['data' => $glossary->getObjectVars(), 'success' => true]);
  1025.             }
  1026.         } else {
  1027.             // get list of glossaries
  1029.             $list = new Glossary\Listing();
  1030.             $list->setLimit($request->get('limit'));
  1031.             $list->setOffset($request->get('start'));
  1033.             $sortingSettings = \Pimcore\Bundle\AdminBundle\Helper\QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  1034.             if ($sortingSettings['orderKey']) {
  1035.                 $list->setOrderKey($sortingSettings['orderKey']);
  1036.                 $list->setOrder($sortingSettings['order']);
  1037.             }
  1039.             if ($request->get('filter')) {
  1040.                 $list->setCondition('`text` LIKE ' . $list->quote('%'.$request->get('filter').'%'));
  1041.             }
  1043.             $list->load();
  1045.             $glossaries = [];
  1046.             foreach ($list->getGlossary() as $glossary) {
  1047.                 if ($link = $glossary->getLink()) {
  1048.                     if ((int)$link > 0) {
  1049.                         if ($doc = Document::getById((int)$link)) {
  1050.                             $glossary->setLink($doc->getRealFullPath());
  1051.                         }
  1052.                     }
  1053.                 }
  1055.                 $glossaries[] = $glossary->getObjectVars();
  1056.             }
  1058.             return $this->adminJson(['data' => $glossaries, 'success' => true, 'total' => $list->getTotalCount()]);
  1059.         }
  1061.         return $this->adminJson(['success' => false]);
  1062.     }
  1064.     /**
  1065.      * @Route("/get-available-sites", name="pimcore_admin_settings_getavailablesites", methods={"GET"})
  1066.      *
  1067.      * @param Request $request
  1068.      *
  1069.      * @return JsonResponse
  1070.      */
  1071.     public function getAvailableSitesAction(Request $request)
  1072.     {
  1073.         $excludeMainSite = $request->get('excludeMainSite');
  1075.         $sitesList = new Model\Site\Listing();
  1076.         $sitesObjects = $sitesList->load();
  1077.         $sites = [];
  1078.         if (!$excludeMainSite) {
  1079.             $sites[] = [
  1080.                 'id' => 'default',
  1081.                 'rootId' => 1,
  1082.                 'domains' => '',
  1083.                 'rootPath' => '/',
  1084.                 'domain' => $this->trans('main_site'),
  1085.             ];
  1086.         }
  1088.         foreach ($sitesObjects as $site) {
  1089.             if ($site->getRootDocument()) {
  1090.                 if ($site->getMainDomain()) {
  1091.                     $sites[] = [
  1092.                         'id' => $site->getId(),
  1093.                         'rootId' => $site->getRootId(),
  1094.                         'domains' => implode(',', $site->getDomains()),
  1095.                         'rootPath' => $site->getRootPath(),
  1096.                         'domain' => $site->getMainDomain(),
  1097.                     ];
  1098.                 }
  1099.             } else {
  1100.                 // site is useless, parent doesn't exist anymore
  1101.                 $site->delete();
  1102.             }
  1103.         }
  1105.         return $this->adminJson($sites);
  1106.     }
  1108.     /**
  1109.      * @Route("/get-available-countries", name="pimcore_admin_settings_getavailablecountries", methods={"GET"})
  1110.      *
  1111.      * @param LocaleServiceInterface $localeService
  1112.      *
  1113.      * @return JsonResponse
  1114.      */
  1115.     public function getAvailableCountriesAction(LocaleServiceInterface $localeService)
  1116.     {
  1117.         $countries = $localeService->getDisplayRegions();
  1118.         asort($countries);
  1120.         $options = [];
  1122.         foreach ($countries as $short => $translation) {
  1123.             if (strlen($short) == 2) {
  1124.                 $options[] = [
  1125.                     'key' => $translation . ' (' . $short . ')',
  1126.                     'value' => $short,
  1127.                 ];
  1128.             }
  1129.         }
  1131.         $result = ['data' => $options, 'success' => true, 'total' => count($options)];
  1133.         return $this->adminJson($result);
  1134.     }
  1136.     /**
  1137.      * @Route("/thumbnail-adapter-check", name="pimcore_admin_settings_thumbnailadaptercheck", methods={"GET"})
  1138.      *
  1139.      * @param Request $request
  1140.      *
  1141.      * @return Response
  1142.      */
  1143.     public function thumbnailAdapterCheckAction(Request $request)
  1144.     {
  1145.         $content = '';
  1147.         $instance = \Pimcore\Image::getInstance();
  1148.         if ($instance instanceof \Pimcore\Image\Adapter\GD) {
  1149.             $content = '<span style="color: red; font-weight: bold;padding: 10px;margin:0 0 20px 0;border:1px solid red;display:block;">' .
  1150.                 $this->trans('important_use_imagick_pecl_extensions_for_best_results_gd_is_just_a_fallback_with_less_quality') .
  1151.                 '</span>';
  1152.         }
  1154.         return new Response($content);
  1155.     }
  1157.     /**
  1158.      * @Route("/thumbnail-tree", name="pimcore_admin_settings_thumbnailtree", methods={"GET", "POST"})
  1159.      *
  1160.      * @param Request $request
  1161.      *
  1162.      * @return JsonResponse
  1163.      */
  1164.     public function thumbnailTreeAction(Request $request)
  1165.     {
  1166.         $this->checkPermission('thumbnails');
  1168.         $thumbnails = [];
  1170.         $list = new Asset\Image\Thumbnail\Config\Listing();
  1171.         $items = $list->getThumbnails();
  1173.         $groups = [];
  1174.         /** @var Asset\Image\Thumbnail\Config $item */
  1175.         foreach ($items as $item) {
  1176.             if ($item->getGroup()) {
  1177.                 if (empty($groups[$item->getGroup()])) {
  1178.                     $groups[$item->getGroup()] = [
  1179.                         'id' => 'group_' . $item->getName(),
  1180.                         'text' => $item->getGroup(),
  1181.                         'expandable' => true,
  1182.                         'leaf' => false,
  1183.                         'allowChildren' => true,
  1184.                         'iconCls' => 'pimcore_icon_folder',
  1185.                         'group' => $item->getGroup(),
  1186.                         'children' => [],
  1187.                     ];
  1188.                 }
  1189.                 $groups[$item->getGroup()]['children'][] =
  1190.                     [
  1191.                         'id' => $item->getName(),
  1192.                         'text' => $item->getName(),
  1193.                         'leaf' => true,
  1194.                         'iconCls' => 'pimcore_icon_thumbnails',
  1195.                         'cls' => 'pimcore_treenode_disabled',
  1196.                         'writeable' => $item->isWriteable(),
  1197.                     ];
  1198.             } else {
  1199.                 $thumbnails[] = [
  1200.                     'id' => $item->getName(),
  1201.                     'text' => $item->getName(),
  1202.                     'leaf' => true,
  1203.                     'iconCls' => 'pimcore_icon_thumbnails',
  1204.                     'cls' => 'pimcore_treenode_disabled',
  1205.                     'writeable' => $item->isWriteable(),
  1206.                 ];
  1207.             }
  1208.         }
  1210.         foreach ($groups as $group) {
  1211.             $thumbnails[] = $group;
  1212.         }
  1214.         return $this->adminJson($thumbnails);
  1215.     }
  1217.     /**
  1218.      * @Route("/thumbnail-downloadable", name="pimcore_admin_settings_thumbnaildownloadable", methods={"GET"})
  1219.      *
  1220.      * @param Request $request
  1221.      *
  1222.      * @return JsonResponse
  1223.      */
  1224.     public function thumbnailDownloadableAction(Request $request)
  1225.     {
  1226.         $thumbnails = [];
  1228.         $list = new Asset\Image\Thumbnail\Config\Listing();
  1229.         $list->setFilter(function (array $config) {
  1230.             return array_key_exists('downloadable', $config) ? $config['downloadable'] : false;
  1231.         });
  1232.         $items = $list->getThumbnails();
  1234.         /** @var Asset\Image\Thumbnail\Config $item */
  1235.         foreach ($items as $item) {
  1236.             $thumbnails[] = [
  1237.                 'id' => $item->getName(),
  1238.                 'text' => $item->getName(),
  1239.             ];
  1240.         }
  1242.         return $this->adminJson($thumbnails);
  1243.     }
  1245.     /**
  1246.      * @Route("/thumbnail-add", name="pimcore_admin_settings_thumbnailadd", methods={"POST"})
  1247.      *
  1248.      * @param Request $request
  1249.      *
  1250.      * @return JsonResponse
  1251.      */
  1252.     public function thumbnailAddAction(Request $request)
  1253.     {
  1254.         $this->checkPermission('thumbnails');
  1256.         $success = false;
  1258.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1260.         if (!$pipe) {
  1261.             $pipe = new Asset\Image\Thumbnail\Config();
  1262.             if (!$pipe->isWriteable()) {
  1263.                 throw new ConfigWriteException();
  1264.             }
  1266.             $pipe->setName($request->get('name'));
  1267.             $pipe->save();
  1269.             $success = true;
  1270.         } else {
  1271.             if (!$pipe->isWriteable()) {
  1272.                 throw new ConfigWriteException();
  1273.             }
  1274.         }
  1276.         return $this->adminJson(['success' => $success, 'id' => $pipe->getName()]);
  1277.     }
  1279.     /**
  1280.      * @Route("/thumbnail-delete", name="pimcore_admin_settings_thumbnaildelete", methods={"DELETE"})
  1281.      *
  1282.      * @param Request $request
  1283.      *
  1284.      * @return JsonResponse
  1285.      */
  1286.     public function thumbnailDeleteAction(Request $request)
  1287.     {
  1288.         $this->checkPermission('thumbnails');
  1290.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1292.         if (!$pipe->isWriteable()) {
  1293.             throw new ConfigWriteException();
  1294.         }
  1296.         $pipe->delete();
  1298.         return $this->adminJson(['success' => true]);
  1299.     }
  1301.     /**
  1302.      * @Route("/thumbnail-get", name="pimcore_admin_settings_thumbnailget", methods={"GET"})
  1303.      *
  1304.      * @param Request $request
  1305.      *
  1306.      * @return JsonResponse
  1307.      */
  1308.     public function thumbnailGetAction(Request $request)
  1309.     {
  1310.         $this->checkPermission('thumbnails');
  1312.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1313.         $data = $pipe->getObjectVars();
  1314.         $data['writeable'] = $pipe->isWriteable();
  1316.         return $this->adminJson($data);
  1317.     }
  1319.     /**
  1320.      * @Route("/thumbnail-update", name="pimcore_admin_settings_thumbnailupdate", methods={"PUT"})
  1321.      *
  1322.      * @param Request $request
  1323.      *
  1324.      * @return JsonResponse
  1325.      */
  1326.     public function thumbnailUpdateAction(Request $request)
  1327.     {
  1328.         $this->checkPermission('thumbnails');
  1330.         $pipe = Asset\Image\Thumbnail\Config::getByName($request->get('name'));
  1332.         if (!$pipe->isWriteable()) {
  1333.             throw new ConfigWriteException();
  1334.         }
  1336.         $settingsData = $this->decodeJson($request->get('settings'));
  1337.         $mediaData = $this->decodeJson($request->get('medias'));
  1338.         $mediaOrder = $this->decodeJson($request->get('mediaOrder'));
  1340.         foreach ($settingsData as $key => $value) {
  1341.             $setter = 'set' . ucfirst($key);
  1342.             if (method_exists($pipe, $setter)) {
  1343.                 $pipe->$setter($value);
  1344.             }
  1345.         }
  1347.         $pipe->resetItems();
  1349.         uksort($mediaData, function ($a, $b) use ($mediaOrder) {
  1350.             if ($a === 'default') {
  1351.                 return -1;
  1352.             }
  1354.             return ($mediaOrder[$a] < $mediaOrder[$b]) ? -1 : 1;
  1355.         });
  1357.         foreach ($mediaData as $mediaName => $items) {
  1358.             foreach ($items as $item) {
  1359.                 $type = $item['type'];
  1360.                 unset($item['type']);
  1362.                 $pipe->addItem($type, $item, $mediaName);
  1363.             }
  1364.         }
  1366.         $pipe->save();
  1368.         return $this->adminJson(['success' => true]);
  1369.     }
  1371.     /**
  1372.      * @Route("/video-thumbnail-adapter-check", name="pimcore_admin_settings_videothumbnailadaptercheck", methods={"GET"})
  1373.      *
  1374.      * @param Request $request
  1375.      *
  1376.      * @return Response
  1377.      */
  1378.     public function videoThumbnailAdapterCheckAction(Request $request)
  1379.     {
  1380.         $content = '';
  1382.         if (!\Pimcore\Video::isAvailable()) {
  1383.             $content = '<span style="color: red; font-weight: bold;padding: 10px;margin:0 0 20px 0;border:1px solid red;display:block;">' .
  1384.                 $this->trans('php_cli_binary_and_or_ffmpeg_binary_setting_is_missing') .
  1385.                 '</span>';
  1386.         }
  1388.         return new Response($content);
  1389.     }
  1391.     /**
  1392.      * @Route("/video-thumbnail-tree", name="pimcore_admin_settings_videothumbnailtree", methods={"GET", "POST"})
  1393.      *
  1394.      * @param Request $request
  1395.      *
  1396.      * @return JsonResponse
  1397.      */
  1398.     public function videoThumbnailTreeAction(Request $request)
  1399.     {
  1400.         $this->checkPermission('thumbnails');
  1402.         $thumbnails = [];
  1404.         $list = new Asset\Video\Thumbnail\Config\Listing();
  1405.         $items = $list->getThumbnails();
  1407.         $groups = [];
  1408.         /** @var Asset\Video\Thumbnail\Config $item */
  1409.         foreach ($items as $item) {
  1410.             if ($item->getGroup()) {
  1411.                 if (!$groups[$item->getGroup()]) {
  1412.                     $groups[$item->getGroup()] = [
  1413.                         'id' => 'group_' . $item->getName(),
  1414.                         'text' => $item->getGroup(),
  1415.                         'expandable' => true,
  1416.                         'leaf' => false,
  1417.                         'allowChildren' => true,
  1418.                         'iconCls' => 'pimcore_icon_folder',
  1419.                         'group' => $item->getGroup(),
  1420.                         'children' => [],
  1421.                     ];
  1422.                 }
  1423.                 $groups[$item->getGroup()]['children'][] =
  1424.                     [
  1425.                         'id' => $item->getName(),
  1426.                         'text' => $item->getName(),
  1427.                         'leaf' => true,
  1428.                         'iconCls' => 'pimcore_icon_videothumbnails',
  1429.                         'cls' => 'pimcore_treenode_disabled',
  1430.                         'writeable' => $item->isWriteable(),
  1431.                     ];
  1432.             } else {
  1433.                 $thumbnails[] = [
  1434.                     'id' => $item->getName(),
  1435.                     'text' => $item->getName(),
  1436.                     'leaf' => true,
  1437.                     'iconCls' => 'pimcore_icon_videothumbnails',
  1438.                     'cls' => 'pimcore_treenode_disabled',
  1439.                     'writeable' => $item->isWriteable(),
  1440.                 ];
  1441.             }
  1442.         }
  1444.         foreach ($groups as $group) {
  1445.             $thumbnails[] = $group;
  1446.         }
  1448.         return $this->adminJson($thumbnails);
  1449.     }
  1451.     /**
  1452.      * @Route("/video-thumbnail-add", name="pimcore_admin_settings_videothumbnailadd", methods={"POST"})
  1453.      *
  1454.      * @param Request $request
  1455.      *
  1456.      * @return JsonResponse
  1457.      */
  1458.     public function videoThumbnailAddAction(Request $request)
  1459.     {
  1460.         $this->checkPermission('thumbnails');
  1462.         $success = false;
  1464.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1466.         if (!$pipe) {
  1467.             $pipe = new Asset\Video\Thumbnail\Config();
  1468.             if (!$pipe->isWriteable()) {
  1469.                 throw new ConfigWriteException();
  1470.             }
  1472.             $pipe->setName($request->get('name'));
  1473.             $pipe->save();
  1475.             $success = true;
  1476.         } else {
  1477.             if (!$pipe->isWriteable()) {
  1478.                 throw new ConfigWriteException();
  1479.             }
  1480.         }
  1482.         return $this->adminJson(['success' => $success, 'id' => $pipe->getName()]);
  1483.     }
  1485.     /**
  1486.      * @Route("/video-thumbnail-delete", name="pimcore_admin_settings_videothumbnaildelete", methods={"DELETE"})
  1487.      *
  1488.      * @param Request $request
  1489.      *
  1490.      * @return JsonResponse
  1491.      */
  1492.     public function videoThumbnailDeleteAction(Request $request)
  1493.     {
  1494.         $this->checkPermission('thumbnails');
  1496.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1498.         if (!$pipe->isWriteable()) {
  1499.             throw new ConfigWriteException();
  1500.         }
  1502.         $pipe->delete();
  1504.         return $this->adminJson(['success' => true]);
  1505.     }
  1507.     /**
  1508.      * @Route("/video-thumbnail-get", name="pimcore_admin_settings_videothumbnailget", methods={"GET"})
  1509.      *
  1510.      * @param Request $request
  1511.      *
  1512.      * @return JsonResponse
  1513.      */
  1514.     public function videoThumbnailGetAction(Request $request)
  1515.     {
  1516.         $this->checkPermission('thumbnails');
  1518.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1520.         $data = $pipe->getObjectVars();
  1521.         $data['writeable'] = $pipe->isWriteable();
  1523.         return $this->adminJson($data);
  1524.     }
  1526.     /**
  1527.      * @Route("/video-thumbnail-update", name="pimcore_admin_settings_videothumbnailupdate", methods={"PUT"})
  1528.      *
  1529.      * @param Request $request
  1530.      *
  1531.      * @return JsonResponse
  1532.      */
  1533.     public function videoThumbnailUpdateAction(Request $request)
  1534.     {
  1535.         $this->checkPermission('thumbnails');
  1537.         $pipe = Asset\Video\Thumbnail\Config::getByName($request->get('name'));
  1539.         if (!$pipe->isWriteable()) {
  1540.             throw new ConfigWriteException();
  1541.         }
  1543.         $settingsData = $this->decodeJson($request->get('settings'));
  1544.         $mediaData = $this->decodeJson($request->get('medias'));
  1545.         $mediaOrder = $this->decodeJson($request->get('mediaOrder'));
  1547.         foreach ($settingsData as $key => $value) {
  1548.             $setter = 'set' . ucfirst($key);
  1549.             if (method_exists($pipe, $setter)) {
  1550.                 $pipe->$setter($value);
  1551.             }
  1552.         }
  1554.         $pipe->resetItems();
  1556.         uksort($mediaData, function ($a, $b) use ($mediaOrder) {
  1557.             if ($a === 'default') {
  1558.                 return -1;
  1559.             }
  1561.             return ($mediaOrder[$a] < $mediaOrder[$b]) ? -1 : 1;
  1562.         });
  1564.         foreach ($mediaData as $mediaName => $items) {
  1565.             foreach ($items as $item) {
  1566.                 $type = $item['type'];
  1567.                 unset($item['type']);
  1569.                 $pipe->addItem($type, $item, $mediaName);
  1570.             }
  1571.         }
  1573.         $pipe->save();
  1575.         return $this->adminJson(['success' => true]);
  1576.     }
  1578.     /**
  1579.      * @Route("/robots-txt", name="pimcore_admin_settings_robotstxtget", methods={"GET"})
  1580.      *
  1581.      * @return JsonResponse
  1582.      */
  1583.     public function robotsTxtGetAction()
  1584.     {
  1585.         $this->checkPermission('robots.txt');
  1587.         $config = Config::getRobotsConfig();
  1588.         $config = $config->toArray();
  1590.         return $this->adminJson([
  1591.             'success' => true,
  1592.             'data' => $config,
  1593.             'onFileSystem' => file_exists(PIMCORE_WEB_ROOT . '/robots.txt'),
  1594.         ]);
  1595.     }
  1597.     /**
  1598.      * @Route("/robots-txt", name="pimcore_admin_settings_robotstxtput", methods={"PUT"})
  1599.      *
  1600.      * @param Request $request
  1601.      *
  1602.      * @return JsonResponse
  1603.      */
  1604.     public function robotsTxtPutAction(Request $request)
  1605.     {
  1606.         $this->checkPermission('robots.txt');
  1608.         $values = $request->get('data');
  1609.         if (!is_array($values)) {
  1610.             $values = [];
  1611.         }
  1613.         foreach ($values as $siteId => $robotsContent) {
  1614.             SettingsStore::set('robots.txt-' . $siteId, $robotsContent, 'string', 'robots.txt');
  1615.         }
  1617.         return $this->adminJson([
  1618.             'success' => true,
  1619.         ]);
  1620.     }
  1622.     /**
  1623.      * @Route("/website-settings", name="pimcore_admin_settings_websitesettings", methods={"POST"})
  1624.      *
  1625.      * @param Request $request
  1626.      *
  1627.      * @return JsonResponse
  1628.      *
  1629.      * @throws \Exception
  1630.      */
  1631.     public function websiteSettingsAction(Request $request)
  1632.     {
  1633.         $this->checkPermission('website_settings');
  1635.         if ($request->get('data')) {
  1636.             $data = $this->decodeJson($request->get('data'));
  1638.             if (is_array($data)) {
  1639.                 foreach ($data as &$value) {
  1640.                     $value = trim($value);
  1641.                 }
  1642.             }
  1644.             if ($request->get('xaction') == 'destroy') {
  1645.                 $id = $data['id'];
  1646.                 $setting = WebsiteSetting::getById($id);
  1647.                 if ($setting instanceof WebsiteSetting) {
  1648.                     $setting->delete();
  1650.                     return $this->adminJson(['success' => true, 'data' => []]);
  1651.                 }
  1652.             } elseif ($request->get('xaction') == 'update') {
  1653.                 // save routes
  1654.                 $setting = WebsiteSetting::getById($data['id']);
  1655.                 if ($setting instanceof WebsiteSetting) {
  1656.                     switch ($setting->getType()) {
  1657.                         case 'document':
  1658.                         case 'asset':
  1659.                         case 'object':
  1660.                             if (isset($data['data'])) {
  1661.                                 $element = Element\Service::getElementByPath($setting->getType(), $data['data']);
  1662.                                 $data['data'] = $element;
  1663.                             }
  1665.                             break;
  1666.                     }
  1668.                     $setting->setValues($data);
  1669.                     $setting->save();
  1671.                     $data = $this->getWebsiteSettingForEditMode($setting);
  1673.                     return $this->adminJson(['data' => $data, 'success' => true]);
  1674.                 }
  1675.             } elseif ($request->get('xaction') == 'create') {
  1676.                 unset($data['id']);
  1678.                 // save route
  1679.                 $setting = new WebsiteSetting();
  1680.                 $setting->setValues($data);
  1682.                 $setting->save();
  1684.                 return $this->adminJson(['data' => $setting->getObjectVars(), 'success' => true]);
  1685.             }
  1686.         } else {
  1687.             $list = new WebsiteSetting\Listing();
  1689.             $list->setLimit($request->get('limit'));
  1690.             $list->setOffset($request->get('start'));
  1692.             $sortingSettings = \Pimcore\Bundle\AdminBundle\Helper\QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  1693.             if ($sortingSettings['orderKey']) {
  1694.                 $list->setOrderKey($sortingSettings['orderKey']);
  1695.                 $list->setOrder($sortingSettings['order']);
  1696.             } else {
  1697.                 $list->setOrderKey('name');
  1698.                 $list->setOrder('asc');
  1699.             }
  1701.             if ($request->get('filter')) {
  1702.                 $list->setCondition('`name` LIKE ' . $list->quote('%'.$request->get('filter').'%'));
  1703.             }
  1705.             $totalCount = $list->getTotalCount();
  1706.             $list = $list->load();
  1708.             $settings = [];
  1709.             foreach ($list as $item) {
  1710.                 $resultItem = $this->getWebsiteSettingForEditMode($item);
  1711.                 $settings[] = $resultItem;
  1712.             }
  1714.             return $this->adminJson(['data' => $settings, 'success' => true, 'total' => $totalCount]);
  1715.         }
  1717.         return $this->adminJson(['success' => false]);
  1718.     }
  1720.     /**
  1721.      * @param WebsiteSetting $item
  1722.      *
  1723.      * @return array
  1724.      */
  1725.     private function getWebsiteSettingForEditMode($item)
  1726.     {
  1727.         $resultItem = [
  1728.             'id' => $item->getId(),
  1729.             'name' => $item->getName(),
  1730.             'language' => $item->getLanguage(),
  1731.             'type' => $item->getType(),
  1732.             'data' => null,
  1733.             'siteId' => $item->getSiteId(),
  1734.             'creationDate' => $item->getCreationDate(),
  1735.             'modificationDate' => $item->getModificationDate(),
  1736.         ];
  1738.         switch ($item->getType()) {
  1739.             case 'document':
  1740.             case 'asset':
  1741.             case 'object':
  1742.                 $element = $item->getData();
  1743.                 if ($element) {
  1744.                     $resultItem['data'] = $element->getRealFullPath();
  1745.                 }
  1747.                 break;
  1748.             default:
  1749.                 $resultItem['data'] = $item->getData();
  1751.                 break;
  1752.         }
  1754.         return $resultItem;
  1755.     }
  1757.     /**
  1758.      * @Route("/get-available-algorithms", name="pimcore_admin_settings_getavailablealgorithms", methods={"GET"})
  1759.      *
  1760.      * @param Request $request
  1761.      *
  1762.      * @return JsonResponse
  1763.      */
  1764.     public function getAvailableAlgorithmsAction(Request $request)
  1765.     {
  1766.         $options = [
  1767.             [
  1768.                 'key' => 'password_hash',
  1769.                 'value' => 'password_hash',
  1770.             ],
  1771.         ];
  1773.         $algorithms = hash_algos();
  1774.         foreach ($algorithms as $algorithm) {
  1775.             $options[] = [
  1776.                 'key' => $algorithm,
  1777.                 'value' => $algorithm,
  1778.             ];
  1779.         }
  1781.         $result = ['data' => $options, 'success' => true, 'total' => count($options)];
  1783.         return $this->adminJson($result);
  1784.     }
  1786.     /**
  1787.      * deleteViews
  1788.      * delete views for localized fields when languages are removed to
  1789.      * prevent mysql errors
  1790.      *
  1791.      * @param string $language
  1792.      * @param string $dbName
  1793.      */
  1794.     protected function deleteViews($language, $dbName)
  1795.     {
  1796.         $db = \Pimcore\Db::get();
  1797.         $views = $db->fetchAll('SHOW FULL TABLES IN ' . $db->quoteIdentifier($dbName) . " WHERE TABLE_TYPE LIKE 'VIEW'");
  1799.         foreach ($views as $view) {
  1800.             if (preg_match('/^object_localized_[0-9]+_' . $language . '$/', $view['Tables_in_' . $dbName])) {
  1801.                 $sql = 'DROP VIEW ' . $db->quoteIdentifier($view['Tables_in_' . $dbName]);
  1802.                 $db->query($sql);
  1803.             }
  1804.         }
  1805.     }
  1807.     /**
  1808.      * @Route("/test-web2print", name="pimcore_admin_settings_testweb2print", methods={"GET"})
  1809.      *
  1810.      * @param Request $request
  1811.      *
  1812.      * @return Response
  1813.      */
  1814.     public function testWeb2printAction(Request $request)
  1815.     {
  1816.         $this->checkPermission('web2print_settings');
  1818.         $response = $this->render('@PimcoreAdmin/Admin/Settings/testWeb2print.html.twig');
  1819.         $html = $response->getContent();
  1821.         $adapter = \Pimcore\Web2Print\Processor::getInstance();
  1822.         $params = [];
  1824.         if ($adapter instanceof \Pimcore\Web2Print\Processor\WkHtmlToPdf) {
  1825.             $params['adapterConfig'] = '-O landscape';
  1826.         } elseif ($adapter instanceof \Pimcore\Web2Print\Processor\PdfReactor) {
  1827.             $params['adapterConfig'] = [
  1828.                 'javaScriptMode' => 0,
  1829.                 'addLinks' => true,
  1830.                 'appendLog' => true,
  1831.                 'enableDebugMode' => true,
  1832.             ];
  1833.         }
  1835.         $responseOptions = [
  1836.             'Content-Type' => 'application/pdf',
  1837.         ];
  1839.         $pdfData = $adapter->getPdfFromString($html, $params);
  1841.         return new \Symfony\Component\HttpFoundation\Response(
  1842.             $pdfData,
  1843.             200,
  1844.             $responseOptions
  1846.         );
  1847.     }
  1848. }