vendor/pimcore/advanced-object-search/src/Controller/AdminController.php line 36

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 AdvancedObjectSearchBundle\Controller;
  18. use AdvancedObjectSearchBundle\Event\AdvancedObjectSearchEvents;
  19. use AdvancedObjectSearchBundle\Event\FilterListingEvent;
  20. use AdvancedObjectSearchBundle\Model\SavedSearch;
  21. use AdvancedObjectSearchBundle\Service;
  22. use Pimcore\Bundle\AdminBundle\Helper\QueryParams;
  23. use Pimcore\Db;
  24. use Pimcore\Model\DataObject;
  25. use Pimcore\Tool;
  26. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  27. use Symfony\Component\HttpFoundation\Request;
  28. use Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface;
  29. use Symfony\Component\Routing\Annotation\Route;
  31. /**
  32.  * Class AdminController
  33.  *
  34.  * @Route("/admin")
  35.  */
  36. class AdminController extends \Pimcore\Bundle\AdminBundle\Controller\AdminController
  37. {
  38.     /**
  39.      * @param Request $request
  40.      * @Route("/get-fields")
  41.      */
  42.     public function getFieldsAction(Request $request, Service $service)
  43.     {
  44.         $type = strip_tags($request->get('type'));
  46.         $allowInheritance = false;
  48.         switch ($type) {
  49.             case 'class':
  50.                 $classId = strip_tags($request->get('class_id'));
  51.                 $definition = DataObject\ClassDefinition::getById($classId);
  52.                 $allowInheritance = $definition->getAllowInherit();
  53.                 break;
  55.             case 'fieldcollection':
  56.                 $key = strip_tags($request->get('key'));
  57.                 $definition = DataObject\Fieldcollection\Definition::getByKey($key);
  58.                 $allowInheritance = false;
  59.                 break;
  61.             case 'objectbrick':
  62.                 $key = strip_tags($request->get('key'));
  63.                 $definition = DataObject\Objectbrick\Definition::getByKey($key);
  65.                 $classId = strip_tags($request->get('class_id'));
  66.                 $classDefinition = DataObject\ClassDefinition::getById($classId);
  67.                 $allowInheritance = $classDefinition->getAllowInherit();
  69.                 break;
  71.             default:
  72.                 throw new \Exception("Invalid type '$type''");
  74.         }
  76.         $fieldSelectionInformationEntries = $service->getFieldSelectionInformationForClassDefinition($definition, $allowInheritance);
  78.         $fields = [];
  79.         foreach ($fieldSelectionInformationEntries as $entry) {
  80.             $fields[] = $entry->toArray();
  81.         }
  83.         return $this->adminJson(['data' => $fields]);
  84.     }
  86.     /**
  87.      * @param Request $request
  88.      * @Route("/grid-proxy")
  89.      */
  90.     public function gridProxyAction(Request $request, Service $service, EventDispatcherInterface $eventDispatcher)
  91.     {
  92.         $requestedLanguage = $request->get('language');
  93.         if ($requestedLanguage) {
  94.             if ($requestedLanguage != 'default') {
  95.                 $request->setLocale($requestedLanguage);
  96.             }
  97.         } else {
  98.             $requestedLanguage = $request->getLocale();
  99.         }
  101.         if ($request->get('data')) {
  102.             return $this->forward('Pimcore\Bundle\AdminBundle\Controller\Admin\DataObject\DataObjectController:gridProxyAction', [], $request->query->all());
  103.         } else {
  105.             // get list of objects
  106.             $class = DataObject\ClassDefinition::getById($request->get('classId'));
  107.             $className = $class->getName();
  109.             $fields = [];
  110.             if ($request->get('fields')) {
  111.                 $fields = $request->get('fields');
  112.             }
  114.             $start = 0;
  115.             $limit = 20;
  116.             if ($request->get('limit')) {
  117.                 $limit = $request->get('limit');
  118.             }
  119.             if ($request->get('start')) {
  120.                 $start = $request->get('start');
  121.             }
  123.             $listClass = '\\Pimcore\\Model\\DataObject\\' . ucfirst($className) . '\\Listing';
  125.             //get ID list from ES Service
  126.             $data = json_decode($request->get('filter'), true);
  127.             $results = $service->doFilter($data['classId'], $data['conditions']['filters'], $data['conditions']['fulltextSearchTerm'], $start, $limit);
  129.             $total = $service->extractTotalCountFromResult($results);
  130.             $ids = $service->extractIdsFromResult($results);
  132.             /**
  133.              * @var \Pimcore\Model\DataObject\Listing $list
  134.              */
  135.             $list = new $listClass();
  136.             $list->setObjectTypes(['object', 'folder', 'variant']);
  138.             $conditionFilters = [];
  139.             if (!$this->getAdminUser()->isAdmin()) {
  140.                 $userIds = $this->getAdminUser()->getRoles();
  141.                 $userIds[] = $this->getAdminUser()->getId();
  142.                 $conditionFilters[] = ' (
  143.                                                     (select list from users_workspaces_object where userId in (' . implode(',', $userIds) . ') and LOCATE(CONCAT(o_path,o_key),cpath)=1  ORDER BY LENGTH(cpath) DESC LIMIT 1)=1
  144.                                                     OR
  145.                                                     (select list from users_workspaces_object where userId in (' . implode(',', $userIds) . ') and LOCATE(cpath,CONCAT(o_path,o_key))=1  ORDER BY LENGTH(cpath) DESC LIMIT 1)=1
  146.                                                  )';
  147.             }
  149.             if (!empty($ids)) {
  150.                 $conditionFilters[] = 'o_id IN (' . implode(',', $ids) . ')';
  151.                 //$list->setCondition("o_id IN (" . implode(",", $ids) . ")");
  152.                 $list->setOrderKey(' FIELD(o_id, ' . implode(',', $ids) . ')', false);
  153.             } else {
  154.                 $conditionFilters[] = '1=2';
  155.                 //$list->setCondition("1=2");
  156.             }
  158.             $list->setCondition(implode(' AND ', $conditionFilters));
  160.             /* @phpstan-ignore-next-line */
  161.             $eventDispatcher->dispatch(new FilterListingEvent($list), AdvancedObjectSearchEvents::LISTING_FILER);
  163.             $list->load();
  165.             $objects = [];
  166.             foreach ($list->getObjects() as $object) {
  167.                 $o = DataObject\Service::gridObjectData($object, $fields, $requestedLanguage);
  168.                 $objects[] = $o;
  169.             }
  171.             return $this->adminJson(['data' => $objects, 'success' => true, 'total' => $total]);
  172.         }
  173.     }
  175.     /**
  176.      * @param Request $request
  177.      * @Route("/get-batch-jobs")
  178.      */
  179.     public function getBatchJobsAction(Request $request, Service $service)
  180.     {
  181.         if ($request->get('language')) {
  182.             $request->setLocale($request->get('language'));
  183.         }
  185.         $class = DataObject\ClassDefinition::getById($request->get('classId'));
  187.         //get ID list from ES Service
  188.         $data = json_decode($request->get('filter'), true);
  189.         $results = $service->doFilter($data['classId'], $data['conditions']['filters'] ?? [], $data['conditions']['fulltextSearchTerm'] ?? [], null, 9999);
  191.         $ids = $service->extractIdsFromResult($results);
  193.         $className = $class->getName();
  194.         $listClass = '\\Pimcore\\Model\\DataObject\\' . ucfirst($className) . '\\Listing';
  195.         $list = new $listClass();
  196.         $list->setObjectTypes(['object', 'folder', 'variant']);
  197.         $list->setCondition('o_id IN (' . implode(',', $ids) . ')');
  198.         $list->setOrderKey(' FIELD(o_id, ' . implode(',', $ids) . ')', false);
  200.         if ($request->get('objecttype')) {
  201.             $list->setObjectTypes([$request->get('objecttype')]);
  202.         }
  204.         $jobs = $list->loadIdList();
  206.         return $this->adminJson(['success' => true, 'jobs' => $jobs]);
  207.     }
  209.     protected function getCsvFile($fileHandle)
  210.     {
  211.         return PIMCORE_SYSTEM_TEMP_DIRECTORY . '/' . $fileHandle . '.csv';
  212.     }
  214.     /**
  215.      * @param Request $request
  216.      * @Route("/get-export-jobs")
  217.      */
  218.     public function getExportJobsAction(Request $request, Service $service)
  219.     {
  220.         if ($request->get('language')) {
  221.             $request->setLocale($request->get('language'));
  222.         }
  224.         $data = json_decode($request->get('filter'), true);
  226.         if (empty($ids = $request->get('ids', false))) {
  227.             $results = $service->doFilter(
  228.                 $data['classId'],
  229.                 $data['conditions']['filters'],
  230.                 $data['conditions']['fulltextSearchTerm'],
  231.                 0,
  232.                 9999 // elastic search cannot export more results than 9999 in one request
  233.             );
  235.             //get ID list from ES Service
  236.             $ids = $service->extractIdsFromResult($results);
  237.         }
  239.         $jobs = array_chunk($ids, 20);
  241.         $fileHandle = uniqid('export-');
  242.         file_put_contents($this->getCsvFile($fileHandle), '');
  244.         return $this->adminJson(['success' => true, 'jobs' => $jobs, 'fileHandle' => $fileHandle]);
  245.     }
  247.     /**
  248.      * @param Request $request
  249.      * @Route("/save")
  250.      */
  251.     public function saveAction(Request $request)
  252.     {
  253.         $data = $request->get('data');
  254.         $data = json_decode($data);
  256.         $id = (intval($request->get('id')));
  257.         if ($id) {
  258.             $savedSearch = SavedSearch::getById($id);
  259.         } else {
  260.             $savedSearch = new SavedSearch();
  261.             $savedSearch->setOwner($this->getAdminUser());
  262.         }
  264.         $savedSearch->setName($data->settings->name);
  265.         $savedSearch->setDescription($data->settings->description);
  266.         $savedSearch->setCategory($data->settings->category);
  267.         $savedSearch->setSharedUserIds(array_merge($data->settings->shared_users, $data->settings->shared_roles));
  268.         $savedSearch->setShareGlobally($this->getAdminUser()->isAdmin() && $data->settings->share_globally);
  270.         $config = ['classId' => $data->classId, 'gridConfig' => $data->gridConfig, 'conditions' => $data->conditions];
  271.         $savedSearch->setConfig(json_encode($config));
  273.         $savedSearch->save();
  275.         return $this->adminJson(['success' => true, 'id' => $savedSearch->getId()]);
  276.     }
  278.     /**
  279.      * @param Request $request
  280.      * @Route("/delete")
  281.      */
  282.     public function deleteAction(Request $request)
  283.     {
  284.         $id = intval($request->get('id'));
  285.         $savedSearch = SavedSearch::getById($id);
  287.         if ($savedSearch) {
  288.             $savedSearch->delete();
  290.             return $this->adminJson(['success' => true, 'id' => $savedSearch->getId()]);
  291.         } else {
  292.             return $this->adminJson(['success' => false, 'message' => "Saved Search with $id not found."]);
  293.         }
  294.     }
  296.     /**
  297.      * @param Request $request
  298.      * @Route("/find")
  299.      */
  300.     public function findAction(Request $request)
  301.     {
  302.         $user = $this->getAdminUser();
  304.         $query = $request->get('query');
  305.         if ($query == '*') {
  306.             $query = '';
  307.         }
  309.         $query = str_replace('%', '*', $query);
  311.         $offset = intval($request->get('start'));
  312.         $limit = intval($request->get('limit'));
  314.         $offset = $offset ? $offset : 0;
  315.         $limit = $limit ? $limit : 50;
  317.         $db = Db::get();
  318.         $searcherList = new SavedSearch\Listing();
  319.         $conditionParts = [];
  320.         $conditionParams = [];
  322.         //filter for current user
  323.         $userIds = [$user->getId()];
  324.         $userIds = array_merge($userIds, $user->getRoles());
  325.         $userIds = implode('|', $userIds);
  326.         $conditionParts[] = '(shareGlobally = 1 OR ownerId = ? OR sharedUserIds REGEXP ?)';
  327.         $conditionParams[] = $user->getId();
  328.         $conditionParams[] = ',(' . $userIds . '),';
  330.         //filter for query
  331.         if (!empty($query)) {
  332.             $conditionParts[] = sprintf('(%s LIKE ? OR %s LIKE ? OR %s LIKE ?)',
  333.                 $db->quoteIdentifier('name'),
  334.                 $db->quoteIdentifier('description'),
  335.                 $db->quoteIdentifier('category')
  336.             );
  337.             $conditionParams[] = '%' . $query . '%';
  338.             $conditionParams[] = '%' . $query . '%';
  339.             $conditionParams[] = '%' . $query . '%';
  340.         }
  342.         $condition = implode(' AND ', $conditionParts);
  343.         $searcherList->setCondition($condition, $conditionParams);
  345.         $searcherList->setOffset($offset);
  346.         $searcherList->setLimit($limit);
  348.         $sortingSettings = QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  349.         if ($sortingSettings['orderKey']) {
  350.             $searcherList->setOrderKey($sortingSettings['orderKey']);
  351.         }
  352.         if ($sortingSettings['order']) {
  353.             $searcherList->setOrder($sortingSettings['order']);
  354.         }
  356.         $results = []; //$searcherList->load();
  357.         foreach ($searcherList->load() as $result) {
  358.             $results[] = [
  359.                 'id' => $result->getId(),
  360.                 'name' => $result->getName(),
  361.                 'description' => $result->getDescription(),
  362.                 'category' => $result->getCategory(),
  363.                 'owner' => $result->getOwner() ? $result->getOwner()->getUsername() . ' (' . $result->getOwner()->getFirstname() . ' ' . $result->getOwner()->getLastName() . ')' : '',
  364.                 'ownerId' => $result->getOwnerId()
  365.             ];
  366.         }
  368.         // only get the real total-count when the limit parameter is given otherwise use the default limit
  369.         if ($request->get('limit')) {
  370.             $totalMatches = $searcherList->getTotalCount();
  371.         } else {
  372.             $totalMatches = count($results);
  373.         }
  375.         return $this->adminJson(['data' => $results, 'success' => true, 'total' => $totalMatches]);
  376.     }
  378.     /**
  379.      * @param Request $request
  380.      * @Route("/load-search")
  381.      */
  382.     public function loadSearchAction(Request $request)
  383.     {
  384.         $id = intval($request->get('id'));
  385.         $savedSearch = SavedSearch::getById($id);
  386.         if ($savedSearch) {
  387.             $config = json_decode($savedSearch->getConfig(), true);
  388.             $classDefinition = DataObject\ClassDefinition::getById($config['classId']);
  390.             if (!empty($config['gridConfig']['columns'])) {
  391.                 $helperColumns = [];
  393.                 foreach ($config['gridConfig']['columns'] as &$column) {
  394.                     if (!($column['isOperator'] ?? false)) {
  395.                         $fieldDefinition = $classDefinition->getFieldDefinition($column['key']);
  396.                         if ($fieldDefinition) {
  397.                             $width = isset($column['layout']['width']) ? $column['layout']['width'] : null;
  398.                             $column['layout'] = json_decode(json_encode($fieldDefinition), true);
  399.                             if ($width) {
  400.                                 $column['layout']['width'] = $width;
  401.                             }
  402.                         }
  403.                     }
  405.                     if (!DataObject\Service::isHelperGridColumnConfig($column['key'])) {
  406.                         continue;
  407.                     }
  409.                     // columnconfig has to be a stdclass
  410.                     $helperColumns[$column['key']] = json_decode(json_encode($column));
  411.                 }
  413.                 // store the saved search columns in the session, otherwise they won't work
  414.                 Tool\Session::useSession(function (AttributeBagInterface $session) use ($helperColumns) {
  415.                     $existingColumns = $session->get('helpercolumns', []);
  416.                     $helperColumns = array_merge($existingColumns, $helperColumns);
  417.                     $session->set('helpercolumns', $helperColumns);
  418.                 }, 'pimcore_gridconfig');
  419.             }
  421.             return $this->adminJson([
  422.                 'id' => $savedSearch->getId(),
  423.                 'classId' => $config['classId'],
  424.                 'settings' => [
  425.                     'name' => $savedSearch->getName(),
  426.                     'description' => $savedSearch->getDescription(),
  427.                     'category' => $savedSearch->getCategory(),
  428.                     'sharedUserIds' => $savedSearch->getSharedUserIds(),
  429.                     'shareGlobally' => $savedSearch->getShareGlobally(),
  430.                     'isOwner' => $savedSearch->getOwnerId() == $this->getAdminUser()->getId(),
  431.                     'hasShortCut' => $savedSearch->isInShortCutsForUser($this->getAdminUser())
  432.                 ],
  433.                 'conditions' => $config['conditions'],
  434.                 'gridConfig' => $config['gridConfig']
  435.             ]);
  436.         } else {
  437.             return $this->adminJson(['success' => false, 'message' => "Saved Search with $id not found."]);
  438.         }
  439.     }
  441.     /**
  442.      * @param Request $request
  443.      * @Route("/load-short-cuts")
  444.      */
  445.     public function loadShortCutsAction(Request $request)
  446.     {
  447.         $list = new SavedSearch\Listing();
  448.         $list->setCondition(
  449.             '(shareGlobally = ? OR ownerId = ? OR sharedUserIds LIKE ?) AND shortCutUserIds LIKE ?',
  450.             [
  451.                 true,
  452.                 $this->getAdminUser()->getId(),
  453.                 '%,' . $this->getAdminUser()->getId() . ',%',
  454.                 '%,' . $this->getAdminUser()->getId() . ',%'
  455.             ]
  456.         );
  457.         $list->load();
  459.         $entries = [];
  460.         foreach ($list->getSavedSearches() as $entry) {
  461.             $entries[] = [
  462.                 'id' => $entry->getId(),
  463.                 'name' => $entry->getName()
  464.             ];
  465.         }
  467.         return $this->adminJson(['entries' => $entries]);
  468.     }
  470.     /**
  471.      * @param Request $request
  472.      * @Route("/toggle-short-cut")
  473.      */
  474.     public function toggleShortCutAction(Request $request)
  475.     {
  476.         $id = intval($request->get('id'));
  477.         $savedSearch = SavedSearch::getById($id);
  478.         if ($savedSearch) {
  479.             $user = $this->getAdminUser();
  480.             if ($savedSearch->isInShortCutsForUser($user)) {
  481.                 $savedSearch->removeShortCutForUser($user);
  482.             } else {
  483.                 $savedSearch->addShortCutForUser($user);
  484.             }
  485.             $savedSearch->save();
  487.             return $this->adminJson(['success' => 'true', 'hasShortCut' => $savedSearch->isInShortCutsForUser($user)]);
  488.         } else {
  489.             return $this->adminJson(['success' => 'false']);
  490.         }
  491.     }
  493.     /**
  494.      * @param Request $request
  495.      * @Route("/get-users")
  496.      */
  497.     public function getUsersAction(Request $request)
  498.     {
  499.         $users = [];
  501.         // condition for users with groups having DAM permission
  502.         $condition = [];
  503.         $rolesList = new \Pimcore\Model\User\Role\Listing();
  504.         $rolesList->addConditionParam("CONCAT(',', permissions, ',') LIKE ?", '%,bundle_advancedsearch_search,%');
  505.         $rolesList->load();
  506.         $roles = $rolesList->getRoles();
  508.         foreach ($roles as $role) {
  509.             $condition[] = "CONCAT(',', roles, ',') LIKE '%," . $role->getId() . ",%'";
  510.         }
  512.         // get available user
  513.         $list = new \Pimcore\Model\User\Listing();
  515.         $condition[] = 'admin = 1';
  516.         $list->addConditionParam("((CONCAT(',', permissions, ',') LIKE ? ) OR " . implode(' OR ', $condition) . ')', '%,bundle_advancedsearch_search,%');
  517.         $list->addConditionParam('id != ?', $this->getAdminUser()->getId());
  518.         $list->load();
  519.         $userList = $list->getUsers();
  521.         foreach ($userList as $user) {
  522.             $users[] = [
  523.                 'id' => $user->getId(),
  524.                 'label' => $user->getName()
  525.             ];
  526.         }
  528.         return $this->adminJson(['success' => true, 'total' => count($users), 'data' => $users]);
  529.     }
  531.     /**
  532.      * @Route("/get-roles")
  533.      */
  534.     public function getRolesAction()
  535.     {
  536.         $roles = [];
  538.         $rolesList = new \Pimcore\Model\User\Role\Listing();
  539.         $rolesList->setCondition('type = "role"');
  540.         $rolesList->addConditionParam("CONCAT(',', permissions, ',') LIKE ?", '%,bundle_advancedsearch_search,%');
  541.         $rolesList->load();
  543.         foreach ($rolesList->getRoles() as $role) {
  544.             $roles[] = [
  545.                 'id' => $role->getId(),
  546.                 'label' => $role->getName()
  547.             ];
  548.         }
  550.         return $this->adminJson(['success' => true, 'total' => count($roles), 'data' => $roles]);
  551.     }
  553.     /**
  554.      * @param Request $request
  555.      * @Route("/check-index-status")
  556.      */
  557.     public function checkIndexStatusAction(Request $request, Service $service)
  558.     {
  559.         return $this->adminJson(['indexUptodate' => $service->updateQueueEmpty()]);
  560.     }
  561. }