3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * This class generates form components for search-result tasks.
21 class CRM_Contact_Form_Task
extends CRM_Core_Form_Task
{
24 * The task being performed
31 * The array that holds all the contact ids
38 * The array that holds all the contact types
42 public $_contactTypes;
45 * The additional clause that we restrict the search with
49 protected $_componentClause = NULL;
52 * The name of the temp table where we store the contact IDs
56 protected $_componentTable = NULL;
59 * The array that holds all the component ids
63 protected $_componentIds;
66 * This includes the submitted values of the search form
69 static protected $_searchFormValues;
72 * Build all the data structures needed to build the form.
74 public function preProcess() {
75 self
::preProcessCommon($this);
79 * Common pre-processing function.
81 * @param CRM_Core_Form $form
83 * @throws \CRM_Core_Exception
85 public static function preProcessCommon(&$form) {
86 $form->_contactIds
= [];
87 $form->_contactTypes
= [];
89 $useTable = (CRM_Utils_System
::getClassName($form->controller
->getStateMachine()) == 'CRM_Export_StateMachine_Standalone');
91 $isStandAlone = in_array('task', $form->urlPath
) ||
in_array('standalone', $form->urlPath
);
93 list($form->_task
, $title) = CRM_Contact_Task
::getTaskAndTitleByClass(get_class($form));
94 if (!array_key_exists($form->_task
, CRM_Contact_Task
::permissionedTaskTitles(CRM_Core_Permission
::getPermission()))) {
95 CRM_Core_Error
::statusBounce(ts('You do not have permission to access this page.'));
97 $form->_contactIds
= explode(',', CRM_Utils_Request
::retrieve('cids', 'CommaSeparatedIntegers', $form, TRUE));
98 if (empty($form->_contactIds
)) {
99 CRM_Core_Error
::statusBounce(ts('No Contacts Selected'));
101 $form->setTitle($title);
104 // get the submitted values of the search form
105 // we'll need to get fv from either search or adv search in the future
106 $fragment = 'search';
107 if ($form->_action
== CRM_Core_Action
::ADVANCED
) {
108 self
::$_searchFormValues = $form->controller
->exportValues('Advanced');
109 $fragment .= '/advanced';
111 elseif ($form->_action
== CRM_Core_Action
::PROFILE
) {
112 self
::$_searchFormValues = $form->controller
->exportValues('Builder');
113 $fragment .= '/builder';
115 elseif ($form->_action
== CRM_Core_Action
::COPY
) {
116 self
::$_searchFormValues = $form->controller
->exportValues('Custom');
117 $fragment .= '/custom';
119 elseif (!$isStandAlone) {
120 self
::$_searchFormValues = $form->controller
->exportValues('Basic');
123 //set the user context for redirection of task actions
124 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String', $form);
125 $urlParams = 'force=1';
126 if (CRM_Utils_Rule
::qfKey($qfKey)) {
127 $urlParams .= "&qfKey=$qfKey";
130 $cacheKey = "civicrm search {$qfKey}";
132 $url = CRM_Utils_System
::url('civicrm/contact/' . $fragment, $urlParams);
133 $session = CRM_Core_Session
::singleton();
134 $session->replaceUserContext($url);
136 $form->_task
= CRM_Utils_Array
::value('task', self
::$_searchFormValues);
137 $crmContactTaskTasks = CRM_Contact_Task
::taskTitles();
138 $form->assign('taskName', CRM_Utils_Array
::value($form->_task
, $crmContactTaskTasks));
141 $tempTable = CRM_Utils_SQL_TempTable
::build()->setCategory('tskact')->setDurable()->setId($qfKey);
142 $form->_componentTable
= $tempTable->getName();
144 $tempTable->createWithColumns('contact_id int primary key');
147 // all contacts or action = save a search
148 if ((CRM_Utils_Array
::value('radio_ts', self
::$_searchFormValues) == 'ts_all') ||
149 ($form->_task
== CRM_Contact_Task
::SAVE_SEARCH
)
151 // since we don't store all contacts in prevnextcache, when user selects "all" use query to retrieve contacts
152 // rather than prevnext cache table for most of the task actions except export where we rebuild query to fetch
155 $allCids = Civi
::service('prevnext')->getSelection($cacheKey, "getall");
158 $allCids[$cacheKey] = self
::getContactIds($form);
161 $form->_contactIds
= [];
165 foreach ($allCids[$cacheKey] as $cid => $ignore) {
167 $insertString[] = " ( {$cid} ) ";
168 if ($count %
200 == 0) {
169 $string = implode(',', $insertString);
170 $sql = "REPLACE INTO {$form->_componentTable} ( contact_id ) VALUES $string";
171 CRM_Core_DAO
::executeQuery($sql);
175 if (!empty($insertString)) {
176 $string = implode(',', $insertString);
177 $sql = "REPLACE INTO {$form->_componentTable} ( contact_id ) VALUES $string";
178 CRM_Core_DAO
::executeQuery($sql);
181 elseif (empty($form->_contactIds
)) {
182 // filter duplicates here
184 // might be better to do this in the query, but that logic is a bit complex
185 // and it decides when to use distinct based on input criteria, which needs
186 // to be fixed and optimized.
188 foreach ($allCids[$cacheKey] as $cid => $ignore) {
189 $form->_contactIds
[] = $cid;
193 elseif (CRM_Utils_Array
::value('radio_ts', self
::$_searchFormValues) == 'ts_sel') {
194 // selected contacts only
195 // need to perform action on only selected contacts
198 // refire sql in case of custom search
199 if ($form->_action
== CRM_Core_Action
::COPY
) {
200 // selected contacts only
201 // need to perform action on only selected contacts
202 foreach (self
::$_searchFormValues as $name => $value) {
203 if (substr($name, 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
204 $contactID = substr($name, CRM_Core_Form
::CB_PREFIX_LEN
);
206 $insertString[] = " ( {$contactID} ) ";
209 $form->_contactIds
[] = substr($name, CRM_Core_Form
::CB_PREFIX_LEN
);
215 // fetching selected contact ids of passed cache key
216 $selectedCids = Civi
::service('prevnext')->getSelection($cacheKey);
217 foreach ($selectedCids[$cacheKey] as $selectedCid => $ignore) {
219 $insertString[] = " ( {$selectedCid} ) ";
222 $form->_contactIds
[] = $selectedCid;
227 if (!empty($insertString)) {
228 $string = implode(',', $insertString);
229 $sql = "REPLACE INTO {$form->_componentTable} ( contact_id ) VALUES $string";
230 CRM_Core_DAO
::executeQuery($sql);
234 //contact type for pick up profiles as per selected contact types with subtypes
236 if ($selectedTypes = CRM_Utils_Array
::value('contact_type', self
::$_searchFormValues)) {
237 if (!is_array($selectedTypes)) {
238 $selectedTypes = explode(' ', $selectedTypes);
240 foreach ($selectedTypes as $ct => $dontcare) {
241 if (strpos($ct, CRM_Core_DAO
::VALUE_SEPARATOR
) === FALSE) {
242 $form->_contactTypes
[] = $ct;
245 $separator = strpos($ct, CRM_Core_DAO
::VALUE_SEPARATOR
);
246 $form->_contactTypes
[] = substr($ct, $separator +
1);
251 if (CRM_Utils_Array
::value('radio_ts', self
::$_searchFormValues) == 'ts_sel'
252 && ($form->_action
!= CRM_Core_Action
::COPY
)
254 $sel = CRM_Utils_Array
::value('radio_ts', self
::$_searchFormValues);
255 $form->assign('searchtype', $sel);
256 $result = self
::getSelectedContactNames();
257 $form->assign("value", $result);
260 if (!empty($form->_contactIds
)) {
261 $form->_componentClause
= ' contact_a.id IN ( ' . implode(',', $form->_contactIds
) . ' ) ';
262 $form->assign('totalSelectedContacts', count($form->_contactIds
));
264 $form->_componentIds
= $form->_contactIds
;
269 * Get the contact ids for:
270 * - "Select Records: All xx records"
271 * - custom search (FIXME: does this still apply to custom search?).
272 * When we call this function we are not using the prev/next cache
274 * @param $form CRM_Core_Form
276 * @return array $contactIds
278 public static function getContactIds($form) {
279 // need to perform action on all contacts
280 // fire the query again and get the contact id's + display name
282 if ($form->get(CRM_Utils_Sort
::SORT_ID
)) {
283 $sortID = CRM_Utils_Sort
::sortIDValue($form->get(CRM_Utils_Sort
::SORT_ID
),
284 $form->get(CRM_Utils_Sort
::SORT_DIRECTION
)
288 $selectorName = $form->controller
->selectorName();
290 $fv = $form->get('formValues');
291 $customClass = $form->get('customSearchClass');
292 $returnProperties = CRM_Core_BAO_Mapping
::returnProperties(self
::$_searchFormValues);
294 $selector = new $selectorName($customClass, $fv, NULL, $returnProperties);
296 $params = $form->get('queryParams');
299 $sortByCharacter = $form->get('sortByCharacter');
300 if ($sortByCharacter && $sortByCharacter != 1) {
301 $params[] = ['sortByCharacter', '=', $sortByCharacter, 0, 0];
303 $queryOperator = $form->get('queryOperator');
304 if (!$queryOperator) {
305 $queryOperator = 'AND';
307 $dao = $selector->contactIDQuery($params, $sortID,
308 CRM_Utils_Array
::value('display_relationship_type', $fv),
313 while ($dao->fetch()) {
314 $contactIds[$dao->contact_id
] = $dao->contact_id
;
321 * Set default values for the form. Relationship that in edit/view action.
323 * The default values are retrieved from the database.
327 public function setDefaultValues() {
333 * Add the rules for form.
335 public function addRules() {
339 * Build the form object.
341 public function buildQuickForm() {
342 $this->addDefaultButtons(ts('Confirm Action'));
346 * Process the form after the input has been submitted and validated.
348 public function postProcess() {
352 * Simple shell that derived classes can call to add form buttons.
354 * Allows customized title for the main Submit
356 * @param string $title
357 * Title of the main button.
358 * @param string $nextType
359 * Button type for the form after processing.
360 * @param string $backType
361 * @param bool $submitOnce
363 public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
372 'name' => ts('Cancel'),
373 'icon' => 'fa-times',
379 * Replace ids of household members in $this->_contactIds with the id of their household.
383 public function mergeContactIdsByHousehold() {
384 if (empty($this->_contactIds
)) {
388 $contactRelationshipTypes = CRM_Contact_BAO_Relationship
::getContactRelationshipType(
398 // Get Head of Household & Household Member relationships
399 $relationKeyMOH = CRM_Utils_Array
::key('Household Member of', $contactRelationshipTypes);
400 $relationKeyHOH = CRM_Utils_Array
::key('Head of Household for', $contactRelationshipTypes);
401 $householdRelationshipTypes = [
402 $relationKeyMOH => $contactRelationshipTypes[$relationKeyMOH],
403 $relationKeyHOH => $contactRelationshipTypes[$relationKeyHOH],
406 $relID = implode(',', $this->_contactIds
);
408 foreach ($householdRelationshipTypes as $rel => $dnt) {
409 list($id, $direction) = explode('_', $rel, 2);
410 // identify the relationship direction
411 $contactA = 'contact_id_a';
412 $contactB = 'contact_id_b';
413 if ($direction == 'b_a') {
414 $contactA = 'contact_id_b';
415 $contactB = 'contact_id_a';
418 // Find related households.
419 $relationSelect = "SELECT contact_household.id as household_id, {$contactA} as refContact ";
420 $relationFrom = " FROM civicrm_contact contact_household
421 INNER JOIN civicrm_relationship crel ON crel.{$contactB} = contact_household.id AND crel.relationship_type_id = {$id} ";
423 // Check for active relationship status only.
424 $today = date('Ymd');
425 $relationActive = " AND (crel.is_active = 1 AND ( crel.end_date is NULL OR crel.end_date >= {$today} ) )";
426 $relationWhere = " WHERE contact_household.is_deleted = 0 AND crel.{$contactA} IN ( {$relID} ) {$relationActive}";
427 $relationGroupBy = " GROUP BY crel.{$contactA}, contact_household.id";
428 $relationQueryString = "$relationSelect $relationFrom $relationWhere $relationGroupBy";
430 $householdsDAO = CRM_Core_DAO
::executeQuery($relationQueryString);
431 while ($householdsDAO->fetch()) {
432 // Remove contact's id from $this->_contactIds and replace with their household's id.
433 foreach (array_keys($this->_contactIds
, $householdsDAO->refContact
) as $idKey) {
434 unset($this->_contactIds
[$idKey]);
436 if (!in_array($householdsDAO->household_id
, $this->_contactIds
)) {
437 $this->_contactIds
[] = $householdsDAO->household_id
;
442 // If contact list has changed, households will probably be at the end of
443 // the list. Sort it again by sort_name.
444 if (implode(',', $this->_contactIds
) != $relID) {
445 $result = civicrm_api3('Contact', 'get', [
447 'id' => ['IN' => $this->_contactIds
],
450 'sort' => "sort_name",
453 $this->_contactIds
= array_keys($result['values']);
459 * List of contact names.
460 * NOTE: These are raw values from the DB. In current data-model, that means
461 * they are pre-encoded HTML.
463 private static function getSelectedContactNames() {
464 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String');
465 $cacheKey = "civicrm search {$qfKey}";
469 foreach (Civi
::service('prevnext')->getSelection($cacheKey) as $cacheKey => $values) {
470 $cids = array_unique(array_merge($cids, array_keys($values)));
473 $result = CRM_Utils_SQL_Select
::from('civicrm_contact')
474 ->where('id IN (#cids)', ['cids' => $cids])
476 ->fetchMap('id', 'sort_name');
481 * Given this task's list of targets, produce a hidden group.
484 * Array(0 => int $groupID, 1 => int|NULL $ssID).
487 public function createHiddenGroup() {
488 // Did the user select "All" matches or cherry-pick a few records?
489 $searchParams = $this->controller
->exportValues();
490 if ($searchParams['radio_ts'] == 'ts_sel') {
491 // Create a static group.
492 // groups require a unique name
493 $randID = md5(time() . rand(1, 1000));
494 $grpTitle = "Hidden Group {$randID}";
495 $grpID = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $grpTitle, 'id', 'title');
499 'title' => $grpTitle,
502 'group_type' => ['2' => 1],
505 $group = CRM_Contact_BAO_Group
::create($groupParams);
508 CRM_Contact_BAO_GroupContact
::addContactsToGroup($this->_contactIds
, $group->id
);
510 $newGroupTitle = "Hidden Group {$grpID}";
513 'name' => CRM_Utils_String
::titleToVar($newGroupTitle),
514 'title' => $newGroupTitle,
515 'group_type' => ['2' => 1],
517 CRM_Contact_BAO_Group
::create($groupParams);
520 // note at this point its a static group
521 return [$grpID, NULL];
524 // Create a smart group.
525 $ssId = $this->get('ssID');
526 $hiddenSmartParams = [
527 'group_type' => ['2' => 1],
528 // queryParams have been preprocessed esp WRT any entity reference fields - see +
529 // https://github.com/civicrm/civicrm-core/pull/13250
530 // Advanced search sets queryParams, for builder you need formValues.
531 // This is kinda fragile but .... see CRM_Mailing_Form_Task_AdhocMailingTest for test effort.
532 // Moral never touch anything ever again and the house of cards will stand tall, unless there is a breeze
533 'form_values' => $this->get('isSearchBuilder') ?
$this->get('formValues') : $this->get('queryParams'),
534 'saved_search_id' => $ssId,
535 'search_custom_id' => $this->get('customSearchID'),
536 'search_context' => $this->get('context'),
539 list($smartGroupId, $savedSearchId) = CRM_Contact_BAO_Group
::createHiddenSmartGroup($hiddenSmartParams);
540 return [$smartGroupId, $savedSearchId];