3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
36 * This class contains all contact related functions that are called using AJAX (jQuery)
38 class CRM_Contact_Page_AJAX
{
40 * When a user chooses a username, CHECK_USERNAME_TTL
41 * is the time window in which they can check usernames
42 * (without reloading the overall form).
44 const CHECK_USERNAME_TTL
= 10800; // 3hr; 3*60*60
46 const AUTOCOMPLETE_TTL
= 21600; // 6hr; 6*60*60
49 * Ajax callback for custom fields of type ContactReference
51 * Todo: Migrate contact reference fields to use EntityRef
53 public static function contactReference() {
54 $name = CRM_Utils_Array
::value('term', $_GET);
55 $name = CRM_Utils_Type
::escape($name, 'String');
56 $cfID = CRM_Utils_Type
::escape($_GET['id'], 'Positive');
58 // check that this is a valid, active custom field of Contact Reference type
59 $params = array('id' => $cfID);
60 $returnProperties = array('filter', 'data_type', 'is_active');
62 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $params, $cf, $returnProperties);
63 if (!$cf['id'] ||
!$cf['is_active'] ||
$cf['data_type'] != 'ContactReference') {
64 CRM_Utils_System
::civiExit('error');
67 if (!empty($cf['filter'])) {
68 $filterParams = array();
69 parse_str($cf['filter'], $filterParams);
71 $action = CRM_Utils_Array
::value('action', $filterParams);
73 if (!empty($action) &&
74 !in_array($action, array('get', 'lookup'))
76 CRM_Utils_System
::civiExit('error');
80 $list = array_keys(CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
81 'contact_reference_options'
84 $return = array_unique(array_merge(array('sort_name'), $list));
86 $limit = Civi
::settings()->get('search_autocomplete_count');
88 $params = array('offset' => 0, 'rowCount' => $limit, 'version' => 3);
89 foreach ($return as $fld) {
90 $params["return.{$fld}"] = 1;
93 if (!empty($action)) {
109 foreach ($_GET as $param => $val) {
111 in_array($param, $excludeGet) ||
112 strpos($param, 'return.') !== FALSE ||
113 strpos($param, 'api.') !== FALSE
117 $params[$param] = $val;
122 $params['sort_name'] = $name;
125 $params['sort'] = 'sort_name';
127 // tell api to skip permission chk. dgg
128 $params['check_permissions'] = 0;
130 // add filter variable to params
131 if (!empty($filterParams)) {
132 $params = array_merge($params, $filterParams);
135 $contact = civicrm_api('Contact', 'Get', $params);
137 if (!empty($contact['is_error'])) {
138 CRM_Utils_System
::civiExit('error');
141 $contactList = array();
142 foreach ($contact['values'] as $value) {
144 foreach ($return as $fld) {
145 if (!empty($value[$fld])) {
146 $view[] = $value[$fld];
149 $contactList[] = array('id' => $value['id'], 'text' => implode(' :: ', $view));
152 CRM_Utils_JSON
::output($contactList);
156 * Fetch PCP ID by PCP Supporter sort_name, also displays PCP title and associated Contribution Page title
158 public static function getPCPList() {
159 $name = CRM_Utils_Array
::value('term', $_GET);
160 $name = CRM_Utils_Type
::escape($name, 'String');
161 $limit = $max = Civi
::settings()->get('search_autocomplete_count');
163 $where = ' AND pcp.page_id = cp.id AND pcp.contact_id = cc.id';
165 $config = CRM_Core_Config
::singleton();
166 if ($config->includeWildCardInName
) {
167 $strSearch = "%$name%";
170 $strSearch = "$name%";
172 $includeEmailFrom = $includeNickName = '';
173 if ($config->includeNickNameInName
) {
174 $includeNickName = " OR nick_name LIKE '$strSearch'";
176 if ($config->includeEmailInName
) {
177 $includeEmailFrom = "LEFT JOIN civicrm_email eml ON ( cc.id = eml.contact_id AND eml.is_primary = 1 )";
178 $whereClause = " WHERE ( email LIKE '$strSearch' OR sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
181 $whereClause = " WHERE ( sort_name LIKE '$strSearch' $includeNickName ) {$where} ";
184 $offset = $count = 0;
185 if (!empty($_GET['page_num'])) {
186 $page = (int) $_GET['page_num'];
187 $offset = $limit * ($page - 1);
191 $select = 'cc.sort_name, pcp.title, cp.title';
195 SELECT pcp.id as id, CONCAT_WS( ' :: ', {$select} ) as data, sort_name
196 FROM civicrm_pcp pcp, civicrm_contribution_page cp, civicrm_contact cc
198 {$whereClause} AND pcp.page_type = 'contribute'
200 SELECT pcp.id as id, CONCAT_WS( ' :: ', {$select} ) as data, sort_name
201 FROM civicrm_pcp pcp, civicrm_event cp, civicrm_contact cc
203 {$whereClause} AND pcp.page_type = 'event'
206 LIMIT $offset, $limit
209 $dao = CRM_Core_DAO
::executeQuery($query);
210 $output = array('results' => array(), 'more' => FALSE);
211 while ($dao->fetch()) {
212 if (++
$count > $max) {
213 $output['more'] = TRUE;
216 $output['results'][] = array('id' => $dao->id
, 'text' => $dao->data
);
219 CRM_Utils_JSON
::output($output);
223 * @throws \CiviCRM_API3_Exception
225 public static function relationship() {
226 $relType = CRM_Utils_Request
::retrieve('rel_type', 'String', CRM_Core_DAO
::$_nullObject, TRUE);
227 $relContactID = CRM_Utils_Request
::retrieve('rel_contact', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
228 $originalCid = CRM_Utils_Request
::retrieve('cid', 'Positive', CRM_Core_DAO
::$_nullObject);
229 $relationshipID = CRM_Utils_Request
::retrieve('rel_id', 'Positive', CRM_Core_DAO
::$_nullObject);
230 $caseID = CRM_Utils_Request
::retrieve('case_id', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
232 if (!CRM_Case_BAO_Case
::accessCase($caseID)) {
233 CRM_Utils_System
::permissionDenied();
236 $ret = array('is_error' => 0);
238 list($relTypeId, $b, $a) = explode('_', $relType);
240 if ($relationshipID && $originalCid) {
241 CRM_Case_BAO_Case
::endCaseRole($caseID, $a, $originalCid, $relTypeId);
244 $clientList = CRM_Case_BAO_Case
::getCaseClients($caseID);
246 // Loop through multiple case clients
247 foreach ($clientList as $i => $sourceContactID) {
248 $result = civicrm_api3('relationship', 'create', array(
249 'case_id' => $caseID,
250 'relationship_type_id' => $relTypeId,
251 "contact_id_$a" => $relContactID,
252 "contact_id_$b" => $sourceContactID,
253 'start_date' => 'now',
255 // Save activity only for the primary (first) client
256 if ($i == 0 && empty($result['is_error'])) {
257 CRM_Case_BAO_Case
::createCaseRoleActivity($caseID, $result['id'], $relContactID);
261 CRM_Utils_JSON
::output($ret);
265 * Fetch the custom field help.
267 public static function customField() {
268 $fieldId = CRM_Utils_Type
::escape($_REQUEST['id'], 'Integer');
269 $params = array('id' => $fieldId);
270 $returnProperties = array('help_pre', 'help_post');
273 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $params, $values, $returnProperties);
274 CRM_Utils_JSON
::output($values);
277 public static function groupTree() {
278 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/json');
279 $gids = CRM_Utils_Type
::escape($_GET['gids'], 'String');
280 echo CRM_Contact_BAO_GroupNestingCache
::json($gids);
281 CRM_Utils_System
::civiExit();
285 * Delete custom value.
287 public static function deleteCustomValue() {
288 CRM_Utils_System
::setHttpHeader('Content-Type', 'text/plain');
289 $customValueID = CRM_Utils_Type
::escape($_REQUEST['valueID'], 'Positive');
290 $customGroupID = CRM_Utils_Type
::escape($_REQUEST['groupID'], 'Positive');
291 $contactId = CRM_Utils_Request
::retrieve('contactId', 'Positive', CRM_Core_DAO
::$_nullObject);
292 CRM_Core_BAO_CustomValue
::deleteCustomValue($customValueID, $customGroupID);
294 echo CRM_Contact_BAO_Contact
::getCountComponent('custom_' . $customGroupID, $contactId);
297 // reset the group contact cache for this group
298 CRM_Contact_BAO_GroupContactCache
::remove();
299 CRM_Utils_System
::civiExit();
303 * check the CMS username.
305 static public function checkUserName() {
306 $signer = new CRM_Utils_Signer(CRM_Core_Key
::privateKey(), array('for', 'ts'));
307 $sig = CRM_Utils_Request
::retrieve('sig', 'String', CRM_Core_DAO
::$_nullObject);
308 $for = CRM_Utils_Request
::retrieve('for', 'String', CRM_Core_DAO
::$_nullObject);
310 CRM_Utils_Time
::getTimeRaw() > $_REQUEST['ts'] + self
::CHECK_USERNAME_TTL
311 ||
$for != 'civicrm/ajax/cmsuser'
312 ||
!$signer->validate($sig, $_REQUEST)
314 $user = array('name' => 'error');
315 CRM_Utils_JSON
::output($user);
318 $config = CRM_Core_Config
::singleton();
319 $username = trim(CRM_Utils_Array
::value('cms_name', $_REQUEST));
321 $params = array('name' => $username);
324 $config->userSystem
->checkUserNameEmailExists($params, $errors);
326 if (isset($errors['cms_name']) ||
isset($errors['name'])) {
327 //user name is not available
328 $user = array('name' => 'no');
329 CRM_Utils_JSON
::output($user);
332 //user name is available
333 $user = array('name' => 'yes');
334 CRM_Utils_JSON
::output($user);
337 // Not reachable: JSON::output() above exits.
338 CRM_Utils_System
::civiExit();
342 * Function to get email address of a contact.
344 public static function getContactEmail() {
345 if (!empty($_REQUEST['contact_id'])) {
346 $contactID = CRM_Utils_Type
::escape($_REQUEST['contact_id'], 'Positive');
347 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactID, CRM_Core_Permission
::EDIT
)) {
352 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID);
354 CRM_Utils_System
::setHttpHeader('Content-Type', 'text/plain');
360 $noemail = CRM_Utils_Array
::value('noemail', $_GET);
362 $name = CRM_Utils_Array
::value('name', $_GET);
364 $name = CRM_Utils_Type
::escape($name, 'String');
366 $queryString = " cc.sort_name LIKE '%$name%'";
369 $queryString = " ( cc.sort_name LIKE '%$name%' OR ce.email LIKE '%$name%' ) ";
373 $cid = CRM_Utils_Array
::value('cid', $_GET);
375 //check cid for integer
376 $contIDS = explode(',', $cid);
377 foreach ($contIDS as $contID) {
378 CRM_Utils_Type
::escape($contID, 'Integer');
380 $queryString = " cc.id IN ( $cid )";
385 $offset = CRM_Utils_Array
::value('offset', $_GET, 0);
386 $rowCount = Civi
::settings()->get('search_autocomplete_count');
388 $offset = CRM_Utils_Type
::escape($offset, 'Int');
390 // add acl clause here
391 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause('cc');
393 $aclWhere = " AND $aclWhere";
397 SELECT sort_name name, cc.id
398 FROM civicrm_contact cc
400 WHERE cc.is_deceased = 0 AND {$queryString}
402 LIMIT {$offset}, {$rowCount}
405 // send query to hook to be modified if needed
406 CRM_Utils_Hook
::contactListQuery($query,
408 CRM_Utils_Request
::retrieve('context', 'String', CRM_Core_DAO
::$_nullObject),
409 CRM_Utils_Request
::retrieve('cid', 'Positive', CRM_Core_DAO
::$_nullObject)
412 $dao = CRM_Core_DAO
::executeQuery($query);
413 while ($dao->fetch()) {
416 'text' => $dao->name
,
422 SELECT sort_name name, ce.email, cc.id
423 FROM civicrm_email ce INNER JOIN civicrm_contact cc ON cc.id = ce.contact_id
425 WHERE ce.on_hold = 0 AND cc.is_deceased = 0 AND cc.do_not_email = 0 AND {$queryString}
427 LIMIT {$offset}, {$rowCount}
430 // send query to hook to be modified if needed
431 CRM_Utils_Hook
::contactListQuery($query,
433 CRM_Utils_Request
::retrieve('context', 'String', CRM_Core_DAO
::$_nullObject),
434 CRM_Utils_Request
::retrieve('cid', 'Positive', CRM_Core_DAO
::$_nullObject)
437 $dao = CRM_Core_DAO
::executeQuery($query);
439 while ($dao->fetch()) {
442 'text' => '"' . $dao->name
. '" <' . $dao->email
. '>',
443 'id' => (CRM_Utils_Array
::value('id', $_GET)) ?
"{$dao->id}::{$dao->email}" : '"' . $dao->name
. '" <' . $dao->email
. '>',
448 CRM_Utils_JSON
::output($result);
452 CRM_Utils_System
::civiExit();
455 public static function getContactPhone() {
458 //check for mobile type
459 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
460 $mobileType = CRM_Utils_Array
::value('Mobile', $phoneTypes);
462 $name = CRM_Utils_Array
::value('name', $_GET);
464 $name = CRM_Utils_Type
::escape($name, 'String');
465 $queryString = " ( cc.sort_name LIKE '%$name%' OR cp.phone LIKE '%$name%' ) ";
468 $cid = CRM_Utils_Array
::value('cid', $_GET);
470 //check cid for integer
471 $contIDS = explode(',', $cid);
472 foreach ($contIDS as $contID) {
473 CRM_Utils_Type
::escape($contID, 'Integer');
475 $queryString = " cc.id IN ( $cid )";
480 $offset = CRM_Utils_Array
::value('offset', $_GET, 0);
481 $rowCount = CRM_Utils_Array
::value('rowcount', $_GET, 20);
483 $offset = CRM_Utils_Type
::escape($offset, 'Int');
484 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
486 // add acl clause here
487 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause('cc');
489 $aclWhere = " AND $aclWhere";
493 SELECT sort_name name, cp.phone, cc.id
494 FROM civicrm_phone cp INNER JOIN civicrm_contact cc ON cc.id = cp.contact_id
496 WHERE cc.is_deceased = 0 AND cc.do_not_sms = 0 AND cp.phone_type_id = {$mobileType} AND {$queryString}
498 LIMIT {$offset}, {$rowCount}
501 // send query to hook to be modified if needed
502 CRM_Utils_Hook
::contactListQuery($query,
504 CRM_Utils_Request
::retrieve('context', 'String', CRM_Core_DAO
::$_nullObject),
505 CRM_Utils_Request
::retrieve('cid', 'Positive', CRM_Core_DAO
::$_nullObject)
508 $dao = CRM_Core_DAO
::executeQuery($query);
510 while ($dao->fetch()) {
512 'text' => '"' . $dao->name
. '" (' . $dao->phone
. ')',
513 'id' => (CRM_Utils_Array
::value('id', $_GET)) ?
"{$dao->id}::{$dao->phone}" : '"' . $dao->name
. '" <' . $dao->phone
. '>',
519 CRM_Utils_JSON
::output($result);
521 CRM_Utils_System
::civiExit();
525 public static function buildSubTypes() {
526 $parent = CRM_Utils_Request
::retrieve('parentId', 'Positive', CRM_Core_DAO
::$_nullObject);
530 $contactType = 'Individual';
534 $contactType = 'Household';
538 $contactType = 'Organization';
542 $subTypes = CRM_Contact_BAO_ContactType
::subTypePairs($contactType, FALSE, NULL);
544 CRM_Utils_JSON
::output($subTypes);
547 public static function buildDedupeRules() {
548 $parent = CRM_Utils_Request
::retrieve('parentId', 'Positive', CRM_Core_DAO
::$_nullObject);
552 $contactType = 'Individual';
556 $contactType = 'Household';
560 $contactType = 'Organization';
564 $dedupeRules = CRM_Dedupe_BAO_RuleGroup
::getByType($contactType);
566 CRM_Utils_JSON
::output($dedupeRules);
570 * Function used for CiviCRM dashboard operations.
572 public static function dashboard() {
573 $operation = CRM_Utils_Type
::escape($_REQUEST['op'], 'String');
575 switch ($operation) {
576 case 'get_widgets_by_column':
577 // This would normally be coming from either the database (this user's settings) or a default/initial dashboard configuration.
578 // get contact id of logged in user
580 $dashlets = CRM_Core_BAO_Dashboard
::getContactDashlets();
584 $dashletID = CRM_Utils_Type
::escape($_GET['id'], 'Positive');
586 $dashlets = CRM_Core_BAO_Dashboard
::getDashletInfo($dashletID);
590 CRM_Core_BAO_Dashboard
::saveDashletChanges($_REQUEST['columns']);
591 CRM_Utils_System
::civiExit();
592 case 'delete_dashlet':
593 $dashletID = CRM_Utils_Type
::escape($_REQUEST['dashlet_id'], 'Positive');
594 CRM_Core_BAO_Dashboard
::deleteDashlet($dashletID);
595 CRM_Utils_System
::civiExit();
598 CRM_Utils_JSON
::output($dashlets);
602 * Retrieve signature based on email id.
604 public static function getSignature() {
605 $emailID = CRM_Utils_Type
::escape($_REQUEST['emailID'], 'Positive');
606 $query = "SELECT signature_text, signature_html FROM civicrm_email WHERE id = {$emailID}";
607 $dao = CRM_Core_DAO
::executeQuery($query);
609 $signatures = array();
610 while ($dao->fetch()) {
612 'signature_text' => $dao->signature_text
,
613 'signature_html' => $dao->signature_html
,
617 CRM_Utils_JSON
::output($signatures);
623 public static function processDupes() {
624 $oper = CRM_Utils_Type
::escape($_REQUEST['op'], 'String');
625 $cid = CRM_Utils_Type
::escape($_REQUEST['cid'], 'Positive');
626 $oid = CRM_Utils_Type
::escape($_REQUEST['oid'], 'Positive');
628 if (!$oper ||
!$cid ||
!$oid) {
632 $exception = new CRM_Dedupe_DAO_Exception();
633 $exception->contact_id1
= $cid;
634 $exception->contact_id2
= $oid;
635 //make sure contact2 > contact1.
637 $exception->contact_id1
= $oid;
638 $exception->contact_id2
= $cid;
640 $exception->find(TRUE);
642 if ($oper == 'dupe-nondupe') {
643 $status = $exception->save();
645 if ($oper == 'nondupe-dupe') {
646 $status = $exception->delete();
649 CRM_Utils_JSON
::output(array('status' => ($status) ?
$oper : $status));
653 * Retrieve list of duplicate pairs from cache table.
655 public static function getDedupes() {
656 $offset = isset($_REQUEST['start']) ? CRM_Utils_Type
::escape($_REQUEST['start'], 'Integer') : 0;
657 $rowCount = isset($_REQUEST['length']) ? CRM_Utils_Type
::escape($_REQUEST['length'], 'Integer') : 25;
659 $gid = isset($_REQUEST['gid']) ? CRM_Utils_Type
::escape($_REQUEST['gid'], 'Integer') : 0;
660 $rgid = isset($_REQUEST['rgid']) ? CRM_Utils_Type
::escape($_REQUEST['rgid'], 'Integer') : 0;
661 $selected = isset($_REQUEST['selected']) ? CRM_Utils_Type
::escape($_REQUEST['selected'], 'Integer') : 0;
667 $contactType = CRM_Core_DAO
::getFieldValue('CRM_Dedupe_DAO_RuleGroup', $rgid, 'contact_type');
670 $cacheKeyString = "merge {$contactType}_{$rgid}_{$gid}";
671 $searchRows = array();
672 $selectorElements = array('is_selected', 'is_selected_input', 'src_image', 'src', 'src_email', 'src_street', 'src_postcode', 'dst_image', 'dst', 'dst_email', 'dst_street', 'dst_postcode', 'conflicts', 'weight', 'actions');
674 foreach ($_REQUEST['columns'] as $columnInfo) {
675 if (!empty($columnInfo['search']['value'])) {
676 $
{$columnInfo['data']} = CRM_Utils_Type
::escape($columnInfo['search']['value'], 'String');
681 $searchData = CRM_Utils_Array
::value('search', $_REQUEST);
682 $searchData['value'] = CRM_Utils_Type
::escape($searchData['value'], 'String');
684 if ($src ||
!empty($searchData['value'])) {
685 $src = $src ?
$src : $searchData['value'];
686 $where[] = " cc1.display_name LIKE '%{$src}%'";
688 if ($dst ||
!empty($searchData['value'])) {
689 $dst = $dst ?
$dst : $searchData['value'];
690 $where[] = " cc2.display_name LIKE '%{$dst}%'";
692 if ($src_email ||
!empty($searchData['value'])) {
693 $src_email = $src_email ?
$src_email : $searchData['value'];
694 $where[] = " (ce1.is_primary = 1 AND ce1.email LIKE '%{$src_email}%')";
696 if ($dst_email ||
!empty($searchData['value'])) {
697 $dst_email = $dst_email ?
$dst_email : $searchData['value'];
698 $where[] = " (ce2.is_primary = 1 AND ce2.email LIKE '%{$dst_email}%')";
700 if ($src_postcode ||
!empty($searchData['value'])) {
701 $src_postcode = $src_postcode ?
$src_postcode : $searchData['value'];
702 $where[] = " (ca1.is_primary = 1 AND ca1.postal_code LIKE '%{$src_postcode}%')";
704 if ($dst_postcode ||
!empty($searchData['value'])) {
705 $dst_postcode = $dst_postcode ?
$dst_postcode : $searchData['value'];
706 $where[] = " (ca2.is_primary = 1 AND ca2.postal_code LIKE '%{$dst_postcode}%')";
708 if ($src_street ||
!empty($searchData['value'])) {
709 $src_street = $src_street ?
$src_street : $searchData['value'];
710 $where[] = " (ca1.is_primary = 1 AND ca1.street_address LIKE '%{$src_street}%')";
712 if ($dst_street ||
!empty($searchData['value'])) {
713 $dst_street = $dst_street ?
$dst_street : $searchData['value'];
714 $where[] = " (ca2.is_primary = 1 AND ca2.street_address LIKE '%{$dst_street}%')";
716 if (!empty($searchData['value'])) {
717 $whereClause = ' ( ' . implode(' OR ', $where) . ' ) ';
720 if (!empty($where)) {
721 $whereClause = implode(' AND ', $where);
724 $whereClause .= $whereClause ?
' AND de.id IS NULL' : ' de.id IS NULL';
727 $whereClause .= ' AND pn.is_selected = 1';
729 $join .= CRM_Dedupe_Merger
::getJoinOnDedupeTable();
732 'cc1.contact_type' => 'src_contact_type',
733 'cc1.display_name' => 'src_display_name',
734 'cc1.contact_sub_type' => 'src_contact_sub_type',
735 'cc2.contact_type' => 'dst_contact_type',
736 'cc2.display_name' => 'dst_display_name',
737 'cc2.contact_sub_type' => 'dst_contact_sub_type',
738 'ce1.email' => 'src_email',
739 'ce2.email' => 'dst_email',
740 'ca1.postal_code' => 'src_postcode',
741 'ca2.postal_code' => 'dst_postcode',
742 'ca1.street_address' => 'src_street',
743 'ca2.street_address' => 'dst_street',
747 $join .= " INNER JOIN civicrm_contact cc1 ON cc1.id = pn.entity_id1";
748 $join .= " INNER JOIN civicrm_contact cc2 ON cc2.id = pn.entity_id2";
749 $join .= " LEFT JOIN civicrm_email ce1 ON (ce1.contact_id = pn.entity_id1 AND ce1.is_primary = 1 )";
750 $join .= " LEFT JOIN civicrm_email ce2 ON (ce2.contact_id = pn.entity_id2 AND ce2.is_primary = 1 )";
751 $join .= " LEFT JOIN civicrm_address ca1 ON (ca1.contact_id = pn.entity_id1 AND ca1.is_primary = 1 )";
752 $join .= " LEFT JOIN civicrm_address ca2 ON (ca2.contact_id = pn.entity_id2 AND ca2.is_primary = 1 )";
754 $iTotal = CRM_Core_BAO_PrevNextCache
::getCount($cacheKeyString, $join, $whereClause);
755 foreach ($_REQUEST['order'] as $orderInfo) {
756 if (!empty($orderInfo['column'])) {
757 $orderColumnNumber = $orderInfo['column'];
758 $dir = $orderInfo['dir'];
761 $columnDetails = CRM_Utils_Array
::value($orderColumnNumber, $_REQUEST['columns']);
762 if (!empty($columnDetails)) {
763 switch ($columnDetails['data']) {
765 $orderByClause = " ORDER BY cc1.display_name {$dir}";
769 $orderByClause = " ORDER BY ce1.email {$dir}";
773 $orderByClause = " ORDER BY ca1.street_address {$dir}";
777 $orderByClause = " ORDER BY ca1.postal_code {$dir}";
781 $orderByClause = " ORDER BY cc2.display_name {$dir}";
785 $orderByClause = " ORDER BY ce2.email {$dir}";
789 $orderByClause = " ORDER BY ca2.street_address {$dir}";
793 $orderByClause = " ORDER BY ca2.postal_code {$dir}";
801 $dupePairs = CRM_Core_BAO_PrevNextCache
::retrieve($cacheKeyString, $join, $whereClause, $offset, $rowCount, $select, $orderByClause);
802 $iFilteredTotal = CRM_Core_DAO
::singleValueQuery("SELECT FOUND_ROWS()");
805 foreach ($dupePairs as $key => $pairInfo) {
806 $pair =& $pairInfo['data'];
807 $srcContactSubType = CRM_Utils_Array
::value('src_contact_sub_type', $pairInfo);
808 $dstContactSubType = CRM_Utils_Array
::value('dst_contact_sub_type', $pairInfo);
809 $srcTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage($srcContactSubType ?
810 $srcContactSubType : $pairInfo['src_contact_type'],
812 $pairInfo['entity_id1']
814 $dstTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage($dstContactSubType ?
815 $dstContactSubType : $pairInfo['dst_contact_type'],
817 $pairInfo['entity_id2']
820 $searchRows[$count]['is_selected'] = $pairInfo['is_selected'];
821 $searchRows[$count]['is_selected_input'] = "<input type='checkbox' class='crm-dedupe-select' name='pnid_{$pairInfo['prevnext_id']}' value='{$pairInfo['is_selected']}' onclick='toggleDedupeSelect(this)'>";
822 $searchRows[$count]['src_image'] = $srcTypeImage;
823 $searchRows[$count]['src'] = CRM_Utils_System
::href($pair['srcName'], 'civicrm/contact/view', "reset=1&cid={$pairInfo['entity_id1']}");
824 $searchRows[$count]['src_email'] = CRM_Utils_Array
::value('src_email', $pairInfo);
825 $searchRows[$count]['src_street'] = CRM_Utils_Array
::value('src_street', $pairInfo);
826 $searchRows[$count]['src_postcode'] = CRM_Utils_Array
::value('src_postcode', $pairInfo);
827 $searchRows[$count]['dst_image'] = $dstTypeImage;
828 $searchRows[$count]['dst'] = CRM_Utils_System
::href($pair['dstName'], 'civicrm/contact/view', "reset=1&cid={$pairInfo['entity_id2']}");
829 $searchRows[$count]['dst_email'] = CRM_Utils_Array
::value('dst_email', $pairInfo);
830 $searchRows[$count]['dst_street'] = CRM_Utils_Array
::value('dst_street', $pairInfo);
831 $searchRows[$count]['dst_postcode'] = CRM_Utils_Array
::value('dst_postcode', $pairInfo);
832 $searchRows[$count]['conflicts'] = str_replace("',", "',<br/>", CRM_Utils_Array
::value('conflicts', $pair));
833 $searchRows[$count]['weight'] = CRM_Utils_Array
::value('weight', $pair);
835 if (!empty($pairInfo['data']['canMerge'])) {
836 $mergeParams = "reset=1&cid={$pairInfo['entity_id1']}&oid={$pairInfo['entity_id2']}&action=update&rgid={$rgid}";
838 $mergeParams .= "&gid={$gid}";
841 $searchRows[$count]['actions'] = "<a class='crm-dedupe-flip' href='#' data-pnid={$pairInfo['prevnext_id']}>" . ts('flip') . "</a> | ";
842 $searchRows[$count]['actions'] .= CRM_Utils_System
::href(ts('merge'), 'civicrm/contact/merge', $mergeParams);
843 $searchRows[$count]['actions'] .= " | <a id='notDuplicate' href='#' onClick=\"processDupes( {$pairInfo['entity_id1']}, {$pairInfo['entity_id2']}, 'dupe-nondupe', 'dupe-listing'); return false;\">" . ts('not a duplicate') . "</a>";
846 $searchRows[$count]['actions'] = '<em>' . ts('Insufficient access rights - cannot merge') . '</em>';
852 'data' => $searchRows,
853 'recordsTotal' => $iTotal,
854 'recordsFiltered' => $iFilteredTotal,
856 CRM_Utils_JSON
::output($dupePairs);
860 * Retrieve a PDF Page Format for the PDF Letter form.
862 public function pdfFormat() {
863 $formatId = CRM_Utils_Type
::escape($_REQUEST['formatId'], 'Integer');
865 $pdfFormat = CRM_Core_BAO_PdfFormat
::getById($formatId);
867 CRM_Utils_JSON
::output($pdfFormat);
871 * Retrieve Paper Size dimensions.
873 public static function paperSize() {
874 $paperSizeName = CRM_Utils_Type
::escape($_REQUEST['paperSizeName'], 'String');
876 $paperSize = CRM_Core_BAO_PaperSize
::getByName($paperSizeName);
878 CRM_Utils_JSON
::output($paperSize);
882 * Swap contacts in a dupe pair i.e main with duplicate contact.
884 * @param int $prevNextId
886 public static function flipDupePairs($prevNextId = NULL) {
888 $prevNextId = $_REQUEST['pnid'];
891 UPDATE civicrm_prevnext_cache cpc
892 INNER JOIN civicrm_prevnext_cache old on cpc.id = old.id
893 SET cpc.entity_id1 = cpc.entity_id2, cpc.entity_id2 = old.entity_id1 ";
894 if (is_array($prevNextId) && !CRM_Utils_Array
::crmIsEmptyArray($prevNextId)) {
895 CRM_Utils_Type
::escapeAll($prevNextId, 'Positive');
896 $prevNextId = implode(', ', $prevNextId);
897 $query .= "WHERE cpc.id IN ({$prevNextId}) AND cpc.is_selected = 1";
900 $prevNextId = CRM_Utils_Type
::escape($prevNextId, 'Positive');
901 $query .= "WHERE cpc.id = $prevNextId";
903 CRM_Core_DAO
::executeQuery($query);
904 CRM_Utils_JSON
::output();
908 * Used to store selected contacts across multiple pages in advanced search.
910 public static function selectUnselectContacts() {
911 $name = CRM_Utils_Array
::value('name', $_REQUEST);
912 $cacheKey = CRM_Utils_Array
::value('qfKey', $_REQUEST);
913 $state = CRM_Utils_Array
::value('state', $_REQUEST, 'checked');
914 $variableType = CRM_Utils_Array
::value('variableType', $_REQUEST, 'single');
916 $actionToPerform = CRM_Utils_Array
::value('action', $_REQUEST, 'select');
918 if ($variableType == 'multiple') {
919 // action post value only works with multiple type variable
921 //multiple names like mark_x_1-mark_x_2 where 1,2 are cids
922 $elements = explode('-', $name);
923 foreach ($elements as $key => $element) {
924 $elements[$key] = self
::_convertToId($element);
926 CRM_Core_BAO_PrevNextCache
::markSelection($cacheKey, $actionToPerform, $elements);
929 CRM_Core_BAO_PrevNextCache
::markSelection($cacheKey, $actionToPerform);
932 elseif ($variableType == 'single') {
933 $cId = self
::_convertToId($name);
934 $action = ($state == 'checked') ?
'select' : 'unselect';
935 CRM_Core_BAO_PrevNextCache
::markSelection($cacheKey, $action, $cId);
937 $contactIds = CRM_Core_BAO_PrevNextCache
::getSelection($cacheKey);
938 $countSelectionCids = count($contactIds[$cacheKey]);
940 $arrRet = array('getCount' => $countSelectionCids);
941 CRM_Utils_JSON
::output($arrRet);
945 * @param string $name
949 public static function _convertToId($name) {
950 if (substr($name, 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
951 $cId = substr($name, CRM_Core_Form
::CB_PREFIX_LEN
);
956 public static function getAddressDisplay() {
957 $contactId = CRM_Utils_Request
::retrieve('contact_id', 'Positive', CRM_Core_DAO
::$_nullObject);
959 $addressVal["error_message"] = "no contact id found";
962 $entityBlock = array(
963 'contact_id' => $contactId,
964 'entity_id' => $contactId,
966 $addressVal = CRM_Core_BAO_Address
::getValues($entityBlock);
969 CRM_Utils_JSON
::output($addressVal);
973 * Mark dupe pairs as selected from un-selected state or vice-versa, in dupe cache table.
975 public static function toggleDedupeSelect() {
976 $rgid = CRM_Utils_Type
::escape($_REQUEST['rgid'], 'Integer');
977 $gid = CRM_Utils_Type
::escape($_REQUEST['gid'], 'Integer');
978 $pnid = $_REQUEST['pnid'];
979 $isSelected = CRM_Utils_Type
::escape($_REQUEST['is_selected'], 'Boolean');
981 $cacheKeyString = CRM_Dedupe_Merger
::getMergeCacheKeyString($rgid, $gid);
984 1 => array($isSelected, 'Boolean'),
985 3 => array("$cacheKeyString%", 'String'), // using % to address rows with conflicts as well
988 //check pnid is_array or integer
990 if (is_array($pnid) && !CRM_Utils_Array
::crmIsEmptyArray($pnid)) {
991 CRM_Utils_Type
::escapeAll($pnid, 'Positive');
992 $pnid = implode(', ', $pnid);
993 $whereClause = " id IN ( {$pnid} ) ";
996 $pnid = CRM_Utils_Type
::escape($pnid, 'Integer');
997 $whereClause = " id = %2";
998 $params[2] = array($pnid, 'Integer');
1001 $sql = "UPDATE civicrm_prevnext_cache SET is_selected = %1 WHERE {$whereClause} AND cacheKey LIKE %3";
1002 CRM_Core_DAO
::executeQuery($sql, $params);
1004 CRM_Utils_System
::civiExit();
1008 * Retrieve contact relationships.
1010 public static function getContactRelationships() {
1011 $contactID = CRM_Utils_Type
::escape($_GET['cid'], 'Integer');
1012 $context = CRM_Utils_Type
::escape($_GET['context'], 'String');
1013 $relationship_type_id = CRM_Utils_Type
::escape(CRM_Utils_Array
::value('relationship_type_id', $_GET), 'Integer', FALSE);
1015 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactID)) {
1016 return CRM_Utils_System
::permissionDenied();
1019 $params = CRM_Core_Page_AJAX
::defaultSortAndPagerParams();
1021 $params['contact_id'] = $contactID;
1022 $params['context'] = $context;
1023 if ($relationship_type_id) {
1024 $params['relationship_type_id'] = $relationship_type_id;
1027 // get the contact relationships
1028 $relationships = CRM_Contact_BAO_Relationship
::getContactRelationshipSelector($params);
1030 CRM_Utils_JSON
::output($relationships);