CRM/Utils/SQL/TempTable.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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  *
  33  * Table naming rules:
  34  *   - MySQL imposes a 64 char limit.
  35  *   - All temp tables start with "civicrm_tmp".
  36  *   - Durable temp tables: "civicrm_tmp_d_{12}_{32}"
  37  *   - Ephemeral temp tables: "civicrm_tmp_e_{12}_{32}"
  38  *
  39  * To use `TempTable`:
  40  *   - Begin by calling `CRM_Utils_SQL_TempTable::build()`.
  41  *   - Optionally, describe the table with `setDurable()`, `setCategory()`, `setId()`.
  42  *   - Finally, call `getName()` or `createWithQuery()` or `createWithColumns()`.
  43  *
  44  * Example 1: Just create a table name. You'll be responsible for CREATE/DROP actions.
  45  *
  46  * $name = CRM_Utils_SQL_TempTable::build()->getName();
  47  * $name = CRM_Utils_SQL_TempTable::build()->setDurable()->getName();
  48  * $name = CRM_Utils_SQL_TempTable::build()->setCategory('contactstats')->setId($contact['id'])->getName();
  49  *
  50  * Example 2: Create a temp table using the results of a SELECT query.
  51  *
  52  * $tmpTbl = CRM_Utils_SQL_TempTable::build()->createWithQuery('SELECT id, display_name FROM civicrm_contact');
  53  * $tmpTbl = CRM_Utils_SQL_TempTable::build()->createWithQuery(CRM_Utils_SQL_Select::from('civicrm_contact')->select('display_name'));
  54  *
  55  * Example 3: Create an empty temp table with list of columns.
  56  *
  57  * $tmpTbl = CRM_Utils_SQL_TempTable::build()->setDurable()->setUtf8()->createWithColumns('id int(10, name varchar(64)');
  58  *
  59  * Example 4: Drop a table that you previously created.
  60  *
  61  * $tmpTbl->drop();
  62  *
  63  * Example 5: Auto-drop a temp table when $tmpTbl falls out of scope
  64  *
  65  * $tmpTbl->setAutodrop();
  66  *
  67  */
  68 class CRM_Utils_SQL_TempTable {
  69
  70   const UTF8 = 'DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci';
  71   const CATEGORY_LENGTH = 12;
  72   const CATEGORY_REGEXP = ';^[a-zA-Z0-9]+$;';
  73   const ID_LENGTH = 37; // MAX{64} - CATEGORY_LENGTH{12} - CONST_LENGHTH{15} = 37
  74   const ID_REGEXP = ';^[a-zA-Z0-9_]+$;';
  75   const INNODB = 'ENGINE=InnoDB';
  76   const MEMORY = 'ENGINE=MEMORY';
  77
  78   /**
  79    * @var bool
  80    */
  81   protected $durable, $utf8;
  82
  83   protected $category;
  84
  85   protected $id;
  86
  87   protected $autodrop;
  88
  89   protected $memory;
  90
  91   protected $createSql;
  92
  93   /**
  94    * @return CRM_Utils_SQL_TempTable
  95    */
  96   public static function build() {
  97     $t = new CRM_Utils_SQL_TempTable();
  98     $t->category = NULL;
  99     $t->id = md5(uniqid('', TRUE));
 100     // The constant CIVICRM_TEMP_FORCE_DURABLE is for local debugging.
 101     $t->durable = CRM_Utils_Constant::value('CIVICRM_TEMP_FORCE_DURABLE', FALSE);
 102     // @deprecated This constant is deprecated and will be removed.
 103     $t->utf8 = CRM_Utils_Constant::value('CIVICRM_TEMP_FORCE_UTF8', TRUE);
 104     $t->autodrop = FALSE;
 105     $t->memory = FALSE;
 106     return $t;
 107   }
 108
 109   public function __destruct() {
 110     if ($this->autodrop) {
 111       $this->drop();
 112     }
 113   }
 114
 115   /**
 116    * Determine the full table name.
 117    *
 118    * @return string
 119    *   Ex: 'civicrm_tmp_d_foo_abcd1234abcd1234'
 120    */
 121   public function getName() {
 122     $parts = ['civicrm', 'tmp'];
 123     $parts[] = ($this->durable ? 'd' : 'e');
 124     $parts[] = $this->category ? $this->category : 'dflt';
 125     $parts[] = $this->id ? $this->id : 'dflt';
 126     return implode('_', $parts);
 127   }
 128
 129   /**
 130    * Create the table using results from a SELECT query.
 131    *
 132    * @param string|CRM_Utils_SQL_Select $selectQuery
 133    * @return CRM_Utils_SQL_TempTable
 134    */
 135   public function createWithQuery($selectQuery) {
 136     $sql = sprintf('%s %s %s AS %s',
 137       $this->toSQL('CREATE'),
 138       $this->memory ? self::MEMORY : self::INNODB,
 139       $this->utf8 ? self::UTF8 : '',
 140       ($selectQuery instanceof CRM_Utils_SQL_Select ? $selectQuery->toSQL() : $selectQuery)
 141     );
 142     CRM_Core_DAO::executeQuery($sql, array(), TRUE, NULL, TRUE, FALSE);
 143     $this->createSql = $sql;
 144     return $this;
 145   }
 146
 147   /**
 148    * Create the empty table.
 149    *
 150    * @parma string $columns
 151    *   SQL column listing.
 152    *   Ex: 'id int(10), name varchar(64)'.
 153    * @return CRM_Utils_SQL_TempTable
 154    */
 155   public function createWithColumns($columns) {
 156     $sql = sprintf('%s (%s) %s %s',
 157       $this->toSQL('CREATE'),
 158       $columns,
 159       $this->memory ? self::MEMORY : self::INNODB,
 160       $this->utf8 ? self::UTF8 : ''
 161     );
 162     CRM_Core_DAO::executeQuery($sql, array(), TRUE, NULL, TRUE, FALSE);
 163     $this->createSql = $sql;
 164     return $this;
 165   }
 166
 167   /**
 168    * Drop the table.
 169    *
 170    * @return CRM_Utils_SQL_TempTable
 171    */
 172   public function drop() {
 173     $sql = $this->toSQL('DROP', 'IF EXISTS');
 174     CRM_Core_DAO::executeQuery($sql, array(), TRUE, NULL, TRUE, FALSE);
 175     return $this;
 176   }
 177
 178   /**
 179    * @param string $action
 180    *   Ex: 'CREATE', 'DROP'
 181    * @param string|NULL $ifne
 182    *   Ex: 'IF EXISTS', 'IF NOT EXISTS'.
 183    * @return string
 184    *   Ex: 'CREATE TEMPORARY TABLE `civicrm_tmp_e_foo_abcd1234`'
 185    *   Ex: 'CREATE TABLE IF NOT EXISTS `civicrm_tmp_d_foo_abcd1234`'
 186    */
 187   private function toSQL($action, $ifne = NULL) {
 188     $parts = [];
 189     $parts[] = $action;
 190     if (!$this->durable) {
 191       $parts[] = 'TEMPORARY';
 192     }
 193     $parts[] = 'TABLE';
 194     if ($ifne) {
 195       $parts[] = $ifne;
 196     }
 197     $parts[] = '`' . $this->getName() . '`';
 198     return implode(' ', $parts);
 199   }
 200
 201   /**
 202    * @return string|NULL
 203    */
 204   public function getCategory() {
 205     return $this->category;
 206   }
 207
 208   /**
 209    * @return string|NULL
 210    */
 211   public function getId() {
 212     return $this->id;
 213   }
 214
 215   /**
 216    * @return string|NULL
 217    */
 218   public function getCreateSql() {
 219     return $this->createSql;
 220   }
 221
 222   /**
 223    * @return bool
 224    */
 225   public function isAutodrop() {
 226     return $this->autodrop;
 227   }
 228
 229   /**
 230    * @return bool
 231    */
 232   public function isDurable() {
 233     return $this->durable;
 234   }
 235
 236   /**
 237    * @return bool
 238    */
 239   public function isMemory() {
 240     return $this->memory;
 241   }
 242
 243   /**
 244    * @return bool
 245    */
 246   public function isUtf8() {
 247     return $this->utf8;
 248   }
 249
 250   /**
 251    * @param bool $autodrop
 252    * @return CRM_Utils_SQL_TempTable
 253    */
 254   public function setAutodrop($autodrop = TRUE) {
 255     $this->autodrop = $autodrop;
 256     return $this;
 257   }
 258
 259   /**
 260    * @param string|NULL $category
 261    *
 262    * @return CRM_Utils_SQL_TempTable
 263    */
 264   public function setCategory($category) {
 265     if ($category && !preg_match(self::CATEGORY_REGEXP, $category) || strlen($category) > self::CATEGORY_LENGTH) {
 266       throw new \RuntimeException("Malformed temp table category");
 267     }
 268     $this->category = $category;
 269     return $this;
 270   }
 271
 272   /**
 273    * Set whether the table should be durable.
 274    *
 275    * Durable tables are not TEMPORARY in the mysql sense.
 276    *
 277    * @param bool $durable
 278    *
 279    * @return CRM_Utils_SQL_TempTable
 280    */
 281   public function setDurable($durable = TRUE) {
 282     $this->durable = $durable;
 283     return $this;
 284   }
 285
 286   /**
 287    * Setter for id
 288    *
 289    * @param mixed $id
 290    *
 291    * @return CRM_Utils_SQL_TempTable
 292    */
 293   public function setId($id) {
 294     if ($id && !preg_match(self::ID_REGEXP, $id) || strlen($id) > self::ID_LENGTH) {
 295       throw new \RuntimeException("Malformed temp table id");
 296     }
 297     $this->id = $id;
 298     return $this;
 299   }
 300
 301   /**
 302    * Set table engine to MEMORY.
 303    *
 304    * @param bool $value
 305    *
 306    * @return $this
 307    */
 308   public function setMemory($value = TRUE) {
 309     $this->memory = $value;
 310     return $this;
 311   }
 312
 313   /**
 314    * Set table collation to UTF8.
 315    *
 316    * This would make sense as a default but cautiousness during phasing in has made it opt-in.
 317    *
 318    * @param bool $value
 319    *
 320    * @return $this
 321    */
 322   public function setUtf8($value = TRUE) {
 323     $this->utf8 = $value;
 324     return $this;
 325   }
 326
 327 }