CRM/Core/BAO/PrevNextCache.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.7                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * BAO object for civicrm_prevnext_cache table
  38  */
  39 class CRM_Core_BAO_PrevNextCache extends CRM_Core_DAO_PrevNextCache {
  40
  41   /**
  42    * @param $cacheKey
  43    * @param $id1
  44    * @param $id2
  45    * @param int $mergeId
  46    * @param NULL $join
  47    * @param NULL $where
  48    * @param bool $flip
  49    *
  50    * @return array
  51    */
  52   public static function getPositions($cacheKey, $id1, $id2, &$mergeId = NULL, $join = NULL, $where = NULL, $flip = FALSE) {
  53     if ($flip) {
  54       list($id1, $id2) = array($id2, $id1);
  55     }
  56
  57     if ($mergeId == NULL) {
  58       $query = "
  59 SELECT id
  60 FROM   civicrm_prevnext_cache
  61 WHERE  cacheKey     = %3 AND
  62        entity_id1 = %1 AND
  63        entity_id2 = %2 AND
  64        entity_table = 'civicrm_contact'
  65 ";
  66
  67       $params = array(
  68         1 => array($id1, 'Integer'),
  69         2 => array($id2, 'Integer'),
  70         3 => array($cacheKey, 'String'),
  71       );
  72
  73       $mergeId = CRM_Core_DAO::singleValueQuery($query, $params);
  74     }
  75
  76     $pos = array('foundEntry' => 0);
  77     if ($mergeId) {
  78       $pos['foundEntry'] = 1;
  79
  80       if ($where) {
  81
  82         $where = " AND {$where}";
  83
  84       }
  85       $p = array(
  86         1 => array($mergeId, 'Integer'),
  87         2 => array($cacheKey, 'String'),
  88       );
  89       $sql = "SELECT pn.id, pn.entity_id1, pn.entity_id2, pn.data FROM civicrm_prevnext_cache pn {$join} ";
  90       $wherePrev = " WHERE pn.id < %1 AND pn.cacheKey = %2 {$where} ORDER BY ID DESC LIMIT 1";
  91       $sqlPrev = $sql . $wherePrev;
  92
  93       $dao = CRM_Core_DAO::executeQuery($sqlPrev, $p);
  94       if ($dao->fetch()) {
  95         $pos['prev']['id1'] = $dao->entity_id1;
  96         $pos['prev']['id2'] = $dao->entity_id2;
  97         $pos['prev']['mergeId'] = $dao->id;
  98         $pos['prev']['data'] = $dao->data;
  99       }
 100
 101       $whereNext = " WHERE pn.id > %1 AND pn.cacheKey = %2 {$where} ORDER BY ID ASC LIMIT 1";
 102       $sqlNext = $sql . $whereNext;
 103
 104       $dao = CRM_Core_DAO::executeQuery($sqlNext, $p);
 105       if ($dao->fetch()) {
 106         $pos['next']['id1'] = $dao->entity_id1;
 107         $pos['next']['id2'] = $dao->entity_id2;
 108         $pos['next']['mergeId'] = $dao->id;
 109         $pos['next']['data'] = $dao->data;
 110       }
 111     }
 112     return $pos;
 113   }
 114
 115   /**
 116    * @param int $id
 117    * @param NULL $cacheKey
 118    * @param string $entityTable
 119    */
 120   public static function deleteItem($id = NULL, $cacheKey = NULL, $entityTable = 'civicrm_contact') {
 121
 122     //clear cache
 123     $sql = "DELETE FROM civicrm_prevnext_cache WHERE  entity_table = %1";
 124     $params = array(1 => array($entityTable, 'String'));
 125
 126     if (is_numeric($id)) {
 127       $sql .= " AND ( entity_id1 = %2 OR entity_id2 = %2 )";
 128       $params[2] = array($id, 'Integer');
 129     }
 130
 131     if (isset($cacheKey)) {
 132       $sql .= " AND cacheKey LIKE %3";
 133       $params[3] = array("{$cacheKey}%", 'String');
 134     }
 135     CRM_Core_DAO::executeQuery($sql, $params);
 136   }
 137
 138   /**
 139    * @param $id1
 140    * @param $id2
 141    * @param NULL $cacheKey
 142    * @param bool $isViceVersa
 143    * @param string $entityTable
 144    */
 145   public static function deletePair($id1, $id2, $cacheKey = NULL, $isViceVersa = FALSE, $entityTable = 'civicrm_contact') {
 146     $sql = "DELETE FROM civicrm_prevnext_cache WHERE  entity_table = %1";
 147     $params = array(1 => array($entityTable, 'String'));
 148
 149     $pair = !$isViceVersa ? "entity_id1 = %2 AND entity_id2 = %3" : "(entity_id1 = %2 AND entity_id2 = %3) OR (entity_id1 = %3 AND entity_id2 = %2)";
 150     $sql .= " AND ( {$pair} )";
 151     $params[2] = array($id1, 'Integer');
 152     $params[3] = array($id2, 'Integer');
 153
 154     if (isset($cacheKey)) {
 155       $sql .= " AND cacheKey LIKE %4";
 156       $params[4] = array("{$cacheKey}%", 'String'); // used % to address any row with conflict-cacheKey e.g "merge Individual_8_0_conflicts"
 157     }
 158
 159     CRM_Core_DAO::executeQuery($sql, $params);
 160   }
 161
 162   public static function markConflict($id1, $id2, $cacheKey, $conflicts) {
 163     if (empty($cacheKey) || empty($conflicts)) {
 164       return FALSE;
 165     }
 166
 167     $sql  = "SELECT pn.*
 168       FROM  civicrm_prevnext_cache pn
 169       WHERE
 170       ((pn.entity_id1 = %1 AND pn.entity_id2 = %2) OR (pn.entity_id1 = %2 AND pn.entity_id2 = %1)) AND
 171       (cacheKey = %3 OR cacheKey = %4)";
 172     $params = array(
 173       1 => array($id1, 'Integer'),
 174       2 => array($id2, 'Integer'),
 175       3 => array("{$cacheKey}", 'String'),
 176       4 => array("{$cacheKey}_conflicts", 'String'),
 177     );
 178     $pncFind = CRM_Core_DAO::executeQuery($sql, $params);
 179
 180     while ($pncFind->fetch()) {
 181       $data = $pncFind->data;
 182       if (!empty($data)) {
 183         $data = unserialize($data);
 184         $data['conflicts'] = implode(",", array_values($conflicts));
 185
 186         $pncUp = new CRM_Core_DAO_PrevNextCache();
 187         $pncUp->id = $pncFind->id;
 188         if ($pncUp->find(TRUE)) {
 189           $pncUp->data     = serialize($data);
 190           $pncUp->cacheKey = "{$cacheKey}_conflicts";
 191           $pncUp->save();
 192         }
 193       }
 194     }
 195     return TRUE;
 196   }
 197
 198   /**
 199    * @param $cacheKey
 200    * @param NULL $join
 201    * @param NULL $where
 202    * @param int $offset
 203    * @param int $rowCount
 204    *
 205    * @return array
 206    */
 207   public static function retrieve($cacheKey, $join = NULL, $where = NULL, $offset = 0, $rowCount = 0, $select = array()) {
 208     $selectString = 'pn.*';
 209     if (!empty($select)) {
 210       $aliasArray = array();
 211       foreach ($select as $column => $alias) {
 212         $aliasArray[] = $column . ' as ' . $alias;
 213       }
 214       $selectString .= " , " . implode(' , ', $aliasArray);
 215     }
 216     $query = "
 217 SELECT SQL_CALC_FOUND_ROWS {$selectString}
 218 FROM   civicrm_prevnext_cache pn
 219        {$join}
 220 WHERE  (pn.cacheKey = %1 OR pn.cacheKey = %2)
 221 ";
 222     $params = array(
 223       1 => array($cacheKey, 'String'),
 224       2 => array("{$cacheKey}_conflicts", 'String'),
 225     );
 226
 227     if ($where) {
 228       $query .= " AND {$where}";
 229     }
 230
 231     if ($rowCount) {
 232       $offset = CRM_Utils_Type::escape($offset, 'Int');
 233       $rowCount = CRM_Utils_Type::escape($rowCount, 'Int');
 234
 235       $query .= " LIMIT {$offset}, {$rowCount}";
 236     }
 237
 238     $dao = CRM_Core_DAO::executeQuery($query, $params);
 239
 240     $main  = array();
 241     $count = 0;
 242     while ($dao->fetch()) {
 243       if (self::is_serialized($dao->data)) {
 244         $main[$count] = unserialize($dao->data);
 245       }
 246       else {
 247         $main[$count] = $dao->data;
 248       }
 249
 250       if (!empty($select)) {
 251         $extraData = array();
 252         foreach ($select as $dfield => $sfield) {
 253           $extraData[$sfield]  = $dao->$sfield;
 254         }
 255         $main[$count] = array(
 256           'prevnext_id' => $dao->id,
 257           'is_selected' => $dao->is_selected,
 258           'entity_id1'  => $dao->entity_id1,
 259           'entity_id2'  => $dao->entity_id2,
 260           'data'        => $main[$count],
 261         );
 262         $main[$count] = array_merge($main[$count], $extraData);
 263       }
 264       $count++;
 265     }
 266
 267     return $main;
 268   }
 269
 270   /**
 271    * @param $string
 272    *
 273    * @return bool
 274    */
 275   public static function is_serialized($string) {
 276     return (@unserialize($string) !== FALSE);
 277   }
 278
 279   /**
 280    * @param $values
 281    */
 282   public static function setItem($values) {
 283     $insert = "INSERT INTO civicrm_prevnext_cache ( entity_table, entity_id1, entity_id2, cacheKey, data ) VALUES \n";
 284     $query = $insert . implode(",\n ", $values);
 285
 286     //dump the dedupe matches in the prevnext_cache table
 287     CRM_Core_DAO::executeQuery($query);
 288   }
 289
 290   /**
 291    * @param $cacheKey
 292    * @param NULL $join
 293    * @param NULL $where
 294    * @param string $op
 295    *
 296    * @return int
 297    */
 298   public static function getCount($cacheKey, $join = NULL, $where = NULL, $op = "=") {
 299     $query = "
 300 SELECT COUNT(*) FROM civicrm_prevnext_cache pn
 301        {$join}
 302 WHERE (pn.cacheKey $op %1 OR pn.cacheKey $op %2)
 303 ";
 304     if ($where) {
 305       $query .= " AND {$where}";
 306     }
 307
 308     $params = array(
 309       1 => array($cacheKey, 'String'),
 310       2 => array("{$cacheKey}_conflicts", 'String'),
 311     );
 312     return (int) CRM_Core_DAO::singleValueQuery($query, $params, TRUE, FALSE);
 313   }
 314
 315   /**
 316    * @param int $rgid
 317    * @param int $gid
 318    * @param NULL $cacheKeyString
 319    *
 320    * @return bool
 321    */
 322   public static function refillCache($rgid = NULL, $gid = NULL, $cacheKeyString = NULL) {
 323     if (!$cacheKeyString && $rgid) {
 324       $contactType = CRM_Core_DAO::getFieldValue('CRM_Dedupe_DAO_RuleGroup', $rgid, 'contact_type');
 325       $cacheKeyString = "merge {$contactType}";
 326       $cacheKeyString .= $rgid ? "_{$rgid}" : '_0';
 327       $cacheKeyString .= $gid ? "_{$gid}" : '_0';
 328     }
 329
 330     if (!$cacheKeyString) {
 331       return FALSE;
 332     }
 333
 334     // 1. Clear cache if any
 335     $sql = "DELETE FROM civicrm_prevnext_cache WHERE  cacheKey LIKE %1";
 336     CRM_Core_DAO::executeQuery($sql, array(1 => array("{$cacheKeyString}%", 'String')));
 337
 338     // FIXME: we need to start using temp tables / queries here instead of arrays.
 339     // And cleanup code in CRM/Contact/Page/DedupeFind.php
 340
 341     // 2. FILL cache
 342     $foundDupes = array();
 343     if ($rgid && $gid) {
 344       $foundDupes = CRM_Dedupe_Finder::dupesInGroup($rgid, $gid);
 345     }
 346     elseif ($rgid) {
 347       $foundDupes = CRM_Dedupe_Finder::dupes($rgid);
 348     }
 349
 350     if (!empty($foundDupes)) {
 351       $cids = $displayNames = $values = array();
 352       foreach ($foundDupes as $dupe) {
 353         $cids[$dupe[0]] = 1;
 354         $cids[$dupe[1]] = 1;
 355       }
 356       $cidString = implode(', ', array_keys($cids));
 357       $sql = "SELECT id, display_name FROM civicrm_contact WHERE id IN ($cidString) ORDER BY sort_name";
 358       $dao = new CRM_Core_DAO();
 359       $dao->query($sql);
 360       while ($dao->fetch()) {
 361         $displayNames[$dao->id] = $dao->display_name;
 362       }
 363
 364       $session = CRM_Core_Session::singleton();
 365       $userId = $session->get('userID');
 366
 367       foreach ($foundDupes as $dupes) {
 368         $srcID = $dupes[0];
 369         $dstID = $dupes[1];
 370         if ($dstID == $userId) {
 371           $srcID = $dupes[1];
 372           $dstID = $dupes[0];
 373         }
 374
 375         $row = array(
 376           'srcID' => $srcID,
 377           'srcName' => $displayNames[$srcID],
 378           'dstID' => $dstID,
 379           'dstName' => $displayNames[$dstID],
 380           'weight' => $dupes[2],
 381           'canMerge' => TRUE,
 382         );
 383
 384         $data = CRM_Core_DAO::escapeString(serialize($row));
 385         $values[] = " ( 'civicrm_contact', $srcID, $dstID, '$cacheKeyString', '$data' ) ";
 386       }
 387       self::setItem($values);
 388     }
 389   }
 390
 391   public static function cleanupCache() {
 392     // clean up all prev next caches older than $cacheTimeIntervalDays days
 393     $cacheTimeIntervalDays = 2;
 394
 395     // first find all the cacheKeys that match this
 396     $sql = "
 397 DELETE     pn, c
 398 FROM       civicrm_cache c
 399 INNER JOIN civicrm_prevnext_cache pn ON c.path = pn.cacheKey
 400 WHERE      c.group_name = %1
 401 AND        c.created_date < date_sub( NOW( ), INTERVAL %2 day )
 402 ";
 403     $params = array(
 404       1 => array('CiviCRM Search PrevNextCache', 'String'),
 405       2 => array($cacheTimeIntervalDays, 'Integer'),
 406     );
 407     CRM_Core_DAO::executeQuery($sql, $params);
 408   }
 409
 410   /**
 411    * Save checkbox selections.
 412    *
 413    * @param $cacheKey
 414    * @param string $action
 415    * @param array $cIds
 416    * @param string $entity_table
 417    */
 418   public static function markSelection($cacheKey, $action = 'unselect', $cIds = NULL, $entity_table = 'civicrm_contact') {
 419     if (!$cacheKey) {
 420       return;
 421     }
 422     $params = array();
 423
 424     $entity_whereClause = " AND entity_table = '{$entity_table}'";
 425     if ($cIds && $cacheKey && $action) {
 426       if (is_array($cIds)) {
 427         $cIdFilter = "(" . implode(',', $cIds) . ")";
 428         $whereClause = "
 429 WHERE cacheKey LIKE %1
 430 AND (entity_id1 IN {$cIdFilter} OR entity_id2 IN {$cIdFilter})
 431 ";
 432       }
 433       else {
 434         $whereClause = "
 435 WHERE cacheKey LIKE %1
 436 AND (entity_id1 = %2 OR entity_id2 = %2)
 437 ";
 438         $params[2] = array("{$cIds}", 'Integer');
 439       }
 440       if ($action == 'select') {
 441         $whereClause .= "AND is_selected = 0";
 442         $sql = "UPDATE civicrm_prevnext_cache SET is_selected = 1 {$whereClause} {$entity_whereClause}";
 443         $params[1] = array("{$cacheKey}%", 'String');
 444       }
 445       elseif ($action == 'unselect') {
 446         $whereClause .= "AND is_selected = 1";
 447         $sql = "UPDATE civicrm_prevnext_cache SET is_selected = 0 {$whereClause} {$entity_whereClause}";
 448         $params[1] = array("%{$cacheKey}%", 'String');
 449       }
 450       // default action is reseting
 451     }
 452     elseif (!$cIds && $cacheKey && $action == 'unselect') {
 453       $sql = "
 454 UPDATE civicrm_prevnext_cache
 455 SET    is_selected = 0
 456 WHERE  cacheKey LIKE %1 AND is_selected = 1
 457        {$entity_whereClause}
 458 ";
 459       $params[1] = array("{$cacheKey}%", 'String');
 460     }
 461     CRM_Core_DAO::executeQuery($sql, $params);
 462   }
 463
 464   /**
 465    * Get the selections.
 466    *
 467    * @param string $cacheKey
 468    *   Cache key.
 469    * @param string $action
 470    *   Action.
 471    *  $action : get - get only selection records
 472    *            getall - get all the records of the specified cache key
 473    * @param string $entity_table
 474    *   Entity table.
 475    *
 476    * @return array|NULL
 477    */
 478   public static function getSelection($cacheKey, $action = 'get', $entity_table = 'civicrm_contact') {
 479     if (!$cacheKey) {
 480       return NULL;
 481     }
 482     $params = array();
 483
 484     $entity_whereClause = " AND entity_table = '{$entity_table}'";
 485     if ($cacheKey && ($action == 'get' || $action == 'getall')) {
 486       $actionGet = ($action == "get") ? " AND is_selected = 1 " : "";
 487       $sql = "
 488 SELECT entity_id1, entity_id2 FROM civicrm_prevnext_cache
 489 WHERE cacheKey LIKE %1
 490       $actionGet
 491       $entity_whereClause
 492 ORDER BY id
 493 ";
 494       $params[1] = array("{$cacheKey}%", 'String');
 495
 496       $contactIds = array($cacheKey => array());
 497       $cIdDao = CRM_Core_DAO::executeQuery($sql, $params);
 498       while ($cIdDao->fetch()) {
 499         if ($cIdDao->entity_id1 == $cIdDao->entity_id2) {
 500           $contactIds[$cacheKey][$cIdDao->entity_id1] = 1;
 501         }
 502       }
 503       return $contactIds;
 504     }
 505   }
 506
 507   /**
 508    * @return array
 509    */
 510   public static function getSelectedContacts() {
 511     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String');
 512     $cacheKey = "civicrm search {$qfKey}";
 513     $query = "
 514 SELECT *
 515 FROM   civicrm_prevnext_cache
 516 WHERE  cacheKey LIKE %1
 517   AND  is_selected=1
 518   AND  cacheKey NOT LIKE %2
 519 ";
 520     $params1[1] = array("{$cacheKey}%", 'String');
 521     $params1[2] = array("{$cacheKey}_alphabet%", 'String');
 522     $dao = CRM_Core_DAO::executeQuery($query, $params1);
 523
 524     $val = array();
 525     while ($dao->fetch()) {
 526       $val[] = $dao->data;
 527     }
 528     return $val;
 529   }
 530
 531   /**
 532    * @param CRM_Core_Form $form
 533    * @param array $params
 534    *
 535    * @return mixed
 536    */
 537   public static function buildSelectedContactPager(&$form, &$params) {
 538     $params['status'] = ts('Contacts %%StatusMessage%%');
 539     $params['csvString'] = NULL;
 540     $params['buttonTop'] = 'PagerTopButton';
 541     $params['buttonBottom'] = 'PagerBottomButton';
 542     $params['rowCount'] = $form->get(CRM_Utils_Pager::PAGE_ROWCOUNT);
 543
 544     if (!$params['rowCount']) {
 545       $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
 546     }
 547
 548     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
 549     $cacheKey = "civicrm search {$qfKey}";
 550
 551     $query = "
 552 SELECT count(id)
 553 FROM   civicrm_prevnext_cache
 554 WHERE  cacheKey LIKE %1
 555   AND  is_selected = 1
 556   AND  cacheKey NOT LIKE %2
 557 ";
 558     $params1[1] = array("{$cacheKey}%", 'String');
 559     $params1[2] = array("{$cacheKey}_alphabet%", 'String');
 560     $paramsTotal = CRM_Core_DAO::singleValueQuery($query, $params1);
 561     $params['total'] = $paramsTotal;
 562     $form->_pager = new CRM_Utils_Pager($params);
 563     $form->assign_by_ref('pager', $form->_pager);
 564     list($offset, $rowCount) = $form->_pager->getOffsetAndRowCount();
 565     $params['offset'] = $offset;
 566     $params['rowCount1'] = $rowCount;
 567     return $params;
 568   }
 569
 570 }