vendor/pimcore/pimcore/bundles/AdminBundle/Controller/Admin/MiscController.php line 210

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\Config;
  20. use Pimcore\Controller\Config\ControllerDataProvider;
  21. use Pimcore\Db;
  22. use Pimcore\File;
  23. use Pimcore\Localization\LocaleServiceInterface;
  24. use Pimcore\Tool;
  25. use Pimcore\Tool\Storage;
  26. use Pimcore\Translation\Translator;
  27. use Symfony\Component\HttpFoundation\BinaryFileResponse;
  28. use Symfony\Component\HttpFoundation\JsonResponse;
  29. use Symfony\Component\HttpFoundation\Request;
  30. use Symfony\Component\HttpFoundation\Response;
  31. use Symfony\Component\HttpKernel\Profiler\Profiler;
  32. use Symfony\Component\Routing\Annotation\Route;
  33. use Symfony\Contracts\Translation\TranslatorInterface;
  35. /**
  36. * @Route("/misc")
  37. *
  38. * @internal
  39. */
  40. class MiscController extends AdminController
  41. {
  42. /**
  43. * @Route("/get-available-controller-references", name="pimcore_admin_misc_getavailablecontroller_references", methods={"GET"})
  44. *
  45. * @param Request $request
  46. * @param ControllerDataProvider $provider
  47. *
  48. * @return JsonResponse
  49. */
  50. public function getAvailableControllerReferencesAction(Request $request, ControllerDataProvider $provider)
  51. {
  52. $controllerReferences = $provider->getControllerReferences();
  54. $result = array_map(function ($controller) {
  55. return [
  56. 'name' => $controller,
  57. ];
  58. }, $controllerReferences);
  60. return $this->adminJson([
  61. 'data' => $result,
  62. ]);
  63. }
  65. /**
  66. * @Route("/get-available-templates", name="pimcore_admin_misc_getavailabletemplates", methods={"GET"})
  67. *
  68. * @param ControllerDataProvider $provider
  69. *
  70. * @return JsonResponse
  71. */
  72. public function getAvailableTemplatesAction(ControllerDataProvider $provider)
  73. {
  74. $templates = $provider->getTemplates();
  76. sort($templates, SORT_NATURAL | SORT_FLAG_CASE);
  78. $result = array_map(static function ($template) {
  79. return [
  80. 'path' => $template,
  81. ];
  82. }, $templates);
  84. return $this->adminJson([
  85. 'data' => $result,
  86. ]);
  87. }
  89. /**
  90. * @Route("/json-translations-system", name="pimcore_admin_misc_jsontranslationssystem", methods={"GET"})
  91. *
  92. * @param Request $request
  93. *
  94. * @return Response
  95. */
  96. public function jsonTranslationsSystemAction(Request $request, TranslatorInterface $translator)
  97. {
  98. $language = $request->get('language');
  100. /** @var Translator $translator */
  101. $translator->lazyInitialize('admin', $language);
  103. $translations = $translator->getCatalogue($language)->all('admin');
  104. if ($language != 'en') {
  105. // add en as a fallback
  106. $translator->lazyInitialize('admin', 'en');
  107. foreach ($translator->getCatalogue('en')->all('admin') as $key => $value) {
  108. if (!isset($translations[$key]) || empty($translations[$key])) {
  109. $translations[$key] = $value;
  110. }
  111. }
  112. }
  114. $response = new Response('pimcore.system_i18n = ' . $this->encodeJson($translations) . ';');
  115. $response->headers->set('Content-Type', 'text/javascript');
  117. return $response;
  118. }
  120. /**
  121. * @Route("/script-proxy", name="pimcore_admin_misc_scriptproxy", methods={"GET"})
  122. *
  123. * @param Request $request
  124. *
  125. * @return Response
  126. */
  127. public function scriptProxyAction(Request $request)
  128. {
  129. if ($storageFile = $request->get('storageFile')) {
  130. $fileExtension = \Pimcore\File::getFileExtension($storageFile);
  131. $storage = Storage::get('admin');
  132. $scriptsContent = $storage->read($storageFile);
  133. } else {
  134. trigger_deprecation('pimcore/pimcore', '10.1', 'Calling /admin/misc/script-proxy without the parameter storageFile is deprecated and will not work in Pimcore 11.');
  135. $allowedFileTypes = ['js', 'css'];
  136. $scripts = explode(',', $request->get('scripts'));
  138. if ($request->get('scriptPath')) {
  139. $scriptPath = PIMCORE_WEB_ROOT . $request->get('scriptPath');
  140. } else {
  141. $scriptPath = PIMCORE_SYSTEM_TEMP_DIRECTORY . '/';
  142. }
  144. $scriptsContent = '';
  145. foreach ($scripts as $script) {
  146. $filePath = $scriptPath . $script;
  147. if (is_file($filePath) && is_readable($filePath) && in_array(\Pimcore\File::getFileExtension($script), $allowedFileTypes)) {
  148. $scriptsContent .= file_get_contents($filePath);
  149. }
  150. }
  152. $fileExtension = \Pimcore\File::getFileExtension($scripts[0]);
  153. }
  155. if (!empty($scriptsContent)) {
  156. $contentType = 'text/javascript';
  157. if ($fileExtension == 'css') {
  158. $contentType = 'text/css';
  159. }
  161. $lifetime = 86400;
  163. $response = new Response($scriptsContent);
  164. $response->headers->set('Cache-Control', 'max-age=' . $lifetime);
  165. $response->headers->set('Pragma', '');
  166. $response->headers->set('Content-Type', $contentType);
  167. $response->headers->set('Expires', gmdate('D, d M Y H:i:s', time() + $lifetime) . ' GMT');
  169. return $response;
  170. } else {
  171. throw $this->createNotFoundException('Scripts not found');
  172. }
  173. }
  175. /**
  176. * @Route("/admin-css", name="pimcore_admin_misc_admincss", methods={"GET"})
  177. *
  178. * @param Request $request
  179. * @param Config $config
  180. *
  181. * @return Response
  182. */
  183. public function adminCssAction(Request $request, Config $config)
  184. {
  185. // customviews config
  186. $cvData = Tool::getCustomViewConfig();
  188. // languages
  189. $languages = \Pimcore\Tool::getValidLanguages();
  190. $adminLanguages = \Pimcore\Tool\Admin::getLanguages();
  191. $languages = array_unique(array_merge($languages, $adminLanguages));
  193. $response = $this->render('@PimcoreAdmin/Admin/Misc/admin-css.html.twig', [
  194. 'customviews' => $cvData,
  195. 'config' => $config,
  196. 'languages' => $languages,
  197. ]);
  198. $response->headers->set('Content-Type', 'text/css; charset=UTF-8');
  200. return $response;
  201. }
  203. /**
  204. * @Route("/ping", name="pimcore_admin_misc_ping", methods={"GET"})
  205. *
  206. * @param Request $request
  207. *
  208. * @return JsonResponse
  209. */
  210. public function pingAction(Request $request)
  211. {
  212. $response = [
  213. 'success' => true,
  214. ];
  216. return $this->adminJson($response);
  217. }
  219. /**
  220. * @Route("/available-languages", name="pimcore_admin_misc_availablelanguages", methods={"GET"})
  221. *
  222. * @param Request $request
  223. *
  224. * @return Response
  225. */
  226. public function availableLanguagesAction(Request $request)
  227. {
  228. $locales = Tool::getSupportedLocales();
  229. $response = new Response('pimcore.available_languages = ' . $this->encodeJson($locales) . ';');
  230. $response->headers->set('Content-Type', 'text/javascript');
  232. return $response;
  233. }
  235. /**
  236. * @Route("/get-valid-filename", name="pimcore_admin_misc_getvalidfilename", methods={"GET"})
  237. *
  238. * @param Request $request
  239. *
  240. * @return JsonResponse
  241. */
  242. public function getValidFilenameAction(Request $request)
  243. {
  244. return $this->adminJson([
  245. 'filename' => \Pimcore\Model\Element\Service::getValidKey($request->get('value'), $request->get('type')),
  246. ]);
  247. }
  249. // FILEEXPLORER
  251. /**
  252. * @Route("/fileexplorer-tree", name="pimcore_admin_misc_fileexplorertree", methods={"GET"})
  253. *
  254. * @param Request $request
  255. *
  256. * @return JsonResponse
  257. */
  258. public function fileexplorerTreeAction(Request $request)
  259. {
  260. $this->checkPermission('fileexplorer');
  261. $referencePath = $this->getFileexplorerPath($request, 'node');
  263. $items = scandir($referencePath);
  264. $contents = [];
  266. foreach ($items as $item) {
  267. if ($item == '.' || $item == '..') {
  268. continue;
  269. }
  271. $file = $referencePath . '/' . $item;
  272. $file = str_replace('//', '/', $file);
  274. if (is_dir($file) || is_file($file)) {
  275. $itemConfig = [
  276. 'id' => '/fileexplorer' . str_replace(PIMCORE_PROJECT_ROOT, '', $file),
  277. 'text' => $item,
  278. 'leaf' => true,
  279. 'writeable' => is_writable($file),
  280. ];
  282. if (is_dir($file)) {
  283. $itemConfig['leaf'] = false;
  284. $itemConfig['type'] = 'folder';
  285. if (is_dir_empty($file)) {
  286. $itemConfig['loaded'] = true;
  287. }
  288. $itemConfig['expandable'] = true;
  289. } elseif (is_file($file)) {
  290. $itemConfig['type'] = 'file';
  291. }
  293. $contents[] = $itemConfig;
  294. }
  295. }
  297. return $this->adminJson($contents);
  298. }
  300. /**
  301. * @Route("/fileexplorer-content", name="pimcore_admin_misc_fileexplorercontent", methods={"GET"})
  302. *
  303. * @param Request $request
  304. *
  305. * @return JsonResponse
  306. */
  307. public function fileexplorerContentAction(Request $request)
  308. {
  309. $this->checkPermission('fileexplorer');
  311. $success = false;
  312. $writeable = false;
  313. $file = $this->getFileexplorerPath($request, 'path');
  314. $content = null;
  315. if (is_file($file)) {
  316. if (is_readable($file)) {
  317. $content = file_get_contents($file);
  318. $success = true;
  319. $writeable = is_writable($file);
  320. }
  321. }
  323. return $this->adminJson([
  324. 'success' => $success,
  325. 'content' => $content,
  326. 'writeable' => $writeable,
  327. 'filename' => basename($file),
  328. 'path' => preg_replace('@^' . preg_quote(PIMCORE_PROJECT_ROOT, '@') . '@', '', $file),
  329. ]);
  330. }
  332. /**
  333. * @Route("/fileexplorer-content-save", name="pimcore_admin_misc_fileexplorercontentsave", methods={"PUT"})
  334. *
  335. * @param Request $request
  336. *
  337. * @return JsonResponse
  338. */
  339. public function fileexplorerContentSaveAction(Request $request)
  340. {
  341. $this->checkPermission('fileexplorer');
  343. $success = false;
  345. if ($request->get('content') && $request->get('path')) {
  346. $file = $this->getFileexplorerPath($request, 'path');
  347. if (is_file($file) && is_writable($file)) {
  348. File::put($file, $request->get('content'));
  350. $success = true;
  351. }
  352. }
  354. return $this->adminJson([
  355. 'success' => $success,
  356. ]);
  357. }
  359. /**
  360. * @Route("/fileexplorer-add", name="pimcore_admin_misc_fileexploreradd", methods={"POST"})
  361. *
  362. * @param Request $request
  363. *
  364. * @return JsonResponse
  365. *
  366. * @throws \Exception
  367. */
  368. public function fileexplorerAddAction(Request $request)
  369. {
  370. $this->checkPermission('fileexplorer');
  372. $success = false;
  374. if ($request->get('filename') && $request->get('path')) {
  375. $path = $this->getFileexplorerPath($request, 'path');
  376. $file = $path . '/' . $request->get('filename');
  378. $file = resolvePath($file);
  379. if (strpos($file, PIMCORE_PROJECT_ROOT) !== 0) {
  380. throw new \Exception('not allowed');
  381. }
  383. if (is_writable(dirname($file))) {
  384. File::put($file, '');
  386. $success = true;
  387. }
  388. }
  390. return $this->adminJson([
  391. 'success' => $success,
  392. ]);
  393. }
  395. /**
  396. * @Route("/fileexplorer-add-folder", name="pimcore_admin_misc_fileexploreraddfolder", methods={"POST"})
  397. *
  398. * @param Request $request
  399. *
  400. * @return JsonResponse
  401. *
  402. * @throws \Exception
  403. */
  404. public function fileexplorerAddFolderAction(Request $request)
  405. {
  406. $this->checkPermission('fileexplorer');
  408. $success = false;
  410. if ($request->get('filename') && $request->get('path')) {
  411. $path = $this->getFileexplorerPath($request, 'path');
  412. $file = $path . '/' . $request->get('filename');
  414. $file = resolvePath($file);
  415. if (strpos($file, PIMCORE_PROJECT_ROOT) !== 0) {
  416. throw new \Exception('not allowed');
  417. }
  419. if (is_writable(dirname($file))) {
  420. File::mkdir($file);
  422. $success = true;
  423. }
  424. }
  426. return $this->adminJson([
  427. 'success' => $success,
  428. ]);
  429. }
  431. /**
  432. * @Route("/fileexplorer-delete", name="pimcore_admin_misc_fileexplorerdelete", methods={"DELETE"})
  433. *
  434. * @param Request $request
  435. *
  436. * @return JsonResponse
  437. */
  438. public function fileexplorerDeleteAction(Request $request)
  439. {
  440. $this->checkPermission('fileexplorer');
  441. $success = false;
  443. if ($request->get('path')) {
  444. $file = $this->getFileexplorerPath($request, 'path');
  445. if (is_writable($file)) {
  446. unlink($file);
  447. $success = true;
  448. }
  449. }
  451. return $this->adminJson([
  452. 'success' => $success,
  453. ]);
  454. }
  456. /**
  457. * @Route("/fileexplorer-rename", name="pimcore_admin_misc_fileexplorerrename", methods={"PUT"})
  458. *
  459. * @param Request $request
  460. *
  461. * @return JsonResponse
  462. */
  463. public function fileexplorerRenameAction(Request $request)
  464. {
  465. $this->checkPermission('fileexplorer');
  466. $success = false;
  468. if ($request->get('path') && $request->get('newPath')) {
  469. $file = $this->getFileexplorerPath($request, 'path');
  470. $newFile = $this->getFileexplorerPath($request, 'newPath');
  472. $success = rename($file, $newFile);
  473. }
  475. return $this->adminJson([
  476. 'success' => $success,
  477. ]);
  478. }
  480. /**
  481. * @param Request $request
  482. * @param string $paramName
  483. *
  484. * @return mixed|string
  485. *
  486. * @throws \Exception
  487. */
  488. private function getFileexplorerPath(Request $request, $paramName = 'node')
  489. {
  490. $path = preg_replace("/^\/fileexplorer/", '', $request->get($paramName));
  491. $path = resolvePath(PIMCORE_PROJECT_ROOT . $path);
  493. if (strpos($path, PIMCORE_PROJECT_ROOT) !== 0) {
  494. throw new \Exception('operation permitted, permission denied');
  495. }
  497. return $path;
  498. }
  500. /**
  501. * @Route("/maintenance", name="pimcore_admin_misc_maintenance", methods={"POST"})
  502. *
  503. * @param Request $request
  504. *
  505. * @return JsonResponse
  506. */
  507. public function maintenanceAction(Request $request)
  508. {
  509. $this->checkPermission('maintenance_mode');
  511. if ($request->get('activate')) {
  512. Tool\Admin::activateMaintenanceMode(Tool\Session::getSessionId());
  513. }
  515. if ($request->get('deactivate')) {
  516. Tool\Admin::deactivateMaintenanceMode();
  517. }
  519. return $this->adminJson([
  520. 'success' => true,
  521. ]);
  522. }
  524. /**
  525. * @Route("/http-error-log", name="pimcore_admin_misc_httperrorlog", methods={"POST"})
  526. *
  527. * @param Request $request
  528. *
  529. * @return JsonResponse
  530. */
  531. public function httpErrorLogAction(Request $request)
  532. {
  533. $this->checkPermission('http_errors');
  535. $db = Db::get();
  537. $limit = (int)$request->get('limit');
  538. $offset = (int)$request->get('start');
  539. $sortInfo = ($request->get('sort') ? json_decode($request->get('sort'), true)[0] : []);
  540. $sort = $sortInfo['property'] ?? null;
  541. $dir = $sortInfo['direction'] ?? null;
  542. $filter = $request->get('filter');
  543. if (!$limit) {
  544. $limit = 20;
  545. }
  546. if (!$offset) {
  547. $offset = 0;
  548. }
  549. if (!$sort || !in_array($sort, ['code', 'uri', 'date', 'count'])) {
  550. $sort = 'count';
  551. }
  552. if (!$dir || !in_array($dir, ['DESC', 'ASC'])) {
  553. $dir = 'DESC';
  554. }
  556. $condition = '';
  557. if ($filter) {
  558. $filter = $db->quote('%' . $filter . '%');
  560. $conditionParts = [];
  561. foreach (['uri', 'code', 'parametersGet', 'parametersPost', 'serverVars', 'cookies'] as $field) {
  562. $conditionParts[] = $field . ' LIKE ' . $filter;
  563. }
  564. $condition = ' WHERE ' . implode(' OR ', $conditionParts);
  565. }
  567. $logs = $db->fetchAll('SELECT code,uri,`count`,date FROM http_error_log ' . $condition . ' ORDER BY ' . $sort . ' ' . $dir . ' LIMIT ' . $offset . ',' . $limit);
  568. $total = $db->fetchOne('SELECT count(*) FROM http_error_log ' . $condition);
  570. return $this->adminJson([
  571. 'items' => $logs,
  572. 'total' => $total,
  573. 'success' => true,
  574. ]);
  575. }
  577. /**
  578. * @Route("/http-error-log-flush", name="pimcore_admin_misc_httperrorlogflush", methods={"DELETE"})
  579. *
  580. * @param Request $request
  581. *
  582. * @return JsonResponse
  583. */
  584. public function httpErrorLogFlushAction(Request $request)
  585. {
  586. $this->checkPermission('http_errors');
  588. $db = Db::get();
  589. $db->query('TRUNCATE TABLE http_error_log');
  591. return $this->adminJson([
  592. 'success' => true,
  593. ]);
  594. }
  596. /**
  597. * @Route("/http-error-log-detail", name="pimcore_admin_misc_httperrorlogdetail", methods={"GET"})
  598. *
  599. * @param Request $request
  600. * @param Profiler $profiler
  601. *
  602. * @return Response
  603. */
  604. public function httpErrorLogDetailAction(Request $request, ?Profiler $profiler)
  605. {
  606. $this->checkPermission('http_errors');
  608. if ($profiler) {
  609. $profiler->disable();
  610. }
  612. $db = Db::get();
  613. $data = $db->fetchRow('SELECT * FROM http_error_log WHERE uri = ?', [$request->get('uri')]);
  615. foreach ($data as $key => &$value) {
  616. if (in_array($key, ['parametersGet', 'parametersPost', 'serverVars', 'cookies'])) {
  617. $value = unserialize($value);
  618. }
  619. }
  621. $response = $this->render('@PimcoreAdmin/Admin/Misc/http-error-log-detail.html.twig', ['data' => $data]);
  623. return $response;
  624. }
  626. /**
  627. * @Route("/country-list", name="pimcore_admin_misc_countrylist", methods={"GET"})
  628. *
  629. * @param LocaleServiceInterface $localeService
  630. *
  631. * @return JsonResponse
  632. */
  633. public function countryListAction(LocaleServiceInterface $localeService)
  634. {
  635. $countries = $localeService->getDisplayRegions();
  636. asort($countries);
  637. $options = [];
  639. foreach ($countries as $short => $translation) {
  640. if (strlen($short) == 2) {
  641. $options[] = [
  642. 'name' => $translation,
  643. 'code' => $short,
  644. ];
  645. }
  646. }
  648. return $this->adminJson(['data' => $options]);
  649. }
  651. /**
  652. * @Route("/language-list", name="pimcore_admin_misc_languagelist", methods={"GET"})
  653. *
  654. * @param Request $request
  655. *
  656. * @return JsonResponse
  657. */
  658. public function languageListAction(Request $request)
  659. {
  660. $locales = Tool::getSupportedLocales();
  661. $options = [];
  663. foreach ($locales as $short => $translation) {
  664. $options[] = [
  665. 'name' => $translation,
  666. 'code' => $short,
  667. ];
  668. }
  670. return $this->adminJson(['data' => $options]);
  671. }
  673. /**
  674. * @Route("/phpinfo", name="pimcore_admin_misc_phpinfo", methods={"GET"})
  675. *
  676. * @param Request $request
  677. * @param Profiler $profiler
  678. *
  679. * @throws \Exception
  680. *
  681. * @return Response
  682. */
  683. public function phpinfoAction(Request $request, ?Profiler $profiler)
  684. {
  685. if ($profiler) {
  686. $profiler->disable();
  687. }
  689. if (!$this->getAdminUser()->isAdmin()) {
  690. throw new \Exception('Permission denied');
  691. }
  693. ob_start();
  694. phpinfo();
  695. $content = ob_get_clean();
  697. return new Response($content);
  698. }
  700. /**
  701. * @Route("/get-language-flag", name="pimcore_admin_misc_getlanguageflag", methods={"GET"})
  702. *
  703. * @param Request $request
  704. *
  705. * @return BinaryFileResponse
  706. */
  707. public function getLanguageFlagAction(Request $request)
  708. {
  709. $iconPath = Tool::getLanguageFlagFile($request->get('language'));
  710. $response = new BinaryFileResponse($iconPath);
  711. $response->headers->set('Content-Type', 'image/svg+xml');
  713. return $response;
  714. }
  716. /**
  717. * @Route("/icon-list", name="pimcore_admin_misc_iconlist", methods={"GET"})
  718. *
  719. * @param Request $request
  720. * @param Profiler $profiler
  721. *
  722. * @return Response
  723. */
  724. public function iconListAction(Request $request, ?Profiler $profiler)
  725. {
  726. if ($profiler) {
  727. $profiler->disable();
  728. }
  730. $publicDir = PIMCORE_WEB_ROOT . '/bundles/pimcoreadmin';
  731. $iconDir = $publicDir . '/img';
  732. $colorIcons = rscandir($iconDir . '/flat-color-icons/');
  733. $whiteIcons = rscandir($iconDir . '/flat-white-icons/');
  734. $twemoji = rscandir($iconDir . '/twemoji/');
  736. //flag icons for locales
  737. $locales = Tool::getSupportedLocales();
  738. $languageOptions = [];
  739. foreach ($locales as $short => $translation) {
  740. if (!empty($short)) {
  741. $languageOptions[] = [
  742. 'language' => $short,
  743. 'display' => $translation . " ($short)",
  744. 'flag' => \Pimcore\Tool::getLanguageFlagFile($short, false),
  745. ];
  746. }
  747. }
  749. $iconsCss = file_get_contents($publicDir . '/css/icons.css');
  751. return $this->render('@PimcoreAdmin/Admin/Misc/iconList.html.twig', [
  752. 'colorIcons' => $colorIcons,
  753. 'whiteIcons' => $whiteIcons,
  754. 'twemoji' => $twemoji,
  755. 'languageOptions' => $languageOptions,
  756. 'iconsCss' => $iconsCss,
  757. ]);
  758. }
  760. /**
  761. * @Route("/test", name="pimcore_admin_misc_test")
  762. *
  763. * @param Request $request
  764. *
  765. * @return Response
  766. */
  767. public function testAction(Request $request)
  768. {
  769. return new Response('done');
  770. }
  771. }