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
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 = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'search_autocomplete_count', NULL, 10);
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 = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'search_autocomplete_count', NULL, 10);
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);
222 public static function relationship() {
223 $relType = CRM_Utils_Request
::retrieve('rel_type', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
224 $relContactID = CRM_Utils_Request
::retrieve('rel_contact', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
225 $relationshipID = CRM_Utils_Request
::retrieve('rel_id', 'Positive', CRM_Core_DAO
::$_nullObject); // this used only to determine add or update mode
226 $caseID = CRM_Utils_Request
::retrieve('case_id', 'Positive', CRM_Core_DAO
::$_nullObject, TRUE);
228 // check if there are multiple clients for this case, if so then we need create
229 // relationship and also activities for each contacts
231 // get case client list
232 $clientList = CRM_Case_BAO_Case
::getCaseClients($caseID);
234 $ret = array('is_error' => 0);
236 foreach ($clientList as $sourceContactID) {
237 $relationParams = array(
238 'relationship_type_id' => $relType . '_a_b',
239 'contact_check' => array($relContactID => 1),
241 'case_id' => $caseID,
242 'start_date' => date("Ymd"),
245 $relationIds = array('contact' => $sourceContactID);
247 // check if we are editing/updating existing relationship
248 if ($relationshipID && $relationshipID != 'null') {
249 // here we need to retrieve appropriate relationshipID based on client id and relationship type id
250 $caseRelationships = new CRM_Contact_DAO_Relationship();
251 $caseRelationships->case_id
= $caseID;
252 $caseRelationships->relationship_type_id
= $relType;
253 $caseRelationships->contact_id_a
= $sourceContactID;
254 $caseRelationships->find();
256 while ($caseRelationships->fetch()) {
257 $relationIds['relationship'] = $caseRelationships->id
;
258 $relationIds['contactTarget'] = $relContactID;
260 $caseRelationships->free();
263 // create new or update existing relationship
264 $return = CRM_Contact_BAO_Relationship
::legacyCreateMultiple($relationParams, $relationIds);
266 if (!empty($return[4][0])) {
267 $relationshipID = $return[4][0];
269 //create an activity for case role assignment.CRM-4480
270 CRM_Case_BAO_Case
::createCaseRoleActivity($caseID, $relationshipID, $relContactID);
275 'error_message' => ts('The relationship type definition for the case role is not valid for the client and / or staff contact types. You can review and edit relationship types at <a href="%1">Administer >> Option Lists >> Relationship Types</a>.',
276 array(1 => CRM_Utils_System
::url('civicrm/admin/reltype', 'reset=1'))),
281 CRM_Utils_JSON
::output($ret);
285 * Fetch the custom field help.
287 public static function customField() {
288 $fieldId = CRM_Utils_Type
::escape($_REQUEST['id'], 'Integer');
289 $params = array('id' => $fieldId);
290 $returnProperties = array('help_pre', 'help_post');
293 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $params, $values, $returnProperties);
294 CRM_Utils_JSON
::output($values);
297 public static function groupTree() {
298 CRM_Utils_System
::setHttpHeader('Content-Type', 'application/json');
299 $gids = CRM_Utils_Type
::escape($_GET['gids'], 'String');
300 echo CRM_Contact_BAO_GroupNestingCache
::json($gids);
301 CRM_Utils_System
::civiExit();
305 * Delete custom value.
307 public static function deleteCustomValue() {
308 CRM_Utils_System
::setHttpHeader('Content-Type', 'text/plain');
309 $customValueID = CRM_Utils_Type
::escape($_REQUEST['valueID'], 'Positive');
310 $customGroupID = CRM_Utils_Type
::escape($_REQUEST['groupID'], 'Positive');
311 $contactId = CRM_Utils_Request
::retrieve('contactId', 'Positive', CRM_Core_DAO
::$_nullObject);
312 CRM_Core_BAO_CustomValue
::deleteCustomValue($customValueID, $customGroupID);
314 echo CRM_Contact_BAO_Contact
::getCountComponent('custom_' . $customGroupID, $contactId);
317 // reset the group contact cache for this group
318 CRM_Contact_BAO_GroupContactCache
::remove();
319 CRM_Utils_System
::civiExit();
323 * check the CMS username.
325 static public function checkUserName() {
326 $signer = new CRM_Utils_Signer(CRM_Core_Key
::privateKey(), array('for', 'ts'));
327 $sig = CRM_Utils_Request
::retrieve('sig', 'String', CRM_Core_DAO
::$_nullObject);
328 $for = CRM_Utils_Request
::retrieve('for', 'String', CRM_Core_DAO
::$_nullObject);
330 CRM_Utils_Time
::getTimeRaw() > $_REQUEST['ts'] + self
::CHECK_USERNAME_TTL
331 ||
$for != 'civicrm/ajax/cmsuser'
332 ||
!$signer->validate($sig, $_REQUEST)
334 $user = array('name' => 'error');
335 CRM_Utils_JSON
::output($user);
338 $config = CRM_Core_Config
::singleton();
339 $username = trim(CRM_Utils_Array
::value('cms_name', $_REQUEST));
341 $params = array('name' => $username);
344 $config->userSystem
->checkUserNameEmailExists($params, $errors);
346 if (isset($errors['cms_name']) ||
isset($errors['name'])) {
347 //user name is not available
348 $user = array('name' => 'no');
349 CRM_Utils_JSON
::output($user);
352 //user name is available
353 $user = array('name' => 'yes');
354 CRM_Utils_JSON
::output($user);
357 // Not reachable: JSON::output() above exits.
358 CRM_Utils_System
::civiExit();
362 * Function to get email address of a contact.
364 public static function getContactEmail() {
365 if (!empty($_REQUEST['contact_id'])) {
366 $contactID = CRM_Utils_Type
::escape($_REQUEST['contact_id'], 'Positive');
367 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactID, CRM_Core_Permission
::EDIT
)) {
372 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($contactID);
374 CRM_Utils_System
::setHttpHeader('Content-Type', 'text/plain');
380 $noemail = CRM_Utils_Array
::value('noemail', $_GET);
382 $name = CRM_Utils_Array
::value('name', $_GET);
384 $name = CRM_Utils_Type
::escape($name, 'String');
386 $queryString = " cc.sort_name LIKE '%$name%'";
389 $queryString = " ( cc.sort_name LIKE '%$name%' OR ce.email LIKE '%$name%' ) ";
393 $cid = CRM_Utils_Array
::value('cid', $_GET);
395 //check cid for integer
396 $contIDS = explode(',', $cid);
397 foreach ($contIDS as $contID) {
398 CRM_Utils_Type
::escape($contID, 'Integer');
400 $queryString = " cc.id IN ( $cid )";
405 $offset = CRM_Utils_Array
::value('offset', $_GET, 0);
406 $rowCount = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'search_autocomplete_count', NULL, 10);
408 $offset = CRM_Utils_Type
::escape($offset, 'Int');
410 // add acl clause here
411 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause('cc');
413 $aclWhere = " AND $aclWhere";
417 SELECT sort_name name, cc.id
418 FROM civicrm_contact cc
420 WHERE cc.is_deceased = 0 AND {$queryString}
422 LIMIT {$offset}, {$rowCount}
425 // send query to hook to be modified if needed
426 CRM_Utils_Hook
::contactListQuery($query,
428 CRM_Utils_Request
::retrieve('context', 'String', CRM_Core_DAO
::$_nullObject),
429 CRM_Utils_Request
::retrieve('cid', 'Positive', CRM_Core_DAO
::$_nullObject)
432 $dao = CRM_Core_DAO
::executeQuery($query);
433 while ($dao->fetch()) {
436 'text' => $dao->name
,
442 SELECT sort_name name, ce.email, cc.id
443 FROM civicrm_email ce INNER JOIN civicrm_contact cc ON cc.id = ce.contact_id
445 WHERE ce.on_hold = 0 AND cc.is_deceased = 0 AND cc.do_not_email = 0 AND {$queryString}
447 LIMIT {$offset}, {$rowCount}
450 // send query to hook to be modified if needed
451 CRM_Utils_Hook
::contactListQuery($query,
453 CRM_Utils_Request
::retrieve('context', 'String', CRM_Core_DAO
::$_nullObject),
454 CRM_Utils_Request
::retrieve('cid', 'Positive', CRM_Core_DAO
::$_nullObject)
457 $dao = CRM_Core_DAO
::executeQuery($query);
459 while ($dao->fetch()) {
462 'text' => '"' . $dao->name
. '" <' . $dao->email
. '>',
463 'id' => (CRM_Utils_Array
::value('id', $_GET)) ?
"{$dao->id}::{$dao->email}" : '"' . $dao->name
. '" <' . $dao->email
. '>',
468 CRM_Utils_JSON
::output($result);
472 CRM_Utils_System
::civiExit();
475 public static function getContactPhone() {
478 //check for mobile type
479 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
480 $mobileType = CRM_Utils_Array
::value('Mobile', $phoneTypes);
482 $name = CRM_Utils_Array
::value('name', $_GET);
484 $name = CRM_Utils_Type
::escape($name, 'String');
485 $queryString = " ( cc.sort_name LIKE '%$name%' OR cp.phone LIKE '%$name%' ) ";
488 $cid = CRM_Utils_Array
::value('cid', $_GET);
490 //check cid for integer
491 $contIDS = explode(',', $cid);
492 foreach ($contIDS as $contID) {
493 CRM_Utils_Type
::escape($contID, 'Integer');
495 $queryString = " cc.id IN ( $cid )";
500 $offset = CRM_Utils_Array
::value('offset', $_GET, 0);
501 $rowCount = CRM_Utils_Array
::value('rowcount', $_GET, 20);
503 $offset = CRM_Utils_Type
::escape($offset, 'Int');
504 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
506 // add acl clause here
507 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause('cc');
509 $aclWhere = " AND $aclWhere";
513 SELECT sort_name name, cp.phone, cc.id
514 FROM civicrm_phone cp INNER JOIN civicrm_contact cc ON cc.id = cp.contact_id
516 WHERE cc.is_deceased = 0 AND cc.do_not_sms = 0 AND cp.phone_type_id = {$mobileType} AND {$queryString}
518 LIMIT {$offset}, {$rowCount}
521 // send query to hook to be modified if needed
522 CRM_Utils_Hook
::contactListQuery($query,
524 CRM_Utils_Request
::retrieve('context', 'String', CRM_Core_DAO
::$_nullObject),
525 CRM_Utils_Request
::retrieve('cid', 'Positive', CRM_Core_DAO
::$_nullObject)
528 $dao = CRM_Core_DAO
::executeQuery($query);
530 while ($dao->fetch()) {
532 'text' => '"' . $dao->name
. '" (' . $dao->phone
. ')',
533 'id' => (CRM_Utils_Array
::value('id', $_GET)) ?
"{$dao->id}::{$dao->phone}" : '"' . $dao->name
. '" <' . $dao->phone
. '>',
539 CRM_Utils_JSON
::output($result);
541 CRM_Utils_System
::civiExit();
545 public static function buildSubTypes() {
546 $parent = CRM_Utils_Request
::retrieve('parentId', 'Positive', CRM_Core_DAO
::$_nullObject);
550 $contactType = 'Individual';
554 $contactType = 'Household';
558 $contactType = 'Organization';
562 $subTypes = CRM_Contact_BAO_ContactType
::subTypePairs($contactType, FALSE, NULL);
564 CRM_Utils_JSON
::output($subTypes);
567 public static function buildDedupeRules() {
568 $parent = CRM_Utils_Request
::retrieve('parentId', 'Positive', CRM_Core_DAO
::$_nullObject);
572 $contactType = 'Individual';
576 $contactType = 'Household';
580 $contactType = 'Organization';
584 $dedupeRules = CRM_Dedupe_BAO_RuleGroup
::getByType($contactType);
586 CRM_Utils_JSON
::output($dedupeRules);
590 * Function used for CiviCRM dashboard operations.
592 public static function dashboard() {
593 $operation = CRM_Utils_Type
::escape($_REQUEST['op'], 'String');
595 switch ($operation) {
596 case 'get_widgets_by_column':
597 // This would normally be coming from either the database (this user's settings) or a default/initial dashboard configuration.
598 // get contact id of logged in user
600 $dashlets = CRM_Core_BAO_Dashboard
::getContactDashlets();
604 $dashletID = CRM_Utils_Type
::escape($_GET['id'], 'Positive');
606 $dashlets = CRM_Core_BAO_Dashboard
::getDashletInfo($dashletID);
610 CRM_Core_BAO_Dashboard
::saveDashletChanges($_REQUEST['columns']);
611 CRM_Utils_System
::civiExit();
612 case 'delete_dashlet':
613 $dashletID = CRM_Utils_Type
::escape($_REQUEST['dashlet_id'], 'Positive');
614 CRM_Core_BAO_Dashboard
::deleteDashlet($dashletID);
615 CRM_Utils_System
::civiExit();
618 CRM_Utils_JSON
::output($dashlets);
622 * Retrieve signature based on email id.
624 public static function getSignature() {
625 $emailID = CRM_Utils_Type
::escape($_REQUEST['emailID'], 'Positive');
626 $query = "SELECT signature_text, signature_html FROM civicrm_email WHERE id = {$emailID}";
627 $dao = CRM_Core_DAO
::executeQuery($query);
629 $signatures = array();
630 while ($dao->fetch()) {
632 'signature_text' => $dao->signature_text
,
633 'signature_html' => $dao->signature_html
,
637 CRM_Utils_JSON
::output($signatures);
643 public static function processDupes() {
644 $oper = CRM_Utils_Type
::escape($_REQUEST['op'], 'String');
645 $cid = CRM_Utils_Type
::escape($_REQUEST['cid'], 'Positive');
646 $oid = CRM_Utils_Type
::escape($_REQUEST['oid'], 'Positive');
648 if (!$oper ||
!$cid ||
!$oid) {
652 $exception = new CRM_Dedupe_DAO_Exception();
653 $exception->contact_id1
= $cid;
654 $exception->contact_id2
= $oid;
655 //make sure contact2 > contact1.
657 $exception->contact_id1
= $oid;
658 $exception->contact_id2
= $cid;
660 $exception->find(TRUE);
662 if ($oper == 'dupe-nondupe') {
663 $status = $exception->save();
665 if ($oper == 'nondupe-dupe') {
666 $status = $exception->delete();
669 CRM_Utils_JSON
::output(array('status' => ($status) ?
$oper : $status));
673 * Retrieve list of duplicate pairs from cache table.
675 public static function getDedupes() {
676 $offset = isset($_REQUEST['start']) ? CRM_Utils_Type
::escape($_REQUEST['start'], 'Integer') : 0;
677 $rowCount = isset($_REQUEST['length']) ? CRM_Utils_Type
::escape($_REQUEST['length'], 'Integer') : 25;
679 $gid = isset($_REQUEST['gid']) ? CRM_Utils_Type
::escape($_REQUEST['gid'], 'Integer') : 0;
680 $rgid = isset($_REQUEST['rgid']) ? CRM_Utils_Type
::escape($_REQUEST['rgid'], 'Integer') : 0;
681 $selected = isset($_REQUEST['selected']) ? CRM_Utils_Type
::escape($_REQUEST['selected'], 'Integer') : 0;
687 $contactType = CRM_Core_DAO
::getFieldValue('CRM_Dedupe_DAO_RuleGroup', $rgid, 'contact_type');
690 $cacheKeyString = "merge {$contactType}_{$rgid}_{$gid}";
691 $searchRows = array();
692 $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');
694 foreach ($_REQUEST['columns'] as $columnInfo) {
695 if (!empty($columnInfo['search']['value'])) {
696 $
{$columnInfo['data']} = CRM_Utils_Type
::escape($columnInfo['search']['value'], 'String');
701 $searchData = CRM_Utils_Array
::value('search', $_REQUEST);
702 $searchData['value'] = CRM_Utils_Type
::escape($searchData['value'], 'String');
704 if ($src ||
!empty($searchData['value'])) {
705 $src = $src ?
$src : $searchData['value'];
706 $where[] = " cc1.display_name LIKE '%{$src}%'";
708 if ($dst ||
!empty($searchData['value'])) {
709 $dst = $dst ?
$dst : $searchData['value'];
710 $where[] = " cc2.display_name LIKE '%{$dst}%'";
712 if ($src_email ||
!empty($searchData['value'])) {
713 $src_email = $src_email ?
$src_email : $searchData['value'];
714 $where[] = " (ce1.is_primary = 1 AND ce1.email LIKE '%{$src_email}%')";
716 if ($dst_email ||
!empty($searchData['value'])) {
717 $dst_email = $dst_email ?
$dst_email : $searchData['value'];
718 $where[] = " (ce2.is_primary = 1 AND ce2.email LIKE '%{$dst_email}%')";
720 if ($src_postcode ||
!empty($searchData['value'])) {
721 $src_postcode = $src_postcode ?
$src_postcode : $searchData['value'];
722 $where[] = " (ca1.is_primary = 1 AND ca1.postal_code LIKE '%{$src_postcode}%')";
724 if ($dst_postcode ||
!empty($searchData['value'])) {
725 $dst_postcode = $dst_postcode ?
$dst_postcode : $searchData['value'];
726 $where[] = " (ca2.is_primary = 1 AND ca2.postal_code LIKE '%{$dst_postcode}%')";
728 if ($src_street ||
!empty($searchData['value'])) {
729 $src_street = $src_street ?
$src_street : $searchData['value'];
730 $where[] = " (ca1.is_primary = 1 AND ca1.street_address LIKE '%{$src_street}%')";
732 if ($dst_street ||
!empty($searchData['value'])) {
733 $dst_street = $dst_street ?
$dst_street : $searchData['value'];
734 $where[] = " (ca2.is_primary = 1 AND ca2.street_address LIKE '%{$dst_street}%')";
736 if (!empty($searchData['value'])) {
737 $whereClause = ' ( ' . implode(' OR ', $where) . ' ) ';
740 if (!empty($where)) {
741 $whereClause = implode(' AND ', $where);
744 $whereClause .= $whereClause ?
' AND de.id IS NULL' : ' de.id IS NULL';
747 $whereClause .= ' AND pn.is_selected = 1';
749 $join .= " LEFT JOIN civicrm_dedupe_exception de ON ( pn.entity_id1 = de.contact_id1 AND pn.entity_id2 = de.contact_id2 )";
752 'cc1.contact_type' => 'src_contact_type',
753 'cc1.display_name' => 'src_display_name',
754 'cc1.contact_sub_type' => 'src_contact_sub_type',
755 'cc2.contact_type' => 'dst_contact_type',
756 'cc2.display_name' => 'dst_display_name',
757 'cc2.contact_sub_type' => 'dst_contact_sub_type',
758 'ce1.email' => 'src_email',
759 'ce2.email' => 'dst_email',
760 'ca1.postal_code' => 'src_postcode',
761 'ca2.postal_code' => 'dst_postcode',
762 'ca1.street_address' => 'src_street',
763 'ca2.street_address' => 'dst_street',
767 $join .= " INNER JOIN civicrm_contact cc1 ON cc1.id = pn.entity_id1";
768 $join .= " INNER JOIN civicrm_contact cc2 ON cc2.id = pn.entity_id2";
769 $join .= " LEFT JOIN civicrm_email ce1 ON (ce1.contact_id = pn.entity_id1 AND ce1.is_primary = 1 )";
770 $join .= " LEFT JOIN civicrm_email ce2 ON (ce2.contact_id = pn.entity_id2 AND ce2.is_primary = 1 )";
771 $join .= " LEFT JOIN civicrm_address ca1 ON (ca1.contact_id = pn.entity_id1 AND ca1.is_primary = 1 )";
772 $join .= " LEFT JOIN civicrm_address ca2 ON (ca2.contact_id = pn.entity_id2 AND ca2.is_primary = 1 )";
774 $iTotal = CRM_Core_BAO_PrevNextCache
::getCount($cacheKeyString, $join, $whereClause);
775 foreach ($_REQUEST['order'] as $orderInfo) {
776 if (!empty($orderInfo['column'])) {
777 $orderColumnNumber = $orderInfo['column'];
778 $dir = $orderInfo['dir'];
781 $columnDetails = CRM_Utils_Array
::value($orderColumnNumber, $_REQUEST['columns']);
782 if (!empty($columnDetails)) {
783 switch ($columnDetails['data']) {
785 $whereClause .= " ORDER BY cc1.display_name {$dir}";
789 $whereClause .= " ORDER BY ce1.email {$dir}";
793 $whereClause .= " ORDER BY ca1.street_address {$dir}";
797 $whereClause .= " ORDER BY ca1.postal_code {$dir}";
801 $whereClause .= " ORDER BY cc2.display_name {$dir}";
805 $whereClause .= " ORDER BY ce2.email {$dir}";
809 $whereClause .= " ORDER BY ca2.street_address {$dir}";
813 $whereClause .= " ORDER BY ca2.postal_code {$dir}";
821 $dupePairs = CRM_Core_BAO_PrevNextCache
::retrieve($cacheKeyString, $join, $whereClause, $offset, $rowCount, $select);
822 $iFilteredTotal = CRM_Core_DAO
::singleValueQuery("SELECT FOUND_ROWS()");
825 foreach ($dupePairs as $key => $pairInfo) {
826 $pair =& $pairInfo['data'];
827 $srcContactSubType = CRM_Utils_Array
::value('src_contact_sub_type', $pairInfo);
828 $dstContactSubType = CRM_Utils_Array
::value('dst_contact_sub_type', $pairInfo);
829 $srcTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage($srcContactSubType ?
830 $srcContactSubType : $pairInfo['src_contact_type'],
832 $pairInfo['entity_id1']
834 $dstTypeImage = CRM_Contact_BAO_Contact_Utils
::getImage($dstContactSubType ?
835 $dstContactSubType : $pairInfo['dst_contact_type'],
837 $pairInfo['entity_id2']
840 $searchRows[$count]['is_selected'] = $pairInfo['is_selected'];
841 $searchRows[$count]['is_selected_input'] = "<input type='checkbox' class='crm-dedupe-select' name='pnid_{$pairInfo['prevnext_id']}' value='{$pairInfo['is_selected']}' onclick='toggleDedupeSelect(this)'>";
842 $searchRows[$count]['src_image'] = $srcTypeImage;
843 $searchRows[$count]['src'] = CRM_Utils_System
::href($pair['srcName'], 'civicrm/contact/view', "reset=1&cid={$pairInfo['entity_id1']}");
844 $searchRows[$count]['src_email'] = CRM_Utils_Array
::value('src_email', $pairInfo);
845 $searchRows[$count]['src_street'] = CRM_Utils_Array
::value('src_street', $pairInfo);
846 $searchRows[$count]['src_postcode'] = CRM_Utils_Array
::value('src_postcode', $pairInfo);
847 $searchRows[$count]['dst_image'] = $dstTypeImage;
848 $searchRows[$count]['dst'] = CRM_Utils_System
::href($pair['dstName'], 'civicrm/contact/view', "reset=1&cid={$pairInfo['entity_id2']}");
849 $searchRows[$count]['dst_email'] = CRM_Utils_Array
::value('dst_email', $pairInfo);
850 $searchRows[$count]['dst_street'] = CRM_Utils_Array
::value('dst_street', $pairInfo);
851 $searchRows[$count]['dst_postcode'] = CRM_Utils_Array
::value('dst_postcode', $pairInfo);
852 $searchRows[$count]['conflicts'] = str_replace("',", "',<br/>", CRM_Utils_Array
::value('conflicts', $pair));
853 $searchRows[$count]['weight'] = CRM_Utils_Array
::value('weight', $pair);
855 if (!empty($pairInfo['data']['canMerge'])) {
856 $mergeParams = "reset=1&cid={$pairInfo['entity_id1']}&oid={$pairInfo['entity_id2']}&action=update&rgid={$rgid}";
858 $mergeParams .= "&gid={$gid}";
861 $searchRows[$count]['actions'] = "<a class='crm-dedupe-flip' href='#' data-pnid={$pairInfo['prevnext_id']}>" . ts('flip') . "</a> | ";
862 $searchRows[$count]['actions'] .= CRM_Utils_System
::href(ts('merge'), 'civicrm/contact/merge', $mergeParams);
863 $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>";
866 $searchRows[$count]['actions'] = '<em>' . ts('Insufficient access rights - cannot merge') . '</em>';
872 'data' => $searchRows,
873 'recordsTotal' => $iTotal,
874 'recordsFiltered' => $iFilteredTotal,
876 CRM_Utils_JSON
::output($dupePairs);
880 * Retrieve a PDF Page Format for the PDF Letter form.
882 public function pdfFormat() {
883 $formatId = CRM_Utils_Type
::escape($_REQUEST['formatId'], 'Integer');
885 $pdfFormat = CRM_Core_BAO_PdfFormat
::getById($formatId);
887 CRM_Utils_JSON
::output($pdfFormat);
891 * Retrieve Paper Size dimensions.
893 public static function paperSize() {
894 $paperSizeName = CRM_Utils_Type
::escape($_REQUEST['paperSizeName'], 'String');
896 $paperSize = CRM_Core_BAO_PaperSize
::getByName($paperSizeName);
898 CRM_Utils_JSON
::output($paperSize);
902 * Swap contacts in a dupe pair i.e main with duplicate contact.
904 public static function flipDupePairs($prevNextId = NULL) {
906 $prevNextId = $_REQUEST['pnid'];
909 UPDATE civicrm_prevnext_cache cpc
910 INNER JOIN civicrm_prevnext_cache old on cpc.id = old.id
911 SET cpc.entity_id1 = cpc.entity_id2, cpc.entity_id2 = old.entity_id1 ";
912 if (is_array($prevNextId) && !CRM_Utils_Array
::crmIsEmptyArray($prevNextId)) {
913 $prevNextId = implode(', ', $prevNextId);
914 $prevNextId = CRM_Utils_Type
::escape($prevNextId, 'String');
915 $query .= "WHERE cpc.id IN ({$prevNextId}) AND cpc.is_selected = 1";
918 $prevNextId = CRM_Utils_Type
::escape($prevNextId, 'Positive');
919 $query .= "WHERE cpc.id = $prevNextId";
921 CRM_Core_DAO
::executeQuery($query);
922 CRM_Utils_JSON
::output();
926 * Used to store selected contacts across multiple pages in advanced search.
928 public static function selectUnselectContacts() {
929 $name = CRM_Utils_Array
::value('name', $_REQUEST);
930 $cacheKey = CRM_Utils_Array
::value('qfKey', $_REQUEST);
931 $state = CRM_Utils_Array
::value('state', $_REQUEST, 'checked');
932 $variableType = CRM_Utils_Array
::value('variableType', $_REQUEST, 'single');
934 $actionToPerform = CRM_Utils_Array
::value('action', $_REQUEST, 'select');
936 if ($variableType == 'multiple') {
937 // action post value only works with multiple type variable
939 //multiple names like mark_x_1-mark_x_2 where 1,2 are cids
940 $elements = explode('-', $name);
941 foreach ($elements as $key => $element) {
942 $elements[$key] = self
::_convertToId($element);
944 CRM_Core_BAO_PrevNextCache
::markSelection($cacheKey, $actionToPerform, $elements);
947 CRM_Core_BAO_PrevNextCache
::markSelection($cacheKey, $actionToPerform);
950 elseif ($variableType == 'single') {
951 $cId = self
::_convertToId($name);
952 $action = ($state == 'checked') ?
'select' : 'unselect';
953 CRM_Core_BAO_PrevNextCache
::markSelection($cacheKey, $action, $cId);
955 $contactIds = CRM_Core_BAO_PrevNextCache
::getSelection($cacheKey);
956 $countSelectionCids = count($contactIds[$cacheKey]);
958 $arrRet = array('getCount' => $countSelectionCids);
959 CRM_Utils_JSON
::output($arrRet);
963 * @param string $name
967 public static function _convertToId($name) {
968 if (substr($name, 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
969 $cId = substr($name, CRM_Core_Form
::CB_PREFIX_LEN
);
974 public static function getAddressDisplay() {
975 $contactId = CRM_Utils_Request
::retrieve('contact_id', 'Positive', CRM_Core_DAO
::$_nullObject);
977 $addressVal["error_message"] = "no contact id found";
980 $entityBlock = array(
981 'contact_id' => $contactId,
982 'entity_id' => $contactId,
984 $addressVal = CRM_Core_BAO_Address
::getValues($entityBlock);
987 CRM_Utils_JSON
::output($addressVal);
991 * Mark dupe pairs as selected from un-selected state or vice-versa, in dupe cache table.
993 public static function toggleDedupeSelect() {
994 $rgid = CRM_Utils_Type
::escape($_REQUEST['rgid'], 'Integer');
995 $gid = CRM_Utils_Type
::escape($_REQUEST['gid'], 'Integer');
996 $pnid = $_REQUEST['pnid'];
997 $isSelected = CRM_Utils_Type
::escape($_REQUEST['is_selected'], 'Boolean');
999 $contactType = CRM_Core_DAO
::getFieldValue('CRM_Dedupe_DAO_RuleGroup', $rgid, 'contact_type');
1000 $cacheKeyString = "merge $contactType";
1001 $cacheKeyString .= $rgid ?
"_{$rgid}" : '_0';
1002 $cacheKeyString .= $gid ?
"_{$gid}" : '_0';
1005 1 => array($isSelected, 'Boolean'),
1006 3 => array("$cacheKeyString%", 'String'), // using % to address rows with conflicts as well
1009 //check pnid is_array or integer
1010 $whereClause = NULL;
1011 if (is_array($pnid) && !CRM_Utils_Array
::crmIsEmptyArray($pnid)) {
1012 $pnid = implode(', ', $pnid);
1013 $pnid = CRM_Utils_Type
::escape($pnid, 'String');
1014 $whereClause = " id IN ( {$pnid} ) ";
1017 $pnid = CRM_Utils_Type
::escape($pnid, 'Integer');
1018 $whereClause = " id = %2";
1019 $params[2] = array($pnid, 'Integer');
1022 $sql = "UPDATE civicrm_prevnext_cache SET is_selected = %1 WHERE {$whereClause} AND cacheKey LIKE %3";
1023 CRM_Core_DAO
::executeQuery($sql, $params);
1025 CRM_Utils_System
::civiExit();
1029 * Retrieve contact relationships.
1031 public static function getContactRelationships() {
1032 $contactID = CRM_Utils_Type
::escape($_GET['cid'], 'Integer');
1033 $context = CRM_Utils_Type
::escape($_GET['context'], 'String');
1034 $relationship_type_id = CRM_Utils_Type
::escape(CRM_Utils_Array
::value('relationship_type_id', $_GET), 'Integer', FALSE);
1036 if (!CRM_Contact_BAO_Contact_Permission
::allow($contactID)) {
1037 return CRM_Utils_System
::permissionDenied();
1040 $sortMapper = array();
1041 foreach ($_GET['columns'] as $key => $value) {
1042 $sortMapper[$key] = $value['data'];
1045 $offset = isset($_GET['start']) ? CRM_Utils_Type
::escape($_GET['start'], 'Integer') : 0;
1046 $rowCount = isset($_GET['length']) ? CRM_Utils_Type
::escape($_GET['length'], 'Integer') : 25;
1047 $sort = isset($_GET['order'][0]['column']) ? CRM_Utils_Array
::value(CRM_Utils_Type
::escape($_GET['order'][0]['column'], 'Integer'), $sortMapper) : NULL;
1048 $sortOrder = isset($_GET['order'][0]['dir']) ? CRM_Utils_Type
::escape($_GET['order'][0]['dir'], 'String') : 'asc';
1051 if ($sort && $sortOrder) {
1052 $params['sortBy'] = $sort . ' ' . $sortOrder;
1055 $params['page'] = ($offset / $rowCount) +
1;
1056 $params['rp'] = $rowCount;
1058 $params['contact_id'] = $contactID;
1059 $params['context'] = $context;
1060 if ($relationship_type_id) {
1061 $params['relationship_type_id'] = $relationship_type_id;
1064 // get the contact relationships
1065 $relationships = CRM_Contact_BAO_Relationship
::getContactRelationshipSelector($params);
1067 CRM_Utils_JSON
::output($relationships);