CRM/Core/DAO.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.4                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2013                                |
   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  * Our base DAO class. All DAO classes should inherit from this class.
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2013
  33  * $Id$
  34  *
  35  */
  36
  37 require_once 'PEAR.php';
  38 require_once 'DB/DataObject.php';
  39
  40 require_once 'CRM/Core/I18n.php';
  41 class CRM_Core_DAO extends DB_DataObject {
  42
  43   /**
  44    * a null object so we can pass it as reference if / when needed
  45    */
  46   static $_nullObject = NULL;
  47   static $_nullArray = array();
  48
  49   static $_dbColumnValueCache = NULL;
  50   CONST NOT_NULL = 1, IS_NULL = 2,
  51   DB_DAO_NOTNULL = 128,
  52   VALUE_SEPARATOR = "\ 1",
  53   BULK_INSERT_COUNT = 200,
  54   BULK_INSERT_HIGH_COUNT = 200,
  55   // special value for mail bulk inserts to avoid
  56   // potential duplication, assuming a smaller number reduces number of queries
  57   // by some factor, so some tradeoff. CRM-8678
  58   BULK_MAIL_INSERT_COUNT = 10,
  59   QUERY_FORMAT_WILDCARD = 1,
  60   QUERY_FORMAT_NO_QUOTES = 2;
  61
  62   /*
  63    * Define entities that shouldn't be created or deleted when creating/ deleting
  64    *  test objects - this prevents world regions, countries etc from being added / deleted
  65    */
  66   static $_testEntitiesToSkip = array();
  67   /**
  68    * the factory class for this application
  69    * @var object
  70    */
  71   static $_factory = NULL;
  72
  73   static $_checkedSqlFunctionsExist = FALSE;
  74
  75   /**
  76    * Class constructor
  77    *
  78    * @return object
  79    * @access public
  80    */
  81   function __construct() {
  82     $this->initialize();
  83     $this->__table = $this->getTableName();
  84   }
  85
  86   /**
  87    * empty definition for virtual function
  88    */
  89   static function getTableName() {
  90     return NULL;
  91   }
  92
  93   /**
  94    * initialize the DAO object
  95    *
  96    * @param string $dsn   the database connection string
  97    *
  98    * @return void
  99    * @access private
 100    * @static
 101    */
 102   static function init($dsn) {
 103     $options = &PEAR::getStaticProperty('DB_DataObject', 'options');
 104     $options['database'] = $dsn;
 105     if (defined('CIVICRM_DAO_DEBUG')) {
 106       self::DebugLevel(CIVICRM_DAO_DEBUG);
 107     }
 108   }
 109
 110   /**
 111    * reset the DAO object. DAO is kinda crappy in that there is an unwritten
 112    * rule of one query per DAO. We attempt to get around this crappy restricrion
 113    * by resetting some of DAO's internal fields. Use this with caution
 114    *
 115    * @return void
 116    * @access public
 117    *
 118    */
 119   function reset() {
 120
 121     foreach (array_keys($this->table()) as $field) {
 122       unset($this->$field);
 123     }
 124
 125     /**
 126      * reset the various DB_DAO structures manually
 127      */
 128     $this->_query = array();
 129     $this->whereAdd();
 130     $this->selectAdd();
 131     $this->joinAdd();
 132   }
 133
 134   static function getLocaleTableName($tableName) {
 135     global $dbLocale;
 136     if ($dbLocale) {
 137       $tables = CRM_Core_I18n_Schema::schemaStructureTables();
 138       if (in_array($tableName, $tables)) {
 139         return $tableName . $dbLocale;
 140       }
 141     }
 142     return $tableName;
 143   }
 144
 145   /**
 146    * Execute a query by the current DAO, localizing it along the way (if needed).
 147    *
 148    * @param string $query        the SQL query for execution
 149    * @param bool   $i18nRewrite  whether to rewrite the query
 150    *
 151    * @return object              the current DAO object after the query execution
 152    */
 153   function query($query, $i18nRewrite = TRUE) {
 154     // rewrite queries that should use $dbLocale-based views for multi-language installs
 155     global $dbLocale;
 156     if ($i18nRewrite and $dbLocale) {
 157       $query = CRM_Core_I18n_Schema::rewriteQuery($query);
 158     }
 159
 160     return parent::query($query);
 161   }
 162
 163   /**
 164    * Static function to set the factory instance for this class.
 165    *
 166    * @param object $factory  the factory application object
 167    *
 168    * @return void
 169    * @access public
 170    * @static
 171    */
 172   static function setFactory(&$factory) {
 173     self::$_factory = &$factory;
 174   }
 175
 176   /**
 177    * Factory method to instantiate a new object from a table name.
 178    *
 179    * @return void
 180    * @access public
 181    */
 182   function factory($table = '') {
 183     if (!isset(self::$_factory)) {
 184       return parent::factory($table);
 185     }
 186
 187     return self::$_factory->create($table);
 188   }
 189
 190   /**
 191    * Initialization for all DAO objects. Since we access DB_DO programatically
 192    * we need to set the links manually.
 193    *
 194    * @return void
 195    * @access protected
 196    */
 197   function initialize() {
 198     $this->_connect();
 199     $this->query("SET NAMES utf8");
 200   }
 201
 202   /**
 203    * Defines the default key as 'id'.
 204    *
 205    * @access protected
 206    *
 207    * @return array
 208    */
 209   function keys() {
 210     static $keys;
 211     if (!isset($keys)) {
 212       $keys = array('id');
 213     }
 214     return $keys;
 215   }
 216
 217   /**
 218    * Tells DB_DataObject which keys use autoincrement.
 219    * 'id' is autoincrementing by default.
 220    *
 221    * @access protected
 222    *
 223    * @return array
 224    */
 225   function sequenceKey() {
 226     static $sequenceKeys;
 227     if (!isset($sequenceKeys)) {
 228       $sequenceKeys = array('id', TRUE);
 229     }
 230     return $sequenceKeys;
 231   }
 232
 233   /**
 234    * returns list of FK relationships
 235    *
 236    * @static
 237    * @access public
 238    *
 239    * @return array of CRM_Core_EntityReference
 240    */
 241   static function getReferenceColumns() {
 242     return array();
 243   }
 244
 245   /**
 246    * returns all the column names of this table
 247    *
 248    * @access public
 249    *
 250    * @return array
 251    */
 252    static function &fields() {
 253     $result = NULL;
 254     return $result;
 255   }
 256
 257   function table() {
 258     $fields = &$this->fields();
 259
 260     $table = array();
 261     if ($fields) {
 262       foreach ($fields as $name => $value) {
 263         $table[$value['name']] = $value['type'];
 264         if (CRM_Utils_Array::value('required', $value)) {
 265           $table[$value['name']] += self::DB_DAO_NOTNULL;
 266         }
 267       }
 268     }
 269
 270     return $table;
 271   }
 272
 273   function save() {
 274     if (!empty($this->id)) {
 275       $this->update();
 276     }
 277     else {
 278       $this->insert();
 279     }
 280     $this->free();
 281
 282     CRM_Utils_Hook::postSave($this);
 283
 284     return $this;
 285   }
 286
 287   function log($created = FALSE) {
 288     static $cid = NULL;
 289
 290     if (!$this->getLog()) {
 291       return;
 292     }
 293
 294     if (!$cid) {
 295       $session = CRM_Core_Session::singleton();
 296       $cid = $session->get('userID');
 297     }
 298
 299     // return is we dont have handle to FK
 300     if (!$cid) {
 301       return;
 302     }
 303
 304     $dao                = new CRM_Core_DAO_Log();
 305     $dao->entity_table  = $this->getTableName();
 306     $dao->entity_id     = $this->id;
 307     $dao->modified_id   = $cid;
 308     $dao->modified_date = date("YmdHis");
 309     $dao->insert();
 310   }
 311
 312   /**
 313    * Given an associative array of name/value pairs, extract all the values
 314    * that belong to this object and initialize the object with said values
 315    *
 316    * @param array $params (reference ) associative array of name/value pairs
 317    *
 318    * @return boolean      did we copy all null values into the object
 319    * @access public
 320    */
 321   function copyValues(&$params) {
 322     $fields = &$this->fields();
 323     $allNull = TRUE;
 324     foreach ($fields as $name => $value) {
 325       $dbName = $value['name'];
 326       if (array_key_exists($dbName, $params)) {
 327         $pValue = $params[$dbName];
 328         $exists = TRUE;
 329       }
 330       elseif (array_key_exists($name, $params)) {
 331         $pValue = $params[$name];
 332         $exists = TRUE;
 333       }
 334       else {
 335         $exists = FALSE;
 336       }
 337
 338       // if there is no value then make the variable NULL
 339       if ($exists) {
 340         if ($pValue === '') {
 341           $this->$dbName = 'null';
 342         }
 343         else {
 344           $this->$dbName = $pValue;
 345           $allNull = FALSE;
 346         }
 347       }
 348     }
 349     return $allNull;
 350   }
 351
 352   /**
 353    * Store all the values from this object in an associative array
 354    * this is a destructive store, calling function is responsible
 355    * for keeping sanity of id's.
 356    *
 357    * @param object $object the object that we are extracting data from
 358    * @param array  $values (reference ) associative array of name/value pairs
 359    *
 360    * @return void
 361    * @access public
 362    * @static
 363    */
 364   static function storeValues(&$object, &$values) {
 365     $fields = &$object->fields();
 366     foreach ($fields as $name => $value) {
 367       $dbName = $value['name'];
 368       if (isset($object->$dbName) && $object->$dbName !== 'null') {
 369         $values[$dbName] = $object->$dbName;
 370         if ($name != $dbName) {
 371           $values[$name] = $object->$dbName;
 372         }
 373       }
 374     }
 375   }
 376
 377   /**
 378    * create an attribute for this specific field. We only do this for strings and text
 379    *
 380    * @param array $field the field under task
 381    *
 382    * @return array|null the attributes for the object
 383    * @access public
 384    * @static
 385    */
 386   static function makeAttribute($field) {
 387     if ($field) {
 388       if (CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_STRING) {
 389         $maxLength = CRM_Utils_Array::value('maxlength', $field);
 390         $size = CRM_Utils_Array::value('size', $field);
 391         if ($maxLength || $size) {
 392           $attributes = array();
 393           if ($maxLength) {
 394             $attributes['maxlength'] = $maxLength;
 395           }
 396           if ($size) {
 397             $attributes['size'] = $size;
 398           }
 399           return $attributes;
 400         }
 401       }
 402       elseif (CRM_Utils_Array::value('type', $field) == CRM_Utils_Type::T_TEXT) {
 403         $rows = CRM_Utils_Array::value('rows', $field);
 404         if (!isset($rows)) {
 405           $rows = 2;
 406         }
 407         $cols = CRM_Utils_Array::value('cols', $field);
 408         if (!isset($cols)) {
 409           $cols = 80;
 410         }
 411
 412         $attributes         = array();
 413         $attributes['rows'] = $rows;
 414         $attributes['cols'] = $cols;
 415         return $attributes;
 416       }
 417       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) {
 418         $attributes['size'] = 6;
 419         $attributes['maxlength'] = 14;
 420         return $attributes;
 421       }
 422     }
 423     return NULL;
 424   }
 425
 426   /**
 427    * Get the size and maxLength attributes for this text field
 428    * (or for all text fields) in the DAO object.
 429    *
 430    * @param string $class     name of DAO class
 431    * @param string $fieldName field that i'm interested in or null if
 432    *                          you want the attributes for all DAO text fields
 433    *
 434    * @return array assoc array of name => attribute pairs
 435    * @access public
 436    * @static
 437    */
 438   static function getAttribute($class, $fieldName = NULL) {
 439     $object = new $class( );
 440     $fields = &$object->fields();
 441     if ($fieldName != NULL) {
 442       $field = CRM_Utils_Array::value($fieldName, $fields);
 443       return self::makeAttribute($field);
 444     }
 445     else {
 446       $attributes = array();
 447       foreach ($fields as $name => $field) {
 448         $attribute = self::makeAttribute($field);
 449         if ($attribute) {
 450           $attributes[$name] = $attribute;
 451         }
 452       }
 453
 454       if (!empty($attributes)) {
 455         return $attributes;
 456       }
 457     }
 458     return NULL;
 459   }
 460
 461   static function transaction($type) {
 462     CRM_Core_Error::fatal('This function is obsolete, please use CRM_Core_Transaction');
 463   }
 464
 465   /**
 466    * Check if there is a record with the same name in the db
 467    *
 468    * @param string $value     the value of the field we are checking
 469    * @param string $daoName   the dao object name
 470    * @param string $daoID     the id of the object being updated. u can change your name
 471    *                          as long as there is no conflict
 472    * @param string $fieldName the name of the field in the DAO
 473    *
 474    * @return boolean     true if object exists
 475    * @access public
 476    * @static
 477    */
 478   static function objectExists($value, $daoName, $daoID, $fieldName = 'name') {
 479     $object = new $daoName( );
 480     $object->$fieldName = $value;
 481
 482     $config = CRM_Core_Config::singleton();
 483
 484     if ($object->find(TRUE)) {
 485       return ($daoID && $object->id == $daoID) ? TRUE : FALSE;
 486     }
 487     else {
 488       return TRUE;
 489     }
 490   }
 491
 492   /**
 493    * Check if there is a given column in a specific table
 494    *
 495    * @param string $tableName
 496    * @param string $columnName
 497    * @param bool   $i18nRewrite  whether to rewrite the query on multilingual setups
 498    *
 499    * @return boolean true if exists, else false
 500    * @static
 501    */
 502   static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) {
 503     $query = "
 504 SHOW COLUMNS
 505 FROM $tableName
 506 LIKE %1
 507 ";
 508     $params = array(1 => array($columnName, 'String'));
 509     $dao    = CRM_Core_DAO::executeQuery($query, $params, TRUE, NULL, FALSE, $i18nRewrite);
 510     $result = $dao->fetch() ? TRUE : FALSE;
 511     $dao->free();
 512     return $result;
 513   }
 514
 515   /**
 516    * Returns the storage engine used by given table-name(optional).
 517    * Otherwise scans all the tables and return an array of all the
 518    * distinct storage engines being used.
 519    *
 520    * @param string $tableName
 521    *
 522    * @return array
 523    * @static
 524    */
 525   static function getStorageValues($tableName = NULL, $maxTablesToCheck = 10, $fieldName = 'Engine') {
 526     $values = array();
 527     $query = "SHOW TABLE STATUS LIKE %1";
 528
 529     $params = array();
 530
 531     if (isset($tableName)) {
 532       $params = array(1 => array($tableName, 'String'));
 533     }
 534     else {
 535       $params = array(1 => array('civicrm_%', 'String'));
 536     }
 537
 538     $dao = CRM_Core_DAO::executeQuery($query, $params);
 539
 540     $count = 0;
 541     while ($dao->fetch()) {
 542       if (isset($values[$dao->$fieldName]) ||
 543         // ignore import and other temp tables
 544         strpos($dao->Name, 'civicrm_import_job_') !== FALSE ||
 545         strpos($dao->Name, '_temp') !== FALSE
 546       ) {
 547         continue;
 548       }
 549       $values[$dao->$fieldName] = 1;
 550       $count++;
 551       if ($maxTablesToCheck &&
 552         $count >= $maxTablesToCheck
 553       ) {
 554         break;
 555       }
 556     }
 557     $dao->free();
 558     return $values;
 559   }
 560
 561   static function isDBMyISAM($maxTablesToCheck = 10) {
 562     // show error if any of the tables, use 'MyISAM' storage engine.
 563     $engines = self::getStorageValues(NULL, $maxTablesToCheck);
 564     if (array_key_exists('MyISAM', $engines)) {
 565       return TRUE;
 566     }
 567     return FALSE;
 568   }
 569
 570   /**
 571    * Checks if a constraint exists for a specified table.
 572    *
 573    * @param string $tableName
 574    * @param string $constraint
 575    *
 576    * @return boolean true if constraint exists, false otherwise
 577    * @static
 578    */
 579   static function checkConstraintExists($tableName, $constraint) {
 580     static $show = array();
 581
 582     if (!array_key_exists($tableName, $show)) {
 583       $query = "SHOW CREATE TABLE $tableName";
 584       $dao = CRM_Core_DAO::executeQuery($query);
 585
 586       if (!$dao->fetch()) {
 587         CRM_Core_Error::fatal();
 588       }
 589
 590       $dao->free();
 591       $show[$tableName] = $dao->Create_Table;
 592     }
 593
 594     return preg_match("/\b$constraint\b/i", $show[$tableName]) ? TRUE : FALSE;
 595   }
 596
 597   /**
 598    * Checks if CONSTRAINT keyword exists for a specified table.
 599    *
 600    * @param string $tableName
 601    *
 602    * @return boolean true if CONSTRAINT keyword exists, false otherwise
 603    */
 604   static function schemaRequiresRebuilding($tables = array("civicrm_contact")) {
 605     $show = array();
 606     foreach($tables as $tableName){
 607       if (!array_key_exists($tableName, $show)) {
 608         $query = "SHOW CREATE TABLE $tableName";
 609         $dao = CRM_Core_DAO::executeQuery($query);
 610
 611         if (!$dao->fetch()) {
 612           CRM_Core_Error::fatal();
 613         }
 614
 615         $dao->free();
 616         $show[$tableName] = $dao->Create_Table;
 617       }
 618
 619       $result = preg_match("/\bCONSTRAINT\b\s/i", $show[$tableName]) ? TRUE : FALSE;
 620       if($result == TRUE){
 621         continue;
 622       }
 623       else{
 624         return FALSE;
 625       }
 626     }
 627     return TRUE;
 628   }
 629
 630   /**
 631    * Checks if the FK constraint name is in the format 'FK_tableName_columnName'
 632    * for a specified column of a table.
 633    *
 634    * @param string $tableName
 635    * @param string $columnName
 636    *
 637    * @return boolean true if in format, false otherwise
 638    * @static
 639    */
 640   static function checkFKConstraintInFormat($tableName, $columnName) {
 641     static $show = array();
 642
 643     if (!array_key_exists($tableName, $show)) {
 644       $query = "SHOW CREATE TABLE $tableName";
 645       $dao = CRM_Core_DAO::executeQuery($query);
 646
 647       if (!$dao->fetch()) {
 648         CRM_Core_Error::fatal();
 649       }
 650
 651       $dao->free();
 652       $show[$tableName] = $dao->Create_Table;
 653     }
 654     $constraint = "`FK_{$tableName}_{$columnName}`";
 655     $pattern = "/\bCONSTRAINT\b\s+%s\s+\bFOREIGN\s+KEY\b\s/i";
 656     return preg_match(sprintf($pattern, $constraint),$show[$tableName]) ? TRUE : FALSE;
 657   }
 658
 659   /**
 660    * Check whether a specific column in a specific table has always the same value
 661    *
 662    * @param string $tableName
 663    * @param string $columnName
 664    * @param string $columnValue
 665    *
 666    * @return boolean true if the value is always $columnValue, false otherwise
 667    * @static
 668    */
 669   static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) {
 670     $query  = "SELECT * FROM $tableName WHERE $columnName != '$columnValue'";
 671     $dao    = CRM_Core_DAO::executeQuery($query);
 672     $result = $dao->fetch() ? FALSE : TRUE;
 673     $dao->free();
 674     return $result;
 675   }
 676
 677   /**
 678    * Check whether a specific column in a specific table is always NULL
 679    *
 680    * @param string $tableName
 681    * @param string $columnName
 682    *
 683    * @return boolean true if if the value is always NULL, false otherwise
 684    * @static
 685    */
 686   static function checkFieldIsAlwaysNull($tableName, $columnName) {
 687     $query  = "SELECT * FROM $tableName WHERE $columnName IS NOT NULL";
 688     $dao    = CRM_Core_DAO::executeQuery($query);
 689     $result = $dao->fetch() ? FALSE : TRUE;
 690     $dao->free();
 691     return $result;
 692   }
 693
 694   /**
 695    * Check if there is a given table in the database
 696    *
 697    * @param string $tableName
 698    *
 699    * @return boolean true if exists, else false
 700    * @static
 701    */
 702   static function checkTableExists($tableName) {
 703     $query = "
 704 SHOW TABLES
 705 LIKE %1
 706 ";
 707     $params = array(1 => array($tableName, 'String'));
 708
 709     $dao = CRM_Core_DAO::executeQuery($query, $params);
 710     $result = $dao->fetch() ? TRUE : FALSE;
 711     $dao->free();
 712     return $result;
 713   }
 714
 715   function checkVersion($version) {
 716     $query = "
 717 SELECT version
 718 FROM   civicrm_domain
 719 ";
 720     $dbVersion = CRM_Core_DAO::singleValueQuery($query);
 721     return trim($version) == trim($dbVersion) ? TRUE : FALSE;
 722   }
 723
 724   /**
 725    * Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record
 726    *
 727    * @param string  $daoName       Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact)
 728    * @param int     $searchValue   Value of the column you want to search by
 729    * @param string  $returnColumn  Name of the column you want to GET the value of
 730    * @param string  $searchColumn  Name of the column you want to search by
 731    * @param boolean $force         Skip use of the cache
 732    *
 733    * @return string|null          Value of $returnColumn in the retrieved record
 734    * @static
 735    * @access public
 736    */
 737   static function getFieldValue($daoName, $searchValue, $returnColumn = 'name', $searchColumn = 'id', $force = FALSE) {
 738     if (
 739       empty($searchValue) ||
 740       trim(strtolower($searchValue)) == 'null'
 741     ) {
 742       // adding this year since developers forget to check for an id
 743       // or for the 'null' (which is a bad DAO kludge)
 744       // and hence we get the first value in the db
 745       CRM_Core_Error::fatal();
 746     }
 747
 748     $cacheKey = "{$daoName}:{$searchValue}:{$returnColumn}:{$searchColumn}";
 749     if (self::$_dbColumnValueCache === NULL) {
 750       self::$_dbColumnValueCache = array();
 751     }
 752
 753     if (!array_key_exists($cacheKey, self::$_dbColumnValueCache) || $force) {
 754       $object   = new $daoName( );
 755       $object->$searchColumn = $searchValue;
 756       $object->selectAdd();
 757       $object->selectAdd($returnColumn);
 758
 759       $result = NULL;
 760       if ($object->find(TRUE)) {
 761         $result = $object->$returnColumn;
 762       }
 763       $object->free();
 764
 765       self::$_dbColumnValueCache[$cacheKey] = $result;
 766     }
 767     return self::$_dbColumnValueCache[$cacheKey];
 768   }
 769
 770   /**
 771    * Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record
 772    *
 773    * @param string $daoName       Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact)
 774    * @param int    $searchValue   Value of the column you want to search by
 775    * @param string $setColumn     Name of the column you want to SET the value of
 776    * @param string $setValue      SET the setColumn to this value
 777    * @param string $searchColumn  Name of the column you want to search by
 778    *
 779    * @return boolean          true if we found and updated the object, else false
 780    * @static
 781    * @access public
 782    */
 783   static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') {
 784     $object = new $daoName( );
 785     $object->selectAdd();
 786     $object->selectAdd("$searchColumn, $setColumn");
 787     $object->$searchColumn = $searchValue;
 788     $result = FALSE;
 789     if ($object->find(TRUE)) {
 790       $object->$setColumn = $setValue;
 791       if ($object->save()) {
 792         $result = TRUE;
 793       }
 794     }
 795     $object->free();
 796     return $result;
 797   }
 798
 799   /**
 800    * Get sort string
 801    *
 802    * @param array|object $sort either array or CRM_Utils_Sort
 803    * @param string $default - default sort value
 804    *
 805    * @return string - sortString
 806    * @access public
 807    * @static
 808    */
 809   static function getSortString($sort, $default = NULL) {
 810     // check if sort is of type CRM_Utils_Sort
 811     if (is_a($sort, 'CRM_Utils_Sort')) {
 812       return $sort->orderBy();
 813     }
 814
 815     // is it an array specified as $field => $sortDirection ?
 816     if ($sort) {
 817       foreach ($sort as $k => $v) {
 818         $sortString .= "$k $v,";
 819       }
 820       return rtrim($sortString, ',');
 821     }
 822     return $default;
 823   }
 824
 825   /**
 826    * Takes a bunch of params that are needed to match certain criteria and
 827    * retrieves the relevant objects. Typically the valid params are only
 828    * contact_id. We'll tweak this function to be more full featured over a period
 829    * of time. This is the inverse function of create. It also stores all the retrieved
 830    * values in the default array
 831    *
 832    * @param string $daoName  name of the dao object
 833    * @param array  $params   (reference ) an assoc array of name/value pairs
 834    * @param array  $defaults (reference ) an assoc array to hold the flattened values
 835    * @param array  $returnProperities     an assoc array of fields that need to be returned, eg array( 'first_name', 'last_name')
 836    *
 837    * @return object an object of type referenced by daoName
 838    * @access public
 839    * @static
 840    */
 841   static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) {
 842     $object = new $daoName( );
 843     $object->copyValues($params);
 844
 845     // return only specific fields if returnproperties are sent
 846     if (!empty($returnProperities)) {
 847       $object->selectAdd();
 848       $object->selectAdd(implode(',', $returnProperities));
 849     }
 850
 851     if ($object->find(TRUE)) {
 852       self::storeValues($object, $defaults);
 853       return $object;
 854     }
 855     return NULL;
 856   }
 857
 858   /**
 859    * Delete the object records that are associated with this contact
 860    *
 861    * @param string $daoName  name of the dao object
 862    * @param  int  $contactId id of the contact to delete
 863    *
 864    * @return void
 865    * @access public
 866    * @static
 867    */
 868   static function deleteEntityContact($daoName, $contactId) {
 869     $object = new $daoName( );
 870
 871     $object->entity_table = 'civicrm_contact';
 872     $object->entity_id = $contactId;
 873     $object->delete();
 874   }
 875
 876   /**
 877    * execute a query
 878    *
 879    * @param string $query query to be executed
 880    *
 881    * @return Object CRM_Core_DAO object that holds the results of the query
 882    * @static
 883    * @access public
 884    */
 885   static function &executeQuery(
 886     $query,
 887     $params        = array(),
 888     $abort         = TRUE,
 889     $daoName       = NULL,
 890     $freeDAO       = FALSE,
 891     $i18nRewrite   = TRUE,
 892     $trapException = FALSE
 893   ) {
 894     $queryStr = self::composeQuery($query, $params, $abort);
 895     //CRM_Core_Error::debug( 'q', $queryStr );
 896
 897     if (!$daoName) {
 898       $dao = new CRM_Core_DAO();
 899     }
 900     else {
 901       $dao = new $daoName( );
 902     }
 903
 904     if ($trapException) {
 905       CRM_Core_Error::ignoreException();
 906     }
 907
 908     $result = $dao->query($queryStr, $i18nRewrite);
 909
 910     if ($trapException) {
 911       CRM_Core_Error::setCallback();
 912     }
 913
 914     if (is_a($result, 'DB_Error')) {
 915       return $result;
 916     }
 917
 918     if ($freeDAO ||
 919       preg_match('/^(insert|update|delete|create|drop|replace)/i', $queryStr)
 920     ) {
 921       // we typically do this for insert/update/delete stataments OR if explicitly asked to
 922       // free the dao
 923       $dao->free();
 924     }
 925     return $dao;
 926   }
 927
 928   /**
 929    * execute a query and get the single result
 930    *
 931    * @param string $query query to be executed
 932    *
 933    * @return string the result of the query
 934    * @static
 935    * @access public
 936    */
 937   static function &singleValueQuery($query,
 938     $params      = array(),
 939     $abort       = TRUE,
 940     $i18nRewrite = TRUE
 941   ) {
 942     $queryStr = self::composeQuery($query, $params, $abort);
 943
 944     static $_dao = NULL;
 945
 946     if (!$_dao) {
 947       $_dao = new CRM_Core_DAO();
 948     }
 949
 950     $_dao->query($queryStr, $i18nRewrite);
 951
 952     $result = $_dao->getDatabaseResult();
 953     $ret = NULL;
 954     if ($result) {
 955       $row = $result->fetchRow();
 956       if ($row) {
 957         $ret = $row[0];
 958       }
 959     }
 960     $_dao->free();
 961     return $ret;
 962   }
 963
 964   static function composeQuery($query, &$params, $abort = TRUE) {
 965     $tr = array();
 966     foreach ($params as $key => $item) {
 967       if (is_numeric($key)) {
 968         if (CRM_Utils_Type::validate($item[0], $item[1]) !== NULL) {
 969           $item[0] = self::escapeString($item[0]);
 970           if ($item[1] == 'String' ||
 971             $item[1] == 'Memo' ||
 972             $item[1] == 'Link'
 973           ) {
 974             // Support class constants stipulating wildcard characters and/or
 975             // non-quoting of strings. Also support legacy code which may be
 976             // passing in TRUE or 1 for $item[2], which used to indicate the
 977             // use of wildcard characters.
 978             if (!empty($item[2])) {
 979               if ($item[2] & CRM_Core_DAO::QUERY_FORMAT_WILDCARD || $item[2] === TRUE) {
 980                 $item[0] = "'%{$item[0]}%'";
 981               }
 982               elseif (!($item[2] & CRM_Core_DAO::QUERY_FORMAT_NO_QUOTES)) {
 983                 $item[0] = "'{$item[0]}'";
 984               }
 985             }
 986             else {
 987               $item[0] = "'{$item[0]}'";
 988             }
 989           }
 990
 991           if (($item[1] == 'Date' || $item[1] == 'Timestamp') &&
 992             strlen($item[0]) == 0
 993           ) {
 994             $item[0] = 'null';
 995           }
 996
 997           $tr['%' . $key] = $item[0];
 998         }
 999         elseif ($abort) {
1000           CRM_Core_Error::fatal("{$item[0]} is not of type {$item[1]}");
1001         }
1002       }
1003     }
1004
1005     return strtr($query, $tr);
1006   }
1007
1008   static function freeResult($ids = NULL) {
1009     global $_DB_DATAOBJECT;
1010
1011     /***
1012      $q = array( );
1013      foreach ( array_keys( $_DB_DATAOBJECT['RESULTS'] ) as $id ) {
1014      $q[] = $_DB_DATAOBJECT['RESULTS'][$id]->query;
1015      }
1016      CRM_Core_Error::debug( 'k', $q );
1017      return;
1018      ***/
1019
1020     if (!$ids) {
1021       if (!$_DB_DATAOBJECT ||
1022         !isset($_DB_DATAOBJECT['RESULTS'])
1023       ) {
1024         return;
1025       }
1026       $ids = array_keys($_DB_DATAOBJECT['RESULTS']);
1027     }
1028
1029     foreach ($ids as $id) {
1030       if (isset($_DB_DATAOBJECT['RESULTS'][$id])) {
1031         if (is_resource($_DB_DATAOBJECT['RESULTS'][$id]->result)) {
1032           mysql_free_result($_DB_DATAOBJECT['RESULTS'][$id]->result);
1033         }
1034         unset($_DB_DATAOBJECT['RESULTS'][$id]);
1035       }
1036
1037       if (isset($_DB_DATAOBJECT['RESULTFIELDS'][$id])) {
1038         unset($_DB_DATAOBJECT['RESULTFIELDS'][$id]);
1039       }
1040     }
1041   }
1042
1043   /**
1044    * This function is to make a shallow copy of an object
1045    * and all the fields in the object
1046    *
1047    * @param string $daoName                 name of the dao
1048    * @param array  $criteria                array of all the fields & values
1049    *                                        on which basis to copy
1050    * @param array  $newData                 array of all the fields & values
1051    *                                        to be copied besides the other fields
1052    * @param string $fieldsFix               array of fields that you want to prefix/suffix/replace
1053    * @param string $blockCopyOfDependencies fields that you want to block from
1054    *                                        getting copied
1055    *
1056    *
1057    * @return (reference )                   the newly created copy of the object
1058    * @access public
1059    */
1060   static function &copyGeneric($daoName, $criteria, $newData = NULL, $fieldsFix = NULL, $blockCopyOfDependencies = NULL) {
1061     $object = new $daoName( );
1062     if (!$newData) {
1063       $object->id = $criteria['id'];
1064     }
1065     else {
1066       foreach ($criteria as $key => $value) {
1067         $object->$key = $value;
1068       }
1069     }
1070
1071     $object->find();
1072     while ($object->fetch()) {
1073
1074       // all the objects except with $blockCopyOfDependencies set
1075       // be copied - addresses #CRM-1962
1076
1077       if ($blockCopyOfDependencies && $object->$blockCopyOfDependencies) {
1078         break;
1079       }
1080
1081       $newObject   = new $daoName( );
1082
1083       $fields = &$object->fields();
1084       if (!is_array($fieldsFix)) {
1085         $fieldsToPrefix  = array();
1086         $fieldsToSuffix  = array();
1087         $fieldsToReplace = array();
1088       }
1089       if (CRM_Utils_Array::value('prefix', $fieldsFix)) {
1090         $fieldsToPrefix = $fieldsFix['prefix'];
1091       }
1092       if (CRM_Utils_Array::value('suffix', $fieldsFix)) {
1093         $fieldsToSuffix = $fieldsFix['suffix'];
1094       }
1095       if (CRM_Utils_Array::value('replace', $fieldsFix)) {
1096         $fieldsToReplace = $fieldsFix['replace'];
1097       }
1098
1099       foreach ($fields as $name => $value) {
1100         if ($name == 'id' || $value['name'] == 'id') {
1101           // copy everything but the id!
1102           continue;
1103         }
1104
1105         $dbName = $value['name'];
1106         $newObject->$dbName = $object->$dbName;
1107         if (isset($fieldsToPrefix[$dbName])) {
1108           $newObject->$dbName = $fieldsToPrefix[$dbName] . $newObject->$dbName;
1109         }
1110         if (isset($fieldsToSuffix[$dbName])) {
1111           $newObject->$dbName .= $fieldsToSuffix[$dbName];
1112         }
1113         if (isset($fieldsToReplace[$dbName])) {
1114           $newObject->$dbName = $fieldsToReplace[$dbName];
1115         }
1116
1117         if (substr($name, -5) == '_date' ||
1118           substr($name, -10) == '_date_time'
1119         ) {
1120           $newObject->$dbName = CRM_Utils_Date::isoToMysql($newObject->$dbName);
1121         }
1122
1123         if ($newData) {
1124           foreach ($newData as $k => $v) {
1125             $newObject->$k = $v;
1126           }
1127         }
1128       }
1129       $newObject->save();
1130     }
1131     return $newObject;
1132   }
1133
1134   /**
1135    * Given the component id, compute the contact id
1136    * since its used for things like send email
1137    */
1138   public static function &getContactIDsFromComponent(&$componentIDs, $tableName) {
1139     $contactIDs = array();
1140
1141     if (empty($componentIDs)) {
1142       return $contactIDs;
1143     }
1144
1145     $IDs = implode(',', $componentIDs);
1146     $query = "
1147 SELECT contact_id
1148   FROM $tableName
1149  WHERE id IN ( $IDs )
1150 ";
1151
1152     $dao = CRM_Core_DAO::executeQuery($query);
1153     while ($dao->fetch()) {
1154       $contactIDs[] = $dao->contact_id;
1155     }
1156     return $contactIDs;
1157   }
1158
1159   /**
1160    * Takes a bunch of params that are needed to match certain criteria and
1161    * retrieves the relevant objects. Typically the valid params are only
1162    * contact_id. We'll tweak this function to be more full featured over a period
1163    * of time. This is the inverse function of create. It also stores all the retrieved
1164    * values in the default array
1165    *
1166    * @param string $daoName  name of the dao object
1167    * @param array  $params   (reference ) an assoc array of name/value pairs
1168    * @param array  $defaults (reference ) an assoc array to hold the flattened values
1169    * @param array  $returnProperities     an assoc array of fields that need to be returned, eg array( 'first_name', 'last_name')
1170    *
1171    * @return object an object of type referenced by daoName
1172    * @access public
1173    * @static
1174    */
1175   static function commonRetrieveAll($daoName, $fieldIdName = 'id', $fieldId, &$details, $returnProperities = NULL) {
1176     require_once (str_replace('_', DIRECTORY_SEPARATOR, $daoName) . ".php");
1177     $object = new $daoName( );
1178     $object->$fieldIdName = $fieldId;
1179
1180     // return only specific fields if returnproperties are sent
1181     if (!empty($returnProperities)) {
1182       $object->selectAdd();
1183       $object->selectAdd('id');
1184       $object->selectAdd(implode(',', $returnProperities));
1185     }
1186
1187     $object->find();
1188     while ($object->fetch()) {
1189       $defaults = array();
1190       self::storeValues($object, $defaults);
1191       $details[$object->id] = $defaults;
1192     }
1193
1194     return $details;
1195   }
1196
1197   static function dropAllTables() {
1198
1199     // first drop all the custom tables we've created
1200     CRM_Core_BAO_CustomGroup::dropAllTables();
1201
1202     // drop all multilingual views
1203     CRM_Core_I18n_Schema::dropAllViews();
1204
1205     CRM_Utils_File::sourceSQLFile(CIVICRM_DSN,
1206       dirname(__FILE__) . DIRECTORY_SEPARATOR .
1207       '..' . DIRECTORY_SEPARATOR .
1208       '..' . DIRECTORY_SEPARATOR .
1209       'sql' . DIRECTORY_SEPARATOR .
1210       'civicrm_drop.mysql'
1211     );
1212   }
1213
1214   static function escapeString($string) {
1215     static $_dao = NULL;
1216
1217     if (!$_dao) {
1218       $_dao = new CRM_Core_DAO();
1219     }
1220
1221     return $_dao->escape($string);
1222   }
1223
1224   /**
1225    * Escape a list of strings for use with "WHERE X IN (...)" queries.
1226    *
1227    * @param $strings array
1228    * @param $default string the value to use if $strings has no elements
1229    * @return string eg "abc","def","ghi"
1230    */
1231   static function escapeStrings($strings, $default = NULL) {
1232     static $_dao = NULL;
1233     if (!$_dao) {
1234       $_dao = new CRM_Core_DAO();
1235     }
1236
1237     if (empty($strings)) {
1238       return $default;
1239     }
1240
1241     $escapes = array_map(array($_dao, 'escape'), $strings);
1242     return '"' . implode('","', $escapes) . '"';
1243   }
1244
1245   static function escapeWildCardString($string) {
1246     // CRM-9155
1247     // ensure we escape the single characters % and _ which are mysql wild
1248     // card characters and could come in via sortByCharacter
1249     // note that mysql does not escape these characters
1250     if ($string && in_array($string,
1251         array('%', '_', '%%', '_%')
1252       )) {
1253       return '\\' . $string;
1254     }
1255
1256     return self::escapeString($string);
1257   }
1258
1259   //Creates a test object, including any required objects it needs via recursion
1260   //createOnly: only create in database, do not store or return the objects (useful for perf testing)
1261   //ONLY USE FOR TESTING
1262   static function createTestObject(
1263     $daoName,
1264     $params = array(),
1265     $numObjects = 1,
1266     $createOnly = FALSE
1267   ) {
1268     //this is a test function  also backtrace is set for the test suite it sometimes unsets itself
1269     // so we re-set here in case
1270     $config = CRM_Core_Config::singleton();
1271     $config->backtrace = TRUE;
1272
1273     static $counter = 0;
1274     CRM_Core_DAO::$_testEntitiesToSkip = array(
1275       'CRM_Core_DAO_Worldregion',
1276       'CRM_Core_DAO_StateProvince',
1277       'CRM_Core_DAO_Country',
1278       'CRM_Core_DAO_Domain',
1279     );
1280
1281     for ($i = 0; $i < $numObjects; ++$i) {
1282
1283       ++$counter;
1284       $object = new $daoName();
1285
1286       $fields = &$object->fields();
1287       foreach ($fields as $name => $value) {
1288         $dbName = $value['name'];
1289         if($dbName == 'contact_sub_type' && empty($params['contact_sub_type'])){
1290           //coming up with a rule to set this is too complex let's not set it
1291           continue;
1292         }
1293         $FKClassName = CRM_Utils_Array::value('FKClassName', $value);
1294         $required = CRM_Utils_Array::value('required', $value);
1295         if (CRM_Utils_Array::value($dbName, $params) !== NULL && !is_array($params[$dbName])) {
1296           $object->$dbName = $params[$dbName];
1297         }
1298
1299         elseif ($dbName != 'id') {
1300           if ($FKClassName != NULL) {
1301             //skip the FK if it is not required
1302             // if it's contact id we should create even if not required
1303             // we'll have a go @ fetching first though
1304             // we WILL create campaigns though for so tests with a campaign pseudoconstant will complete
1305             if($FKClassName === 'CRM_Campaign_DAO_Campaign' && $daoName != $FKClassName) {
1306               $required = TRUE;
1307             }
1308             if (!$required && $dbName != 'contact_id') {
1309               $fkDAO = new $FKClassName;
1310               if($fkDAO->find(TRUE)){
1311                 $object->$dbName = $fkDAO->id;
1312               }
1313               unset($fkDAO);
1314               continue;
1315             }
1316             if(in_array($FKClassName, CRM_Core_DAO::$_testEntitiesToSkip)){
1317               $depObject = new $FKClassName();
1318               $depObject->find(TRUE);
1319             } elseif ($daoName == 'CRM_Member_DAO_MembershipType' && $name == 'member_of_contact_id') {
1320               // FIXME: the fields() metadata is not specific enough
1321               $depObject = CRM_Core_DAO::createTestObject($FKClassName, array('contact_type' => 'Organization'));
1322             }else{
1323             //if it is required we need to generate the dependency object first
1324               $depObject = CRM_Core_DAO::createTestObject($FKClassName, CRM_Utils_Array::value($dbName, $params, 1));
1325             }
1326             $object->$dbName = $depObject->id;
1327             unset($depObject);
1328
1329             continue;
1330           }
1331           // Pick an option value if needed
1332           if ($value['type'] !== CRM_Utils_Type::T_BOOLEAN) {
1333             $options = $daoName::buildOptions($dbName, 'create');
1334             if ($options) {
1335               $object->$dbName = key($options);
1336               continue;
1337             }
1338           }
1339
1340           switch ($value['type']) {
1341             case CRM_Utils_Type::T_INT:
1342             case CRM_Utils_Type::T_FLOAT:
1343             case CRM_Utils_Type::T_MONEY:
1344               $object->$dbName = $counter;
1345               break;
1346
1347             case CRM_Utils_Type::T_BOOLEAN:
1348               if (isset($value['default'])) {
1349                 $object->$dbName = $value['default'];
1350               }
1351               elseif ($value['name'] == 'is_deleted' || $value['name'] == 'is_test') {
1352                 $object->$dbName = 0;
1353               }
1354               else {
1355                 $object->$dbName = 1;
1356               }
1357               break;
1358
1359             case CRM_Utils_Type::T_DATE:
1360             case CRM_Utils_Type::T_TIMESTAMP:
1361             case CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME:
1362               $object->$dbName = '19700101';
1363               if($dbName == 'end_date') {
1364                 // put this in the future
1365                 $object->$dbName = '20200101';
1366               }
1367               break;
1368
1369             case CRM_Utils_Type::T_TIME:
1370               CRM_Core_Error::fatal('T_TIME shouldnt be used.');
1371               //$object->$dbName='000000';
1372               //break;
1373             case CRM_Utils_Type::T_CCNUM:
1374               $object->$dbName = '4111 1111 1111 1111';
1375               break;
1376
1377             case CRM_Utils_Type::T_URL:
1378               $object->$dbName = 'http://www.civicrm.org';
1379               break;
1380
1381             case CRM_Utils_Type::T_STRING:
1382             case CRM_Utils_Type::T_BLOB:
1383             case CRM_Utils_Type::T_MEDIUMBLOB:
1384             case CRM_Utils_Type::T_TEXT:
1385             case CRM_Utils_Type::T_LONGTEXT:
1386             case CRM_Utils_Type::T_EMAIL:
1387             default:
1388               if (isset($value['enumValues'])) {
1389                 if (isset($value['default'])) {
1390                   $object->$dbName = $value['default'];
1391                 }
1392                 else {
1393                   if (is_array($value['enumValues'])) {
1394                     $object->$dbName = $value['enumValues'][0];
1395                   }
1396                   else {
1397                     $defaultValues = explode(',', $value['enumValues']);
1398                     $object->$dbName = $defaultValues[0];
1399                   }
1400                 }
1401               }
1402               else {
1403                 $object->$dbName = $dbName . '_' . $counter;
1404                 $maxlength = CRM_Utils_Array::value('maxlength', $value);
1405                 if ($maxlength > 0 && strlen($object->$dbName) > $maxlength) {
1406                   $object->$dbName = substr($object->$dbName, 0, $value['maxlength']);
1407                 }
1408               }
1409           }
1410         }
1411       }
1412       $object->save();
1413
1414       if (!$createOnly) {
1415
1416         $objects[$i] = $object;
1417
1418       }
1419       else unset($object);
1420     }
1421
1422     if ($createOnly) {
1423
1424       return;
1425
1426     }
1427     elseif ($numObjects == 1) {  return $objects[0];}
1428     else return $objects;
1429   }
1430
1431   //deletes the this object plus any dependent objects that are associated with it
1432   //ONLY USE FOR TESTING
1433
1434   static function deleteTestObjects($daoName, $params = array(
1435     )) {
1436     //this is a test function  also backtrace is set for the test suite it sometimes unsets itself
1437     // so we re-set here in case
1438     $config = CRM_Core_Config::singleton();
1439     $config->backtrace = TRUE;
1440
1441     $object = new $daoName();
1442     $object->id = CRM_Utils_Array::value('id', $params);
1443
1444     $deletions = array(); // array(array(0 => $daoName, 1 => $daoParams))
1445     if ($object->find(TRUE)) {
1446
1447       $fields = &$object->fields();
1448       foreach ($fields as $name => $value) {
1449
1450         $dbName = $value['name'];
1451
1452         $FKClassName = CRM_Utils_Array::value('FKClassName', $value);
1453         $required = CRM_Utils_Array::value('required', $value);
1454         if ($FKClassName != NULL
1455           && $object->$dbName
1456           && !in_array($FKClassName, CRM_Core_DAO::$_testEntitiesToSkip)
1457           && ($required || $dbName == 'contact_id')) {
1458           $deletions[] = array($FKClassName, array('id' => $object->$dbName)); // x
1459         }
1460       }
1461     }
1462
1463     $object->delete();
1464
1465     foreach ($deletions as $deletion) {
1466       CRM_Core_DAO::deleteTestObjects($deletion[0], $deletion[1]);
1467   }
1468   }
1469
1470   static function createTempTableName($prefix = 'civicrm', $addRandomString = TRUE, $string = NULL) {
1471     $tableName = $prefix . "_temp";
1472
1473     if ($addRandomString) {
1474       if ($string) {
1475         $tableName .= "_" . $string;
1476       }
1477       else {
1478         $tableName .= "_" . md5(uniqid('', TRUE));
1479       }
1480     }
1481     return $tableName;
1482   }
1483
1484   static function checkTriggerViewPermission($view = TRUE, $trigger = TRUE) {
1485     // test for create view and trigger permissions and if allowed, add the option to go multilingual
1486     // and logging
1487     // I'm not sure why we use the getStaticProperty for an error, rather than checking for DB_Error
1488     CRM_Core_Error::ignoreException();
1489     $dao = new CRM_Core_DAO();
1490     if ($view) {
1491       $dao->query('CREATE OR REPLACE VIEW civicrm_domain_view AS SELECT * FROM civicrm_domain');
1492       if (PEAR::getStaticProperty('DB_DataObject', 'lastError')) {
1493         CRM_Core_Error::setCallback();
1494         return FALSE;
1495       }
1496     }
1497
1498     if ($trigger) {
1499       $result = $dao->query('CREATE TRIGGER civicrm_domain_trigger BEFORE INSERT ON civicrm_domain FOR EACH ROW BEGIN END');
1500       if (PEAR::getStaticProperty('DB_DataObject', 'lastError') || is_a($result, 'DB_Error')) {
1501         CRM_Core_Error::setCallback();
1502         if ($view) {
1503           $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
1504         }
1505         return FALSE;
1506       }
1507
1508       $dao->query('DROP TRIGGER IF EXISTS civicrm_domain_trigger');
1509       if (PEAR::getStaticProperty('DB_DataObject', 'lastError')) {
1510         CRM_Core_Error::setCallback();
1511         if ($view) {
1512           $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
1513         }
1514         return FALSE;
1515       }
1516     }
1517
1518     if ($view) {
1519       $dao->query('DROP VIEW IF EXISTS civicrm_domain_view');
1520       if (PEAR::getStaticProperty('DB_DataObject', 'lastError')) {
1521         CRM_Core_Error::setCallback();
1522         return FALSE;
1523       }
1524     }
1525     CRM_Core_Error::setCallback();
1526
1527     return TRUE;
1528   }
1529
1530   static function debugPrint($message = NULL, $printDAO = TRUE) {
1531     CRM_Utils_System::xMemory("{$message}: ");
1532
1533     if ($printDAO) {
1534       global $_DB_DATAOBJECT;
1535       $q = array();
1536       foreach (array_keys($_DB_DATAOBJECT['RESULTS']) as $id) {
1537         $q[] = $_DB_DATAOBJECT['RESULTS'][$id]->query;
1538       }
1539       CRM_Core_Error::debug('_DB_DATAOBJECT', $q);
1540     }
1541   }
1542
1543    /**
1544     * Build a list of triggers via hook and add them to (err, reconcile them
1545     * with) the database.
1546     *
1547     * @param $tableName string the specific table requiring a rebuild; or NULL to rebuild all tables
1548     * @see CRM-9716
1549     */
1550   static function triggerRebuild($tableName = NULL, $force = FALSE) {
1551     $info = array();
1552
1553     $logging = new CRM_Logging_Schema;
1554     $logging->triggerInfo($info, $tableName, $force);
1555
1556     CRM_Core_I18n_Schema::triggerInfo($info, $tableName);
1557     CRM_Contact_BAO_Contact::triggerInfo($info, $tableName);
1558
1559     CRM_Utils_Hook::triggerInfo($info, $tableName);
1560
1561     // drop all existing triggers on all tables
1562     $logging->dropTriggers($tableName);
1563
1564     // now create the set of new triggers
1565     self::createTriggers($info);
1566   }
1567
1568   /**
1569    * Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests
1570    * @see http://issues.civicrm.org/jira/browse/CRM-13822
1571    * TODO: Alternative solutions might be
1572    *  * Stop using functions and find another way to strip numeric characters from phones
1573    *  * Give better error messages (currently a missing fn fatals with "unknown error")
1574    */
1575   static function checkSqlFunctionsExist() {
1576     if (!self::$_checkedSqlFunctionsExist) {
1577       self::$_checkedSqlFunctionsExist = TRUE;
1578       $dao = CRM_Core_DAO::executeQuery("SHOW function status WHERE db = database() AND name = 'civicrm_strip_non_numeric'");
1579       if (!$dao->fetch()) {
1580         self::triggerRebuild();
1581       }
1582     }
1583   }
1584
1585   /**
1586    * Wrapper function to drop triggers
1587    *
1588    * @param $tableName string the specific table requiring a rebuild; or NULL to rebuild all tables
1589    */
1590   static function dropTriggers($tableName = NULL) {
1591     $info = array();
1592
1593     $logging = new CRM_Logging_Schema;
1594     $logging->triggerInfo($info, $tableName);
1595
1596     // drop all existing triggers on all tables
1597     $logging->dropTriggers($tableName);
1598   }
1599
1600   /**
1601    * @param $info array per hook_civicrm_triggerInfo
1602    * @param $onlyTableName string the specific table requiring a rebuild; or NULL to rebuild all tables
1603    */
1604   static function createTriggers(&$info, $onlyTableName = NULL) {
1605     // Validate info array, should probably raise errors?
1606     if (is_array($info) == FALSE) {
1607       return;
1608     }
1609
1610     $triggers = array();
1611
1612     // now enumerate the tables and the events and collect the same set in a different format
1613     foreach ($info as $value) {
1614
1615       // clean the incoming data, skip malformed entries
1616       // TODO: malformed entries should raise errors or get logged.
1617       if (isset($value['table']) == FALSE ||
1618         isset($value['event']) == FALSE ||
1619         isset($value['when']) == FALSE ||
1620         isset($value['sql']) == FALSE
1621       ) {
1622         continue;
1623       }
1624
1625       if (is_string($value['table']) == TRUE) {
1626         $tables = array($value['table']);
1627       }
1628       else {
1629         $tables = $value['table'];
1630       }
1631
1632       if (is_string($value['event']) == TRUE) {
1633         $events = array(strtolower($value['event']));
1634       }
1635       else {
1636         $events = array_map('strtolower', $value['event']);
1637       }
1638
1639       $whenName = strtolower($value['when']);
1640
1641       foreach ($tables as $tableName) {
1642         if (!isset($triggers[$tableName])) {
1643           $triggers[$tableName] = array();
1644         }
1645
1646         foreach ($events as $eventName) {
1647           $template_params = array('{tableName}', '{eventName}');
1648           $template_values = array($tableName, $eventName);
1649
1650           $sql = str_replace($template_params,
1651             $template_values,
1652             $value['sql']
1653           );
1654           $variables = str_replace($template_params,
1655             $template_values,
1656             CRM_Utils_Array::value('variables', $value)
1657           );
1658
1659           if (!isset($triggers[$tableName][$eventName])) {
1660             $triggers[$tableName][$eventName] = array();
1661           }
1662
1663           if (!isset($triggers[$tableName][$eventName][$whenName])) {
1664             // We're leaving out cursors, conditions, and handlers for now
1665             // they are kind of dangerous in this context anyway
1666             // better off putting them in stored procedures
1667             $triggers[$tableName][$eventName][$whenName] = array(
1668               'variables' => array(),
1669               'sql' => array(),
1670             );
1671           }
1672
1673           if ($variables) {
1674             $triggers[$tableName][$eventName][$whenName]['variables'][] = $variables;
1675           }
1676
1677           $triggers[$tableName][$eventName][$whenName]['sql'][] = $sql;
1678         }
1679       }
1680     }
1681
1682     // now spit out the sql
1683     foreach ($triggers as $tableName => $tables) {
1684       if ($onlyTableName != NULL && $onlyTableName != $tableName) {
1685         continue;
1686       }
1687       foreach ($tables as $eventName => $events) {
1688         foreach ($events as $whenName => $parts) {
1689           $varString   = implode("\n", $parts['variables']);
1690           $sqlString   = implode("\n", $parts['sql']);
1691           $validName   = CRM_Core_DAO::shortenSQLName($tableName, 48, TRUE);
1692           $triggerName = "{$validName}_{$whenName}_{$eventName}";
1693           $triggerSQL  = "CREATE TRIGGER $triggerName $whenName $eventName ON $tableName FOR EACH ROW BEGIN $varString $sqlString END";
1694
1695           CRM_Core_DAO::executeQuery("DROP TRIGGER IF EXISTS $triggerName");
1696           CRM_Core_DAO::executeQuery(
1697             $triggerSQL,
1698             array(),
1699             TRUE,
1700             NULL,
1701             FALSE,
1702             FALSE
1703           );
1704         }
1705       }
1706     }
1707   }
1708
1709   /**
1710    * Find all records which refer to this entity.
1711    *
1712    * @return array of objects referencing this
1713    */
1714   function findReferences() {
1715     $links = self::getReferencesToTable(static::getTableName());
1716
1717     $occurrences = array();
1718     foreach ($links as $refSpec) {
1719       $refColumn = $refSpec->getReferenceKey();
1720       $targetColumn = $refSpec->getTargetKey();
1721       $params = array(1 => array($this->$targetColumn, 'String'));
1722       $sql = <<<EOS
1723 SELECT id
1724 FROM {$refSpec->getReferenceTable()}
1725 WHERE {$refColumn} = %1
1726 EOS;
1727       if ($refSpec->isGeneric()) {
1728         $params[2] = array(static::getTableName(), 'String');
1729         $sql .= <<<EOS
1730     AND {$refSpec->getTypeColumn()} = %2
1731 EOS;
1732       }
1733       $daoName = CRM_Core_DAO_AllCoreTables::getClassForTable($refSpec->getReferenceTable());
1734       $result = self::executeQuery($sql, $params, TRUE, $daoName);
1735       while ($result->fetch()) {
1736         $obj = new $daoName();
1737         $obj->id = $result->id;
1738         $occurrences[] = $obj;
1739       }
1740     }
1741
1742     return $occurrences;
1743   }
1744
1745   /**
1746    * List all tables which have hard foreign keys to this table.
1747    *
1748    * For now, this returns a description of every entity_id/entity_table
1749    * reference.
1750    * TODO: filter dynamic entity references on the $tableName, based on
1751    * schema metadata in dynamicForeignKey which enumerates a restricted
1752    * set of possible entity_table's.
1753    *
1754    * @param string $tableName table referred to
1755    *
1756    * @return array structure of table and column, listing every table with a
1757    * foreign key reference to $tableName, and the column where the key appears.
1758    */
1759   static function getReferencesToTable($tableName) {
1760     $refsFound = array();
1761     foreach (CRM_Core_DAO_AllCoreTables::getClasses() as $daoClassName) {
1762       $links = $daoClassName::getReferenceColumns();
1763       $daoTableName = $daoClassName::getTableName();
1764
1765       foreach ($links as $refSpec) {
1766         if ($refSpec->getTargetTable() === $tableName
1767               or $refSpec->isGeneric()
1768         ) {
1769           $refsFound[] = $refSpec;
1770         }
1771       }
1772     }
1773     return $refsFound;
1774   }
1775
1776   /**
1777    * Lookup the value of a MySQL global configuration variable.
1778    *
1779    * @param string $name e.g. "thread_stack"
1780    * @param mixed $default
1781    * @return mixed
1782    */
1783   public static function getGlobalSetting($name, $default = NULL) {
1784     // Alternatively, SELECT @@GLOBAL.thread_stack, but
1785     // that has been reported to fail under MySQL 5.0 for OS X
1786     $escapedName = self::escapeString($name);
1787     $dao = CRM_Core_DAO::executeQuery("SHOW VARIABLES LIKE '$escapedName'");
1788     if ($dao->fetch()) {
1789       return $dao->Value;
1790     }
1791     else {
1792       return $default;
1793     }
1794   }
1795
1796   /**
1797    * Get options for the called BAO object's field.
1798    * This function can be overridden by each BAO to add more logic related to context.
1799    * The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
1800    *
1801    * @param string $fieldName
1802    * @param string $context: @see CRM_Core_DAO::buildOptionsContext
1803    * @param array  $props: whatever is known about this bao object
1804    */
1805   public static function buildOptions($fieldName, $context = NULL, $props = array()) {
1806     // If a given bao does not override this function
1807     $baoName = get_called_class();
1808     return CRM_Core_PseudoConstant::get($baoName, $fieldName, array(), $context);
1809   }
1810
1811   /**
1812    * Populate option labels for this object's fields.
1813    *
1814    * @throws exception if called directly on the base class
1815    */
1816   public function getOptionLabels() {
1817     $fields = $this->fields();
1818     if ($fields === NULL) {
1819       throw new Exception ('Cannot call getOptionLabels on CRM_Core_DAO');
1820     }
1821     foreach ($fields as $field) {
1822       $name = CRM_Utils_Array::value('name', $field);
1823       if ($name && isset($this->$name)) {
1824         $label = CRM_Core_PseudoConstant::getLabel(get_class($this), $name, $this->$name);
1825         if ($label !== FALSE) {
1826           // Append 'label' onto the field name
1827           $labelName = $name . '_label';
1828           $this->$labelName = $label;
1829         }
1830       }
1831     }
1832   }
1833
1834   /**
1835    * Provides documentation and validation for the buildOptions $context param
1836    *
1837    * @param String $context
1838    */
1839   public static function buildOptionsContext($context = NULL) {
1840     $contexts = array(
1841       'get' => "All options are returned, even if they are disabled. Labels are translated.",
1842       'create' => "Options are filtered appropriately for the object being created/updated. Labels are translated.",
1843       'search' => "Searchable options are returned. Labels are translated.",
1844       'validate' => "All options are returned, even if they are disabled. Machine names are used in place of labels.",
1845     );
1846     // Validation: enforce uniformity of this param
1847     if ($context !== NULL && !isset($contexts[$context])) {
1848       throw new Exception("'$context' is not a valid context for buildOptions.");
1849     }
1850     return $contexts;
1851   }
1852
1853   /**
1854    * SQL version of api function to assign filters to the DAO based on the syntax
1855    * $field => array('IN' => array(4,6,9))
1856    * OR
1857    * $field => array('LIKE' => array('%me%))
1858    * etc
1859    *
1860    * @param $fieldname string name of fields
1861    * @param $filter array filter to be applied indexed by operator
1862    * @param $type String type of field (not actually used - nor in api @todo )
1863    * @param $alias String alternative field name ('as') @todo- not actually used
1864    * @param bool $returnSanitisedArray return a sanitised array instead of a clause
1865    *  this is primarily so we can add filters @ the api level to the Query object based fields
1866    *  @todo a better solutution would be for the query object to apply these filters based on the
1867    *  api supported format (but we don't want to risk breakage in alpha stage & query class is scary
1868    *  @todo @time of writing only IN & NOT IN are supported for the array style syntax (as test is
1869    *  required to extend further & it may be the comments per above should be implemented. It may be
1870    *  preferable to not double-banger the return context next refactor of this - but keeping the attention
1871    *  in one place has some advantages as we try to extend this format
1872    *
1873    *  @return NULL|string|array a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL
1874    *   depending on whether it is supported as yet
1875    **/
1876   public static function createSQLFilter($fieldName, $filter, $type, $alias = NULL, $returnSanitisedArray = FALSE) {
1877     // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now
1878     // support for other syntaxes is discussed in ticket but being put off for now
1879     $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN');
1880     foreach ($filter as $operator => $criteria) {
1881       if (in_array($operator, $acceptedSQLOperators)) {
1882         switch ($operator) {
1883           // unary operators
1884           case 'IS NULL':
1885           case 'IS NOT NULL':
1886             if(!$returnSanitisedArray) {
1887               return (sprintf('%s %s', $fieldName, $operator));
1888             }
1889             else{
1890               return NULL;  // not yet implemented (tests required to implement)
1891             }
1892             break;
1893
1894           // ternary operators
1895           case 'BETWEEN':
1896           case 'NOT BETWEEN':
1897             if (empty($criteria[0]) || empty($criteria[1])) {
1898               throw new Exception("invalid criteria for $operator");
1899             }
1900             if(!$returnSanitisedArray) {
1901               return (sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO::escapeString($criteria[0]), CRM_Core_DAO::escapeString($criteria[1])));
1902             }
1903             else{
1904               return NULL;  // not yet implemented (tests required to implement)
1905             }
1906             break;
1907
1908           // n-ary operators
1909           case 'IN':
1910           case 'NOT IN':
1911             if (empty($criteria)) {
1912               throw new Exception("invalid criteria for $operator");
1913             }
1914             $escapedCriteria = array_map(array(
1915               'CRM_Core_DAO',
1916               'escapeString'
1917             ), $criteria);
1918             if(!$returnSanitisedArray) {
1919               return (sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria)));
1920             }
1921             return $escapedCriteria;
1922             break;
1923
1924           // binary operators
1925
1926           default:
1927             if(!$returnSanitisedArray) {
1928               return(sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO::escapeString($criteria)));
1929             }
1930             else{
1931               return NULL; // not yet implemented (tests required to implement)
1932             }
1933         }
1934       }
1935     }
1936   }
1937
1938   /**
1939    * SQL has a limit of 64 characters on various names:
1940    * table name, trigger name, column name ...
1941    *
1942    * For custom groups and fields we generated names from user entered input
1943    * which can be longer than this length, this function helps with creating
1944    * strings that meet various criteria.
1945    *
1946    * @param string $string - the string to be shortened
1947    * @param int    $length - the max length of the string
1948    */
1949   public static function shortenSQLName($string, $length = 60, $makeRandom = FALSE) {
1950     // early return for strings that meet the requirements
1951     if (strlen($string) <= $length) {
1952       return $string;
1953     }
1954
1955     // easy return for calls that dont need a randomized uniq string
1956     if (! $makeRandom) {
1957       return substr($string, 0, $length);
1958     }
1959
1960     // the string is longer than the length and we need a uniq string
1961     // for the same tablename we need the same uniq string everytime
1962     // hence we use md5 on the string, which is not random
1963     // we'll append 8 characters to the end of the tableName
1964     $md5string = substr(md5($string), 0, 8);
1965     return substr($string, 0, $length - 8) . "_{$md5string}";
1966   }
1967
1968   function setApiFilter(&$params) {}
1969
1970 }