CRM/Core/DAO.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 /**
  13  * Base Database Access Object class.
  14  *
  15  * All DAO classes should inherit from this class.
  16  *
  17  * @package CRM
  18  * @copyright CiviCRM LLC https://civicrm.org/licensing
  19  */
  20
  21 if (!defined('DB_DSN_MODE')) {
  22   define('DB_DSN_MODE', 'auto');
  23 }
  24
  25 require_once 'PEAR.php';
  26 require_once 'DB/DataObject.php';
  27
  28 require_once 'CRM/Core/I18n.php';
  29
  30 /**
  31  * Class CRM_Core_DAO
  32  */
  33 class CRM_Core_DAO extends DB_DataObject {
  34
  35   /**
  36    * Primary key field(s).
  37    *
  38    * @var string[]
  39    */
  40   public static $_primaryKey = ['id'];
  41
  42   /**
  43    * How many times has this instance been cloned.
  44    *
  45    * @var int
  46    */
  47   protected $resultCopies = 0;
  48
  49   /**
  50    * @var null
  51    * @deprecated
  52    */
  53   public static $_nullObject = NULL;
  54
  55   /**
  56    * Icon associated with this entity.
  57    *
  58    * @var string
  59    */
  60   public static $_icon = NULL;
  61
  62   /**
  63    * Field to show when displaying a record.
  64    *
  65    * @var string
  66    */
  67   public static $_labelField = NULL;
  68
  69   /**
  70    * @var array
  71    * @deprecated
  72    */
  73   public static $_nullArray = [];
  74
  75   public static $_dbColumnValueCache = NULL;
  76   const NOT_NULL = 1, IS_NULL = 2,
  77     DB_DAO_NOTNULL = 128,
  78     VALUE_SEPARATOR = "\ 1",
  79     BULK_INSERT_COUNT = 200,
  80     BULK_INSERT_HIGH_COUNT = 200,
  81     QUERY_FORMAT_WILDCARD = 1,
  82     QUERY_FORMAT_NO_QUOTES = 2,
  83
  84     /**
  85      * Serialized string separated by and bookended with VALUE_SEPARATOR
  86      */
  87     SERIALIZE_SEPARATOR_BOOKEND = 1,
  88     /**
  89      * @deprecated format separated by VALUE_SEPARATOR
  90      */
  91     SERIALIZE_SEPARATOR_TRIMMED = 2,
  92     /**
  93      * Recommended serialization format
  94      */
  95     SERIALIZE_JSON = 3,
  96     /**
  97      * @deprecated format using php serialize()
  98      */
  99     SERIALIZE_PHP = 4,
 100     /**
 101      * Comma separated string, no quotes, no spaces
 102      */
 103     SERIALIZE_COMMA = 5;
 104
 105   /**
 106    * Define entities that shouldn't be created or deleted when creating/ deleting
 107    * test objects - this prevents world regions, countries etc from being added / deleted
 108    * @var array
 109    */
 110   public static $_testEntitiesToSkip = [];
 111   /**
 112    * The factory class for this application.
 113    * @var object
 114    */
 115   public static $_factory = NULL;
 116
 117   /**
 118    * https://issues.civicrm.org/jira/browse/CRM-17748
 119    * internal variable for DAO to hold per-query settings
 120    * @var array
 121    */
 122   protected $_options = [];
 123
 124   /**
 125    * Class constructor.
 126    *
 127    * @return static
 128    */
 129   public function __construct() {
 130     $this->initialize();
 131     $this->__table = $this->getTableName();
 132   }
 133
 134   /**
 135    * Returns localized title of this entity.
 136    *
 137    * @return string
 138    */
 139   public static function getEntityTitle() {
 140     $className = static::class;
 141     CRM_Core_Error::deprecatedWarning("$className needs to be regenerated. Missing getEntityTitle method.");
 142     return CRM_Core_DAO_AllCoreTables::getBriefName($className);
 143   }
 144
 145   /**
 146    * Returns user-friendly description of this entity.
 147    *
 148    * @return string|null
 149    */
 150   public static function getEntityDescription() {
 151     return NULL;
 152   }
 153
 154   public function __clone() {
 155     if (!empty($this->_DB_resultid)) {
 156       $this->resultCopies++;
 157     }
 158   }
 159
 160   /**
 161    * Class destructor.
 162    */
 163   public function __destruct() {
 164     if ($this->resultCopies === 0) {
 165       $this->free();
 166     }
 167     $this->resultCopies--;
 168   }
 169
 170   /**
 171    * Returns the name of this table
 172    *
 173    * @return string
 174    */
 175   public static function getTableName() {
 176     return self::getLocaleTableName(static::$_tableName ?? NULL);
 177   }
 178
 179   /**
 180    * Returns if this table needs to be logged
 181    *
 182    * @return bool
 183    */
 184   public function getLog() {
 185     return static::$_log ?? FALSE;
 186   }
 187
 188   /**
 189    * Initialize the DAO object.
 190    *
 191    * @param string $dsn
 192    *   The database connection string.
 193    */
 194   public static function init($dsn) {
 195     Civi::$statics[__CLASS__]['init'] = 1;
 196     $options = &PEAR::getStaticProperty('DB_DataObject', 'options');
 197     $dsn = CRM_Utils_SQL::autoSwitchDSN($dsn);
 198     $options['database'] = $dsn;
 199     $options['quote_identifiers'] = TRUE;
 200     if (CRM_Utils_SQL::isSSLDSN($dsn)) {
 201       // There are two different options arrays.
 202       $other_options = &PEAR::getStaticProperty('DB', 'options');
 203       $other_options['ssl'] = TRUE;
 204     }
 205     if (defined('CIVICRM_DAO_DEBUG')) {
 206       self::DebugLevel(CIVICRM_DAO_DEBUG);
 207     }
 208     $factory = new CRM_Contact_DAO_Factory();
 209     CRM_Core_DAO::setFactory($factory);
 210     CRM_Core_DAO::executeQuery('SET NAMES utf8mb4');
 211     CRM_Core_DAO::executeQuery('SET @uniqueID = %1', [1 => [CRM_Utils_Request::id(), 'String']]);
 212   }
 213
 214   /**
 215    * @return DB_common
 216    */
 217   public static function getConnection() {
 218     global $_DB_DATAOBJECT;
 219     $dao = new CRM_Core_DAO();
 220     return $_DB_DATAOBJECT['CONNECTIONS'][$dao->_database_dsn_md5];
 221   }
 222
 223   /**
 224    * Disables usage of the ONLY_FULL_GROUP_BY Mode if necessary
 225    */
 226   public static function disableFullGroupByMode() {
 227     $currentModes = CRM_Utils_SQL::getSqlModes();
 228     if (in_array('ONLY_FULL_GROUP_BY', $currentModes) && CRM_Utils_SQL::isGroupByModeInDefault()) {
 229       $key = array_search('ONLY_FULL_GROUP_BY', $currentModes);
 230       unset($currentModes[$key]);
 231       CRM_Core_DAO::executeQuery("SET SESSION sql_mode = %1", [1 => [implode(',', $currentModes), 'String']]);
 232     }
 233   }
 234
 235   /**
 236    * Re-enables ONLY_FULL_GROUP_BY sql_mode as necessary..
 237    */
 238   public static function reenableFullGroupByMode() {
 239     $currentModes = CRM_Utils_SQL::getSqlModes();
 240     if (!in_array('ONLY_FULL_GROUP_BY', $currentModes) && CRM_Utils_SQL::isGroupByModeInDefault()) {
 241       $currentModes[] = 'ONLY_FULL_GROUP_BY';
 242       CRM_Core_DAO::executeQuery("SET SESSION sql_mode = %1", [1 => [implode(',', $currentModes), 'String']]);
 243     }
 244   }
 245
 246   /**
 247    * @param string $fieldName
 248    * @param $fieldDef
 249    * @param array $params
 250    */
 251   protected function assignTestFK($fieldName, $fieldDef, $params) {
 252     $required = $fieldDef['required'] ?? NULL;
 253     $FKClassName = $fieldDef['FKClassName'] ?? NULL;
 254     $dbName = $fieldDef['name'];
 255     $daoName = str_replace('_BAO_', '_DAO_', get_class($this));
 256
 257     // skip the FK if it is not required
 258     // if it's contact id we should create even if not required
 259     // we'll have a go @ fetching first though
 260     // we WILL create campaigns though for so tests with a campaign pseudoconstant will complete
 261     if ($FKClassName === 'CRM_Campaign_DAO_Campaign' && $daoName != $FKClassName) {
 262       $required = TRUE;
 263     }
 264     if (!$required && $dbName != 'contact_id') {
 265       $fkDAO = new $FKClassName();
 266       if ($fkDAO->find(TRUE)) {
 267         $this->$dbName = $fkDAO->id;
 268       }
 269     }
 270
 271     elseif (in_array($FKClassName, CRM_Core_DAO::$_testEntitiesToSkip)) {
 272       $depObject = new $FKClassName();
 273       $depObject->find(TRUE);
 274       $this->$dbName = $depObject->id;
 275     }
 276     elseif ($daoName == 'CRM_Member_DAO_MembershipType' && $fieldName == 'member_of_contact_id') {
 277       // FIXME: the fields() metadata is not specific enough
 278       $depObject = CRM_Core_DAO::createTestObject($FKClassName, ['contact_type' => 'Organization']);
 279       $this->$dbName = $depObject->id;
 280     }
 281     else {
 282       //if it is required we need to generate the dependency object first
 283       $depObject = CRM_Core_DAO::createTestObject($FKClassName, CRM_Utils_Array::value($dbName, $params, 1));
 284       $this->$dbName = $depObject->id;
 285     }
 286   }
 287
 288   /**
 289    * Generate and assign an arbitrary value to a field of a test object.
 290    *
 291    * @param string $fieldName
 292    * @param array $fieldDef
 293    * @param int $counter
 294    *   The globally-unique ID of the test object.
 295    *
 296    * @throws \CRM_Core_Exception
 297    */
 298   protected function assignTestValue($fieldName, &$fieldDef, $counter) {
 299     $dbName = $fieldDef['name'];
 300     $daoName = get_class($this);
 301     $handled = FALSE;
 302
 303     if (in_array($dbName, ['contact_sub_type', 'email_greeting_id', 'postal_greeting_id', 'addressee_id'], TRUE)) {
 304       //coming up with a rule to set these is too complex - skip
 305       return;
 306     }
 307
 308     // Pick an option value if needed
 309     if (!$handled && $fieldDef['type'] !== CRM_Utils_Type::T_BOOLEAN) {
 310       $options = $daoName::buildOptions($dbName, 'create');
 311       if ($options) {
 312         $this->$dbName = key($options);
 313         $handled = TRUE;
 314       }
 315     }
 316
 317     if (!$handled) {
 318       switch ($fieldDef['type']) {
 319         case CRM_Utils_Type::T_INT:
 320         case CRM_Utils_Type::T_FLOAT:
 321         case CRM_Utils_Type::T_MONEY:
 322           if (isset($fieldDef['precision'])) {
 323             // $object->$dbName = CRM_Utils_Number::createRandomDecimal($value['precision']);
 324             $this->$dbName = CRM_Utils_Number::createTruncatedDecimal($counter, $fieldDef['precision']);
 325           }
 326           else {
 327             $this->$dbName = $counter;
 328           }
 329           break;
 330
 331         case CRM_Utils_Type::T_BOOLEAN:
 332           if (isset($fieldDef['default'])) {
 333             $this->$dbName = $fieldDef['default'];
 334           }
 335           elseif ($fieldDef['name'] == 'is_deleted' || $fieldDef['name'] == 'is_test') {
 336             $this->$dbName = 0;
 337           }
 338           else {
 339             $this->$dbName = 1;
 340           }
 341           break;
 342
 343         case CRM_Utils_Type::T_DATE:
 344         case CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME:
 345           $this->$dbName = '19700101';
 346           if ($dbName == 'end_date') {
 347             // put this in the future
 348             $this->$dbName = '20200101';
 349           }
 350           break;
 351
 352         case CRM_Utils_Type::T_TIMESTAMP:
 353           $this->$dbName = '19700201000000';
 354           break;
 355
 356         case CRM_Utils_Type::T_TIME:
 357           throw new CRM_Core_Exception('T_TIME shouldn\'t be used.');
 358
 359         case CRM_Utils_Type::T_CCNUM:
 360           $this->$dbName = '4111 1111 1111 1111';
 361           break;
 362
 363         case CRM_Utils_Type::T_URL:
 364           $this->$dbName = 'http://www.civicrm.org';
 365           break;
 366
 367         case CRM_Utils_Type::T_STRING:
 368         case CRM_Utils_Type::T_BLOB:
 369         case CRM_Utils_Type::T_MEDIUMBLOB:
 370         case CRM_Utils_Type::T_TEXT:
 371         case CRM_Utils_Type::T_LONGTEXT:
 372         case CRM_Utils_Type::T_EMAIL:
 373         default:
 374           // WAS: if (isset($value['enumValues'])) {
 375           // TODO: see if this works with all pseudoconstants
 376           if (isset($fieldDef['pseudoconstant'], $fieldDef['pseudoconstant']['callback'])) {
 377             if (isset($fieldDef['default'])) {
 378               $this->$dbName = $fieldDef['default'];
 379             }
 380             else {
 381               $options = CRM_Core_PseudoConstant::get($daoName, $fieldName);
 382               if (is_array($options)) {
 383                 $this->$dbName = $options[0];
 384               }
 385               else {
 386                 $defaultValues = explode(',', $options);
 387                 $this->$dbName = $defaultValues[0];
 388               }
 389             }
 390           }
 391           else {
 392             $this->$dbName = $dbName . '_' . $counter;
 393             $maxlength = $fieldDef['maxlength'] ?? NULL;
 394             if ($maxlength > 0 && strlen($this->$dbName) > $maxlength) {
 395               $this->$dbName = substr($this->$dbName, 0, $fieldDef['maxlength']);
 396             }
 397           }
 398       }
 399     }
 400   }
 401
 402   /**
 403    * Reset the DAO object.
 404    *
 405    * DAO is kinda crappy in that there is an unwritten rule of one query per DAO.
 406    *
 407    * We attempt to get around this crappy restriction by resetting some of DAO's internal fields. Use this with caution
 408    */
 409   public function reset() {
 410
 411     foreach (array_keys($this->table()) as $field) {
 412       unset($this->$field);
 413     }
 414
 415     /**
 416      * reset the various DB_DAO structures manually
 417      */
 418     $this->_query = [];
 419     $this->whereAdd();
 420     $this->selectAdd();
 421     $this->joinAdd();
 422   }
 423
 424   /**
 425    * @param string $tableName
 426    *
 427    * @return string
 428    */
 429   public static function getLocaleTableName($tableName) {
 430     global $dbLocale;
 431     if ($dbLocale) {
 432       $tables = CRM_Core_I18n_Schema::schemaStructureTables();
 433       if (in_array($tableName, $tables)) {
 434         return $tableName . $dbLocale;
 435       }
 436     }
 437     return $tableName;
 438   }
 439
 440   /**
 441    * Execute a query by the current DAO, localizing it along the way (if needed).
 442    *
 443    * @param string $query
 444    *   The SQL query for execution.
 445    * @param bool $i18nRewrite
 446    *   Whether to rewrite the query.
 447    *
 448    * @return object
 449    *   the current DAO object after the query execution
 450    */
 451   public function query($query, $i18nRewrite = TRUE) {
 452     // rewrite queries that should use $dbLocale-based views for multi-language installs
 453     global $dbLocale, $_DB_DATAOBJECT;
 454
 455     if (empty($_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5])) {
 456       // Will force connection to be populated per CRM-20541.
 457       new CRM_Core_DAO();
 458     }
 459
 460     $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
 461     $orig_options = $conn->options;
 462     $this->_setDBOptions($this->_options);
 463
 464     if ($i18nRewrite and $dbLocale) {
 465       $query = CRM_Core_I18n_Schema::rewriteQuery($query);
 466     }
 467
 468     $ret = parent::query($query);
 469
 470     $this->_setDBOptions($orig_options);
 471     return $ret;
 472   }
 473
 474   /**
 475    * Static function to set the factory instance for this class.
 476    *
 477    * @param object $factory
 478    *   The factory application object.
 479    */
 480   public static function setFactory(&$factory) {
 481     self::$_factory = &$factory;
 482   }
 483
 484   /**
 485    * Factory method to instantiate a new object from a table name.
 486    *
 487    * @param string $table
 488    * @return \DataObject|\PEAR_Error
 489    */
 490   public function factory($table = '') {
 491     if (!isset(self::$_factory)) {
 492       return parent::factory($table);
 493     }
 494
 495     return self::$_factory->create($table);
 496   }
 497
 498   /**
 499    * Initialization for all DAO objects. Since we access DB_DO programatically
 500    * we need to set the links manually.
 501    */
 502   public function initialize() {
 503     $this->_connect();
 504     if (empty(Civi::$statics[__CLASS__]['init'])) {
 505       // CRM_Core_DAO::init() must be called before CRM_Core_DAO->initialize().
 506       // This occurs very early in bootstrap - error handlers may not be wired up.
 507       echo "Inconsistent system initialization sequence. Premature access of (" . get_class($this) . ")";
 508       CRM_Utils_System::civiExit();
 509     }
 510   }
 511
 512   /**
 513    * Defines the default key as 'id'.
 514    *
 515    * @return array
 516    */
 517   public function keys() {
 518     static $keys;
 519     if (!isset($keys)) {
 520       $keys = ['id'];
 521     }
 522     return $keys;
 523   }
 524
 525   /**
 526    * Tells DB_DataObject which keys use autoincrement.
 527    * 'id' is autoincrementing by default.
 528    *
 529    *
 530    * @return array
 531    */
 532   public function sequenceKey() {
 533     static $sequenceKeys;
 534     if (!isset($sequenceKeys)) {
 535       $sequenceKeys = ['id', TRUE];
 536     }
 537     return $sequenceKeys;
 538   }
 539
 540   /**
 541    * Returns list of FK relationships.
 542    *
 543    * @return CRM_Core_Reference_Basic[]
 544    */
 545   public static function getReferenceColumns() {
 546     if (!isset(Civi::$statics[static::class]['links'])) {
 547       Civi::$statics[static::class]['links'] = static::createReferenceColumns(static::class);
 548       CRM_Core_DAO_AllCoreTables::invoke(static::class, 'links_callback', Civi::$statics[static::class]['links']);
 549     }
 550     return Civi::$statics[static::class]['links'];
 551   }
 552
 553   /**
 554    * Returns all the column names of this table.
 555    *
 556    *
 557    * @return array
 558    */
 559   public static function &fields() {
 560     $result = NULL;
 561     return $result;
 562   }
 563
 564   /**
 565    * Returns all usable fields, indexed by name.
 566    *
 567    * This function differs from fields() in that it indexes by name rather than unique_name.
 568    *
 569    * It excludes fields not added yet by pending upgrades.
 570    * This avoids problems with trying to SELECT a field that exists in code but has not yet been added to the db.
 571    *
 572    * @param bool $checkPermissions
 573    *   Filter by field permissions.
 574    * @return array
 575    */
 576   public static function getSupportedFields($checkPermissions = FALSE) {
 577     $fields = array_column((array) static::fields(), NULL, 'name');
 578
 579     // Exclude fields yet not added by pending upgrades
 580     $dbVer = \CRM_Core_BAO_Domain::version();
 581     $daoExt = defined(static::class . '::EXT') ? constant(static::class . '::EXT') : NULL;
 582     if ($fields && $daoExt === 'civicrm' && version_compare($dbVer, \CRM_Utils_System::version()) < 0) {
 583       $fields = array_filter($fields, function($field) use ($dbVer) {
 584         $add = $field['add'] ?? '1.0.0';
 585         if (substr_count($add, '.') < 2) {
 586           $add .= '.alpha1';
 587         }
 588         return version_compare($dbVer, $add, '>=');
 589       });
 590     }
 591
 592     // Exclude fields the user does not have permission for
 593     if ($checkPermissions) {
 594       $fields = array_filter($fields, function($field) {
 595         return empty($field['permission']) || CRM_Core_Permission::check($field['permission']);
 596       });
 597     }
 598
 599     return $fields;
 600   }
 601
 602   /**
 603    * Get/set an associative array of table columns
 604    *
 605    * @return array
 606    *   (associative)
 607    */
 608   public function table() {
 609     $fields = $this->fields();
 610
 611     $table = [];
 612     if ($fields) {
 613       foreach ($fields as $name => $value) {
 614         $table[$value['name']] = $value['type'];
 615         if (!empty($value['required'])) {
 616           $table[$value['name']] += self::DB_DAO_NOTNULL;
 617         }
 618       }
 619     }
 620
 621     return $table;
 622   }
 623
 624   /**
 625    * Save DAO object.
 626    *
 627    * @param bool $hook
 628    *
 629    * @return CRM_Core_DAO
 630    */
 631   public function save($hook = TRUE) {
 632     $eventID = uniqid();
 633     if (!empty($this->id)) {
 634       if ($hook) {
 635         $preEvent = new \Civi\Core\DAO\Event\PreUpdate($this);
 636         $preEvent->eventID = $eventID;
 637         \Civi::dispatcher()->dispatch("civi.dao.preUpdate", $preEvent);
 638       }
 639
 640       $result = $this->update();
 641
 642       if ($hook) {
 643         $event = new \Civi\Core\DAO\Event\PostUpdate($this, $result);
 644         $event->eventID = $eventID;
 645         \Civi::dispatcher()->dispatch("civi.dao.postUpdate", $event);
 646       }
 647       $this->clearDbColumnValueCache();
 648     }
 649     else {
 650       if ($hook) {
 651         $preEvent = new \Civi\Core\DAO\Event\PreUpdate($this);
 652         $preEvent->eventID = $eventID;
 653         \Civi::dispatcher()->dispatch("civi.dao.preInsert", $preEvent);
 654       }
 655
 656       $result = $this->insert();
 657
 658       if ($hook) {
 659         $event = new \Civi\Core\DAO\Event\PostUpdate($this, $result);
 660         $event->eventID = $eventID;
 661         \Civi::dispatcher()->dispatch("civi.dao.postInsert", $event);
 662       }
 663     }
 664     $this->free();
 665
 666     if ($hook) {
 667       CRM_Utils_Hook::postSave($this);
 668     }
 669
 670     return $this;
 671   }
 672
 673   /**
 674    * Deletes items from table which match current objects variables.
 675    *
 676    * Returns the true on success
 677    *
 678    * for example
 679    *
 680    * Designed to be extended
 681    *
 682    * $object = new mytable();
 683    * $object->ID=123;
 684    * echo $object->delete(); // builds a conditon
 685    *
 686    * $object = new mytable();
 687    * $object->whereAdd('age > 12');
 688    * $object->limit(1);
 689    * $object->orderBy('age DESC');
 690    * $object->delete(true); // dont use object vars, use the conditions, limit and order.
 691    *
 692    * @param bool $useWhere (optional) If DB_DATAOBJECT_WHEREADD_ONLY is passed in then
 693    *             we will build the condition only using the whereAdd's.  Default is to
 694    *             build the condition only using the object parameters.
 695    *
 696    * @return int|false
 697    *   Int (No. of rows affected) on success, false on failure, 0 on no data affected
 698    */
 699   public function delete($useWhere = FALSE) {
 700     $preEvent = new \Civi\Core\DAO\Event\PreDelete($this);
 701     \Civi::dispatcher()->dispatch("civi.dao.preDelete", $preEvent);
 702
 703     $result = parent::delete($useWhere);
 704
 705     $event = new \Civi\Core\DAO\Event\PostDelete($this, $result);
 706     \Civi::dispatcher()->dispatch("civi.dao.postDelete", $event);
 707     $this->free();
 708
 709     $this->clearDbColumnValueCache();
 710
 711     return $result;
 712   }
 713
 714   /**
 715    * @param bool $created
 716    */
 717   public function log($created = FALSE) {
 718     static $cid = NULL;
 719
 720     if (!$this->getLog()) {
 721       return;
 722     }
 723
 724     if (!$cid) {
 725       $session = CRM_Core_Session::singleton();
 726       $cid = $session->get('userID');
 727     }
 728
 729     // return is we dont have handle to FK
 730     if (!$cid) {
 731       return;
 732     }
 733
 734     $dao = new CRM_Core_DAO_Log();
 735     $dao->entity_table = $this->getTableName();
 736     $dao->entity_id = $this->id;
 737     $dao->modified_id = $cid;
 738     $dao->modified_date = date("YmdHis");
 739     $dao->insert();
 740   }
 741
 742   /**
 743    * Given an associative array of name/value pairs, extract all the values
 744    * that belong to this object and initialize the object with said values
 745    *
 746    * @param array $params
 747    *   Array of name/value pairs to save.
 748    *
 749    * @return bool
 750    *   Did we copy all null values into the object
 751    */
 752   public function copyValues($params) {
 753     $allNull = TRUE;
 754     foreach ($this->fields() as $uniqueName => $field) {
 755       $dbName = $field['name'];
 756       if (array_key_exists($dbName, $params)) {
 757         $value = $params[$dbName];
 758         $exists = TRUE;
 759       }
 760       elseif (array_key_exists($uniqueName, $params)) {
 761         $value = $params[$uniqueName];
 762         $exists = TRUE;
 763       }
 764       else {
 765         $exists = FALSE;
 766       }
 767
 768       // if there is no value then make the variable NULL
 769       if ($exists) {
 770         if ($value === '') {
 771           $this->$dbName = 'null';
 772         }
 773         elseif (is_array($value) && !empty($field['serialize'])) {
 774           $this->$dbName = CRM_Core_DAO::serializeField($value, $field['serialize']);
 775           $allNull = FALSE;
 776         }
 777         else {
 778           $maxLength = $field['maxlength'] ?? NULL;
 779           if (!is_array($value) && $maxLength && mb_strlen($value) > $maxLength && empty($field['pseudoconstant'])) {
 780             // No ts() since this is a sysadmin-y string not seen by general users.
 781             Civi::log()->warning('A string for field {dbName} has been truncated. The original string was {value}.', ['dbName' => $dbName, 'value' => $value]);
 782             // The string is too long - what to do what to do? Well losing data is generally bad so let's truncate
 783             $value = CRM_Utils_String::ellipsify($value, $maxLength);
 784           }
 785           $this->$dbName = $value;
 786           $allNull = FALSE;
 787         }
 788       }
 789     }
 790     return $allNull;
 791   }
 792
 793   /**
 794    * Store all the values from this object in an associative array
 795    * this is a destructive store, calling function is responsible
 796    * for keeping sanity of id's.
 797    *
 798    * @param object $object
 799    *   The object that we are extracting data from.
 800    * @param array $values
 801    *   (reference ) associative array of name/value pairs.
 802    */
 803   public static function storeValues(&$object, &$values) {
 804     $fields = $object->fields();
 805     foreach ($fields as $name => $value) {
 806       $dbName = $value['name'];
 807       if (isset($object->$dbName) && $object->$dbName !== 'null') {
 808         $values[$dbName] = $object->$dbName;
 809         if ($name != $dbName) {
 810           $values[$name] = $object->$dbName;
 811         }
 812       }
 813     }
 814   }
 815
 816   /**
 817    * Create an attribute for this specific field. We only do this for strings and text
 818    *
 819    * @param array $field
 820    *   The field under task.
 821    *
 822    * @return array|null
 823    *   the attributes for the object
 824    */
 825   public static function makeAttribute($field) {
 826     if ($field) {
 827       if (CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_STRING) {
 828         $maxLength = $field['maxlength'] ?? NULL;
 829         $size = $field['size'] ?? NULL;
 830         if ($maxLength || $size) {
 831           $attributes = [];
 832           if ($maxLength) {
 833             $attributes['maxlength'] = $maxLength;
 834           }
 835           if ($size) {
 836             $attributes['size'] = $size;
 837           }
 838           return $attributes;
 839         }
 840       }
 841       elseif (CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_TEXT) {
 842         $rows = $field['rows'] ?? NULL;
 843         if (!isset($rows)) {
 844           $rows = 2;
 845         }
 846         $cols = $field['cols'] ?? NULL;
 847         if (!isset($cols)) {
 848           $cols = 80;
 849         }
 850
 851         $attributes = [];
 852         $attributes['rows'] = $rows;
 853         $attributes['cols'] = $cols;
 854         return $attributes;
 855       }
 856       elseif (CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_INT || CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_FLOAT || CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_MONEY) {
 857         $attributes['size'] = 6;
 858         $attributes['maxlength'] = 14;
 859         return $attributes;
 860       }
 861     }
 862     return NULL;
 863   }
 864
 865   /**
 866    * Get the size and maxLength attributes for this text field.
 867    * (or for all text fields) in the DAO object.
 868    *
 869    * @param string $class
 870    *   Name of DAO class.
 871    * @param string $fieldName
 872    *   Field that i'm interested in or null if.
 873    *                          you want the attributes for all DAO text fields
 874    *
 875    * @return array
 876    *   assoc array of name => attribute pairs
 877    */
 878   public static function getAttribute($class, $fieldName = NULL) {
 879     $object = new $class();
 880     $fields = $object->fields();
 881     if ($fieldName != NULL) {
 882       $field = $fields[$fieldName] ?? NULL;
 883       return self::makeAttribute($field);
 884     }
 885     else {
 886       $attributes = [];
 887       foreach ($fields as $name => $field) {
 888         $attribute = self::makeAttribute($field);
 889         if ($attribute) {
 890           $attributes[$name] = $attribute;
 891         }
 892       }
 893
 894       if (!empty($attributes)) {
 895         return $attributes;
 896       }
 897     }
 898     return NULL;
 899   }
 900
 901   /**
 902    * Create or update a record from supplied params.
 903    *
 904    * If 'id' is supplied, an existing record will be updated
 905    * Otherwise a new record will be created.
 906    *
 907    * @param array $record
 908    *
 909    * @return static
 910    * @throws \CRM_Core_Exception
 911    */
 912   public static function writeRecord(array $record): CRM_Core_DAO {
 913     $op = empty($record['id']) ? 'create' : 'edit';
 914     $className = CRM_Core_DAO_AllCoreTables::getCanonicalClassName(static::class);
 915     if ($className === 'CRM_Core_DAO') {
 916       throw new CRM_Core_Exception('Function writeRecord must be called on a subclass of CRM_Core_DAO');
 917     }
 918     $entityName = CRM_Core_DAO_AllCoreTables::getBriefName($className);
 919
 920     \CRM_Utils_Hook::pre($op, $entityName, $record['id'] ?? NULL, $record);
 921     $instance = new $className();
 922     // Ensure fields exist before attempting to write to them
 923     $values = array_intersect_key($record, self::getSupportedFields());
 924     $instance->copyValues($values);
 925     $instance->save();
 926
 927     if (!empty($record['custom']) && is_array($record['custom'])) {
 928       CRM_Core_BAO_CustomValueTable::store($record['custom'], static::$_tableName, $instance->id, $op);
 929     }
 930
 931     \CRM_Utils_Hook::post($op, $entityName, $instance->id, $instance);
 932
 933     return $instance;
 934   }
 935
 936   /**
 937    * Bulk save multiple records
 938    *
 939    * @param array[] $records
 940    * @return static[]
 941    * @throws CRM_Core_Exception
 942    */
 943   public static function writeRecords(array $records): array {
 944     $results = [];
 945     foreach ($records as $record) {
 946       $results[] = static::writeRecord($record);
 947     }
 948     return $results;
 949   }
 950
 951   /**
 952    * Delete a record from supplied params.
 953    *
 954    * @param array $record
 955    *   'id' is required.
 956    * @return static
 957    * @throws CRM_Core_Exception
 958    */
 959   public static function deleteRecord(array $record) {
 960     $className = CRM_Core_DAO_AllCoreTables::getCanonicalClassName(static::class);
 961     if ($className === 'CRM_Core_DAO') {
 962       throw new CRM_Core_Exception('Function deleteRecord must be called on a subclass of CRM_Core_DAO');
 963     }
 964     $entityName = CRM_Core_DAO_AllCoreTables::getBriefName($className);
 965     if (empty($record['id'])) {
 966       throw new CRM_Core_Exception("Cannot delete {$entityName} with no id.");
 967     }
 968     CRM_Utils_Type::validate($record['id'], 'Positive');
 969
 970     CRM_Utils_Hook::pre('delete', $entityName, $record['id'], $record);
 971     $instance = new $className();
 972     $instance->id = $record['id'];
 973     // Load complete object for the sake of hook_civicrm_post, below
 974     $instance->find(TRUE);
 975     if (!$instance || !$instance->delete()) {
 976       throw new CRM_Core_Exception("Could not delete {$entityName} id {$record['id']}");
 977     }
 978     // For other operations this hook is passed an incomplete object and hook listeners can load if needed.
 979     // But that's not possible with delete because it's gone from the database by the time this hook is called.
 980     // So in this case the object has been pre-loaded so hook listeners have access to the complete record.
 981     CRM_Utils_Hook::post('delete', $entityName, $record['id'], $instance);
 982
 983     return $instance;
 984   }
 985
 986   /**
 987    * Bulk delete multiple records.
 988    *
 989    * @param array[] $records
 990    * @return static[]
 991    * @throws CRM_Core_Exception
 992    */
 993   public static function deleteRecords(array $records) {
 994     $results = [];
 995     foreach ($records as $record) {
 996       $results[] = static::deleteRecord($record);
 997     }
 998     return $results;
 999   }
1000
1001   /**
1002    * Check if there is a record with the same name in the db.
1003    *
1004    * @param string $value
1005    *   The value of the field we are checking.
1006    * @param string $daoName
1007    *   The dao object name.
1008    * @param string $daoID
1009    *   The id of the object being updated. u can change your name.
1010    *                          as long as there is no conflict
1011    * @param string $fieldName
1012    *   The name of the field in the DAO.
1013    *
1014    * @param string $domainID
1015    *   The id of the domain.  Object exists only for the given domain.
1016    *
1017    * @return bool
1018    *   true if object exists
1019    */
1020   public static function objectExists($value, $daoName, $daoID, $fieldName = 'name', $domainID = NULL) {
1021     $object = new $daoName();
1022     $object->$fieldName = $value;
1023     if ($domainID) {
1024       $object->domain_id = $domainID;
1025     }
1026
1027     if ($object->find(TRUE)) {
1028       return $daoID && $object->id == $daoID;
1029     }
1030     else {
1031       return TRUE;
1032     }
1033   }
1034
1035   /**
1036    * Check if there is a given column in a specific table.
1037    *
1038    * @deprecated
1039    * @see CRM_Core_BAO_SchemaHandler::checkIfFieldExists
1040    *
1041    * @param string $tableName
1042    * @param string $columnName
1043    * @param bool $i18nRewrite
1044    *   Whether to rewrite the query on multilingual setups.
1045    *
1046    * @return bool
1047    *   true if exists, else false
1048    */
1049   public static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) {
1050     CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_BAO_SchemaHandler::checkIfFieldExists');
1051     return CRM_Core_BAO_SchemaHandler::checkIfFieldExists($tableName, $columnName, $i18nRewrite);
1052   }
1053
1054   /**
1055    * Scans all the tables using a slow query and table name.
1056    *
1057    * @return array
1058    */
1059   public static function getTableNames() {
1060     $dao = CRM_Core_DAO::executeQuery(
1061       "SELECT TABLE_NAME
1062        FROM information_schema.TABLES
1063        WHERE TABLE_SCHEMA = '" . CRM_Core_DAO::getDatabaseName() . "'
1064          AND TABLE_NAME LIKE 'civicrm_%'
1065          AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
1066          AND TABLE_NAME NOT LIKE '%_temp%'
1067       ");
1068
1069     while ($dao->fetch()) {
1070       $values[] = $dao->TABLE_NAME;
1071     }
1072     return $values;
1073   }
1074
1075   /**
1076    * @param int $maxTablesToCheck
1077    *
1078    * @return bool
1079    */
1080   public static function isDBMyISAM($maxTablesToCheck = 10) {
1081     return CRM_Core_DAO::singleValueQuery(
1082       "SELECT count(*)
1083        FROM information_schema.TABLES
1084        WHERE ENGINE = 'MyISAM'
1085          AND TABLE_SCHEMA = '" . CRM_Core_DAO::getDatabaseName() . "'
1086          AND TABLE_NAME LIKE 'civicrm_%'
1087          AND TABLE_NAME NOT LIKE 'civicrm_import_job_%'
1088          AND TABLE_NAME NOT LIKE '%_temp%'
1089          AND TABLE_NAME NOT LIKE 'civicrm_tmp_%'
1090       ");
1091   }
1092
1093   /**
1094    * Get the name of the CiviCRM database.
1095    *
1096    * @return string
1097    */
1098   public static function getDatabaseName() {
1099     $daoObj = new CRM_Core_DAO();
1100     return $daoObj->database();
1101   }
1102
1103   /**
1104    * Checks if a constraint exists for a specified table.
1105    *
1106    * @param string $tableName
1107    * @param string $constraint
1108    *
1109    * @return bool
1110    *   true if constraint exists, false otherwise
1111    *
1112    * @throws \CRM_Core_Exception
1113    */
1114   public static function checkConstraintExists($tableName, $constraint) {
1115     static $show = [];
1116
1117     if (!array_key_exists($tableName, $show)) {
1118       $query = "SHOW CREATE TABLE $tableName";
1119       $dao = CRM_Core_DAO::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
1120
1121       if (!$dao->fetch()) {
1122         throw new CRM_Core_Exception('query failed');
1123       }
1124
1125       $show[$tableName] = $dao->Create_Table;
1126     }
1127
1128     return (bool) preg_match("/\b$constraint\b/i", $show[$tableName]);
1129   }
1130
1131   /**
1132    * Checks if CONSTRAINT keyword exists for a specified table.
1133    *
1134    * @param array $tables
1135    *
1136    * @throws CRM_Core_Exception
1137    *
1138    * @return bool
1139    *   true if CONSTRAINT keyword exists, false otherwise
1140    */
1141   public static function schemaRequiresRebuilding($tables = ["civicrm_contact"]) {
1142     $show = [];
1143     foreach ($tables as $tableName) {
1144       if (!array_key_exists($tableName, $show)) {
1145         $query = "SHOW CREATE TABLE $tableName";
1146         $dao = CRM_Core_DAO::executeQuery($query, [], TRUE, NULL, FALSE, FALSE);
1147
1148         if (!$dao->fetch()) {
1149           throw new CRM_Core_Exception('Show create table failed.');
1150         }
1151
1152         $show[$tableName] = $dao->Create_Table;
1153       }
1154
1155       $result = (bool) preg_match("/\bCONSTRAINT\b\s/i", $show[$tableName]);
1156       if ($result == TRUE) {
1157         continue;
1158       }
1159       else {
1160         return FALSE;
1161       }
1162     }
1163     return TRUE;
1164   }
1165
1166   /**
1167    * Checks if the FK constraint name is in the format 'FK_tableName_columnName'
1168    * for a specified column of a table.
1169    *
1170    * @param string $tableName
1171    * @param string $columnName
1172    *
1173    * @return bool
1174    *   true if in format, false otherwise
1175    *
1176    * @throws \CRM_Core_Exception
1177    */
1178   public static function checkFKConstraintInFormat($tableName, $columnName) {
1179     static $show = [];
1180
1181     if (!array_key_exists($tableName, $show)) {
1182       $query = "SHOW CREATE TABLE $tableName";
1183       $dao = CRM_Core_DAO::executeQuery($query);
1184
1185       if (!$dao->fetch()) {
1186         throw new CRM_Core_Exception('query failed');
1187       }
1188
1189       $show[$tableName] = $dao->Create_Table;
1190     }
1191     $constraint = "`FK_{$tableName}_{$columnName}`";
1192     $pattern = "/\bCONSTRAINT\b\s+%s\s+\bFOREIGN\s+KEY\b\s/i";
1193     return (bool) preg_match(sprintf($pattern, $constraint), $show[$tableName]);
1194   }
1195
1196   /**
1197    * Check whether a specific column in a specific table has always the same value.
1198    *
1199    * @param string $tableName
1200    * @param string $columnName
1201    * @param string $columnValue
1202    *
1203    * @return bool
1204    *   true if the value is always $columnValue, false otherwise
1205    */
1206   public static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) {
1207     $query = "SELECT * FROM $tableName WHERE $columnName != '$columnValue'";
1208     $dao = CRM_Core_DAO::executeQuery($query);
1209     $result = $dao->fetch() ? FALSE : TRUE;
1210     return $result;
1211   }
1212
1213   /**
1214    * Check whether a specific column in a specific table is always NULL.
1215    *
1216    * @param string $tableName
1217    * @param string $columnName
1218    *
1219    * @return bool
1220    *   true if if the value is always NULL, false otherwise
1221    */
1222   public static function checkFieldIsAlwaysNull($tableName, $columnName) {
1223     $query = "SELECT * FROM $tableName WHERE $columnName IS NOT NULL";
1224     $dao = CRM_Core_DAO::executeQuery($query);
1225     $result = $dao->fetch() ? FALSE : TRUE;
1226     return $result;
1227   }
1228
1229   /**
1230    * Checks if this DAO's table ought to exist.
1231    *
1232    * If there are pending DB updates, this function compares the CiviCRM version of the table to the current schema version.
1233    *
1234    * @return bool
1235    * @throws CRM_Core_Exception
1236    */
1237   public static function tableHasBeenAdded() {
1238     if (CRM_Utils_System::version() === CRM_Core_BAO_Domain::version()) {
1239       return TRUE;
1240     }
1241     $daoExt = defined(static::class . '::EXT') ? constant(static::class . '::EXT') : NULL;
1242     $daoVersion = defined(static::class . '::TABLE_ADDED') ? constant(static::class . '::TABLE_ADDED') : '1.0';
1243     return !($daoExt === 'civicrm' && version_compare(CRM_Core_BAO_Domain::version(), $daoVersion, '<'));
1244   }
1245
1246   /**
1247    * Check if there is a given table in the database.
1248    *
1249    * @param string $tableName
1250    *
1251    * @return bool
1252    *   true if exists, else false
1253    */
1254   public static function checkTableExists($tableName) {
1255     $query = "
1256 SHOW TABLES
1257 LIKE %1
1258 ";
1259     $params = [1 => [$tableName, 'String']];
1260
1261     $dao = CRM_Core_DAO::executeQuery($query, $params);
1262     return (bool) $dao->fetch();
1263   }
1264
1265   /**
1266    * Check if a given table has data.
1267    *
1268    * @param string $tableName
1269    * @return bool
1270    *   TRUE if $tableName has at least one record.
1271    */
1272   public static function checkTableHasData($tableName) {
1273     $c = CRM_Core_DAO::singleValueQuery(sprintf('SELECT count(*) c FROM `%s`', $tableName));
1274     return $c > 0;
1275   }
1276
1277   /**
1278    * @param $version
1279    * @deprecated
1280    * @return bool
1281    */
1282   public function checkVersion($version) {
1283     CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_BAO_Domain::version');
1284     $dbVersion = CRM_Core_BAO_Domain::version();
1285     return trim($version) == trim($dbVersion);
1286   }
1287
1288   /**
1289    * Find a DAO object for the given ID and return it.
1290    *
1291    * @param int $id
1292    *   Id of the DAO object being searched for.
1293    *
1294    * @return CRM_Core_DAO
1295    *   Object of the type of the class that called this function.
1296    *
1297    * @throws Exception
1298    */
1299   public static function findById($id) {
1300     $object = new static();
1301     $object->id = $id;
1302     if (!$object->find(TRUE)) {
1303       throw new Exception("Unable to find a " . get_called_class() . " with id {$id}.");
1304     }
1305     return $object;
1306   }
1307
1308   /**
1309    * Returns all results as array-encoded records.
1310    *
1311    * @return array
1312    */
1313   public function fetchAll($k = FALSE, $v = FALSE, $method = FALSE) {
1314     $result = [];
1315     while ($this->fetch()) {
1316       $result[] = $this->toArray();
1317     }
1318     return $result;
1319   }
1320
1321   /**
1322    * Return the results as PHP generator.
1323    *
1324    * @param string $type
1325    *   Whether the generator yields 'dao' objects or 'array's.
1326    */
1327   public function fetchGenerator($type = 'dao') {
1328     while ($this->fetch()) {
1329       switch ($type) {
1330         case 'dao':
1331           yield $this;
1332           break;
1333
1334         case 'array':
1335           yield $this->toArray();
1336           break;
1337
1338         default:
1339           throw new \RuntimeException("Invalid record type ($type)");
1340       }
1341     }
1342   }
1343
1344   /**
1345    * Returns a singular value.
1346    *
1347    * @return mixed|NULL
1348    */
1349   public function fetchValue() {
1350     $result = $this->getDatabaseResult();
1351     $row = $result->fetchRow();
1352     $ret = NULL;
1353     if ($row) {
1354       $ret = $row[0];
1355     }
1356     $this->free();
1357     return $ret;
1358   }
1359
1360   /**
1361    * Get all the result records as mapping between columns.
1362    *
1363    * @param string $keyColumn
1364    *   Ex: "name"
1365    * @param string $valueColumn
1366    *   Ex: "label"
1367    * @return array
1368    *   Ex: ["foo" => "The Foo Bar", "baz" => "The Baz Qux"]
1369    */
1370   public function fetchMap($keyColumn, $valueColumn) {
1371     $result = [];
1372     while ($this->fetch()) {
1373       $result[$this->{$keyColumn}] = $this->{$valueColumn};
1374     }
1375     return $result;
1376   }
1377
1378   /**
1379    * Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
1380    *
1381    * @param string $daoName
1382    *   Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1383    * @param int $searchValue
1384    *   Value of the column you want to search by.
1385    * @param string $returnColumn
1386    *   Name of the column you want to GET the value of.
1387    * @param string $searchColumn
1388    *   Name of the column you want to search by.
1389    * @param bool $force
1390    *   Skip use of the cache.
1391    *
1392    * @return string|int|null
1393    *   Value of $returnColumn in the retrieved record
1394    *
1395    * @throws \CRM_Core_Exception
1396    */
1397   public static function getFieldValue($daoName, $searchValue, $returnColumn = 'name', $searchColumn = 'id', $force = FALSE) {
1398     if (
1399       empty($searchValue) ||
1400       trim(strtolower($searchValue)) == 'null'
1401     ) {
1402       // adding this here since developers forget to check for an id
1403       // or for the 'null' (which is a bad DAO kludge)
1404       // and hence we get the first value in the db
1405       throw new CRM_Core_Exception('getFieldValue failed');
1406     }
1407
1408     self::$_dbColumnValueCache = self::$_dbColumnValueCache ?? [];
1409
1410     while (strpos($daoName, '_BAO_') !== FALSE) {
1411       $daoName = get_parent_class($daoName);
1412     }
1413
1414     if ($force ||
1415       empty(self::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue]) ||
1416       !array_key_exists($returnColumn, self::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue])
1417     ) {
1418       $object = new $daoName();
1419       $object->$searchColumn = $searchValue;
1420       $object->selectAdd();
1421       $object->selectAdd($returnColumn);
1422
1423       $result = NULL;
1424       if ($object->find(TRUE)) {
1425         $result = $object->$returnColumn;
1426       }
1427
1428       self::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue][$returnColumn] = $result;
1429     }
1430     return self::$_dbColumnValueCache[$daoName][$searchColumn][$searchValue][$returnColumn];
1431   }
1432
1433   /**
1434    * Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
1435    *
1436    * @param string $daoName
1437    *   Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact).
1438    * @param int $searchValue
1439    *   Value of the column you want to search by.
1440    * @param string $setColumn
1441    *   Name of the column you want to SET the value of.
1442    * @param string $setValue
1443    *   SET the setColumn to this value.
1444    * @param string $searchColumn
1445    *   Name of the column you want to search by.
1446    *
1447    * @return bool
1448    *   true if we found and updated the object, else false
1449    */
1450   public static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') {
1451     $object = new $daoName();
1452     $object->selectAdd();
1453     $object->selectAdd("$searchColumn, $setColumn");
1454     $object->$searchColumn = $searchValue;
1455     $result = FALSE;
1456     if ($object->find(TRUE)) {
1457       $object->$setColumn = $setValue;
1458       if ($object->save()) {
1459         $result = TRUE;
1460       }
1461     }
1462     $object->free();
1463     return $result;
1464   }
1465
1466   /**
1467    * Get sort string.
1468    *
1469    * @param array|object $sort either array or CRM_Utils_Sort
1470    * @param string $default
1471    *   Default sort value.
1472    *
1473    * @return string
1474    */
1475   public static function getSortString($sort, $default = NULL) {
1476     // check if sort is of type CRM_Utils_Sort
1477     if (is_a($sort, 'CRM_Utils_Sort')) {
1478       return $sort->orderBy();
1479     }
1480
1481     $sortString = '';
1482
1483     // is it an array specified as $field => $sortDirection ?
1484     if ($sort) {
1485       foreach ($sort as $k => $v) {
1486         $sortString .= "$k $v,";
1487       }
1488       return rtrim($sortString, ',');
1489     }
1490     return $default;
1491   }
1492
1493   /**
1494    * Fetch object based on array of properties.
1495    *
1496    * @param string $daoName
1497    *   Name of the dao object.
1498    * @param array $params
1499    *   (reference ) an assoc array of name/value pairs.
1500    * @param array $defaults
1501    *   (reference ) an assoc array to hold the flattened values.
1502    * @param array $returnProperities
1503    *   An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
1504    *
1505    * @return object
1506    *   an object of type referenced by daoName
1507    */
1508   public static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) {
1509     $object = new $daoName();
1510     $object->copyValues($params);
1511
1512     // return only specific fields if returnproperties are sent
1513     if (!empty($returnProperities)) {
1514       $object->selectAdd();
1515       $object->selectAdd(implode(',', $returnProperities));
1516     }
1517
1518     if ($object->find(TRUE)) {
1519       self::storeValues($object, $defaults);
1520       return $object;
1521     }
1522     return NULL;
1523   }
1524
1525   /**
1526    * Delete the object records that are associated with this contact.
1527    *
1528    * @param string $daoName
1529    *   Name of the dao object.
1530    * @param int $contactId
1531    *   Id of the contact to delete.
1532    */
1533   public static function deleteEntityContact($daoName, $contactId) {
1534     $object = new $daoName();
1535
1536     $object->entity_table = 'civicrm_contact';
1537     $object->entity_id = $contactId;
1538     $object->delete();
1539   }
1540
1541   /**
1542    * Execute an unbuffered query.
1543    *
1544    * This is a wrapper around new functionality exposed with CRM-17748.
1545    *
1546    * @param string $query query to be executed
1547    *
1548    * @param array $params
1549    * @param bool $abort
1550    * @param null $daoName
1551    * @param bool $freeDAO
1552    * @param bool $i18nRewrite
1553    * @param bool $trapException
1554    *
1555    * @return CRM_Core_DAO
1556    *   Object that points to an unbuffered result set
1557    */
1558   public static function executeUnbufferedQuery(
1559     $query,
1560     $params = [],
1561     $abort = TRUE,
1562     $daoName = NULL,
1563     $freeDAO = FALSE,
1564     $i18nRewrite = TRUE,
1565     $trapException = FALSE
1566   ) {
1567
1568     return self::executeQuery(
1569       $query,
1570       $params,
1571       $abort,
1572       $daoName,
1573       $freeDAO,
1574       $i18nRewrite,
1575       $trapException,
1576       ['result_buffering' => 0]
1577     );
1578   }
1579
1580   /**
1581    * Execute a query.
1582    *
1583    * @param string $query
1584    *   Query to be executed.
1585    *
1586    * @param array $params
1587    * @param bool $abort
1588    * @param null $daoName
1589    * @param bool $freeDAO
1590    * @param bool $i18nRewrite
1591    * @param bool $trapException
1592    * @param array $options
1593    *
1594    * @return CRM_Core_DAO|object
1595    *   object that holds the results of the query
1596    *   NB - if this is defined as just returning a DAO phpstorm keeps pointing
1597    *   out all the properties that are not part of the DAO
1598    */
1599   public static function &executeQuery(
1600     $query,
1601     $params = [],
1602     $abort = TRUE,
1603     $daoName = NULL,
1604     $freeDAO = FALSE,
1605     $i18nRewrite = TRUE,
1606     $trapException = FALSE,
1607     $options = []
1608   ) {
1609     $queryStr = self::composeQuery($query, $params, $abort);
1610
1611     if (!$daoName) {
1612       $dao = new CRM_Core_DAO();
1613     }
1614     else {
1615       $dao = new $daoName();
1616     }
1617
1618     if ($trapException) {
1619       CRM_Core_Error::deprecatedFunctionWarning('calling functions should handle exceptions');
1620       $errorScope = CRM_Core_TemporaryErrorScope::ignoreException();
1621     }
1622
1623     if ($dao->isValidOption($options)) {
1624       $dao->setOptions($options);
1625     }
1626
1627     $result = $dao->query($queryStr, $i18nRewrite);
1628
1629     // since it is unbuffered, ($dao->N==0) is true.  This blocks the standard fetch() mechanism.
1630     if (CRM_Utils_Array::value('result_buffering', $options) === 0) {
1631       $dao->N = TRUE;
1632     }
1633
1634     if (is_a($result, 'DB_Error')) {
1635       CRM_Core_Error::deprecatedFunctionWarning('calling functions should handle exceptions');
1636       return $result;
1637     }
1638
1639     return $dao;
1640   }
1641
1642   /**
1643    * Wrapper to validate internal DAO options before passing to DB_mysql/DB_Common level
1644    *
1645    * @param array $options
1646    *
1647    * @return bool
1648    *   Provided options are valid
1649    */
1650   public function isValidOption($options) {
1651     $isValid = FALSE;
1652     $validOptions = [
1653       'result_buffering',
1654       'persistent',
1655       'ssl',
1656       'portability',
1657     ];
1658
1659     if (empty($options)) {
1660       return $isValid;
1661     }
1662
1663     foreach (array_keys($options) as $option) {
1664       if (!in_array($option, $validOptions)) {
1665         return FALSE;
1666       }
1667       $isValid = TRUE;
1668     }
1669
1670     return $isValid;
1671   }
1672
1673   /**
1674    * Execute a query and get the single result.
1675    *
1676    * @param string $query
1677    *   Query to be executed.
1678    * @param array $params
1679    * @param bool $abort
1680    * @param bool $i18nRewrite
1681    * @return string|null
1682    *   the result of the query if any
1683    *
1684    */
1685   public static function &singleValueQuery(
1686     $query,
1687     $params = [],
1688     $abort = TRUE,
1689     $i18nRewrite = TRUE
1690   ) {
1691     $queryStr = self::composeQuery($query, $params, $abort);
1692
1693     static $_dao = NULL;
1694
1695     if (!$_dao) {
1696       $_dao = new CRM_Core_DAO();
1697     }
1698
1699     $_dao->query($queryStr, $i18nRewrite);
1700
1701     $result = $_dao->getDatabaseResult();
1702     $ret = NULL;
1703     if ($result) {
1704       $row = $result->fetchRow();
1705       if ($row) {
1706         $ret = $row[0];
1707       }
1708     }
1709     $_dao->free();
1710     return $ret;
1711   }
1712
1713   /**
1714    * Compose the query by merging the parameters into it.
1715    *
1716    * @param string $query
1717    * @param array $params
1718    * @param bool $abort
1719    *
1720    * @return string
1721    * @throws CRM_Core_Exception
1722    */
1723   public static function composeQuery($query, $params = [], $abort = TRUE) {
1724     $tr = [];
1725     foreach ($params as $key => $item) {
1726       if (is_numeric($key)) {
1727         if (CRM_Utils_Type::validate($item[0], $item[1]) !== NULL) {
1728           $item[0] = self::escapeString($item[0]);
1729           if ($item[1] == 'String' ||
1730             $item[1] == 'Memo' ||
1731             $item[1] == 'Link'
1732           ) {
1733             // Support class constants stipulating wildcard characters and/or
1734             // non-quoting of strings. Also support legacy code which may be
1735             // passing in TRUE or 1 for $item[2], which used to indicate the
1736             // use of wildcard characters.
1737             if (!empty($item[2])) {
1738               if ($item[2] & CRM_Core_DAO::QUERY_FORMAT_WILDCARD || $item[2] === TRUE) {
1739                 $item[0] = "'%{$item[0]}%'";
1740               }
1741               elseif (!($item[2] & CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES)) {
1742                 $item[0] = "'{$item[0]}'";
1743               }
1744             }
1745             else {
1746               $item[0] = "'{$item[0]}'";
1747             }
1748           }
1749
1750           if (($item[1] == 'Date' || $item[1] == 'Timestamp') &&
1751             strlen($item[0]) == 0
1752           ) {
1753             $item[0] = 'null';
1754           }
1755
1756           $tr['%' . $key] = $item[0];
1757         }
1758         elseif ($abort) {
1759           throw new CRM_Core_Exception("{$item[0]} is not of type {$item[1]}");
1760         }
1761       }
1762     }
1763
1764     return strtr($query, $tr);
1765   }
1766
1767   /**
1768    * @param null $ids
1769    */
1770   public static function freeResult($ids = NULL) {
1771     global $_DB_DATAOBJECT;
1772
1773     if (!$ids) {
1774       if (!$_DB_DATAOBJECT ||
1775         !isset($_DB_DATAOBJECT['RESULTS'])
1776       ) {
1777         return;
1778       }
1779       $ids = array_keys($_DB_DATAOBJECT['RESULTS']);
1780     }
1781
1782     foreach ($ids as $id) {
1783       if (isset($_DB_DATAOBJECT['RESULTS'][$id])) {
1784         $_DB_DATAOBJECT['RESULTS'][$id]->free();
1785         unset($_DB_DATAOBJECT['RESULTS'][$id]);
1786       }
1787
1788       if (isset($_DB_DATAOBJECT['RESULTFIELDS'][$id])) {
1789         unset($_DB_DATAOBJECT['RESULTFIELDS'][$id]);
1790       }
1791     }
1792   }
1793
1794   /**
1795    * Make a shallow copy of an object and all the fields in the object.
1796    *
1797    * @param string $daoName
1798    *   Name of the dao.
1799    * @param array $criteria
1800    *   Array of all the fields & values.
1801    *   on which basis to copy
1802    * @param array $newData
1803    *   Array of all the fields & values.
1804    *   to be copied besides the other fields
1805    * @param string $fieldsFix
1806    *   Array of fields that you want to prefix/suffix/replace.
1807    * @param string $blockCopyOfDependencies
1808    *   Fields that you want to block from.
1809    *   getting copied
1810    * @param bool $blockCopyofCustomValues
1811    *   Case when you don't want to copy the custom values set in a
1812    *   template as it will override/ignore the submitted custom values
1813    *
1814    * @return CRM_Core_DAO|bool
1815    *   the newly created copy of the object. False if none created.
1816    */
1817   public static function copyGeneric($daoName, $criteria, $newData = NULL, $fieldsFix = NULL, $blockCopyOfDependencies = NULL, $blockCopyofCustomValues = FALSE) {
1818     $object = new $daoName();
1819     $newObject = FALSE;
1820     if (!$newData) {
1821       $object->id = $criteria['id'];
1822     }
1823     else {
1824       foreach ($criteria as $key => $value) {
1825         $object->$key = $value;
1826       }
1827     }
1828
1829     $object->find();
1830     while ($object->fetch()) {
1831
1832       // all the objects except with $blockCopyOfDependencies set
1833       // be copied - addresses #CRM-1962
1834
1835       if ($blockCopyOfDependencies && $object->$blockCopyOfDependencies) {
1836         break;
1837       }
1838
1839       $newObject = new $daoName();
1840
1841       $fields = $object->fields();
1842       $fieldsToPrefix = [];
1843       $fieldsToSuffix = [];
1844       $fieldsToReplace = [];
1845       if (!empty($fieldsFix['prefix'])) {
1846         $fieldsToPrefix = $fieldsFix['prefix'];
1847       }
1848       if (!empty($fieldsFix['suffix'])) {
1849         $fieldsToSuffix = $fieldsFix['suffix'];
1850       }
1851       if (!empty($fieldsFix['replace'])) {
1852         $fieldsToReplace = $fieldsFix['replace'];
1853       }
1854
1855       $localizableFields = FALSE;
1856       foreach ($fields as $name => $value) {
1857         if ($name == 'id' || $value['name'] == 'id') {
1858           // copy everything but the id!
1859           continue;
1860         }
1861
1862         $dbName = $value['name'];
1863         $type = CRM_Utils_Type::typeToString($value['type']);
1864         $newObject->$dbName = $object->$dbName;
1865         if (isset($fieldsToPrefix[$dbName])) {
1866           $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName;
1867         }
1868         if (isset($fieldsToSuffix[$dbName])) {
1869           $newObject->$dbName .= $fieldsToSuffix[$dbName];
1870         }
1871         if (isset($fieldsToReplace[$dbName])) {
1872           $newObject->$dbName = $fieldsToReplace[$dbName];
1873         }
1874
1875         if ($type == 'Timestamp' || $type == 'Date') {
1876           $newObject->$dbName = CRM_Utils_Date::isoToMysql($newObject->$dbName);
1877         }
1878
1879         if (!empty($value['localizable'])) {
1880           $localizableFields = TRUE;
1881         }
1882
1883         if ($newData) {
1884           $newObject->copyValues($newData);
1885         }
1886       }
1887       $newObject->save();
1888
1889       // ensure we copy all localized fields as well
1890       if (CRM_Core_I18n::isMultilingual() && $localizableFields) {
1891         global $dbLocale;
1892         $locales = CRM_Core_I18n::getMultilingual();
1893         $curLocale = CRM_Core_I18n::getLocale();
1894         // loop on other locales
1895         foreach ($locales as $locale) {
1896           if ($locale != $curLocale) {
1897             // setLocale doesn't seems to be reliable to set dbLocale and we only need to change the db locale
1898             $dbLocale = '_' . $locale;
1899             $newObject->copyLocalizable($object->id, $newObject->id, $fieldsToPrefix, $fieldsToSuffix, $fieldsToReplace);
1900           }
1901         }
1902         // restore dbLocale to starting value
1903         $dbLocale = '_' . $curLocale;
1904       }
1905
1906       if (!$blockCopyofCustomValues) {
1907         $newObject->copyCustomFields($object->id, $newObject->id);
1908       }
1909       CRM_Utils_Hook::post('create', CRM_Core_DAO_AllCoreTables::getBriefName($daoName), $newObject->id, $newObject);
1910     }
1911
1912     return $newObject;
1913   }
1914
1915   /**
1916    * Method that copies localizable fields from an old entity to a new one.
1917    *
1918    * Fixes bug dev/core#2479,
1919    * where non current locale fields are copied from current locale losing translation when copying
1920    *
1921    * @param int $entityID
1922    * @param int $newEntityID
1923    * @param array $fieldsToPrefix
1924    * @param array $fieldsToSuffix
1925    * @param array $fieldsToReplace
1926    */
1927   protected function copyLocalizable($entityID, $newEntityID, $fieldsToPrefix, $fieldsToSuffix, $fieldsToReplace) {
1928     $entity = get_class($this);
1929     $object = new $entity();
1930     $object->id = $entityID;
1931     $object->find();
1932
1933     $newObject = new $entity();
1934     $newObject->id = $newEntityID;
1935
1936     $newObject->find();
1937
1938     if ($object->fetch() && $newObject->fetch()) {
1939
1940       $fields = $object->fields();
1941       foreach ($fields as $name => $value) {
1942
1943         if ($name == 'id' || $value['name'] == 'id') {
1944           // copy everything but the id!
1945           continue;
1946         }
1947
1948         // only copy localizable fields
1949         if (!$value['localizable']) {
1950           continue;
1951         }
1952
1953         $dbName = $value['name'];
1954         $type = CRM_Utils_Type::typeToString($value['type']);
1955         $newObject->$dbName = $object->$dbName;
1956         if (isset($fieldsToPrefix[$dbName])) {
1957           $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName;
1958         }
1959         if (isset($fieldsToSuffix[$dbName])) {
1960           $newObject->$dbName .= $fieldsToSuffix[$dbName];
1961         }
1962         if (isset($fieldsToReplace[$dbName])) {
1963           $newObject->$dbName = $fieldsToReplace[$dbName];
1964         }
1965
1966         if ($type == 'Timestamp' || $type == 'Date') {
1967           $newObject->$dbName = CRM_Utils_Date::isoToMysql($newObject->$dbName);
1968         }
1969
1970       }
1971       $newObject->save();
1972
1973     }
1974   }
1975
1976   /**
1977    * Method that copies custom fields values from an old entity to a new one.
1978    *
1979    * Fixes bug CRM-19302,
1980    * where if a custom field of File type was present, left both events using the same file,
1981    * breaking download URL's for the old event.
1982    *
1983    * @todo the goal here is to clean this up so that it works for any entity. Copy Generic already DOES some custom field stuff
1984    * but it seems to be bypassed & perhaps less good than this (or this just duplicates it...)
1985    *
1986    * @param int $entityID
1987    * @param int $newEntityID
1988    * @param string $parentOperation
1989    */
1990   public function copyCustomFields($entityID, $newEntityID, $parentOperation = NULL) {
1991     $entity = CRM_Core_DAO_AllCoreTables::getBriefName(get_class($this));
1992     $tableName = CRM_Core_DAO_AllCoreTables::getTableForClass(get_class($this));
1993     // Obtain custom values for the old entity.
1994     $customParams = $htmlType = [];
1995     $customValues = CRM_Core_BAO_CustomValueTable::getEntityValues($entityID, $entity);
1996
1997     // If custom values present, we copy them
1998     if (!empty($customValues)) {
1999       // Get Field ID's and identify File type attributes, to handle file copying.
2000       $fieldIds = implode(', ', array_keys($customValues));
2001       $sql = "SELECT id FROM civicrm_custom_field WHERE html_type = 'File' AND id IN ( {$fieldIds} )";
2002       $result = CRM_Core_DAO::executeQuery($sql);
2003
2004       // Build array of File type fields
2005       while ($result->fetch()) {
2006         $htmlType[] = $result->id;
2007       }
2008
2009       // Build params array of custom values
2010       foreach ($customValues as $field => $value) {
2011         if ($value !== NULL) {
2012           // Handle File type attributes
2013           if (in_array($field, $htmlType)) {
2014             $fileValues = CRM_Core_BAO_File::path($value, $entityID);
2015             $customParams["custom_{$field}_-1"] = [
2016               'name' => CRM_Utils_File::duplicate($fileValues[0]),
2017               'type' => $fileValues[1],
2018             ];
2019           }
2020           // Handle other types
2021           else {
2022             $customParams["custom_{$field}_-1"] = $value;
2023           }
2024         }
2025       }
2026
2027       // Save Custom Fields for new Entity.
2028       CRM_Core_BAO_CustomValueTable::postProcess($customParams, $tableName, $newEntityID, $entity, $parentOperation ?? 'create');
2029     }
2030
2031     // copy activity attachments ( if any )
2032     CRM_Core_BAO_File::copyEntityFile($tableName, $entityID, $tableName, $newEntityID);
2033   }
2034
2035   /**
2036    * Cascade update through related entities.
2037    *
2038    * @param string $daoName
2039    * @param $fromId
2040    * @param $toId
2041    * @param array $newData
2042    *
2043    * @return CRM_Core_DAO|null
2044    */
2045   public static function cascadeUpdate($daoName, $fromId, $toId, $newData = []) {
2046     $object = new $daoName();
2047     $object->id = $fromId;
2048
2049     if ($object->find(TRUE)) {
2050       $newObject = new $daoName();
2051       $newObject->id = $toId;
2052
2053       if ($newObject->find(TRUE)) {
2054         $fields = $object->fields();
2055         foreach ($fields as $name => $value) {
2056           if ($name == 'id' || $value['name'] == 'id') {
2057             // copy everything but the id!
2058             continue;
2059           }
2060
2061           $colName = $value['name'];
2062           $newObject->$colName = $object->$colName;
2063
2064           if (substr($name, -5) == '_date' ||
2065             substr($name, -10) == '_date_time'
2066           ) {
2067             $newObject->$colName = CRM_Utils_Date::isoToMysql($newObject->$colName);
2068           }
2069         }
2070         foreach ($newData as $k => $v) {
2071           $newObject->$k = $v;
2072         }
2073         $newObject->save();
2074         return $newObject;
2075       }
2076     }
2077     return NULL;
2078   }
2079
2080   /**
2081    * Given the component id, compute the contact id
2082    * since its used for things like send email
2083    *
2084    * @param $componentIDs
2085    * @param string $tableName
2086    * @param string $idField
2087    *
2088    * @return array
2089    */
2090   public static function getContactIDsFromComponent($componentIDs, $tableName, $idField = 'id') {
2091     $contactIDs = [];
2092
2093     if (empty($componentIDs)) {
2094       return $contactIDs;
2095     }
2096
2097     $IDs = implode(',', $componentIDs);
2098     $query = "
2099 SELECT contact_id
2100   FROM $tableName
2101  WHERE $idField IN ( $IDs )
2102 ";
2103
2104     $dao = CRM_Core_DAO::executeQuery($query);
2105     while ($dao->fetch()) {
2106       $contactIDs[] = $dao->contact_id;
2107     }
2108     return $contactIDs;
2109   }
2110
2111   /**
2112    * Fetch object based on array of properties.
2113    *
2114    * @param string $daoName
2115    *   Name of the dao object.
2116    * @param string $fieldIdName
2117    * @param int $fieldId
2118    * @param $details
2119    * @param array $returnProperities
2120    *   An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
2121    *
2122    * @return object
2123    *   an object of type referenced by daoName
2124    */
2125   public static function commonRetrieveAll($daoName, $fieldIdName, $fieldId, &$details, $returnProperities = NULL) {
2126     require_once str_replace('_', DIRECTORY_SEPARATOR, $daoName) . ".php";
2127     $object = new $daoName();
2128     $object->$fieldIdName = $fieldId;
2129
2130     // return only specific fields if returnproperties are sent
2131     if (!empty($returnProperities)) {
2132       $object->selectAdd();
2133       $object->selectAdd('id');
2134       $object->selectAdd(implode(',', $returnProperities));
2135     }
2136
2137     $object->find();
2138     while ($object->fetch()) {
2139       $defaults = [];
2140       self::storeValues($object, $defaults);
2141       $details[$object->id] = $defaults;
2142     }
2143
2144     return $details;
2145   }
2146
2147   /**
2148    * Drop all CiviCRM tables.
2149    *
2150    * @throws \CRM_Core_Exception
2151    */
2152   public static function dropAllTables() {
2153
2154     // first drop all the custom tables we've created
2155     CRM_Core_BAO_CustomGroup::dropAllTables();
2156
2157     // drop all multilingual views
2158     CRM_Core_I18n_Schema::dropAllViews();
2159
2160     CRM_Utils_File::sourceSQLFile(CIVICRM_DSN,
2161       dirname(__FILE__) . DIRECTORY_SEPARATOR .
2162       '..' . DIRECTORY_SEPARATOR .
2163       '..' . DIRECTORY_SEPARATOR .
2164       'sql' . DIRECTORY_SEPARATOR .
2165       'civicrm_drop.mysql'
2166     );
2167   }
2168
2169   /**
2170    * @param $string
2171    *
2172    * @return string
2173    */
2174   public static function escapeString($string) {
2175     static $_dao = NULL;
2176     if (!$_dao) {
2177       // If this is an atypical case (e.g. preparing .sql file before CiviCRM
2178       // has been installed), then we fallback DB-less str_replace escaping, as
2179       // we can't use mysqli_real_escape_string, as there is no DB connection.
2180       // Note: In typical usage, escapeString() will only check one conditional
2181       // ("if !$_dao") rather than two conditionals ("if !defined(DSN)")
2182       if (!defined('CIVICRM_DSN')) {
2183         // See http://php.net/manual/en/mysqli.real-escape-string.php for the
2184         // list of characters mysqli_real_escape_string escapes.
2185         $search = ["\\", "\x00", "\n", "\r", "'", '"', "\x1a"];
2186         $replace = ["\\\\", "\\0", "\\n", "\\r", "\'", '\"', "\\Z"];
2187         return str_replace($search, $replace, $string);
2188       }
2189       $_dao = new CRM_Core_DAO();
2190     }
2191     return $_dao->escape($string);
2192   }
2193
2194   /**
2195    * Escape a list of strings for use with "WHERE X IN (...)" queries.
2196    *
2197    * @param array $strings
2198    * @param string $default
2199    *   the value to use if $strings has no elements.
2200    * @return string
2201    *   eg "abc","def","ghi"
2202    */
2203   public static function escapeStrings($strings, $default = NULL) {
2204     static $_dao = NULL;
2205     if (!$_dao) {
2206       $_dao = new CRM_Core_DAO();
2207     }
2208
2209     if (empty($strings)) {
2210       return $default;
2211     }
2212
2213     $escapes = array_map([$_dao, 'escape'], $strings);
2214     return '"' . implode('","', $escapes) . '"';
2215   }
2216
2217   /**
2218    * @param $string
2219    *
2220    * @return string
2221    */
2222   public static function escapeWildCardString($string) {
2223     // CRM-9155
2224     // ensure we escape the single characters % and _ which are mysql wild
2225     // card characters and could come in via sortByCharacter
2226     // note that mysql does not escape these characters
2227     if ($string && in_array($string,
2228         ['%', '_', '%%', '_%']
2229       )
2230     ) {
2231       return '\\' . $string;
2232     }
2233
2234     return self::escapeString($string);
2235   }
2236
2237   /**
2238    * Creates a test object, including any required objects it needs via recursion
2239    * createOnly: only create in database, do not store or return the objects (useful for perf testing)
2240    * ONLY USE FOR TESTING
2241    *
2242    * @param string $daoName
2243    * @param array $params
2244    * @param int $numObjects
2245    * @param bool $createOnly
2246    *
2247    * @return object|array|NULL
2248    *   NULL if $createOnly. A single object if $numObjects==1. Otherwise, an array of multiple objects.
2249    */
2250   public static function createTestObject(
2251     $daoName,
2252     $params = [],
2253     $numObjects = 1,
2254     $createOnly = FALSE
2255   ) {
2256     //this is a test function  also backtrace is set for the test suite it sometimes unsets itself
2257     // so we re-set here in case
2258     $config = CRM_Core_Config::singleton();
2259     $config->backtrace = TRUE;
2260
2261     static $counter = 0;
2262     CRM_Core_DAO::$_testEntitiesToSkip = [
2263       'CRM_Core_DAO_Worldregion',
2264       'CRM_Core_DAO_StateProvince',
2265       'CRM_Core_DAO_Country',
2266       'CRM_Core_DAO_Domain',
2267       'CRM_Financial_DAO_FinancialType',
2268       //because valid ones exist & we use pick them due to pseudoconstant can't reliably create & delete these
2269     ];
2270
2271     // Prefer to instantiate BAO's instead of DAO's (when possible)
2272     // so that assignTestValue()/assignTestFK() can be overloaded.
2273     $baoName = str_replace('_DAO_', '_BAO_', $daoName);
2274     if ($baoName === 'CRM_Financial_BAO_FinancialTrxn') {
2275       // OMG OMG OMG this is so incredibly bad. The BAO is insanely named.
2276       // @todo create a new class called what the BAO SHOULD be
2277       // that extends BAO-crazy-name.... migrate.
2278       $baoName = 'CRM_Core_BAO_FinancialTrxn';
2279     }
2280     if (class_exists($baoName)) {
2281       $daoName = $baoName;
2282     }
2283
2284     for ($i = 0; $i < $numObjects; ++$i) {
2285
2286       ++$counter;
2287       /** @var CRM_Core_DAO $object */
2288       $object = new $daoName();
2289
2290       $fields = $object->fields();
2291       foreach ($fields as $fieldName => $fieldDef) {
2292         $dbName = $fieldDef['name'];
2293         $FKClassName = $fieldDef['FKClassName'] ?? NULL;
2294
2295         if (isset($params[$dbName]) && !is_array($params[$dbName])) {
2296           $object->$dbName = $params[$dbName];
2297         }
2298
2299         elseif ($dbName != 'id') {
2300           if ($FKClassName != NULL) {
2301             $object->assignTestFK($fieldName, $fieldDef, $params);
2302             continue;
2303           }
2304           else {
2305             $object->assignTestValue($fieldName, $fieldDef, $counter);
2306           }
2307         }
2308       }
2309
2310       $object->save();
2311
2312       if (!$createOnly) {
2313         $objects[$i] = $object;
2314       }
2315       else {
2316         unset($object);
2317       }
2318     }
2319
2320     if ($createOnly) {
2321       return NULL;
2322     }
2323     elseif ($numObjects == 1) {
2324       return $objects[0];
2325     }
2326     else {
2327       return $objects;
2328     }
2329   }
2330
2331   /**
2332    * Deletes the this object plus any dependent objects that are associated with it.
2333    * ONLY USE FOR TESTING
2334    *
2335    * @param string $daoName
2336    * @param array $params
2337    */
2338   public static function deleteTestObjects($daoName, $params = []) {
2339     //this is a test function  also backtrace is set for the test suite it sometimes unsets itself
2340     // so we re-set here in case
2341     $config = CRM_Core_Config::singleton();
2342     $config->backtrace = TRUE;
2343
2344     $object = new $daoName();
2345     $object->id = $params['id'] ?? NULL;
2346
2347     // array(array(0 => $daoName, 1 => $daoParams))
2348     $deletions = [];
2349     if ($object->find(TRUE)) {
2350
2351       $fields = $object->fields();
2352       foreach ($fields as $name => $value) {
2353
2354         $dbName = $value['name'];
2355
2356         $FKClassName = $value['FKClassName'] ?? NULL;
2357         $required = $value['required'] ?? NULL;
2358         if ($FKClassName != NULL
2359           && $object->$dbName
2360           && !in_array($FKClassName, CRM_Core_DAO::$_testEntitiesToSkip)
2361           && ($required || $dbName == 'contact_id')
2362           //I'm a bit stuck on this one - we might need to change the singleValueAlter so that the entities don't share a contact
2363           // to make this test process pass - line below makes pass for now
2364           && $dbName != 'member_of_contact_id'
2365         ) {
2366           // x
2367           $deletions[] = [$FKClassName, ['id' => $object->$dbName]];
2368         }
2369       }
2370     }
2371
2372     $object->delete();
2373
2374     foreach ($deletions as $deletion) {
2375       CRM_Core_DAO::deleteTestObjects($deletion[0], $deletion[1]);
2376     }
2377   }
2378
2379   /**
2380    * Set defaults when creating new entity.
2381    * (don't call this set defaults as already in use with different signature in some places)
2382    *
2383    * @param array $params
2384    * @param $defaults
2385    */
2386   public static function setCreateDefaults(&$params, $defaults) {
2387     if (!empty($params['id'])) {
2388       return;
2389     }
2390     foreach ($defaults as $key => $value) {
2391       if (!array_key_exists($key, $params) || $params[$key] === NULL) {
2392         $params[$key] = $value;
2393       }
2394     }
2395   }
2396
2397   /**
2398    * @param string $prefix
2399    * @param bool $addRandomString
2400    * @param null $string
2401    *
2402    * @return string
2403    * @deprecated
2404    * @see CRM_Utils_SQL_TempTable
2405    */
2406   public static function createTempTableName($prefix = 'civicrm', $addRandomString = TRUE, $string = NULL) {
2407     CRM_Core_Error::deprecatedFunctionWarning('Use CRM_Utils_SQL_TempTable interface to create temporary tables');
2408     $tableName = $prefix . "_temp";
2409
2410     if ($addRandomString) {
2411       if ($string) {
2412         $tableName .= "_" . $string;
2413       }
2414       else {
2415         $tableName .= "_" . md5(uniqid('', TRUE));
2416       }
2417     }
2418     return $tableName;
2419   }
2420
2421   /**
2422    * @param bool $view
2423    * @param bool $trigger
2424    *
2425    * @return bool
2426    */
2427   public static function checkTriggerViewPermission($view = TRUE, $trigger = TRUE) {
2428     if (\Civi::settings()->get('logging_no_trigger_permission')) {
2429       return TRUE;
2430     }
2431     // test for create view and trigger permissions and if allowed, add the option to go multilingual and logging
2432     $dao = new CRM_Core_DAO();
2433     try {
2434       if ($view) {
2435         $dao->query('CREATE OR REPLACE VIEW civicrm_domain_view AS SELECT * FROM civicrm_domain');
2436         $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
2437       }
2438
2439       if ($trigger) {
2440         $dao->query('CREATE TRIGGER civicrm_domain_trigger BEFORE INSERT ON civicrm_domain FOR EACH ROW BEGIN END');
2441         $dao->query('DROP TRIGGER IF EXISTS civicrm_domain_trigger');
2442       }
2443     }
2444     catch (Exception $e) {
2445       return FALSE;
2446     }
2447
2448     return TRUE;
2449   }
2450
2451   /**
2452    * @param null $message
2453    * @param bool $printDAO
2454    */
2455   public static function debugPrint($message = NULL, $printDAO = TRUE) {
2456     CRM_Utils_System::xMemory("{$message}: ");
2457
2458     if ($printDAO) {
2459       global $_DB_DATAOBJECT;
2460       $q = [];
2461       foreach (array_keys($_DB_DATAOBJECT['RESULTS']) as $id) {
2462         $q[] = $_DB_DATAOBJECT['RESULTS'][$id]->query;
2463       }
2464       CRM_Core_Error::debug('_DB_DATAOBJECT', $q);
2465     }
2466   }
2467
2468   /**
2469    * Build a list of triggers via hook and add them to (err, reconcile them
2470    * with) the database.
2471    *
2472    * @param string $tableName
2473    *   the specific table requiring a rebuild; or NULL to rebuild all tables.
2474    * @param bool $force
2475    * @deprecated
2476    *
2477    * @see CRM-9716
2478    */
2479   public static function triggerRebuild($tableName = NULL, $force = FALSE) {
2480     Civi::service('sql_triggers')->rebuild($tableName, $force);
2481   }
2482
2483   /**
2484    * Wrapper function to drop triggers.
2485    *
2486    * @param string $tableName
2487    *   the specific table requiring a rebuild; or NULL to rebuild all tables.
2488    * @deprecated
2489    */
2490   public static function dropTriggers($tableName = NULL) {
2491     Civi::service('sql_triggers')->dropTriggers($tableName);
2492   }
2493
2494   /**
2495    * @param array $info
2496    *   per hook_civicrm_triggerInfo.
2497    * @param string $onlyTableName
2498    *   the specific table requiring a rebuild; or NULL to rebuild all tables.
2499    * @deprecated
2500    */
2501   public static function createTriggers(&$info, $onlyTableName = NULL) {
2502     Civi::service('sql_triggers')->createTriggers($info, $onlyTableName);
2503   }
2504
2505   /**
2506    * Given a list of fields, create a list of references.
2507    *
2508    * @param string $className
2509    *   BAO/DAO class name.
2510    * @return array<CRM_Core_Reference_Interface>
2511    */
2512   public static function createReferenceColumns($className) {
2513     $result = [];
2514     $fields = $className::fields();
2515     foreach ($fields as $field) {
2516       if (isset($field['pseudoconstant'], $field['pseudoconstant']['optionGroupName'])) {
2517         $result[] = new CRM_Core_Reference_OptionValue(
2518           $className::getTableName(),
2519           $field['name'],
2520           'civicrm_option_value',
2521           CRM_Utils_Array::value('keyColumn', $field['pseudoconstant'], 'value'),
2522           $field['pseudoconstant']['optionGroupName']
2523         );
2524       }
2525     }
2526     return $result;
2527   }
2528
2529   /**
2530    * Find all records which refer to this entity.
2531    *
2532    * @return CRM_Core_DAO[]
2533    */
2534   public function findReferences() {
2535     $links = self::getReferencesToTable(static::getTableName());
2536
2537     $occurrences = [];
2538     foreach ($links as $refSpec) {
2539       /** @var $refSpec CRM_Core_Reference_Interface */
2540       $daoName = CRM_Core_DAO_AllCoreTables::getClassForTable($refSpec->getReferenceTable());
2541       $result = $refSpec->findReferences($this);
2542       if ($result) {
2543         while ($result->fetch()) {
2544           $obj = new $daoName();
2545           $obj->id = $result->id;
2546           $occurrences[] = $obj;
2547         }
2548       }
2549     }
2550
2551     return $occurrences;
2552   }
2553
2554   /**
2555    * @return array{name: string, type: string, count: int, table: string|null, key: string|null}[]
2556    *   each item has keys:
2557    *   - name: string
2558    *   - type: string
2559    *   - count: int
2560    *   - table: string|null SQL table name
2561    *   - key: string|null SQL column name
2562    */
2563   public function getReferenceCounts() {
2564     $links = self::getReferencesToTable(static::getTableName());
2565
2566     $counts = [];
2567     foreach ($links as $refSpec) {
2568       /** @var $refSpec CRM_Core_Reference_Interface */
2569       $count = $refSpec->getReferenceCount($this);
2570       if (!empty($count['count'])) {
2571         $counts[] = $count;
2572       }
2573     }
2574
2575     foreach (CRM_Core_Component::getEnabledComponents() as $component) {
2576       /** @var $component CRM_Core_Component_Info */
2577       $counts = array_merge($counts, $component->getReferenceCounts($this));
2578     }
2579     CRM_Utils_Hook::referenceCounts($this, $counts);
2580
2581     return $counts;
2582   }
2583
2584   /**
2585    * List all tables which have hard foreign keys to this table.
2586    *
2587    * For now, this returns a description of every entity_id/entity_table
2588    * reference.
2589    * TODO: filter dynamic entity references on the $tableName, based on
2590    * schema metadata in dynamicForeignKey which enumerates a restricted
2591    * set of possible entity_table's.
2592    *
2593    * @param string $tableName
2594    *   Table referred to.
2595    *
2596    * @return CRM_Core_Reference_Interface[]
2597    *   structure of table and column, listing every table with a
2598    *   foreign key reference to $tableName, and the column where the key appears.
2599    */
2600   public static function getReferencesToTable($tableName) {
2601     $refsFound = [];
2602     foreach (CRM_Core_DAO_AllCoreTables::getClasses() as $daoClassName) {
2603       $links = $daoClassName::getReferenceColumns();
2604
2605       foreach ($links as $refSpec) {
2606         /** @var $refSpec CRM_Core_Reference_Interface */
2607         if ($refSpec->matchesTargetTable($tableName)) {
2608           $refsFound[] = $refSpec;
2609         }
2610       }
2611     }
2612     return $refsFound;
2613   }
2614
2615   /**
2616    * Get all references to contact table.
2617    *
2618    * This includes core tables, custom group tables, tables added by the merge
2619    * hook and  the entity_tag table.
2620    *
2621    * Refer to CRM-17454 for information on the danger of querying the information
2622    * schema to derive this.
2623    *
2624    * @throws \CiviCRM_API3_Exception
2625    */
2626   public static function getReferencesToContactTable() {
2627     if (isset(\Civi::$statics[__CLASS__]) && isset(\Civi::$statics[__CLASS__]['contact_references'])) {
2628       return \Civi::$statics[__CLASS__]['contact_references'];
2629     }
2630     $contactReferences = [];
2631     $coreReferences = CRM_Core_DAO::getReferencesToTable('civicrm_contact');
2632     foreach ($coreReferences as $coreReference) {
2633       if (
2634         // Exclude option values
2635         !is_a($coreReference, 'CRM_Core_Reference_Dynamic') &&
2636         // Exclude references to other columns
2637         $coreReference->getTargetKey() === 'id'
2638       ) {
2639         $contactReferences[$coreReference->getReferenceTable()][] = $coreReference->getReferenceKey();
2640       }
2641     }
2642     self::appendCustomTablesExtendingContacts($contactReferences);
2643     self::appendCustomContactReferenceFields($contactReferences);
2644     \Civi::$statics[__CLASS__]['contact_references'] = $contactReferences;
2645     return \Civi::$statics[__CLASS__]['contact_references'];
2646   }
2647
2648   /**
2649    * Get all dynamic references to the given table.
2650    *
2651    * @param string $tableName
2652    *
2653    * @return array
2654    */
2655   public static function getDynamicReferencesToTable($tableName) {
2656     if (!isset(\Civi::$statics[__CLASS__]['contact_references_dynamic'][$tableName])) {
2657       \Civi::$statics[__CLASS__]['contact_references_dynamic'][$tableName] = [];
2658       $coreReferences = CRM_Core_DAO::getReferencesToTable($tableName);
2659       foreach ($coreReferences as $coreReference) {
2660         if ($coreReference instanceof \CRM_Core_Reference_Dynamic) {
2661           \Civi::$statics[__CLASS__]['contact_references_dynamic'][$tableName][$coreReference->getReferenceTable()][] = [$coreReference->getReferenceKey(), $coreReference->getTypeColumn()];
2662         }
2663       }
2664     }
2665     return \Civi::$statics[__CLASS__]['contact_references_dynamic'][$tableName];
2666   }
2667
2668   /**
2669    * Add custom tables that extend contacts to the list of contact references.
2670    *
2671    * CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity seems like a safe-ish
2672    * function to be sure all are retrieved & we don't miss subtypes or inactive or multiples
2673    * - the down side is it is not cached.
2674    *
2675    * Further changes should be include tests in the CRM_Core_MergerTest class
2676    * to ensure that disabled, subtype, multiple etc groups are still captured.
2677    *
2678    * @param array $cidRefs
2679    */
2680   public static function appendCustomTablesExtendingContacts(&$cidRefs) {
2681     $customValueTables = CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity('Contact');
2682     $customValueTables->find();
2683     while ($customValueTables->fetch()) {
2684       $cidRefs[$customValueTables->table_name][] = 'entity_id';
2685     }
2686   }
2687
2688   /**
2689    * Add custom ContactReference fields to the list of contact references
2690    *
2691    * This includes active and inactive fields/groups
2692    *
2693    * @param array $cidRefs
2694    *
2695    * @throws \CiviCRM_API3_Exception
2696    */
2697   public static function appendCustomContactReferenceFields(&$cidRefs) {
2698     $fields = civicrm_api3('CustomField', 'get', [
2699       'return'    => ['column_name', 'custom_group_id.table_name'],
2700       'data_type' => 'ContactReference',
2701       'options' => ['limit' => 0],
2702     ])['values'];
2703     foreach ($fields as $field) {
2704       $cidRefs[$field['custom_group_id.table_name']][] = $field['column_name'];
2705     }
2706   }
2707
2708   /**
2709    * Lookup the value of a MySQL global configuration variable.
2710    *
2711    * @param string $name
2712    *   E.g. "thread_stack".
2713    * @param mixed $default
2714    * @return mixed
2715    */
2716   public static function getGlobalSetting($name, $default = NULL) {
2717     // Alternatively, SELECT @@GLOBAL.thread_stack, but
2718     // that has been reported to fail under MySQL 5.0 for OS X
2719     $escapedName = self::escapeString($name);
2720     $dao = CRM_Core_DAO::executeQuery("SHOW VARIABLES LIKE '$escapedName'");
2721     if ($dao->fetch()) {
2722       return $dao->Value;
2723     }
2724     else {
2725       return $default;
2726     }
2727   }
2728
2729   /**
2730    * Update the fields array to also hold keys for pseudoconstant fields that relate to contained fields.
2731    *
2732    * This is relevant where we want to offer both the ID field and the label field
2733    * as an option, e.g. search builder.
2734    *
2735    * It is currently limited for optionGroupName & id+ name+ FK combos for purposes keeping the scope of the
2736    * change small, but is appropriate for other sorts of pseudoconstants.
2737    *
2738    * @param array $fields
2739    */
2740   public static function appendPseudoConstantsToFields(&$fields) {
2741     foreach ($fields as $fieldUniqueName => $field) {
2742       if (!empty($field['pseudoconstant'])) {
2743         $pseudoConstant = $field['pseudoconstant'];
2744         if (!empty($pseudoConstant['optionGroupName'])) {
2745           $fields[$pseudoConstant['optionGroupName']] = [
2746             'title' => CRM_Core_BAO_OptionGroup::getTitleByName($pseudoConstant['optionGroupName']),
2747             'name' => $pseudoConstant['optionGroupName'],
2748             'data_type' => CRM_Utils_Type::T_STRING,
2749             'is_pseudofield_for' => $fieldUniqueName,
2750           ];
2751         }
2752         // We restrict to id + name + FK as we are extending this a bit, but cautiously.
2753         elseif (
2754           !empty($field['FKClassName'])
2755           && CRM_Utils_Array::value('keyColumn', $pseudoConstant) === 'id'
2756           && CRM_Utils_Array::value('labelColumn', $pseudoConstant) === 'name'
2757         ) {
2758           $pseudoFieldName = str_replace('_' . $pseudoConstant['keyColumn'], '', $field['name']);
2759           // This if is just an extra caution when adding change.
2760           if (!isset($fields[$pseudoFieldName])) {
2761             $daoName = $field['FKClassName'];
2762             $fkFields = $daoName::fields();
2763             foreach ($fkFields as $fkField) {
2764               if ($fkField['name'] === $pseudoConstant['labelColumn']) {
2765                 $fields[$pseudoFieldName] = [
2766                   'name' => $pseudoFieldName,
2767                   'is_pseudofield_for' => $field['name'],
2768                   'title' => $fkField['title'],
2769                   'data_type' => $fkField['type'],
2770                   'where' => $field['where'],
2771                 ];
2772               }
2773             }
2774           }
2775         }
2776       }
2777     }
2778   }
2779
2780   /**
2781    * Get options for the called BAO object's field.
2782    *
2783    * This function can be overridden by each BAO to add more logic related to context.
2784    * The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
2785    *
2786    * @param string $fieldName
2787    * @param string $context
2788    * @see CRM_Core_DAO::buildOptionsContext
2789    * @param array $props
2790    *   Raw field values; whatever is known about this bao object.
2791    *
2792    * Note: $props can contain unsanitized input and should not be passed directly to CRM_Core_PseudoConstant::get
2793    *
2794    * @return array|bool
2795    */
2796   public static function buildOptions($fieldName, $context = NULL, $props = []) {
2797     // If a given bao does not override this function
2798     $baoName = get_called_class();
2799     return CRM_Core_PseudoConstant::get($baoName, $fieldName, [], $context);
2800   }
2801
2802   /**
2803    * Populate option labels for this object's fields.
2804    *
2805    * @throws exception if called directly on the base class
2806    */
2807   public function getOptionLabels() {
2808     $fields = $this->fields();
2809     if ($fields === NULL) {
2810       throw new Exception('Cannot call getOptionLabels on CRM_Core_DAO');
2811     }
2812     foreach ($fields as $field) {
2813       $name = $field['name'] ?? NULL;
2814       if ($name && isset($this->$name)) {
2815         $label = CRM_Core_PseudoConstant::getLabel(get_class($this), $name, $this->$name);
2816         if ($label !== FALSE) {
2817           // Append 'label' onto the field name
2818           $labelName = $name . '_label';
2819           $this->$labelName = $label;
2820         }
2821       }
2822     }
2823   }
2824
2825   /**
2826    * Provides documentation and validation for the buildOptions $context param
2827    *
2828    * @param string $context
2829    *
2830    * @throws CRM_Core_Exception
2831    * @return array
2832    */
2833   public static function buildOptionsContext($context = NULL) {
2834     $contexts = [
2835       'get' => "get: all options are returned, even if they are disabled; labels are translated.",
2836       'create' => "create: options are filtered appropriately for the object being created/updated; labels are translated.",
2837       'search' => "search: searchable options are returned; labels are translated.",
2838       'validate' => "validate: all options are returned, even if they are disabled; machine names are used in place of labels.",
2839       'abbreviate' => "abbreviate: enabled options are returned; labels are replaced with abbreviations.",
2840       'match' => "match: enabled options are returned using machine names as keys; labels are translated.",
2841     ];
2842     // Validation: enforce uniformity of this param
2843     if ($context !== NULL && !isset($contexts[$context])) {
2844       throw new CRM_Core_Exception("'$context' is not a valid context for buildOptions.");
2845     }
2846     return $contexts;
2847   }
2848
2849   /**
2850    * @param string $fieldName
2851    * @return bool|array
2852    */
2853   public function getFieldSpec($fieldName) {
2854     $fields = $this->fields();
2855
2856     // Support "unique names" as well as sql names
2857     $fieldKey = $fieldName;
2858     if (empty($fields[$fieldKey])) {
2859       $fieldKeys = $this->fieldKeys();
2860       $fieldKey = $fieldKeys[$fieldName] ?? NULL;
2861     }
2862     // If neither worked then this field doesn't exist. Return false.
2863     if (empty($fields[$fieldKey])) {
2864       return FALSE;
2865     }
2866     return $fields[$fieldKey];
2867   }
2868
2869   /**
2870    * Get SQL where clause for SQL filter syntax input parameters.
2871    *
2872    * SQL version of api function to assign filters to the DAO based on the syntax
2873    * $field => array('IN' => array(4,6,9))
2874    * OR
2875    * $field => array('LIKE' => array('%me%))
2876    * etc
2877    *
2878    * @param string $fieldName
2879    *   Name of fields.
2880    * @param array $filter
2881    *   filter to be applied indexed by operator.
2882    * @param string $type
2883    *   type of field (not actually used - nor in api @todo ).
2884    * @param string $alias
2885    *   alternative field name ('as') @todo- not actually used.
2886    * @param bool $returnSanitisedArray
2887    *   Return a sanitised array instead of a clause.
2888    *   this is primarily so we can add filters @ the api level to the Query object based fields
2889    *
2890    * @throws Exception
2891    *
2892    * @return NULL|string|array
2893    *   a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL
2894    *   depending on whether it is supported as yet
2895    */
2896   public static function createSQLFilter($fieldName, $filter, $type = NULL, $alias = NULL, $returnSanitisedArray = FALSE) {
2897     foreach ($filter as $operator => $criteria) {
2898       $emojiFilter = CRM_Utils_SQL::handleEmojiInQuery($criteria);
2899       if ($emojiFilter === '0 = 1') {
2900         return $emojiFilter;
2901       }
2902
2903       if (in_array($operator, self::acceptedSQLOperators(), TRUE)) {
2904         switch ($operator) {
2905           // unary operators
2906           case 'IS NULL':
2907           case 'IS NOT NULL':
2908             if (!$returnSanitisedArray) {
2909               return (sprintf('%s %s', $fieldName, $operator));
2910             }
2911             else {
2912               return (sprintf('%s %s ', $fieldName, $operator));
2913             }
2914             break;
2915
2916           // ternary operators
2917           case 'BETWEEN':
2918           case 'NOT BETWEEN':
2919             if ((empty($criteria[0]) && !in_array($criteria[0], ['0', 0]))|| (empty($criteria[1]) &&  !in_array($criteria[1], ['0', 0]))) {
2920               throw new Exception("invalid criteria for $operator");
2921             }
2922             if (!$returnSanitisedArray) {
2923               return (sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO::escapeString($criteria[0]), CRM_Core_DAO::escapeString($criteria[1])));
2924             }
2925             else {
2926               // not yet implemented (tests required to implement)
2927               return NULL;
2928             }
2929             break;
2930
2931           // n-ary operators
2932           case 'IN':
2933           case 'NOT IN':
2934             if (empty($criteria)) {
2935               throw new Exception("invalid criteria for $operator");
2936             }
2937             $escapedCriteria = array_map([
2938               'CRM_Core_DAO',
2939               'escapeString',
2940             ], $criteria);
2941             if (!$returnSanitisedArray) {
2942               return (sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria)));
2943             }
2944             return $escapedCriteria;
2945
2946           // binary operators
2947
2948           default:
2949             if (!$returnSanitisedArray) {
2950               return (sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO::escapeString($criteria)));
2951             }
2952             else {
2953               // not yet implemented (tests required to implement)
2954               return NULL;
2955             }
2956         }
2957       }
2958     }
2959   }
2960
2961   /**
2962    * @see http://issues.civicrm.org/jira/browse/CRM-9150
2963    * support for other syntaxes is discussed in ticket but being put off for now
2964    * @return string[]
2965    */
2966   public static function acceptedSQLOperators() {
2967     return [
2968       '=',
2969       '<=',
2970       '>=',
2971       '>',
2972       '<',
2973       'LIKE',
2974       "<>",
2975       "!=",
2976       "NOT LIKE",
2977       'IN',
2978       'NOT IN',
2979       'BETWEEN',
2980       'NOT BETWEEN',
2981       'IS NOT NULL',
2982       'IS NULL',
2983     ];
2984   }
2985
2986   /**
2987    * SQL has a limit of 64 characters on various names:
2988    * table name, trigger name, column name ...
2989    *
2990    * For custom groups and fields we generated names from user entered input
2991    * which can be longer than this length, this function helps with creating
2992    * strings that meet various criteria.
2993    *
2994    * @param string $string
2995    *   The string to be shortened.
2996    * @param int $length
2997    *   The max length of the string.
2998    *
2999    * @param bool $makeRandom
3000    *
3001    * @return string
3002    */
3003   public static function shortenSQLName($string, $length = 60, $makeRandom = FALSE) {
3004     // early return for strings that meet the requirements
3005     if (strlen($string) <= $length) {
3006       return $string;
3007     }
3008
3009     // easy return for calls that dont need a randomized uniq string
3010     if (!$makeRandom) {
3011       return substr($string, 0, $length);
3012     }
3013
3014     // the string is longer than the length and we need a uniq string
3015     // for the same tablename we need the same uniq string every time
3016     // hence we use md5 on the string, which is not random
3017     // we'll append 8 characters to the end of the tableName
3018     $md5string = substr(md5($string), 0, 8);
3019     return substr($string, 0, $length - 8) . "_{$md5string}";
3020   }
3021
3022   /**
3023    * https://issues.civicrm.org/jira/browse/CRM-17748
3024    * Sets the internal options to be used on a query
3025    *
3026    * @param array $options
3027    *
3028    */
3029   public function setOptions($options) {
3030     if (is_array($options)) {
3031       $this->_options = $options;
3032     }
3033   }
3034
3035   /**
3036    * https://issues.civicrm.org/jira/browse/CRM-17748
3037    * wrapper to pass internal DAO options down to DB_mysql/DB_Common level
3038    *
3039    * @param array $options
3040    *
3041    */
3042   protected function _setDBOptions($options) {
3043     global $_DB_DATAOBJECT;
3044
3045     if (is_array($options) && count($options)) {
3046       $conn = &$_DB_DATAOBJECT['CONNECTIONS'][$this->_database_dsn_md5];
3047       foreach ($options as $option_name => $option_value) {
3048         $conn->setOption($option_name, $option_value);
3049       }
3050     }
3051   }
3052
3053   /**
3054    * @deprecated
3055    * @param array $params
3056    */
3057   public function setApiFilter(&$params) {
3058   }
3059
3060   /**
3061    * Generates acl clauses suitable for adding to WHERE or ON when doing an api.get for this entity
3062    *
3063    * Return format is in the form of fieldname => clauses starting with an operator. e.g.:
3064    * ```
3065    *   array(
3066    *     'location_type_id' => array('IS NOT NULL', 'IN (1,2,3)')
3067    *   )
3068    * ```
3069    *
3070    * Note that all array keys must be actual field names in this entity. Use subqueries to filter on other tables e.g. custom values.
3071    *
3072    * @return array
3073    */
3074   public function addSelectWhereClause() {
3075     $clauses = [];
3076     $fields = $this->fields();
3077     foreach ($fields as $fieldName => $field) {
3078       // Clause for contact-related entities like Email, Relationship, etc.
3079       if (strpos($fieldName, 'contact_id') === 0 && CRM_Utils_Array::value('FKClassName', $field) == 'CRM_Contact_DAO_Contact') {
3080         $clauses[$fieldName] = CRM_Utils_SQL::mergeSubquery('Contact');
3081       }
3082       // Clause for an entity_table/entity_id combo
3083       if ($fieldName === 'entity_id' && isset($fields['entity_table'])) {
3084         $relatedClauses = [];
3085         $relatedEntities = $this->buildOptions('entity_table', 'get');
3086         foreach ((array) $relatedEntities as $table => $ent) {
3087           if (!empty($ent)) {
3088             $ent = CRM_Core_DAO_AllCoreTables::getEntityNameForTable($table);
3089             $subquery = CRM_Utils_SQL::mergeSubquery($ent);
3090             if ($subquery) {
3091               $relatedClauses[] = "(entity_table = '$table' AND entity_id " . implode(' AND entity_id ', $subquery) . ")";
3092             }
3093             else {
3094               $relatedClauses[] = "(entity_table = '$table')";
3095             }
3096           }
3097         }
3098         if ($relatedClauses) {
3099           $clauses['id'] = 'IN (SELECT id FROM `' . $this->tableName() . '` WHERE (' . implode(') OR (', $relatedClauses) . '))';
3100         }
3101       }
3102     }
3103     CRM_Utils_Hook::selectWhereClause($this, $clauses);
3104     return $clauses;
3105   }
3106
3107   /**
3108    * This returns the final permissioned query string for this entity
3109    *
3110    * With acls from related entities + additional clauses from hook_civicrm_selectWhereClause
3111    *
3112    * @param string $tableAlias
3113    * @return array
3114    */
3115   public static function getSelectWhereClause($tableAlias = NULL) {
3116     $bao = new static();
3117     if ($tableAlias === NULL) {
3118       $tableAlias = $bao->tableName();
3119     }
3120     $clauses = [];
3121     foreach ((array) $bao->addSelectWhereClause() as $field => $vals) {
3122       $clauses[$field] = NULL;
3123       if ($vals) {
3124         $clauses[$field] = "(`$tableAlias`.`$field` IS NULL OR (`$tableAlias`.`$field` " . implode(" AND `$tableAlias`.`$field` ", (array) $vals) . '))';
3125       }
3126     }
3127     return $clauses;
3128   }
3129
3130   /**
3131    * ensure database name is 'safe', i.e. only contains word characters (includes underscores)
3132    * and dashes, and contains at least one [a-z] case insensitive.
3133    *
3134    * @param $database
3135    *
3136    * @return bool
3137    */
3138   public static function requireSafeDBName($database) {
3139     $matches = [];
3140     preg_match(
3141       "/^[\w\-]*[a-z]+[\w\-]*$/i",
3142       $database,
3143       $matches
3144     );
3145     if (empty($matches)) {
3146       return FALSE;
3147     }
3148     return TRUE;
3149   }
3150
3151   /**
3152    * Transform an array to a serialized string for database storage.
3153    *
3154    * @param array|null $value
3155    * @param int $serializationType
3156    * @return string|null
3157    *
3158    * @throws \Exception
3159    */
3160   public static function serializeField($value, $serializationType) {
3161     if ($value === NULL) {
3162       return NULL;
3163     }
3164     switch ($serializationType) {
3165       case self::SERIALIZE_SEPARATOR_BOOKEND:
3166         return $value === [] ? '' : CRM_Utils_Array::implodePadded($value);
3167
3168       case self::SERIALIZE_SEPARATOR_TRIMMED:
3169         return is_array($value) ? implode(self::VALUE_SEPARATOR, $value) : $value;
3170
3171       case self::SERIALIZE_JSON:
3172         return is_array($value) ? json_encode($value) : $value;
3173
3174       case self::SERIALIZE_PHP:
3175         return is_array($value) ? serialize($value) : $value;
3176
3177       case self::SERIALIZE_COMMA:
3178         return is_array($value) ? implode(',', $value) : $value;
3179
3180       default:
3181         throw new Exception('Unknown serialization method for field.');
3182     }
3183   }
3184
3185   /**
3186    * Transform a serialized string from the database into an array.
3187    *
3188    * @param string|null $value
3189    * @param $serializationType
3190    *
3191    * @return array|null
3192    * @throws CRM_Core_Exception
3193    */
3194   public static function unSerializeField($value, $serializationType) {
3195     if ($value === NULL) {
3196       return NULL;
3197     }
3198     if ($value === '') {
3199       return [];
3200     }
3201     switch ($serializationType) {
3202       case self::SERIALIZE_SEPARATOR_BOOKEND:
3203         return (array) CRM_Utils_Array::explodePadded($value);
3204
3205       case self::SERIALIZE_SEPARATOR_TRIMMED:
3206         return explode(self::VALUE_SEPARATOR, trim($value));
3207
3208       case self::SERIALIZE_JSON:
3209         return strlen($value) ? json_decode($value, TRUE) : [];
3210
3211       case self::SERIALIZE_PHP:
3212         return strlen($value) ? CRM_Utils_String::unserialize($value) : [];
3213
3214       case self::SERIALIZE_COMMA:
3215         return explode(',', trim(str_replace(', ', '', $value)));
3216
3217       default:
3218         throw new CRM_Core_Exception('Unknown serialization method for field.');
3219     }
3220   }
3221
3222   /**
3223    * @return array
3224    */
3225   public static function getEntityRefFilters() {
3226     return [];
3227   }
3228
3229   /**
3230    * Get exportable fields with pseudoconstants rendered as an extra field.
3231    *
3232    * @param string $baoClass
3233    *
3234    * @return array
3235    */
3236   public static function getExportableFieldsWithPseudoConstants($baoClass) {
3237     if (method_exists($baoClass, 'exportableFields')) {
3238       $fields = $baoClass::exportableFields();
3239     }
3240     else {
3241       $fields = $baoClass::export();
3242     }
3243     CRM_Core_DAO::appendPseudoConstantsToFields($fields);
3244     return $fields;
3245   }
3246
3247   /**
3248    * Remove item from static cache during update/delete operations
3249    */
3250   private function clearDbColumnValueCache() {
3251     $daoName = get_class($this);
3252     while (strpos($daoName, '_BAO_') !== FALSE) {
3253       $daoName = get_parent_class($daoName);
3254     }
3255     if (isset($this->id)) {
3256       unset(self::$_dbColumnValueCache[$daoName]['id'][$this->id]);
3257     }
3258     if (isset($this->name)) {
3259       unset(self::$_dbColumnValueCache[$daoName]['name'][$this->name]);
3260     }
3261   }
3262
3263   /**
3264    * Return a mapping from field-name to the corresponding key (as used in fields()).
3265    *
3266    * @return array
3267    *   Array(string $name => string $uniqueName).
3268    */
3269   public static function fieldKeys() {
3270     return array_flip(CRM_Utils_Array::collect('name', static::fields()));
3271   }
3272
3273   /**
3274    * Returns system paths related to this entity (as defined in the xml schema)
3275    *
3276    * @return array
3277    */
3278   public static function getEntityPaths() {
3279     return static::$_paths ?? [];
3280   }
3281
3282 }