ext/search/Civi/Search/Admin.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 namespace Civi\Search;
  13
  14 /**
  15  * Class Admin
  16  * @package Civi\Search
  17  */
  18 class Admin {
  19
  20   /**
  21    * @return array
  22    */
  23   public static function getAdminSettings():array {
  24     $schema = self::getSchema();
  25     return [
  26       'schema' => $schema,
  27       'joins' => self::getJoins(array_column($schema, NULL, 'name')),
  28       'operators' => \CRM_Utils_Array::makeNonAssociative(self::getOperators()),
  29       'functions' => \CRM_Api4_Page_Api4Explorer::getSqlFunctions(),
  30       'displayTypes' => Display::getDisplayTypes(['name', 'label', 'description', 'icon']),
  31     ];
  32   }
  33
  34   /**
  35    * @return string[]
  36    */
  37   public static function getOperators():array {
  38     return [
  39       '=' => '=',
  40       '!=' => '≠',
  41       '>' => '>',
  42       '<' => '<',
  43       '>=' => '≥',
  44       '<=' => '≤',
  45       'CONTAINS' => ts('Contains'),
  46       'IN' => ts('Is One Of'),
  47       'NOT IN' => ts('Not One Of'),
  48       'LIKE' => ts('Is Like'),
  49       'NOT LIKE' => ts('Not Like'),
  50       'BETWEEN' => ts('Is Between'),
  51       'NOT BETWEEN' => ts('Not Between'),
  52       'IS NULL' => ts('Is Null'),
  53       'IS NOT NULL' => ts('Not Null'),
  54     ];
  55   }
  56
  57   /**
  58    * Fetch all entities the current user has permission to `get`
  59    * @return array
  60    */
  61   public static function getSchema() {
  62     $schema = [];
  63     $entities = \Civi\Api4\Entity::get()
  64       ->addSelect('name', 'title', 'type', 'title_plural', 'description', 'icon', 'paths', 'dao', 'bridge', 'ui_join_filters')
  65       ->addWhere('searchable', '=', TRUE)
  66       ->addOrderBy('title_plural')
  67       ->setChain([
  68         'get' => ['$name', 'getActions', ['where' => [['name', '=', 'get']]], ['params']],
  69       ])->execute();
  70     $getFields = ['name', 'label', 'description', 'options', 'input_type', 'input_attrs', 'data_type', 'serialize', 'fk_entity'];
  71     foreach ($entities as $entity) {
  72       // Skip if entity doesn't have a 'get' action or the user doesn't have permission to use get
  73       if ($entity['get']) {
  74         // Add paths (but only RUD actions) with translated titles
  75         foreach ($entity['paths'] as $action => $path) {
  76           unset($entity['paths'][$action]);
  77           switch ($action) {
  78             case 'view':
  79               $title = ts('View %1', [1 => $entity['title']]);
  80               break;
  81
  82             case 'update':
  83               $title = ts('Edit %1', [1 => $entity['title']]);
  84               break;
  85
  86             case 'delete':
  87               $title = ts('Delete %1', [1 => $entity['title']]);
  88               break;
  89
  90             default:
  91               continue 2;
  92           }
  93           $entity['paths'][] = [
  94             'path' => $path,
  95             'title' => $title,
  96             'action' => $action,
  97           ];
  98         }
  99         $entity['fields'] = (array) civicrm_api4($entity['name'], 'getFields', [
 100           'select' => $getFields,
 101           'where' => [['name', 'NOT IN', ['api_key', 'hash']]],
 102           'orderBy' => ['label'],
 103         ]);
 104         $params = $entity['get'][0];
 105         // Entity must support at least these params or it is too weird for search kit
 106         if (!array_diff(['select', 'where', 'orderBy', 'limit', 'offset'], array_keys($params))) {
 107           \CRM_Utils_Array::remove($params, 'checkPermissions', 'debug', 'chain', 'language', 'select', 'where', 'orderBy', 'limit', 'offset');
 108           unset($entity['get']);
 109           $schema[] = ['params' => array_keys($params)] + array_filter($entity);
 110         }
 111       }
 112     }
 113     return $schema;
 114   }
 115
 116   /**
 117    * @param array $allowedEntities
 118    * @return array
 119    */
 120   public static function getJoins(array $allowedEntities) {
 121     $joins = [];
 122     foreach ($allowedEntities as $entity) {
 123       if (!empty($entity['dao'])) {
 124         /* @var \CRM_Core_DAO $daoClass */
 125         $daoClass = $entity['dao'];
 126         $references = $daoClass::getReferenceColumns();
 127         // Only the first bridge reference gets processed, so if it's dynamic we want to be sure it's first in the list
 128         usort($references, function($reference) {
 129           return is_a($reference, 'CRM_Core_Reference_Dynamic') ? -1 : 1;
 130         });
 131         $fields = array_column($entity['fields'], NULL, 'name');
 132         $bridge = in_array('EntityBridge', $entity['type']) ? $entity['name'] : NULL;
 133         foreach ($references as $reference) {
 134           $keyField = $fields[$reference->getReferenceKey()] ?? NULL;
 135           // Exclude any joins that are better represented by pseudoconstants
 136           if (is_a($reference, 'CRM_Core_Reference_OptionValue')
 137             || !$keyField || !empty($keyField['options'])
 138             // Limit bridge joins to just the first
 139             || $bridge && array_search($keyField['name'], $entity['bridge']) !== 0
 140             // Sanity check - table should match
 141             || $daoClass::getTableName() !== $reference->getReferenceTable()
 142           ) {
 143             continue;
 144           }
 145           // For dynamic references getTargetEntities will return multiple targets; for normal joins this loop will only run once
 146           foreach ($reference->getTargetEntities() as $targetTable => $targetEntityName) {
 147             if (!isset($allowedEntities[$targetEntityName]) || $targetEntityName === $entity['name']) {
 148               continue;
 149             }
 150             $targetEntity = $allowedEntities[$targetEntityName];
 151             // Dynamic references use a column like "entity_table"
 152             $dynamicCol = $reference->getTypeColumn();
 153             // Non-bridge joins directly between 2 entities
 154             if (!$bridge) {
 155               // Add the straight 1-1 join
 156               $alias = $entity['name'] . '_' . $targetEntityName . '_' . $keyField['name'];
 157               $joins[$entity['name']][] = [
 158                 'label' => $entity['title'] . ' ' . $targetEntity['title'],
 159                 'description' => $dynamicCol ? '' : $keyField['label'],
 160                 'entity' => $targetEntityName,
 161                 'conditions' => self::getJoinConditions($keyField['name'], $alias . '.' . $reference->getTargetKey(), $targetTable, $dynamicCol),
 162                 'defaults' => self::getJoinDefaults($alias, $targetEntity),
 163                 'alias' => $alias,
 164                 'multi' => FALSE,
 165               ];
 166               // Flip the conditions & add the reverse (1-n) join
 167               $alias = $targetEntityName . '_' . $entity['name'] . '_' . $keyField['name'];
 168               $joins[$targetEntityName][] = [
 169                 'label' => $targetEntity['title'] . ' ' . $entity['title_plural'],
 170                 'description' => $dynamicCol ? '' : $keyField['label'],
 171                 'entity' => $entity['name'],
 172                 'conditions' => self::getJoinConditions($reference->getTargetKey(), $alias . '.' . $keyField['name'], $targetTable, $dynamicCol ? $alias . '.' . $dynamicCol : NULL),
 173                 'defaults' => self::getJoinDefaults($alias, $entity),
 174                 'alias' => $alias,
 175                 'multi' => TRUE,
 176               ];
 177             }
 178             // Bridge joins (sanity check - bridge must specify exactly 2 FK fields)
 179             elseif (count($entity['bridge']) === 2) {
 180               // Get the other entity being linked through this bridge
 181               $baseKey = array_search($reference->getReferenceKey(), $entity['bridge']) ? $entity['bridge'][0] : $entity['bridge'][1];
 182               $baseEntity = $allowedEntities[$fields[$baseKey]['fk_entity']] ?? NULL;
 183               if (!$baseEntity) {
 184                 continue;
 185               }
 186               // Add joins for the two entities that connect through this bridge (n-n)
 187               $symmetric = $baseEntity['name'] === $targetEntityName;
 188               $targetsTitle = $symmetric ? $allowedEntities[$bridge]['title_plural'] : $targetEntity['title_plural'];
 189               $alias = $baseEntity['name'] . "_{$bridge}_" . $targetEntityName;
 190               $joins[$baseEntity['name']][] = [
 191                 'label' => $baseEntity['title'] . ' ' . $targetsTitle,
 192                 'description' => ts('Multiple %1 per %2', [1 => $targetsTitle, 2 => $baseEntity['title']]),
 193                 'entity' => $targetEntityName,
 194                 'conditions' => array_merge(
 195                   [$bridge],
 196                   self::getJoinConditions('id', $alias . '.' . $baseKey, NULL, NULL)
 197                 ),
 198                 'defaults' => self::getJoinDefaults($alias, $targetEntity, $entity),
 199                 'bridge' => $bridge,
 200                 'alias' => $alias,
 201                 'multi' => TRUE,
 202               ];
 203               if (!$symmetric) {
 204                 $alias = $targetEntityName . "_{$bridge}_" . $baseEntity['name'];
 205                 $joins[$targetEntityName][] = [
 206                   'label' => $targetEntity['title'] . ' ' . $baseEntity['title_plural'],
 207                   'description' => ts('Multiple %1 per %2', [1 => $baseEntity['title_plural'], 2 => $targetEntity['title']]),
 208                   'entity' => $baseEntity['name'],
 209                   'conditions' => array_merge(
 210                     [$bridge],
 211                     self::getJoinConditions($reference->getTargetKey(), $alias . '.' . $keyField['name'], $targetTable, $dynamicCol ? $alias . '.' . $dynamicCol : NULL)
 212                   ),
 213                   'defaults' => self::getJoinDefaults($alias, $baseEntity, $entity),
 214                   'bridge' => $bridge,
 215                   'alias' => $alias,
 216                   'multi' => TRUE,
 217                 ];
 218               }
 219             }
 220           }
 221         }
 222       }
 223     }
 224     return $joins;
 225   }
 226
 227   /**
 228    * Boilerplate join clause
 229    *
 230    * @param string $nearCol
 231    * @param string $farCol
 232    * @param string $targetTable
 233    * @param string|null $dynamicCol
 234    * @return array[]
 235    */
 236   private static function getJoinConditions($nearCol, $farCol, $targetTable, $dynamicCol) {
 237     $conditions = [
 238       [
 239         $nearCol,
 240         '=',
 241         $farCol,
 242       ],
 243     ];
 244     if ($dynamicCol) {
 245       $conditions[] = [
 246         $dynamicCol,
 247         '=',
 248         "'$targetTable'",
 249       ];
 250     }
 251     return $conditions;
 252   }
 253
 254   /**
 255    * @param $alias
 256    * @param array ...$entities
 257    * @return array
 258    */
 259   private static function getJoinDefaults($alias, ...$entities):array {
 260     $conditions = [];
 261     foreach ($entities as $entity) {
 262       foreach ($entity['ui_join_filters'] ?? [] as $fieldName) {
 263         $field = civicrm_api4($entity['name'], 'getFields', [
 264           'select' => ['options'],
 265           'where' => [['name', '=', $fieldName]],
 266           'loadOptions' => ['name'],
 267         ])->first();
 268         $value = isset($field['options'][0]) ? json_encode($field['options'][0]['name']) : '';
 269         $conditions[] = [
 270           $alias . '.' . $fieldName . ($value ? ':name' : ''),
 271           '=',
 272           $value,
 273         ];
 274       }
 275     }
 276     return $conditions;
 277   }
 278
 279 }