CRM/Core/BAO/PrevNextCache.php

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