3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
37 * BAO object for civicrm_prevnext_cache table
39 class CRM_Core_BAO_PrevNextCache
extends CRM_Core_DAO_PrevNextCache
{
52 public static function getPositions($cacheKey, $id1, $id2, &$mergeId = NULL, $join = NULL, $where = NULL, $flip = FALSE) {
54 list($id1, $id2) = array($id2, $id1);
57 if ($mergeId == NULL) {
60 FROM civicrm_prevnext_cache
61 WHERE cacheKey = %3 AND
64 entity_table = 'civicrm_contact'
68 1 => array($id1, 'Integer'),
69 2 => array($id2, 'Integer'),
70 3 => array($cacheKey, 'String'),
73 $mergeId = CRM_Core_DAO
::singleValueQuery($query, $params);
76 $pos = array('foundEntry' => 0);
78 $pos['foundEntry'] = 1;
82 $where = " AND {$where}";
86 1 => array($mergeId, 'Integer'),
87 2 => array($cacheKey, 'String'),
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;
93 $dao = CRM_Core_DAO
::executeQuery($sqlPrev, $p);
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
;
101 $whereNext = " WHERE pn.id > %1 AND pn.cacheKey = %2 {$where} ORDER BY ID ASC LIMIT 1";
102 $sqlNext = $sql . $whereNext;
104 $dao = CRM_Core_DAO
::executeQuery($sqlNext, $p);
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
;
117 * @param NULL $cacheKey
118 * @param string $entityTable
120 public static function deleteItem($id = NULL, $cacheKey = NULL, $entityTable = 'civicrm_contact') {
123 $sql = "DELETE FROM civicrm_prevnext_cache WHERE entity_table = %1";
124 $params = array(1 => array($entityTable, 'String'));
126 if (is_numeric($id)) {
127 $sql .= " AND ( entity_id1 = %2 OR entity_id2 = %2 )";
128 $params[2] = array($id, 'Integer');
131 if (isset($cacheKey)) {
132 $sql .= " AND cacheKey LIKE %3";
133 $params[3] = array("{$cacheKey}%", 'String');
135 CRM_Core_DAO
::executeQuery($sql, $params);
141 * @param NULL $cacheKey
142 * @param bool $isViceVersa
143 * @param string $entityTable
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'));
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');
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"
159 CRM_Core_DAO
::executeQuery($sql, $params);
162 public static function markConflict($id1, $id2, $cacheKey, $conflicts) {
163 if (empty($cacheKey) ||
empty($conflicts)) {
168 FROM civicrm_prevnext_cache pn
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)";
173 1 => array($id1, 'Integer'),
174 2 => array($id2, 'Integer'),
175 3 => array("{$cacheKey}", 'String'),
176 4 => array("{$cacheKey}_conflicts", 'String'),
178 $pncFind = CRM_Core_DAO
::executeQuery($sql, $params);
180 while ($pncFind->fetch()) {
181 $data = $pncFind->data
;
183 $data = unserialize($data);
184 $data['conflicts'] = implode(",", array_values($conflicts));
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";
203 * @param int $rowCount
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;
214 $selectString .= " , " . implode(' , ', $aliasArray);
217 SELECT SQL_CALC_FOUND_ROWS {$selectString}
218 FROM civicrm_prevnext_cache pn
220 WHERE (pn.cacheKey = %1 OR pn.cacheKey = %2)
223 1 => array($cacheKey, 'String'),
224 2 => array("{$cacheKey}_conflicts", 'String'),
228 $query .= " AND {$where}";
232 $offset = CRM_Utils_Type
::escape($offset, 'Int');
233 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
235 $query .= " LIMIT {$offset}, {$rowCount}";
238 $dao = CRM_Core_DAO
::executeQuery($query, $params);
242 while ($dao->fetch()) {
243 if (self
::is_serialized($dao->data
)) {
244 $main[$count] = unserialize($dao->data
);
247 $main[$count] = $dao->data
;
250 if (!empty($select)) {
251 $extraData = array();
252 foreach ($select as $dfield => $sfield) {
253 $extraData[$sfield] = $dao->$sfield;
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],
262 $main[$count] = array_merge($main[$count], $extraData);
275 public static function is_serialized($string) {
276 return (@unserialize
($string) !== FALSE);
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);
286 //dump the dedupe matches in the prevnext_cache table
287 CRM_Core_DAO
::executeQuery($query);
298 public static function getCount($cacheKey, $join = NULL, $where = NULL, $op = "=") {
300 SELECT COUNT(*) FROM civicrm_prevnext_cache pn
302 WHERE (pn.cacheKey $op %1 OR pn.cacheKey $op %2)
305 $query .= " AND {$where}";
309 1 => array($cacheKey, 'String'),
310 2 => array("{$cacheKey}_conflicts", 'String'),
312 return (int) CRM_Core_DAO
::singleValueQuery($query, $params, TRUE, FALSE);
318 * @param NULL $cacheKeyString
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';
330 if (!$cacheKeyString) {
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')));
338 // FIXME: we need to start using temp tables / queries here instead of arrays.
339 // And cleanup code in CRM/Contact/Page/DedupeFind.php
342 $foundDupes = array();
344 $foundDupes = CRM_Dedupe_Finder
::dupesInGroup($rgid, $gid);
347 $foundDupes = CRM_Dedupe_Finder
::dupes($rgid);
350 if (!empty($foundDupes)) {
351 $cids = $displayNames = $values = array();
352 foreach ($foundDupes as $dupe) {
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();
360 while ($dao->fetch()) {
361 $displayNames[$dao->id
] = $dao->display_name
;
364 $session = CRM_Core_Session
::singleton();
365 $userId = $session->get('userID');
367 foreach ($foundDupes as $dupes) {
370 if ($dstID == $userId) {
377 'srcName' => $displayNames[$srcID],
379 'dstName' => $displayNames[$dstID],
380 'weight' => $dupes[2],
384 $data = CRM_Core_DAO
::escapeString(serialize($row));
385 $values[] = " ( 'civicrm_contact', $srcID, $dstID, '$cacheKeyString', '$data' ) ";
387 self
::setItem($values);
391 public static function cleanupCache() {
392 // clean up all prev next caches older than $cacheTimeIntervalDays days
393 $cacheTimeIntervalDays = 2;
395 // first find all the cacheKeys that match this
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 )
404 1 => array('CiviCRM Search PrevNextCache', 'String'),
405 2 => array($cacheTimeIntervalDays, 'Integer'),
407 CRM_Core_DAO
::executeQuery($sql, $params);
411 * Save checkbox selections.
414 * @param string $action
416 * @param string $entity_table
418 public static function markSelection($cacheKey, $action = 'unselect', $cIds = NULL, $entity_table = 'civicrm_contact') {
424 $entity_whereClause = " AND entity_table = '{$entity_table}'";
425 if ($cIds && $cacheKey && $action) {
426 if (is_array($cIds)) {
427 $cIdFilter = "(" . implode(',', $cIds) . ")";
429 WHERE cacheKey LIKE %1
430 AND (entity_id1 IN {$cIdFilter} OR entity_id2 IN {$cIdFilter})
435 WHERE cacheKey LIKE %1
436 AND (entity_id1 = %2 OR entity_id2 = %2)
438 $params[2] = array("{$cIds}", 'Integer');
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');
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');
450 // default action is reseting
452 elseif (!$cIds && $cacheKey && $action == 'unselect') {
454 UPDATE civicrm_prevnext_cache
456 WHERE cacheKey LIKE %1 AND is_selected = 1
457 {$entity_whereClause}
459 $params[1] = array("{$cacheKey}%", 'String');
461 CRM_Core_DAO
::executeQuery($sql, $params);
465 * Get the selections.
467 * @param string $cacheKey
469 * @param string $action
471 * $action : get - get only selection records
472 * getall - get all the records of the specified cache key
473 * @param string $entity_table
478 public static function getSelection($cacheKey, $action = 'get', $entity_table = 'civicrm_contact') {
484 $entity_whereClause = " AND entity_table = '{$entity_table}'";
485 if ($cacheKey && ($action == 'get' ||
$action == 'getall')) {
486 $actionGet = ($action == "get") ?
" AND is_selected = 1 " : "";
488 SELECT entity_id1, entity_id2 FROM civicrm_prevnext_cache
489 WHERE cacheKey LIKE %1
494 $params[1] = array("{$cacheKey}%", 'String');
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;
510 public static function getSelectedContacts() {
511 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String');
512 $cacheKey = "civicrm search {$qfKey}";
515 FROM civicrm_prevnext_cache
516 WHERE cacheKey LIKE %1
518 AND cacheKey NOT LIKE %2
520 $params1[1] = array("{$cacheKey}%", 'String');
521 $params1[2] = array("{$cacheKey}_alphabet%", 'String');
522 $dao = CRM_Core_DAO
::executeQuery($query, $params1);
525 while ($dao->fetch()) {
532 * @param CRM_Core_Form $form
533 * @param array $params
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
);
544 if (!$params['rowCount']) {
545 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
548 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String', $form);
549 $cacheKey = "civicrm search {$qfKey}";
553 FROM civicrm_prevnext_cache
554 WHERE cacheKey LIKE %1
556 AND cacheKey NOT LIKE %2
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;