vendor/pimcore/pimcore/bundles/AdminBundle/Controller/Admin/Asset/AssetHelperController.php line 736

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\Asset;
  18. use PhpOffice\PhpSpreadsheet\Reader\Csv;
  19. use PhpOffice\PhpSpreadsheet\Writer\Xlsx;
  20. use Pimcore\Bundle\AdminBundle\Controller\AdminController;
  21. use Pimcore\Bundle\AdminBundle\Helper\GridHelperService;
  22. use Pimcore\Db;
  23. use Pimcore\Event\AdminEvents;
  24. use Pimcore\Loader\ImplementationLoader\Exception\UnsupportedException;
  25. use Pimcore\Localization\LocaleServiceInterface;
  26. use Pimcore\Logger;
  27. use Pimcore\Model\Asset;
  28. use Pimcore\Model\Element;
  29. use Pimcore\Model\GridConfig;
  30. use Pimcore\Model\GridConfigFavourite;
  31. use Pimcore\Model\GridConfigShare;
  32. use Pimcore\Model\Metadata;
  33. use Pimcore\Model\User;
  34. use Pimcore\Tool;
  35. use Pimcore\Version;
  36. use Symfony\Component\EventDispatcher\GenericEvent;
  37. use Symfony\Component\HttpFoundation\BinaryFileResponse;
  38. use Symfony\Component\HttpFoundation\JsonResponse;
  39. use Symfony\Component\HttpFoundation\Request;
  40. use Symfony\Component\HttpFoundation\ResponseHeaderBag;
  41. use Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface;
  42. use Symfony\Component\Routing\Annotation\Route;
  43. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  45. /**
  46.  * @Route("/asset-helper")
  47.  *
  48.  * @internal
  49.  */
  50. class AssetHelperController extends AdminController
  51. {
  52.     /**
  53.      * @param int $userId
  54.      * @param string $classId
  55.      * @param string $searchType
  56.      *
  57.      * @return array
  58.      */
  59.     public function getMyOwnGridColumnConfigs($userId, $classId, $searchType)
  60.     {
  61.         $db = Db::get();
  62.         $configListingConditionParts = [];
  63.         $configListingConditionParts[] = 'ownerId = ' . $userId;
  64.         $configListingConditionParts[] = 'classId = ' . $db->quote($classId);
  66.         if ($searchType) {
  67.             $configListingConditionParts[] = 'searchType = ' . $db->quote($searchType);
  68.         }
  70.         $configCondition = implode(' AND ', $configListingConditionParts);
  71.         $configListing = new GridConfig\Listing();
  72.         $configListing->setOrderKey('name');
  73.         $configListing->setOrder('ASC');
  74.         $configListing->setCondition($configCondition);
  75.         $configListing = $configListing->load();
  77.         $configData = [];
  78.         if (is_array($configListing)) {
  79.             foreach ($configListing as $config) {
  80.                 $configData[] = $config->getObjectVars();
  81.             }
  82.         }
  84.         return $configData;
  85.     }
  87.     /**
  88.      * @param User $user
  89.      * @param string $classId
  90.      * @param string $searchType
  91.      *
  92.      * @return array
  93.      */
  94.     public function getSharedGridColumnConfigs($user, $classId, $searchType = null)
  95.     {
  96.         $db = Db::get();
  98.         $configListing = [];
  100.         $userIds = [$user->getId()];
  101.         // collect all roles
  102.         $userIds = array_merge($userIds, $user->getRoles());
  103.         $userIds = implode(',', $userIds);
  105.         $query = 'select distinct c1.id from gridconfigs c1, gridconfig_shares s
  106.                     where (c1.searchType = ' . $db->quote($searchType) . ' and ((c1.id = s.gridConfigId and s.sharedWithUserId IN (' . $userIds . '))) and c1.classId = ' . $db->quote($classId) . ')
  107.                             UNION distinct select c2.id from gridconfigs c2 where shareGlobally = 1 and c2.classId = '. $db->quote($classId) . '  and c2.ownerId != ' . $db->quote($user->getId());
  109.         $ids = $db->fetchCol($query);
  111.         if ($ids) {
  112.             $ids = implode(',', $ids);
  113.             $configListing = new GridConfig\Listing();
  114.             $configListing->setOrderKey('name');
  115.             $configListing->setOrder('ASC');
  116.             $configListing->setCondition('id in (' . $ids . ')');
  117.             $configListing = $configListing->load();
  118.         }
  120.         $configData = [];
  121.         if (is_array($configListing)) {
  122.             foreach ($configListing as $config) {
  123.                 $configData[] = $config->getObjectVars();
  124.             }
  125.         }
  127.         return $configData;
  128.     }
  130.     /**
  131.      * @Route("/grid-delete-column-config", name="pimcore_admin_asset_assethelper_griddeletecolumnconfig", methods={"DELETE"})
  132.      *
  133.      * @param Request $request
  134.      *
  135.      * @return JsonResponse
  136.      */
  137.     public function gridDeleteColumnConfigAction(Request $request)
  138.     {
  139.         $gridConfigId = $request->get('gridConfigId');
  140.         $gridConfig = GridConfig::getById($gridConfigId);
  141.         $success = false;
  142.         if ($gridConfig) {
  143.             if ($gridConfig->getOwnerId() != $this->getAdminUser()->getId()) {
  144.                 throw new \Exception("don't mess with someone elses grid config");
  145.             }
  147.             $gridConfig->delete();
  148.             $success = true;
  149.         }
  151.         $newGridConfig = $this->doGetGridColumnConfig($request, true);
  152.         $newGridConfig['deleteSuccess'] = $success;
  154.         return $this->adminJson($newGridConfig);
  155.     }
  157.     /**
  158.      * @Route("/grid-get-column-config", name="pimcore_admin_asset_assethelper_gridgetcolumnconfig", methods={"GET"})
  159.      *
  160.      * @param Request $request
  161.      *
  162.      * @return JsonResponse
  163.      */
  164.     public function gridGetColumnConfigAction(Request $request)
  165.     {
  166.         $result = $this->doGetGridColumnConfig($request);
  168.         return $this->adminJson($result);
  169.     }
  171.     /**
  172.      * @param Request $request
  173.      * @param bool $isDelete
  174.      *
  175.      * @return array
  176.      */
  177.     public function doGetGridColumnConfig(Request $request, $isDelete = false)
  178.     {
  179.         $gridConfigId = null;
  181.         $classId = $request->get('id');
  182.         $type = $request->get('type');
  184.         $context = ['purpose' => 'gridconfig'];
  186.         $types = [];
  187.         if ($request->get('types')) {
  188.             $types = explode(',', $request->get('types'));
  189.         }
  191.         $userId = $this->getAdminUser()->getId();
  193.         $requestedGridConfigId = $isDelete ? null : $request->get('gridConfigId');
  195.         // grid config
  196.         $gridConfig = [];
  197.         $searchType = $request->get('searchType');
  199.         if (strlen($requestedGridConfigId) == 0) {
  200.             // check if there is a favourite view
  201.             $favourite = GridConfigFavourite::getByOwnerAndClassAndObjectId($userId, $classId, 0, $searchType);
  203.             if ($favourite) {
  204.                 $requestedGridConfigId = $favourite->getGridConfigId();
  205.             }
  206.         }
  208.         if (is_numeric($requestedGridConfigId) && $requestedGridConfigId > 0) {
  209.             $db = Db::get();
  210.             $savedGridConfig = GridConfig::getById((int) $requestedGridConfigId);
  212.             if ($savedGridConfig) {
  213.                 $shared = null;
  215.                 try {
  216.                     $userIds = [$this->getAdminUser()->getId()];
  217.                     if ($this->getAdminUser()->getRoles()) {
  218.                         $userIds = array_merge($userIds, $this->getAdminUser()->getRoles());
  219.                     }
  220.                     $userIds = implode(',', $userIds);
  221.                     $shared = ($savedGridConfig->getOwnerId() != $userId && $savedGridConfig->isShareGlobally()) || $db->fetchOne('select * from gridconfig_shares where sharedWithUserId IN (' . $userIds . ') and gridConfigId = ' . $savedGridConfig->getId());
  222.                 } catch (\Exception $e) {
  223.                 }
  225.                 if (!$shared && $savedGridConfig->getOwnerId() != $this->getAdminUser()->getId()) {
  226.                     throw new \Exception('You are neither the owner of this config nor it is shared with you');
  227.                 }
  228.                 $gridConfigId = $savedGridConfig->getId();
  229.                 $gridConfig = $savedGridConfig->getConfig();
  230.                 $gridConfig = json_decode($gridConfig, true);
  231.                 $gridConfigName = $savedGridConfig->getName();
  232.                 $gridConfigDescription = $savedGridConfig->getDescription();
  233.                 $sharedGlobally = $savedGridConfig->isShareGlobally();
  234.                 $setAsFavourite = $savedGridConfig->isSetAsFavourite();
  235.             }
  236.         }
  238.         $availableFields = [];
  239.         $language = '';
  241.         if (empty($gridConfig)) {
  242.             $availableFields = $this->getDefaultGridFields(
  243.                 $request->get('no_system_columns'),
  244.                 [], //maybe required for types other than metadata
  245.                 $context,
  246.                 $types);
  247.         } else {
  248.             $savedColumns = $gridConfig['columns'];
  250.             foreach ($savedColumns as $key => $sc) {
  251.                 if (!$sc['hidden']) {
  252.                     $colConfig = $this->getFieldGridConfig($sc, $language, null);
  253.                     if ($colConfig) {
  254.                         $availableFields[] = $colConfig;
  255.                     }
  256.                 }
  257.             }
  258.         }
  259.         usort($availableFields, function ($a, $b) {
  260.             if ($a['position'] == $b['position']) {
  261.                 return 0;
  262.             }
  264.             return ($a['position'] < $b['position']) ? -1 : 1;
  265.         });
  267.         $availableConfigs = $classId ? $this->getMyOwnGridColumnConfigs($userId, $classId, $searchType) : [];
  268.         $sharedConfigs = $classId ? $this->getSharedGridColumnConfigs($this->getAdminUser(), $classId, $searchType) : [];
  269.         $settings = $this->getShareSettings((int)$gridConfigId);
  270.         $settings['gridConfigId'] = (int)$gridConfigId;
  271.         $settings['gridConfigName'] = $gridConfigName ?? null;
  272.         $settings['gridConfigDescription'] = $gridConfigDescription ?? null;
  273.         $settings['shareGlobally'] = $sharedGlobally ?? null;
  274.         $settings['setAsFavourite'] = $setAsFavourite ?? null;
  275.         $settings['isShared'] = !$gridConfigId || ($shared ?? null);
  277.         $context = $gridConfig['context'] ?? null;
  278.         if ($context) {
  279.             $context = json_decode($context, true);
  280.         }
  282.         return [
  283.             'sortinfo' => isset($gridConfig['sortinfo']) ? $gridConfig['sortinfo'] : false,
  284.             'availableFields' => $availableFields,
  285.             'settings' => $settings,
  286.             'onlyDirectChildren' => isset($gridConfig['onlyDirectChildren']) ? $gridConfig['onlyDirectChildren'] : false,
  287.             'onlyUnreferenced' => isset($gridConfig['onlyUnreferenced']) ? $gridConfig['onlyUnreferenced'] : false,
  288.             'pageSize' => isset($gridConfig['pageSize']) ? $gridConfig['pageSize'] : false,
  289.             'availableConfigs' => $availableConfigs,
  290.             'sharedConfigs' => $sharedConfigs,
  291.             'context' => $context,
  292.         ];
  293.     }
  295.     /**
  296.      * @param array $field
  297.      * @param string $language
  298.      * @param string|null $keyPrefix
  299.      *
  300.      * @return array|null
  301.      */
  302.     protected function getFieldGridConfig($field, $language = '', $keyPrefix = null)
  303.     {
  304.         $defaulMetadataFields = ['copyright', 'alt', 'title'];
  305.         $predefined = null;
  307.         if (isset($field['fieldConfig']['layout']['name'])) {
  308.             $predefined = Metadata\Predefined::getByName($field['fieldConfig']['layout']['name']);
  309.         }
  311.         $key = $field['name'];
  312.         if ($keyPrefix) {
  313.             $key = $keyPrefix . $key;
  314.         }
  316.         $fieldDef = explode('~', $field['name']);
  317.         $field['name'] = $fieldDef[0];
  319.         if (isset($fieldDef[1]) && $fieldDef[1] === 'system') {
  320.             $type = 'system';
  321.         } elseif (in_array($fieldDef[0], $defaulMetadataFields)) {
  322.             $type = 'input';
  323.         } else {
  324.             $type = $field['fieldConfig']['type'];
  325.             if (isset($fieldDef[1])) {
  326.                 $field['fieldConfig']['label'] = $field['fieldConfig']['layout']['title'] = $fieldDef[0] . ' (' . $fieldDef[1] . ')';
  327.                 $field['fieldConfig']['layout']['icon'] = Tool::getLanguageFlagFile($fieldDef[1], true);
  328.             }
  329.         }
  331.         $result = [
  332.             'key' => $key,
  333.             'type' => $type,
  334.             'label' => $field['fieldConfig']['label'] ?? $key,
  335.             'width' => $field['width'],
  336.             'position' => $field['position'],
  337.             'language' => $field['fieldConfig']['language'] ?? null,
  338.             'layout' => $field['fieldConfig']['layout'] ?? null,
  339.         ];
  341.         if (isset($field['locked'])) {
  342.             $result['locked'] = $field['locked'];
  343.         }
  345.         if ($type === 'select' && $predefined) {
  346.             $field['fieldConfig']['layout']['config'] = $predefined->getConfig();
  347.             $result['layout'] = $field['fieldConfig']['layout'];
  348.         } elseif ($type === 'document' || $type === 'asset' || $type === 'object') {
  349.             $result['layout']['fieldtype'] = 'manyToOneRelation';
  350.             $result['layout']['subtype'] = $type;
  351.         }
  353.         return $result;
  354.     }
  356.     /**
  357.      * @param bool $noSystemColumns
  358.      * @param array $fields
  359.      * @param array $context
  360.      * @param array $types
  361.      *
  362.      * @return array
  363.      */
  364.     public function getDefaultGridFields($noSystemColumns, $fields, $context, $types = [])
  365.     {
  366.         $count = 0;
  367.         $availableFields = [];
  369.         if (!$noSystemColumns) {
  370.             foreach (Asset\Service::GRID_SYSTEM_COLUMNS as $sc) {
  371.                 if (empty($types)) {
  372.                     $availableFields[] = [
  373.                         'key' => $sc . '~system',
  374.                         'type' => 'system',
  375.                         'label' => $sc,
  376.                         'position' => $count, ];
  377.                     $count++;
  378.                 }
  379.             }
  380.         }
  382.         return $availableFields;
  383.     }
  385.     /**
  386.      * @Route("/prepare-helper-column-configs", name="pimcore_admin_asset_assethelper_preparehelpercolumnconfigs", methods={"POST"})
  387.      *
  388.      * @param Request $request
  389.      *
  390.      * @return JsonResponse
  391.      */
  392.     public function prepareHelperColumnConfigs(Request $request)
  393.     {
  394.         $helperColumns = [];
  395.         $newData = [];
  396.         $data = json_decode($request->get('columns'));
  397.         /** @var \stdClass $item */
  398.         foreach ($data as $item) {
  399.             if (!empty($item->isOperator)) {
  400.                 $itemKey = '#' . uniqid();
  402.                 $item->key = $itemKey;
  403.                 $newData[] = $item;
  404.                 $helperColumns[$itemKey] = $item;
  405.             } else {
  406.                 $newData[] = $item;
  407.             }
  408.         }
  410.         Tool\Session::useSession(function (AttributeBagInterface $session) use ($helperColumns) {
  411.             $existingColumns = $session->get('helpercolumns', []);
  412.             $helperColumns = array_merge($helperColumns, $existingColumns);
  413.             $session->set('helpercolumns', $helperColumns);
  414.         }, 'pimcore_gridconfig');
  416.         return $this->adminJson(['success' => true, 'columns' => $newData]);
  417.     }
  419.     /**
  420.      * @Route("/grid-mark-favourite-column-config", name="pimcore_admin_asset_assethelper_gridmarkfavouritecolumnconfig", methods={"POST"})
  421.      *
  422.      * @param Request $request
  423.      *
  424.      * @return JsonResponse
  425.      */
  426.     public function gridMarkFavouriteColumnConfigAction(Request $request)
  427.     {
  428.         $classId = $request->get('classId');
  429.         $asset = Asset::getById($classId);
  431.         if ($asset->isAllowed('list')) {
  432.             $gridConfigId = $request->get('gridConfigId');
  433.             $searchType = $request->get('searchType');
  434.             $type = $request->get('type');
  435.             $user = $this->getAdminUser();
  437.             $favourite = new GridConfigFavourite();
  438.             $favourite->setOwnerId($user->getId());
  439.             $favourite->setClassId($classId);
  440.             $favourite->setSearchType($searchType);
  441.             $favourite->setType($type);
  442.             $specializedConfigs = false;
  444.             try {
  445.                 if ($gridConfigId != 0) {
  446.                     $gridConfig = GridConfig::getById($gridConfigId);
  447.                     $favourite->setGridConfigId($gridConfig->getId());
  448.                 }
  450.                 $favourite->setObjectId(0);
  451.                 $favourite->save();
  452.             } catch (\Exception $e) {
  453.                 $favourite->delete();
  454.             }
  456.             return $this->adminJson(['success' => true, 'spezializedConfigs' => $specializedConfigs]);
  457.         }
  459.         throw $this->createAccessDeniedHttpException();
  460.     }
  462.     /**
  463.      * @param int $gridConfigId
  464.      *
  465.      * @return array
  466.      */
  467.     protected function getShareSettings($gridConfigId)
  468.     {
  469.         $result = [
  470.             'sharedUserIds' => [],
  471.             'sharedRoleIds' => [],
  472.         ];
  474.         $db = Db::get();
  475.         $allShares = $db->fetchAll('select s.sharedWithUserId, u.type from gridconfig_shares s, users u
  476.                       where s.sharedWithUserId = u.id and s.gridConfigId = ' . $gridConfigId);
  478.         if ($allShares) {
  479.             foreach ($allShares as $share) {
  480.                 $type = $share['type'];
  481.                 $key = 'shared' . ucfirst($type) . 'Ids';
  482.                 $result[$key][] = $share['sharedWithUserId'];
  483.             }
  484.         }
  486.         foreach ($result as $idx => $value) {
  487.             $value = $value ? implode(',', $value) : '';
  488.             $result[$idx] = $value;
  489.         }
  491.         return $result;
  492.     }
  494.     /**
  495.      * @Route("/grid-save-column-config", name="pimcore_admin_asset_assethelper_gridsavecolumnconfig", methods={"POST"})
  496.      *
  497.      * @param Request $request
  498.      *
  499.      * @return JsonResponse
  500.      */
  501.     public function gridSaveColumnConfigAction(Request $request)
  502.     {
  503.         $asset = Asset::getById((int) $request->get('id'));
  505.         if (!$asset) {
  506.             throw $this->createNotFoundException();
  507.         }
  509.         if ($asset->isAllowed('list')) {
  510.             try {
  511.                 $classId = $request->get('class_id');
  512.                 $context = $request->get('context');
  514.                 $searchType = $request->get('searchType');
  515.                 $type = $request->get('type');
  517.                 // grid config
  518.                 $gridConfigData = $this->decodeJson($request->get('gridconfig'));
  519.                 $gridConfigData['pimcore_version'] = Version::getVersion();
  520.                 $gridConfigData['pimcore_revision'] = Version::getRevision();
  521.                 $gridConfigData['context'] = $context;
  522.                 unset($gridConfigData['settings']['isShared']);
  524.                 $metadata = $request->get('settings');
  525.                 $metadata = json_decode($metadata, true);
  527.                 $gridConfigId = $metadata['gridConfigId'];
  528.                 $gridConfig = GridConfig::getById($gridConfigId);
  530.                 if ($gridConfig && $gridConfig->getOwnerId() != $this->getAdminUser()->getId()) {
  531.                     throw new \Exception("don't mess around with somebody else's configuration");
  532.                 }
  534.                 $this->updateGridConfigShares($gridConfig, $metadata);
  536.                 if ($metadata['setAsFavourite'] && $this->getAdminUser()->isAdmin()) {
  537.                     $this->updateGridConfigFavourites($gridConfig, $metadata);
  538.                 }
  540.                 if (!$gridConfig) {
  541.                     $gridConfig = new GridConfig();
  542.                     $gridConfig->setName(date('c'));
  543.                     $gridConfig->setClassId($classId);
  544.                     $gridConfig->setSearchType($searchType);
  545.                     $gridConfig->setType($type);
  547.                     $gridConfig->setOwnerId($this->getAdminUser()->getId());
  548.                 }
  550.                 if ($metadata) {
  551.                     $gridConfig->setName($metadata['gridConfigName']);
  552.                     $gridConfig->setDescription($metadata['gridConfigDescription']);
  553.                     $gridConfig->setShareGlobally($metadata['shareGlobally'] && $this->getAdminUser()->isAdmin());
  554.                     $gridConfig->setSetAsFavourite($metadata['setAsFavourite'] && $this->getAdminUser()->isAdmin());
  555.                 }
  557.                 $gridConfigData = json_encode($gridConfigData);
  558.                 $gridConfig->setConfig($gridConfigData);
  559.                 $gridConfig->save();
  561.                 $userId = $this->getAdminUser()->getId();
  563.                 $availableConfigs = $this->getMyOwnGridColumnConfigs($userId, $classId, $searchType);
  564.                 $sharedConfigs = $this->getSharedGridColumnConfigs($this->getAdminUser(), $classId, $searchType);
  566.                 $settings = $this->getShareSettings($gridConfig->getId());
  567.                 $settings['gridConfigId'] = (int)$gridConfig->getId();
  568.                 $settings['gridConfigName'] = $gridConfig->getName();
  569.                 $settings['gridConfigDescription'] = $gridConfig->getDescription();
  570.                 $settings['shareGlobally'] = $gridConfig->isShareGlobally();
  571.                 $settings['setAsFavourite'] = $gridConfig->isSetAsFavourite();
  572.                 $settings['isShared'] = $gridConfig->getOwnerId() != $this->getAdminUser()->getId();
  574.                 return $this->adminJson([
  575.                     'success' => true,
  576.                     'settings' => $settings,
  577.                     'availableConfigs' => $availableConfigs,
  578.                     'sharedConfigs' => $sharedConfigs,
  579.                 ]);
  580.             } catch (\Exception $e) {
  581.                 return $this->adminJson(['success' => false, 'message' => $e->getMessage()]);
  582.             }
  583.         }
  585.         throw $this->createAccessDeniedHttpException();
  586.     }
  588.     /**
  589.      * @param GridConfig|null $gridConfig
  590.      * @param array $metadata
  591.      *
  592.      * @throws \Exception
  593.      */
  594.     protected function updateGridConfigShares($gridConfig, $metadata)
  595.     {
  596.         $user = $this->getAdminUser();
  597.         if (!$gridConfig || !$user->isAllowed('share_configurations')) {
  598.             // nothing to do
  599.             return;
  600.         }
  602.         if ($gridConfig->getOwnerId() != $this->getAdminUser()->getId()) {
  603.             throw new \Exception("don't mess with someone elses grid config");
  604.         }
  605.         $combinedShares = [];
  606.         $sharedUserIds = $metadata['sharedUserIds'];
  607.         $sharedRoleIds = $metadata['sharedRoleIds'];
  609.         if ($sharedUserIds) {
  610.             $combinedShares = explode(',', $sharedUserIds);
  611.         }
  613.         if ($sharedRoleIds) {
  614.             $sharedRoleIds = explode(',', $sharedRoleIds);
  615.             $combinedShares = array_merge($combinedShares, $sharedRoleIds);
  616.         }
  618.         $db = Db::get();
  619.         $db->delete('gridconfig_shares', ['gridConfigId' => $gridConfig->getId()]);
  621.         foreach ($combinedShares as $id) {
  622.             $share = new GridConfigShare();
  623.             $share->setGridConfigId($gridConfig->getId());
  624.             $share->setSharedWithUserId((int) $id);
  625.             $share->save();
  626.         }
  627.     }
  629.     /**
  630.      * @param GridConfig|null $gridConfig
  631.      * @param array $metadata
  632.      *
  633.      * @throws \Exception
  634.      */
  635.     protected function updateGridConfigFavourites($gridConfig, $metadata)
  636.     {
  637.         $currentUser = $this->getAdminUser();
  639.         if (!$gridConfig || $currentUser === null || !$currentUser->isAllowed('share_configurations')) {
  640.             // nothing to do
  641.             return;
  642.         }
  644.         if (!$currentUser->isAdmin() && (int) $gridConfig->getOwnerId() !== $currentUser->getId()) {
  645.             throw new \Exception("don't mess with someone elses grid config");
  646.         }
  648.         $sharedUsers = [];
  650.         if ($metadata['shareGlobally'] === false) {
  651.             $sharedUserIds = $metadata['sharedUserIds'];
  653.             if ($sharedUserIds) {
  654.                 $sharedUsers = explode(',', $sharedUserIds);
  655.             }
  656.         }
  658.         if ($metadata['shareGlobally'] === true) {
  659.             $users = new User\Listing();
  660.             $users->setCondition('id = ?', $currentUser->getId());
  662.             foreach ($users as $user) {
  663.                 $sharedUsers[] = $user->getId();
  664.             }
  665.         }
  667.         foreach ($sharedUsers as $id) {
  668.             // Check if the user has already a favourite
  669.             $favourite = GridConfigFavourite::getByOwnerAndClassAndObjectId(
  670.                 (int) $id,
  671.                 $gridConfig->getClassId(),
  672.                 0,
  673.                 $gridConfig->getSearchType()
  674.             );
  676.             if ($favourite instanceof GridConfigFavourite) {
  677.                 $favouriteGridConfig = GridConfig::getById($favourite->getGridConfigId());
  679.                 if ($favouriteGridConfig instanceof GridConfig) {
  680.                     // Check if the grid config was shared globally if that is *not* the case we also not update
  681.                     if ((bool) $favouriteGridConfig->isShareGlobally() === false) {
  682.                         continue;
  683.                     }
  685.                     // Check if the user is the owner. If that is the case we do not update the favourite
  686.                     if ((int) $favouriteGridConfig->getOwnerId() === (int) $id) {
  687.                         continue;
  688.                     }
  689.                 }
  690.             }
  692.             $favourite = new GridConfigFavourite();
  693.             $favourite->setGridConfigId($gridConfig->getId());
  694.             $favourite->setClassId($gridConfig->getClassId());
  695.             $favourite->setObjectId(0);
  696.             $favourite->setOwnerId($id);
  697.             $favourite->setType($gridConfig->getType());
  698.             $favourite->setSearchType($gridConfig->getSearchType());
  699.             $favourite->save();
  700.         }
  701.     }
  703.     /**
  704.      * @Route("/get-export-jobs", name="pimcore_admin_asset_assethelper_getexportjobs", methods={"GET"})
  705.      *
  706.      * @param Request $request
  707.      * @param GridHelperService $gridHelperService
  708.      *
  709.      * @return JsonResponse
  710.      */
  711.     public function getExportJobsAction(Request $request, GridHelperService $gridHelperService)
  712.     {
  713.         $allParams = array_merge($request->request->all(), $request->query->all());
  714.         $list = $gridHelperService->prepareAssetListingForGrid($allParams, $this->getAdminUser());
  716.         if (empty($ids = $allParams['ids'] ?? '')) {
  717.             $ids = $list->loadIdList();
  718.         }
  720.         $jobs = array_chunk($ids, 20);
  722.         $fileHandle = uniqid('asset-export-');
  723.         file_put_contents($this->getCsvFile($fileHandle), '');
  725.         return $this->adminJson(['success' => true, 'jobs' => $jobs, 'fileHandle' => $fileHandle]);
  726.     }
  728.     /**
  729.      * @Route("/do-export", name="pimcore_admin_asset_assethelper_doexport", methods={"POST"})
  730.      *
  731.      * @param Request $request
  732.      * @param LocaleServiceInterface $localeService
  733.      *
  734.      * @return JsonResponse
  735.      */
  736.     public function doExportAction(Request $request, LocaleServiceInterface $localeService)
  737.     {
  738.         $fileHandle = \Pimcore\File::getValidFilename($request->get('fileHandle'));
  739.         $ids = $request->get('ids');
  740.         $settings = $request->get('settings');
  741.         $settings = json_decode($settings, true);
  742.         $delimiter = $settings['delimiter'] ?? ';';
  743.         $language = str_replace('default', '', $request->get('language'));
  745.         $list = new Asset\Listing();
  747.         $quotedIds = [];
  748.         foreach ($ids as $id) {
  749.             $quotedIds[] = $list->quote($id);
  750.         }
  752.         $list->setCondition('id IN (' . implode(',', $quotedIds) . ')');
  753.         $list->setOrderKey(' FIELD(id, ' . implode(',', $quotedIds) . ')', false);
  755.         $fields = $request->get('fields');
  757.         $addTitles = $request->get('initial');
  759.         $csv = $this->getCsvData($request, $language, $list, $fields, $addTitles);
  761.         $fp = fopen($this->getCsvFile($fileHandle), 'a');
  763.         $firstLine = true;
  764.         foreach ($csv as $line) {
  765.             if ($addTitles && $firstLine) {
  766.                 $firstLine = false;
  767.                 $line = implode($delimiter, $line) . "\r\n";
  768.                 fwrite($fp, $line);
  769.             } else {
  770.                 fwrite($fp, implode($delimiter, array_map([$this, 'encodeFunc'], $line)) . "\r\n");
  771.             }
  772.         }
  774.         fclose($fp);
  776.         return $this->adminJson(['success' => true]);
  777.     }
  779.     public function encodeFunc($value)
  780.     {
  781.         $value = str_replace('"', '""', $value);
  782.         //force wrap value in quotes and return
  783.         return '"' . $value . '"';
  784.     }
  786.     /**
  787.      * @param Request $request
  788.      * @param string $language
  789.      * @param Asset\Listing $list
  790.      * @param array $fields
  791.      * @param bool $addTitles
  792.      *
  793.      * @return array
  794.      */
  795.     protected function getCsvData(Request $request, $language, $list, $fields, $addTitles = true)
  796.     {
  797.         //create csv
  798.         $csv = [];
  800.         $unsupportedFields = ['preview~system', 'size~system'];
  801.         $fields = array_diff($fields, $unsupportedFields);
  803.         if ($addTitles) {
  804.             $columns = $fields;
  805.             foreach ($columns as $columnIdx => $columnKey) {
  806.                 $columns[$columnIdx] = '"' . $columnKey . '"';
  807.             }
  808.             $csv[] = $columns;
  809.         }
  811.         foreach ($list->load() as $asset) {
  812.             if ($fields) {
  813.                 $dataRows = [];
  814.                 foreach ($fields as $field) {
  815.                     $fieldDef = explode('~', $field);
  816.                     $getter = 'get' . ucfirst($fieldDef[0]);
  818.                     if (isset($fieldDef[1])) {
  819.                         if ($fieldDef[1] == 'system' && method_exists($asset, $getter)) {
  820.                             $data = $asset->$getter($language);
  821.                             if(is_numeric($data) && $data > 1000000000){
  822.                               $data = date("Y-m-d H:i:s", $data);
  823.                             }
  825.                         } else {
  826.                             $fieldDef[1] = str_replace('none', '', $fieldDef[1]);
  827.                             $data = $asset->getMetadata($fieldDef[0], $fieldDef[1], true);
  828.                         }
  829.                     } else {
  830.                         $data = $asset->getMetadata($field, $language, true);
  831.                     }
  833.                     if ($data instanceof Element\ElementInterface) {
  834.                         $data = $data->getRealFullPath();
  835.                     }
  836.                     $dataRows[] = $data;
  837.                 }
  838.                 $dataRows = Element\Service::escapeCsvRecord($dataRows);
  839.                 $csv[] = $dataRows;
  840.             }
  841.         }
  843.         return $csv;
  844.     }
  846.     /**
  847.      * @param Request $request
  848.      *
  849.      * @return mixed|string
  850.      */
  851.     protected function extractLanguage(Request $request)
  852.     {
  853.         $requestedLanguage = $request->get('language');
  854.         if ($requestedLanguage) {
  855.             if ($requestedLanguage != 'default') {
  856.                 $request->setLocale($requestedLanguage);
  857.             }
  858.         } else {
  859.             $requestedLanguage = $request->getLocale();
  860.         }
  862.         return $requestedLanguage;
  863.     }
  865.     /**
  866.      * @param string $fileHandle
  867.      *
  868.      * @return string
  869.      */
  870.     protected function getCsvFile($fileHandle)
  871.     {
  872.         return PIMCORE_SYSTEM_TEMP_DIRECTORY . '/' . $fileHandle . '.csv';
  873.     }
  875.     /**
  876.      * @Route("/download-csv-file", name="pimcore_admin_asset_assethelper_downloadcsvfile", methods={"GET"})
  877.      *
  878.      * @param Request $request
  879.      *
  880.      * @return BinaryFileResponse
  881.      */
  882.     public function downloadCsvFileAction(Request $request)
  883.     {
  884.         $fileHandle = \Pimcore\File::getValidFilename($request->get('fileHandle'));
  885.         $csvFile = $this->getCsvFile($fileHandle);
  886.         if (file_exists($csvFile)) {
  887.             $response = new BinaryFileResponse($csvFile);
  888.             $response->headers->set('Content-Type', 'application/csv');
  889.             $response->setContentDisposition(ResponseHeaderBag::DISPOSITION_ATTACHMENT, 'export.csv');
  890.             $response->deleteFileAfterSend(true);
  892.             return $response;
  893.         }
  895.         throw $this->createNotFoundException('CSV file not found');
  896.     }
  898.     /**
  899.      * @Route("/download-xlsx-file", name="pimcore_admin_asset_assethelper_downloadxlsxfile", methods={"GET"})
  900.      *
  901.      * @param Request $request
  902.      *
  903.      * @return BinaryFileResponse
  904.      */
  905.     public function downloadXlsxFileAction(Request $request)
  906.     {
  907.         $fileHandle = \Pimcore\File::getValidFilename($request->get('fileHandle'));
  908.         $csvFile = $this->getCsvFile($fileHandle);
  909.         if (file_exists($csvFile)) {
  910.             $csvReader = new Csv();
  911.             $csvReader->setDelimiter(';');
  912.             $csvReader->setSheetIndex(0);
  914.             $spreadsheet = $csvReader->load($csvFile);
  915.             $writer = new Xlsx($spreadsheet);
  916.             $xlsxFilename = PIMCORE_SYSTEM_TEMP_DIRECTORY. '/' .$fileHandle. '.xlsx';
  917.             $writer->save($xlsxFilename);
  919.             $response = new BinaryFileResponse($xlsxFilename);
  920.             $response->headers->set('Content-Type', 'application/xlsx');
  921.             $response->setContentDisposition(ResponseHeaderBag::DISPOSITION_ATTACHMENT, 'export.xlsx');
  922.             $response->deleteFileAfterSend(true);
  924.             return $response;
  925.         }
  927.         throw $this->createNotFoundException('XLSX file not found');
  928.     }
  930.     /**
  931.      * @Route("/get-metadata-for-column-config", name="pimcore_admin_asset_assethelper_getmetadataforcolumnconfig", methods={"GET"})
  932.      *
  933.      * @param Request $request
  934.      *
  935.      * @return JsonResponse
  936.      */
  937.     public function getMetadataForColumnConfigAction(Request $request)
  938.     {
  939.         $result = [];
  941.         //default metadata
  942.         $defaultMetadataNames = ['copyright', 'alt', 'title'];
  943.         foreach ($defaultMetadataNames as $defaultMetadata) {
  944.             $defaultColumns[] = ['title' => $defaultMetadata, 'name' => $defaultMetadata, 'datatype' => 'data', 'fieldtype' => 'input'];
  945.         }
  946.         $result['defaultColumns']['nodeLabel'] = 'default_metadata';
  947.         $result['defaultColumns']['nodeType'] = 'image';
  948.         $result['defaultColumns']['children'] = $defaultColumns;
  950.         //predefined metadata
  951.         $list = Metadata\Predefined\Listing::getByTargetType('asset');
  952.         $metadataItems = [];
  953.         $tmp = [];
  954.         foreach ($list as $item) {
  955.             //only allow unique metadata columns with subtypes
  956.             $uniqueKey = $item->getName().'_'.$item->getTargetSubtype();
  957.             if (!in_array($uniqueKey, $tmp) && !in_array($item->getName(), $defaultMetadataNames)) {
  958.                 $tmp[] = $uniqueKey;
  959.                 $item->expand();
  960.                 $metadataItems[] = [
  961.                     'title' => $item->getName(),
  962.                     'name' => $item->getName(),
  963.                     'subtype' => $item->getTargetSubtype(),
  964.                     'datatype' => 'data',
  965.                     'fieldtype' => $item->getType(),
  966.                     'config' => $item->getConfig(),
  967.                 ];
  968.             }
  969.         }
  971.         $result['metadataColumns']['children'] = $metadataItems;
  972.         $result['metadataColumns']['nodeLabel'] = 'predefined_metadata';
  973.         $result['metadataColumns']['nodeType'] = 'metadata';
  975.         //system columns
  976.         $systemColumnNames = Asset\Service::GRID_SYSTEM_COLUMNS;
  977.         $systemColumns = [];
  978.         foreach ($systemColumnNames as $systemColumn) {
  979.             $systemColumns[] = ['title' => $systemColumn, 'name' => $systemColumn, 'datatype' => 'data', 'fieldtype' => 'system'];
  980.         }
  981.         $result['systemColumns']['nodeLabel'] = 'system_columns';
  982.         $result['systemColumns']['nodeType'] = 'system';
  983.         $result['systemColumns']['children'] = $systemColumns;
  985.         return $this->adminJson($result);
  986.     }
  988.     /**
  989.      * @Route("/get-batch-jobs", name="pimcore_admin_asset_assethelper_getbatchjobs", methods={"GET"})
  990.      *
  991.      * @param Request $request
  992.      *
  993.      * @return JsonResponse
  994.      */
  995.     public function getBatchJobsAction(Request $request, GridHelperService $gridHelperService)
  996.     {
  997.         if ($request->get('language')) {
  998.             $request->setLocale($request->get('language'));
  999.         }
  1001.         $allParams = array_merge($request->request->all(), $request->query->all());
  1002.         $list = $gridHelperService->prepareAssetListingForGrid($allParams, $this->getAdminUser());
  1004.         $jobs = $list->loadIdList();
  1006.         return $this->adminJson(['success' => true, 'jobs' => $jobs]);
  1007.     }
  1009.     /**
  1010.      * @Route("/batch", name="pimcore_admin_asset_assethelper_batch", methods={"PUT"})
  1011.      *
  1012.      * @param Request $request
  1013.      * @param EventDispatcherInterface $eventDispatcher
  1014.      *
  1015.      * @return JsonResponse
  1016.      */
  1017.     public function batchAction(Request $request, EventDispatcherInterface $eventDispatcher)
  1018.     {
  1019.         try {
  1020.             if ($request->get('data')) {
  1021.                 $loader = \Pimcore::getContainer()->get('pimcore.implementation_loader.asset.metadata.data');
  1023.                 $data = $this->decodeJson($request->get('data'), true);
  1025.                 $updateEvent = new GenericEvent($this, [
  1026.                     'data' => $data,
  1027.                     'processed' => false,
  1028.                 ]);
  1030.                 $eventDispatcher->dispatch($updateEvent, AdminEvents::ASSET_LIST_BEFORE_BATCH_UPDATE);
  1032.                 $processed = $updateEvent->getArgument('processed');
  1034.                 if ($processed) {
  1035.                     return $this->adminJson(['success' => true]);
  1036.                 }
  1038.                 $language = null;
  1039.                 if (isset($data['language'])) {
  1040.                     $language = $data['language'] != 'default' ? $data['language'] : null;
  1041.                 }
  1043.                 $asset = Asset::getById($data['job']);
  1045.                 if ($asset) {
  1046.                     if (!$asset->isAllowed('publish')) {
  1047.                         throw new \Exception("Permission denied. You don't have the rights to save this asset.");
  1048.                     }
  1050.                     $metadata = $asset->getMetadata(null, null, false, true);
  1051.                     $dirty = false;
  1053.                     $name = $data['name'];
  1054.                     $value = $data['value'];
  1056.                     if ($data['valueType'] == 'object') {
  1057.                         $value = $this->decodeJson($value);
  1058.                     }
  1060.                     $fieldDef = explode('~', $name);
  1061.                     $name = $fieldDef[0];
  1062.                     if (count($fieldDef) > 1) {
  1063.                         $language = ($fieldDef[1] == 'none' ? '' : $fieldDef[1]);
  1064.                     }
  1066.                     foreach ($metadata as $idx => &$em) {
  1067.                         if ($em['name'] == $name && $em['language'] == $language) {
  1068.                             try {
  1069.                                 $dataImpl = $loader->build($em['type']);
  1070.                                 $value = $dataImpl->getDataFromListfolderGrid($value, $em);
  1071.                             } catch (UnsupportedException $le) {
  1072.                                 Logger::error('could not resolve metadata implementation for ' . $em['type']);
  1073.                             }
  1074.                             $em['data'] = $value;
  1075.                             $dirty = true;
  1077.                             break;
  1078.                         }
  1079.                     }
  1081.                     if (!$dirty) {
  1082.                         $defaulMetadata = ['title', 'alt', 'copyright'];
  1083.                         if (in_array($name, $defaulMetadata)) {
  1084.                             $newEm = [
  1085.                                 'name' => $name,
  1086.                                 'language' => $language,
  1087.                                 'type' => 'input',
  1088.                                 'data' => $value,
  1089.                             ];
  1091.                             try {
  1092.                                 $dataImpl = $loader->build($newEm['type']);
  1093.                                 $newEm['data'] = $dataImpl->getDataFromListfolderGrid($value, $newEm);
  1094.                             } catch (UnsupportedException $le) {
  1095.                                 Logger::error('could not resolve metadata implementation for ' . $newEm['type']);
  1096.                             }
  1098.                             $metadata[] = $newEm;
  1099.                             $dirty = true;
  1100.                         } else {
  1101.                             $predefined = Metadata\Predefined::getByName($name);
  1102.                             if ($predefined && (empty($predefined->getTargetSubtype())
  1103.                                     || $predefined->getTargetSubtype() == $asset->getType())) {
  1104.                                 $newEm = [
  1105.                                     'name' => $name,
  1106.                                     'language' => $language,
  1107.                                     'type' => $predefined->getType(),
  1108.                                     'data' => $value,
  1109.                                 ];
  1111.                                 try {
  1112.                                     $dataImpl = $loader->build($newEm['type']);
  1113.                                     $newEm['data'] = $dataImpl->getDataFromListfolderGrid($value, $newEm);
  1114.                                 } catch (UnsupportedException $le) {
  1115.                                     Logger::error('could not resolve metadata implementation for ' . $newEm['type']);
  1116.                                 }
  1118.                                 $metadata[] = $newEm;
  1120.                                 $dirty = true;
  1121.                             }
  1122.                         }
  1123.                     }
  1125.                     try {
  1126.                         if ($dirty) {
  1127.                             // $metadata = Asset\Service::minimizeMetadata($metadata, "grid");
  1128.                             $asset->setMetadataRaw($metadata);
  1129.                             $asset->save();
  1131.                             return $this->adminJson(['success' => true]);
  1132.                         }
  1133.                     } catch (\Exception $e) {
  1134.                         return $this->adminJson(['success' => false, 'message' => $e->getMessage()]);
  1135.                     }
  1136.                 } else {
  1137.                     Logger::debug('AssetHelperController::batchAction => There is no asset left to update.');
  1139.                     return $this->adminJson(['success' => false, 'message' => 'AssetHelperController::batchAction => There is no asset left to update.']);
  1140.                 }
  1141.             }
  1142.         } catch (\Exception $e) {
  1143.             Logger::err($e);
  1145.             return $this->adminJson(['success' => false, 'message' => $e->getMessage()]);
  1146.         }
  1148.         return $this->adminJson(['success' => false, 'message' => 'something went wrong.']);
  1149.     }
  1150. }