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

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\Model\DataObject;
  24. use Pimcore\Tool;
  25. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  26. use Symfony\Component\HttpFoundation\Request;
  27. use Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface;
  28. use Symfony\Component\Routing\Annotation\Route;
  30. /**
  31.  * Class AdminController
  32.  *
  33.  * @Route("/admin")
  34.  */
  35. class AdminController extends \Pimcore\Bundle\AdminBundle\Controller\AdminController
  36. {
  37.     /**
  38.      * @param Request $request
  39.      * @Route("/get-fields")
  40.      */
  41.     public function getFieldsAction(Request $request, Service $service)
  42.     {
  43.         $type = strip_tags($request->get('type'));
  45.         $allowInheritance = false;
  47.         switch ($type) {
  48.             case 'class':
  49.                 $classId = strip_tags($request->get('class_id'));
  50.                 $definition = DataObject\ClassDefinition::getById($classId);
  51.                 $allowInheritance = $definition->getAllowInherit();
  52.                 break;
  54.             case 'fieldcollection':
  55.                 $key = strip_tags($request->get('key'));
  56.                 $definition = DataObject\Fieldcollection\Definition::getByKey($key);
  57.                 $allowInheritance = false;
  58.                 break;
  60.             case 'objectbrick':
  61.                 $key = strip_tags($request->get('key'));
  62.                 $definition = DataObject\Objectbrick\Definition::getByKey($key);
  64.                 $classId = strip_tags($request->get('class_id'));
  65.                 $classDefinition = DataObject\ClassDefinition::getById($classId);
  66.                 $allowInheritance = $classDefinition->getAllowInherit();
  68.                 break;
  70.             default:
  71.                 throw new \Exception("Invalid type '$type''");
  73.         }
  75.         $fieldSelectionInformationEntries = $service->getFieldSelectionInformationForClassDefinition($definition, $allowInheritance);
  77.         $fields = [];
  78.         foreach ($fieldSelectionInformationEntries as $entry) {
  79.             $fields[] = $entry->toArray();
  80.         }
  82.         return $this->adminJson(['data' => $fields]);
  83.     }
  85.     /**
  86.      * @param Request $request
  87.      * @Route("/grid-proxy")
  88.      */
  89.     public function gridProxyAction(Request $request, Service $service, EventDispatcherInterface $eventDispatcher)
  90.     {
  91.         $requestedLanguage = $request->get('language');
  92.         if ($requestedLanguage) {
  93.             if ($requestedLanguage != 'default') {
  94.                 $request->setLocale($requestedLanguage);
  95.             }
  96.         } else {
  97.             $requestedLanguage = $request->getLocale();
  98.         }
  100.         if ($request->get('data')) {
  101.             return $this->forward('PimcoreAdminBundle:Admin/DataObject/DataObject:gridProxy', [], $request->query->all());
  102.         } else {
  104.             // get list of objects
  105.             $class = DataObject\ClassDefinition::getById($request->get('classId'));
  106.             $className = $class->getName();
  108.             $fields = [];
  109.             if ($request->get('fields')) {
  110.                 $fields = $request->get('fields');
  111.             }
  113.             $start = 0;
  114.             $limit = 20;
  115.             if ($request->get('limit')) {
  116.                 $limit = $request->get('limit');
  117.             }
  118.             if ($request->get('start')) {
  119.                 $start = $request->get('start');
  120.             }
  122.             $listClass = '\\Pimcore\\Model\\DataObject\\' . ucfirst($className) . '\\Listing';
  124.             //get ID list from ES Service
  125.             $data = json_decode($request->get('filter'), true);
  126.             $results = $service->doFilter($data['classId'], $data['conditions']['filters'], $data['conditions']['fulltextSearchTerm'], $start, $limit);
  128.             $total = $service->extractTotalCountFromResult($results);
  129.             $ids = $service->extractIdsFromResult($results);
  131.             /**
  132.              * @var $list \Pimcore\Model\DataObject\Listing
  133.              */
  134.             $list = new $listClass();
  135.             $list->setObjectTypes(['object', 'folder', 'variant']);
  137.             $conditionFilters = [];
  138.             if (!$this->getAdminUser()->isAdmin()) {
  139.                 $userIds = $this->getAdminUser()->getRoles();
  140.                 $userIds[] = $this->getAdminUser()->getId();
  141.                 $conditionFilters[] .= ' (
  142.                                                     (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
  143.                                                     OR
  144.                                                     (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
  145.                                                  )';
  146.             }
  148.             if (!empty($ids)) {
  149.                 $conditionFilters[] = 'o_id IN (' . implode(',', $ids) . ')';
  150.                 //$list->setCondition("o_id IN (" . implode(",", $ids) . ")");
  151.                 $list->setOrderKey(' FIELD(o_id, ' . implode(',', $ids) . ')', false);
  152.             } else {
  153.                 $conditionFilters[] = '1=2';
  154.                 //$list->setCondition("1=2");
  155.             }
  157.             $list->setCondition(implode(' AND ', $conditionFilters));
  158.             $eventDispatcher->dispatch(new FilterListingEvent($list), AdvancedObjectSearchEvents::LISTING_FILER);
  160.             $list->load();
  162.             $objects = [];
  163.             foreach ($list->getObjects() as $object) {
  164.                 $o = DataObject\Service::gridObjectData($object, $fields, $requestedLanguage);
  165.                 $objects[] = $o;
  166.             }
  168.             return $this->adminJson(['data' => $objects, 'success' => true, 'total' => $total]);
  169.         }
  170.     }
  172.     /**
  173.      * @param Request $request
  174.      * @Route("/get-batch-jobs")
  175.      */
  176.     public function getBatchJobsAction(Request $request, Service $service)
  177.     {
  178.         if ($request->get('language')) {
  179.             $request->setLocale($request->get('language'));
  180.         }
  182.         $class = DataObject\ClassDefinition::getById($request->get('classId'));
  184.         //get ID list from ES Service
  185.         $data = json_decode($request->get('filter'), true);
  186.         $results = $service->doFilter($data['classId'], $data['conditions']['filters'] ?? [], $data['conditions']['fulltextSearchTerm'] ?? [], null, 9999);
  188.         $ids = $service->extractIdsFromResult($results);
  190.         $className = $class->getName();
  191.         $listClass = '\\Pimcore\\Model\\DataObject\\' . ucfirst($className) . '\\Listing';
  192.         $list = new $listClass();
  193.         $list->setObjectTypes(['object', 'folder', 'variant']);
  194.         $list->setCondition('o_id IN (' . implode(',', $ids) . ')');
  195.         $list->setOrderKey(' FIELD(o_id, ' . implode(',', $ids) . ')', false);
  197.         if ($request->get('objecttype')) {
  198.             $list->setObjectTypes([$request->get('objecttype')]);
  199.         }
  201.         $jobs = $list->loadIdList();
  203.         return $this->adminJson(['success' => true, 'jobs' => $jobs]);
  204.     }
  206.     protected function getCsvFile($fileHandle)
  207.     {
  208.         return PIMCORE_SYSTEM_TEMP_DIRECTORY . '/' . $fileHandle . '.csv';
  209.     }
  211.     /**
  212.      * @param Request $request
  213.      * @Route("/get-export-jobs")
  214.      */
  215.     public function getExportJobsAction(Request $request, Service $service)
  216.     {
  217.         if ($request->get('language')) {
  218.             $request->setLocale($request->get('language'));
  219.         }
  221.         $data = json_decode($request->get('filter'), true);
  223.         if (empty($ids = $request->get('ids', false))) {
  224.             $results = $service->doFilter(
  225.                 $data['classId'],
  226.                 $data['conditions']['filters'],
  227.                 $data['conditions']['fulltextSearchTerm'],
  228.                 0,
  229.                 9999 // elastic search cannot export more results than 9999 in one request
  230.             );
  232.             //get ID list from ES Service
  233.             $ids = $service->extractIdsFromResult($results);
  234.         }
  236.         $jobs = array_chunk($ids, 20);
  238.         $fileHandle = uniqid('export-');
  239.         file_put_contents($this->getCsvFile($fileHandle), '');
  241.         return $this->adminJson(['success' => true, 'jobs' => $jobs, 'fileHandle' => $fileHandle]);
  242.     }
  244.     /**
  245.      * @param Request $request
  246.      * @Route("/save")
  247.      */
  248.     public function saveAction(Request $request)
  249.     {
  250.         $data = $request->get('data');
  251.         $data = json_decode($data);
  253.         $id = (intval($request->get('id')));
  254.         if ($id) {
  255.             $savedSearch = SavedSearch::getById($id);
  256.         } else {
  257.             $savedSearch = new SavedSearch();
  258.             $savedSearch->setOwner($this->getAdminUser());
  259.         }
  261.         $savedSearch->setName($data->settings->name);
  262.         $savedSearch->setDescription($data->settings->description);
  263.         $savedSearch->setCategory($data->settings->category);
  264.         $savedSearch->setSharedUserIds(array_merge($data->settings->shared_users, $data->settings->shared_roles));
  265.         $savedSearch->setShareGlobally($data->settings->share_globally && $this->getAdminUser()->isAdmin());
  267.         $config = ['classId' => $data->classId, 'gridConfig' => $data->gridConfig, 'conditions' => $data->conditions];
  268.         $savedSearch->setConfig(json_encode($config));
  270.         $savedSearch->save();
  272.         return $this->adminJson(['success' => true, 'id' => $savedSearch->getId()]);
  273.     }
  275.     /**
  276.      * @param Request $request
  277.      * @Route("/delete")
  278.      */
  279.     public function deleteAction(Request $request)
  280.     {
  281.         $id = intval($request->get('id'));
  282.         $savedSearch = SavedSearch::getById($id);
  284.         if ($savedSearch) {
  285.             $savedSearch->delete();
  287.             return $this->adminJson(['success' => true, 'id' => $savedSearch->getId()]);
  288.         } else {
  289.             return $this->adminJson(['success' => false, 'message' => "Saved Search with $id not found."]);
  290.         }
  291.     }
  293.     /**
  294.      * @param Request $request
  295.      * @Route("/find")
  296.      */
  297.     public function findAction(Request $request)
  298.     {
  299.         $user = $this->getAdminUser();
  301.         $query = $request->get('query');
  302.         if ($query == '*') {
  303.             $query = '';
  304.         }
  306.         $query = str_replace('%', '*', $query);
  308.         $offset = intval($request->get('start'));
  309.         $limit = intval($request->get('limit'));
  311.         $offset = $offset ? $offset : 0;
  312.         $limit = $limit ? $limit : 50;
  314.         $searcherList = new SavedSearch\Listing();
  315.         $conditionParts = [];
  316.         $conditionParams = [];
  318.         //filter for current user
  319.         $userIds = [$user->getId()];
  320.         $userIds = array_merge($userIds, $user->getRoles());
  321.         $userIds = implode('|', $userIds);
  322.         $conditionParts[] = '(shareGlobally = 1 OR ownerId = ? OR sharedUserIds REGEXP ?)';
  323.         $conditionParams[] = $user->getId();
  324.         $conditionParams[] = ',(' . $userIds . '),';
  326.         //filter for query
  327.         if (!empty($query)) {
  328.             $conditionParts[] = '(name LIKE ? OR description LIKE ? OR category LIKE ?)';
  329.             $conditionParams[] = '%' . $query . '%';
  330.             $conditionParams[] = '%' . $query . '%';
  331.             $conditionParams[] = '%' . $query . '%';
  332.         }
  334.         if (count($conditionParts) > 0) {
  335.             $condition = implode(' AND ', $conditionParts);
  336.             $searcherList->setCondition($condition, $conditionParams);
  337.         }
  339.         $searcherList->setOffset($offset);
  340.         $searcherList->setLimit($limit);
  342.         $sortingSettings = QueryParams::extractSortingSettings(array_merge($request->request->all(), $request->query->all()));
  343.         if ($sortingSettings['orderKey']) {
  344.             $searcherList->setOrderKey($sortingSettings['orderKey']);
  345.         }
  346.         if ($sortingSettings['order']) {
  347.             $searcherList->setOrder($sortingSettings['order']);
  348.         }
  350.         $results = []; //$searcherList->load();
  351.         foreach ($searcherList->load() as $result) {
  352.             $results[] = [
  353.                 'id' => $result->getId(),
  354.                 'name' => $result->getName(),
  355.                 'description' => $result->getDescription(),
  356.                 'category' => $result->getCategory(),
  357.                 'owner' => $result->getOwner() ? $result->getOwner()->getUsername() . ' (' . $result->getOwner()->getFirstname() . ' ' . $result->getOwner()->getLastName() . ')' : '',
  358.                 'ownerId' => $result->getOwnerId()
  359.             ];
  360.         }
  362.         // only get the real total-count when the limit parameter is given otherwise use the default limit
  363.         if ($request->get('limit')) {
  364.             $totalMatches = $searcherList->getTotalCount();
  365.         } else {
  366.             $totalMatches = count($results);
  367.         }
  369.         return $this->adminJson(['data' => $results, 'success' => true, 'total' => $totalMatches]);
  370.     }
  372.     /**
  373.      * @param Request $request
  374.      * @Route("/load-search")
  375.      */
  376.     public function loadSearchAction(Request $request)
  377.     {
  378.         $id = intval($request->get('id'));
  379.         $savedSearch = SavedSearch::getById($id);
  380.         if ($savedSearch) {
  381.             $config = json_decode($savedSearch->getConfig(), true);
  382.             $classDefinition = DataObject\ClassDefinition::getById($config['classId']);
  384.             if (!empty($config['gridConfig']['columns'])) {
  385.                 $helperColumns = [];
  387.                 foreach ($config['gridConfig']['columns'] as &$column) {
  388.                     if (!($column['isOperator'] ?? false)) {
  389.                         $fieldDefinition = $classDefinition->getFieldDefinition($column['key']);
  390.                         if ($fieldDefinition) {
  391.                             $width = isset($column['layout']['width']) ? $column['layout']['width'] : null;
  392.                             $column['layout'] = json_decode(json_encode($fieldDefinition), true);
  393.                             if ($width) {
  394.                                 $column['layout']['width'] = $width;
  395.                             }
  396.                         }
  397.                     }
  399.                     if (!DataObject\Service::isHelperGridColumnConfig($column['key'])) {
  400.                         continue;
  401.                     }
  403.                     // columnconfig has to be a stdclass
  404.                     $helperColumns[$column['key']] = json_decode(json_encode($column));
  405.                 }
  407.                 // store the saved search columns in the session, otherwise they won't work
  408.                 Tool\Session::useSession(function (AttributeBagInterface $session) use ($helperColumns) {
  409.                     $existingColumns = $session->get('helpercolumns', []);
  410.                     $helperColumns = array_merge($existingColumns, $helperColumns);
  411.                     $session->set('helpercolumns', $helperColumns);
  412.                 }, 'pimcore_gridconfig');
  413.             }
  415.             return $this->adminJson([
  416.                 'id' => $savedSearch->getId(),
  417.                 'classId' => $config['classId'],
  418.                 'settings' => [
  419.                     'name' => $savedSearch->getName(),
  420.                     'description' => $savedSearch->getDescription(),
  421.                     'category' => $savedSearch->getCategory(),
  422.                     'sharedUserIds' => $savedSearch->getSharedUserIds(),
  423.                     'shareGlobally' => $savedSearch->getShareGlobally(),
  424.                     'isOwner' => $savedSearch->getOwnerId() == $this->getAdminUser()->getId(),
  425.                     'hasShortCut' => $savedSearch->isInShortCutsForUser($this->getAdminUser())
  426.                 ],
  427.                 'conditions' => $config['conditions'],
  428.                 'gridConfig' => $config['gridConfig']
  429.             ]);
  430.         } else {
  431.             return $this->adminJson(['success' => false, 'message' => "Saved Search with $id not found."]);
  432.         }
  433.     }
  435.     /**
  436.      * @param Request $request
  437.      * @Route("/load-short-cuts")
  438.      */
  439.     public function loadShortCutsAction(Request $request)
  440.     {
  441.         $list = new SavedSearch\Listing();
  442.         $list->setCondition(
  443.             '(shareGlobally = ? OR ownerId = ? OR sharedUserIds LIKE ?) AND shortCutUserIds LIKE ?',
  444.             [
  445.                 true,
  446.                 $this->getAdminUser()->getId(),
  447.                 '%,' . $this->getAdminUser()->getId() . ',%',
  448.                 '%,' . $this->getAdminUser()->getId() . ',%'
  449.             ]
  450.         );
  451.         $list->load();
  453.         $entries = [];
  454.         foreach ($list->getSavedSearches() as $entry) {
  455.             $entries[] = [
  456.                 'id' => $entry->getId(),
  457.                 'name' => $entry->getName()
  458.             ];
  459.         }
  461.         return $this->adminJson(['entries' => $entries]);
  462.     }
  464.     /**
  465.      * @param Request $request
  466.      * @Route("/toggle-short-cut")
  467.      */
  468.     public function toggleShortCutAction(Request $request)
  469.     {
  470.         $id = intval($request->get('id'));
  471.         $savedSearch = SavedSearch::getById($id);
  472.         if ($savedSearch) {
  473.             $user = $this->getAdminUser();
  474.             if ($savedSearch->isInShortCutsForUser($user)) {
  475.                 $savedSearch->removeShortCutForUser($user);
  476.             } else {
  477.                 $savedSearch->addShortCutForUser($user);
  478.             }
  479.             $savedSearch->save();
  481.             return $this->adminJson(['success' => 'true', 'hasShortCut' => $savedSearch->isInShortCutsForUser($user)]);
  482.         } else {
  483.             return $this->adminJson(['success' => 'false']);
  484.         }
  485.     }
  487.     /**
  488.      * @param Request $request
  489.      * @Route("/get-users")
  490.      */
  491.     public function getUsersAction(Request $request)
  492.     {
  493.         $users = [];
  495.         // condition for users with groups having DAM permission
  496.         $condition = [];
  497.         $rolesList = new \Pimcore\Model\User\Role\Listing();
  498.         $rolesList->addConditionParam("CONCAT(',', permissions, ',') LIKE ?", '%,bundle_advancedsearch_search,%');
  499.         $rolesList->load();
  500.         $roles = $rolesList->getRoles();
  502.         foreach ($roles as $role) {
  503.             $condition[] = "CONCAT(',', roles, ',') LIKE '%," . $role->getId() . ",%'";
  504.         }
  506.         // get available user
  507.         $list = new \Pimcore\Model\User\Listing();
  509.         $condition[] = 'admin = 1';
  510.         $list->addConditionParam("((CONCAT(',', permissions, ',') LIKE ? ) OR " . implode(' OR ', $condition) . ')', '%,bundle_advancedsearch_search,%');
  511.         $list->addConditionParam('id != ?', $this->getAdminUser()->getId());
  512.         $list->load();
  513.         $userList = $list->getUsers();
  515.         foreach ($userList as $user) {
  516.             $users[] = [
  517.                 'id' => $user->getId(),
  518.                 'label' => $user->getName()
  519.             ];
  520.         }
  522.         return $this->adminJson(['success' => true, 'total' => count($users), 'data' => $users]);
  523.     }
  525.     /**
  526.      * @param Request $request
  527.      * @Route("/get-roles")
  528.      */
  529.     public function getRolesAction()
  530.     {
  531.         $roles = [];
  533.         $rolesList = new \Pimcore\Model\User\Role\Listing();
  534.         $rolesList->setCondition('type = "role"');
  535.         $rolesList->addConditionParam("CONCAT(',', permissions, ',') LIKE ?", '%,bundle_advancedsearch_search,%');
  536.         $rolesList->load();
  538.         foreach ($rolesList->getRoles() as $role) {
  539.             $roles[] = [
  540.                 'id' => $role->getId(),
  541.                 'label' => $role->getName()
  542.             ];
  543.         }
  545.         return $this->adminJson(['success' => true, 'total' => count($roles), 'data' => $roles]);
  546.     }
  548.     /**
  549.      * @param Request $request
  550.      * @Route("/check-index-status")
  551.      */
  552.     public function checkIndexStatusAction(Request $request, Service $service)
  553.     {
  554.         return $this->adminJson(['indexUptodate' => $service->updateQueueEmpty()]);
  555.     }
  556. }