CRM/Core/DAO.php

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