Merge pull request #5536 from totten/4.5-httpclient
[civicrm-core.git] / CRM / Campaign / Form / Task / Interview.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
13 | |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
18 | |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2015
32 * $Id$
33 *
34 */
35
36 /**
37 * This class provides the functionality to record voter's interview.
38 */
39 class CRM_Campaign_Form_Task_Interview extends CRM_Campaign_Form_Task {
40
41 /**
42 * The title of the group
43 *
44 * @var string
45 */
46 protected $_title;
47
48 /**
49 * Variable to store redirect path
50 */
51 private $_userContext;
52
53 private $_groupTree;
54
55 private $_surveyFields;
56
57 private $_surveyTypeId;
58
59 private $_interviewerId;
60
61 private $_surveyActivityIds;
62
63 private $_votingTab = FALSE;
64
65 private $_surveyValues;
66
67 private $_resultOptions;
68
69 private $_allowAjaxReleaseButton;
70
71 /**
72 * Build all the data structures needed to build the form.
73 *
74 * @return void
75 */
76 public function preProcess() {
77 $this->_votingTab = $this->get('votingTab');
78 $this->_reserveToInterview = $this->get('reserveToInterview');
79 if ($this->_reserveToInterview || $this->_votingTab) {
80 //user came from voting tab / reserve form.
81 foreach (array(
82 'surveyId',
83 'contactIds',
84 'interviewerId',
85 ) as $fld) {
86 $this->{"_$fld"} = $this->get($fld);
87 }
88 //get the target voter ids.
89 if ($this->_votingTab) {
90 $this->getVoterIds();
91 }
92 }
93 else {
94 parent::preProcess();
95 //get the survey id from user submitted values.
96 $this->_surveyId = CRM_Utils_Array::value('campaign_survey_id', $this->get('formValues'));
97 $this->_interviewerId = CRM_Utils_Array::value('survey_interviewer_id', $this->get('formValues'));
98 }
99
100 if ($this->_surveyId) {
101 $params = array('id' => $this->_surveyId);
102 CRM_Campaign_BAO_Survey::retrieve($params, $this->_surveyDetails);
103 }
104
105 $orderClause = FALSE;
106 $buttonName = $this->controller->getButtonName();
107 if ($buttonName == '_qf_Interview_submit_orderBy' && !empty($_POST['order_bys'])) {
108 $orderByParams = CRM_Utils_Array::value('order_bys', $_POST);
109 }
110 elseif (CRM_Core_OptionGroup::getValue('activity_type', 'WalkList') == $this->_surveyDetails['activity_type_id']) {
111 $orderByParams
112 = array(
113 1 => array(
114 'column' => 'civicrm_address.street_name',
115 'order' => 'ASC',
116 ),
117 2 => array(
118 'column' => 'civicrm_address.street_number%2',
119 'order' => 'ASC',
120 ),
121 3 => array(
122 'column' => 'civicrm_address.street_number',
123 'order' => 'ASC',
124 ),
125 4 => array(
126 'column' => 'contact_a.sort_name',
127 'order' => 'ASC',
128 ),
129 );
130 }
131
132 $orderBy = array();
133 if (!empty($orderByParams)) {
134 foreach ($orderByParams as $key => $val) {
135 if (!empty($val['column'])) {
136 $orderBy[] = "{$val['column']} {$val['order']}";
137 }
138 }
139 if (!empty($orderBy)) {
140 $orderClause = "ORDER BY " . implode(', ', $orderBy);
141 }
142 }
143
144 $this->_contactIds = array_unique($this->_contactIds);
145 if (!empty($this->_contactIds) && $orderClause) {
146 $clause = 'contact_a.id IN ( ' . implode(',', $this->_contactIds) . ' ) ';
147 $sql = "
148 SELECT contact_a.id
149 FROM civicrm_contact contact_a
150 LEFT JOIN civicrm_address ON contact_a.id = civicrm_address.contact_id
151 WHERE {$clause}
152 {$orderClause}";
153
154 $this->_contactIds = array();
155 $dao = CRM_Core_DAO::executeQuery($sql);
156 while ($dao->fetch()) {
157 $this->_contactIds[] = $dao->id;
158 }
159 }
160
161 //get the contact read only fields to display.
162 $readOnlyFields = array_merge(array(
163 'contact_type' => '',
164 'sort_name' => ts('Name'),
165 ));
166
167 //get the read only field data.
168 $returnProperties = array_fill_keys(array_keys($readOnlyFields), 1);
169 $returnProperties['contact_sub_type'] = TRUE;
170
171 //validate all voters for required activity.
172 //get the survey activities for given voters.
173 $this->_surveyActivityIds = CRM_Campaign_BAO_Survey::voterActivityDetails($this->_surveyId,
174 $this->_contactIds,
175 $this->_interviewerId
176 );
177 $activityStatus = CRM_Core_PseudoConstant::activityStatus('name');
178 $scheduledStatusId = array_search('Scheduled', $activityStatus);
179
180 $activityIds = array();
181 foreach ($this->_contactIds as $key => $voterId) {
182 $actVals = CRM_Utils_Array::value($voterId, $this->_surveyActivityIds);
183 $statusId = CRM_Utils_Array::value('status_id', $actVals);
184 $activityId = CRM_Utils_Array::value('activity_id', $actVals);
185 if ($activityId &&
186 $statusId &&
187 $scheduledStatusId == $statusId
188 ) {
189 $activityIds["activity_id_{$voterId}"] = $activityId;
190 }
191 else {
192 unset($this->_contactIds[$key]);
193 }
194 }
195
196 //retrieve the contact details.
197 $voterDetails = CRM_Campaign_BAO_Survey::voterDetails($this->_contactIds, $returnProperties);
198
199 $this->_allowAjaxReleaseButton = FALSE;
200 if ($this->_votingTab &&
201 (CRM_Core_Permission::check('manage campaign') ||
202 CRM_Core_Permission::check('administer CiviCampaign') ||
203 CRM_Core_Permission::check('release campaign contacts')
204 )
205 ) {
206 $this->_allowAjaxReleaseButton = TRUE;
207 }
208
209 //validate voter ids across profile.
210 $this->filterVoterIds();
211 $this->assign('votingTab', $this->_votingTab);
212 $this->assign('componentIds', $this->_contactIds);
213 $this->assign('componentIdsJson', json_encode($this->_contactIds));
214 $this->assign('voterDetails', $voterDetails);
215 $this->assign('readOnlyFields', $readOnlyFields);
216 $this->assign('interviewerId', $this->_interviewerId);
217 $this->assign('surveyActivityIds', json_encode($activityIds));
218 $this->assign('allowAjaxReleaseButton', $this->_allowAjaxReleaseButton);
219
220 //get the survey values.
221 $this->_surveyValues = $this->get('surveyValues');
222 if (!is_array($this->_surveyValues)) {
223 $this->_surveyValues = array();
224 if ($this->_surveyId) {
225 $surveyParams = array('id' => $this->_surveyId);
226 CRM_Campaign_BAO_Survey::retrieve($surveyParams, $this->_surveyValues);
227 }
228 $this->set('surveyValues', $this->_surveyValues);
229 }
230 $this->assign('surveyValues', $this->_surveyValues);
231
232 $result = CRM_Campaign_BAO_Survey::getReportID($this->_surveyId);
233 $this->assign("instanceId", $result);
234
235 //get the survey result options.
236 $this->_resultOptions = $this->get('resultOptions');
237 if (!is_array($this->_resultOptions)) {
238 $this->_resultOptions = array();
239 if ($resultOptionId = CRM_Utils_Array::value('result_id', $this->_surveyValues)) {
240 $this->_resultOptions = CRM_Core_OptionGroup::valuesByID($resultOptionId);
241 }
242 $this->set('resultOptions', $this->_resultOptions);
243 }
244
245 //validate the required ids.
246 $this->validateIds();
247
248 //append breadcrumb to survey dashboard.
249 if (CRM_Campaign_BAO_Campaign::accessCampaign()) {
250 $url = CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=survey');
251 CRM_Utils_System::appendBreadCrumb(array(array('title' => ts('Survey(s)'), 'url' => $url)));
252 }
253
254 //set the title.
255 $activityTypes = CRM_Core_PseudoConstant::activityType(FALSE, TRUE, FALSE, 'label', TRUE);
256 $this->_surveyTypeId = CRM_Utils_Array::value('activity_type_id', $this->_surveyValues);
257 CRM_Utils_System::setTitle(ts('Record %1 Responses', array(1 => $activityTypes[$this->_surveyTypeId])));
258 }
259
260 public function validateIds() {
261 $required = array(
262 'surveyId' => ts('Could not find Survey.'),
263 'interviewerId' => ts('Could not find Interviewer.'),
264 'contactIds' => ts('No respondents are currently reserved for you to interview.'),
265 'resultOptions' => ts('Oops. It looks like there is no response option configured.'),
266 );
267
268 $errorMessages = array();
269 foreach ($required as $fld => $msg) {
270 if (empty($this->{"_$fld"})) {
271 if (!$this->_votingTab) {
272 CRM_Core_Error::statusBounce($msg);
273 break;
274 }
275 $errorMessages[] = $msg;
276 }
277 }
278
279 $this->assign('errorMessages', empty($errorMessages) ? FALSE : $errorMessages);
280 }
281
282 /**
283 * Build the form object.
284 *
285 *
286 * @return void
287 */
288 public function buildQuickForm() {
289 $this->assign('surveyTypeId', $this->_surveyTypeId);
290
291 $options
292 = array(
293 '' => ' - none - ',
294 'civicrm_address.street_name' => 'Street Name',
295 'civicrm_address.street_number%2' => 'Odd / Even Street Number',
296 'civicrm_address.street_number' => 'Street Number',
297 'contact_a.sort_name' => 'Respondent Name',
298 );
299 for ($i = 1; $i < count($options); $i++) {
300 $this->addElement('select', "order_bys[{$i}][column]", ts('Order by Column'), $options);
301 $this->addElement('select', "order_bys[{$i}][order]", ts('Order by Order'), array(
302 'ASC' => 'Ascending',
303 'DESC' => 'Descending',
304 ));
305 }
306
307 //pickup the uf fields.
308 $this->_surveyFields = CRM_Campaign_BAO_Survey::getSurveyResponseFields($this->_surveyId,
309 $this->_surveyTypeId
310 );
311
312 foreach ($this->_contactIds as $contactId) {
313 //build the profile fields.
314 foreach ($this->_surveyFields as $name => $field) {
315 if ($field) {
316 CRM_Core_BAO_UFGroup::buildProfile($this, $field, NULL, $contactId);
317 }
318 }
319
320 //build the result field.
321 if (!empty($this->_resultOptions)) {
322 $this->add('select', "field[$contactId][result]", ts('Result'),
323 array(
324 '' => ts('- select -'),
325 ) +
326 array_combine($this->_resultOptions, $this->_resultOptions)
327 );
328 }
329
330 $this->add('text', "field[{$contactId}][note]", ts('Note'));
331
332 //need to keep control for release/reserve.
333 if ($this->_allowAjaxReleaseButton) {
334 $this->addElement('hidden',
335 "field[{$contactId}][is_release_or_reserve]", 0,
336 array('id' => "field_{$contactId}_is_release_or_reserve")
337 );
338 }
339 }
340 $this->assign('surveyFields', empty($this->_surveyFields) ? FALSE : $this->_surveyFields);
341
342 //no need to get qf buttons.
343 if ($this->_votingTab) {
344 return;
345 }
346
347 $buttons = array(
348 array(
349 'type' => 'cancel',
350 'name' => ts('Done'),
351 'subName' => 'interview',
352 'isDefault' => TRUE,
353 ),
354 );
355
356 $buttons[] = array(
357 'type' => 'submit',
358 'name' => ts('Order By >>'),
359 'subName' => 'orderBy',
360 );
361
362 $manageCampaign = CRM_Core_Permission::check('manage campaign');
363 $adminCampaign = CRM_Core_Permission::check('administer CiviCampaign');
364 if ($manageCampaign ||
365 $adminCampaign ||
366 CRM_Core_Permission::check('release campaign contacts')
367 ) {
368 $buttons[] = array(
369 'type' => 'next',
370 'name' => ts('Release Respondents >>'),
371 'subName' => 'interviewToRelease',
372 );
373 }
374 if ($manageCampaign ||
375 $adminCampaign ||
376 CRM_Core_Permission::check('reserve campaign contacts')
377 ) {
378 $buttons[] = array(
379 'type' => 'done',
380 'name' => ts('Reserve More Respondents >>'),
381 'subName' => 'interviewToReserve',
382 );
383 }
384
385 $this->addButtons($buttons);
386 }
387
388 /**
389 * Set default values for the form.
390 *
391 *
392 * @return void
393 */
394 public function setDefaultValues() {
395 //load default data for only contact fields.
396 $contactFields = $defaults = array();
397 foreach ($this->_surveyFields as $name => $field) {
398 $acceptable_types = CRM_Contact_BAO_ContactType::basicTypes();
399 $acceptable_types[] = 'Contact';
400 if (in_array($field['field_type'], $acceptable_types)) {
401 $contactFields[$name] = $field;
402 }
403 }
404 if (!empty($contactFields)) {
405 foreach ($this->_contactIds as $contactId) {
406 CRM_Core_BAO_UFGroup::setProfileDefaults($contactId, $contactFields, $defaults, FALSE);
407 }
408 }
409
410 if (CRM_Core_OptionGroup::getValue('activity_type', 'WalkList') == $this->_surveyDetails['activity_type_id']) {
411 $defaults['order_bys']
412 = array(
413 1 => array(
414 'column' => 'civicrm_address.street_name',
415 'order' => 'ASC',
416 ),
417 2 => array(
418 'column' => 'civicrm_address.street_number%2',
419 'order' => 'ASC',
420 ),
421 3 => array(
422 'column' => 'civicrm_address.street_number',
423 'order' => 'ASC',
424 ),
425 4 => array(
426 'column' => 'contact_a.sort_name',
427 'order' => 'ASC',
428 ),
429 );
430 }
431 else {
432 $defaults['order_bys']
433 = array(
434 1 => array(
435 'column' => 'contact_a.sort_name',
436 'order' => 'ASC',
437 ),
438 );
439 }
440 return $defaults;
441 }
442
443 /**
444 * Process the form after the input has been submitted and validated.
445 *
446 *
447 * @return void
448 */
449 public function postProcess() {
450 $buttonName = $this->controller->getButtonName();
451 if ($buttonName == '_qf_Interview_done_interviewToReserve') {
452 //hey its time to stop cycle.
453 CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/survey/search', 'reset=1&op=reserve'));
454 }
455 elseif ($buttonName == '_qf_Interview_next_interviewToRelease') {
456 //get ready to jump to release form.
457 foreach (array(
458 'surveyId',
459 'contactIds',
460 'interviewerId',
461 ) as $fld) {
462 $this->controller->set($fld, $this->{"_$fld"});
463 }
464 $this->controller->set('interviewToRelease', TRUE);
465 }
466
467 // vote is done through ajax
468 }
469
470 /**
471 * @param array $params
472 *
473 * @return mixed
474 */
475 public static function registerInterview($params) {
476 $activityId = CRM_Utils_Array::value('activity_id', $params);
477 $surveyTypeId = CRM_Utils_Array::value('activity_type_id', $params);
478 if (!is_array($params) || !$surveyTypeId || !$activityId) {
479 return FALSE;
480 }
481
482 static $surveyFields;
483 if (!is_array($surveyFields)) {
484 $surveyFields = CRM_Core_BAO_CustomField::getFields('Activity',
485 FALSE,
486 FALSE,
487 $surveyTypeId,
488 NULL,
489 FALSE,
490 TRUE
491 );
492 }
493
494 static $statusId;
495 if (!$statusId) {
496 $statusId = array_search('Completed', CRM_Core_PseudoConstant::activityStatus('name'));
497 }
498
499 //format custom fields.
500 $customParams = CRM_Core_BAO_CustomField::postProcess($params,
501 $surveyFields,
502 $activityId,
503 'Activity'
504 );
505
506 CRM_Core_BAO_CustomValueTable::store($customParams, 'civicrm_activity', $activityId);
507
508 //process contact data.
509 $contactParams = $fields = array();
510
511 $contactFieldTypes = array_merge(array('Contact'), CRM_Contact_BAO_ContactType::basicTypes());
512 $responseFields = CRM_Campaign_BAO_Survey::getSurveyResponseFields($params['survey_id']);
513 if (!empty($responseFields)) {
514 foreach ($params as $key => $value) {
515 if (array_key_exists($key, $responseFields)) {
516 if (in_array($responseFields[$key]['field_type'], $contactFieldTypes)) {
517 $fields[$key] = $responseFields[$key];
518 $contactParams[$key] = $value;
519 if (isset($params["{$key}_id"])) {
520 $contactParams["{$key}_id"] = $params["{$key}_id"];
521 }
522 }
523 }
524 }
525 }
526
527 $contactId = CRM_Utils_Array::value('voter_id', $params);
528 if ($contactId && !empty($contactParams)) {
529 CRM_Contact_BAO_Contact::createProfileContact($contactParams, $fields, $contactId);
530 }
531
532 //update activity record.
533 $activity = new CRM_Activity_DAO_Activity();
534 $activity->id = $activityId;
535
536 $activity->selectAdd();
537 $activity->selectAdd('activity_date_time, status_id, result, subject');
538 $activity->find(TRUE);
539 $activity->activity_date_time = date('YmdHis');
540 $activity->status_id = $statusId;
541
542 if (!empty($params['activity_date_time'])) {
543 $activity->activity_date_time = CRM_Utils_Date::processDate($params['activity_date_time'], $params['activity_date_time_time']);
544 }
545
546 $subject = '';
547 $surveyTitle = CRM_Utils_Array::value('surveyTitle', $params);
548 if ($surveyTitle) {
549 $subject = $surveyTitle . ' - ';
550 }
551 $subject .= ts('Respondent Interview');
552
553 $activity->subject = $subject;
554 $activityParams = array(
555 'details' => 'details',
556 'result' => 'result',
557 'engagement_level' => 'activity_engagement_level',
558 'subject' => 'activity_subject',
559 'status_id' => 'activity_status_id',
560 'source_contact_id' => 'source_contact',
561 'location' => 'activity_location',
562 'campaign_id' => 'activity_campaign_id',
563 'duration' => 'activity_duration',
564 );
565 foreach ($activityParams as $key => $field) {
566 if (!empty($params[$field])) {
567 $activity->$key = $params[$field];
568 }
569 }
570
571 $activity->save();
572 //really this should use Activity BAO& not be here but refactoring will have to be later
573 //actually the whole ajax call could be done as an api ajax call & post hook would be sorted
574 CRM_Utils_Hook::post('edit', 'Activity', $activity->id, $activity);
575 $activity->free();
576
577 return $activityId;
578 }
579
580 public function getVoterIds() {
581 if (!$this->_interviewerId) {
582 $session = CRM_Core_Session::singleton();
583 $this->_interviewerId = $session->get('userID');
584 }
585 if (!$this->_surveyId) {
586 // use default survey id
587 $dao = new CRM_Campaign_DAO_Survey();
588 $dao->is_active = 1;
589 $dao->is_default = 1;
590 $dao->find(TRUE);
591 $this->_surveyId = $dao->id;
592 }
593
594 $this->_contactIds = $this->get('contactIds');
595 if (!is_array($this->_contactIds)) {
596 //get the survey activities.
597 $activityStatus = CRM_Core_PseudoConstant::activityStatus('name');
598 $statusIds = array();
599 if ($statusId = array_search('Scheduled', $activityStatus)) {
600 $statusIds[] = $statusId;
601 }
602 $surveyActivities = CRM_Campaign_BAO_Survey::getSurveyVoterInfo($this->_surveyId,
603 $this->_interviewerId,
604 $statusIds
605 );
606 $this->_contactIds = array();
607 foreach ($surveyActivities as $val) {
608 $this->_contactIds[$val['voter_id']] = $val['voter_id'];
609 }
610 $this->set('contactIds', $this->_contactIds);
611 }
612 }
613
614 public function filterVoterIds() {
615 //do the cleanup later on.
616 if (!is_array($this->_contactIds)) {
617 return;
618 }
619
620 $profileId = CRM_Campaign_BAO_Survey::getSurveyProfileId($this->_surveyId);
621 if ($profileId) {
622 $profileType = CRM_Core_BAO_UFField::getProfileType($profileId);
623 if (in_array($profileType, CRM_Contact_BAO_ContactType::basicTypes())) {
624 $voterIdCount = count($this->_contactIds);
625
626 //create temporary table to store voter ids.
627 $tempTableName = CRM_Core_DAO::createTempTableName('civicrm_survey_respondent');
628 CRM_Core_DAO::executeQuery("DROP TABLE IF EXISTS {$tempTableName}");
629 $query = "
630 CREATE TEMPORARY TABLE {$tempTableName} (
631 id int unsigned NOT NULL AUTO_INCREMENT,
632 survey_contact_id int unsigned NOT NULL,
633 PRIMARY KEY ( id )
634 );
635 ";
636 CRM_Core_DAO::executeQuery($query);
637 $batch = 100;
638 $insertedCount = 0;
639 do {
640 $processIds = $this->_contactIds;
641 $insertIds = array_splice($processIds, $insertedCount, $batch);
642 if (!empty($insertIds)) {
643 $insertSQL = "INSERT IGNORE INTO {$tempTableName}( survey_contact_id )
644 VALUES (" . implode('),(', $insertIds) . ');';
645 CRM_Core_DAO::executeQuery($insertSQL);
646 }
647 $insertedCount += $batch;
648 } while ($insertedCount < $voterIdCount);
649
650 $query = "
651 SELECT contact.id as id
652 FROM civicrm_contact contact
653 INNER JOIN {$tempTableName} ON ( {$tempTableName}.survey_contact_id = contact.id )
654 WHERE contact.contact_type != %1";
655 $removeContact = CRM_Core_DAO::executeQuery($query,
656 array(1 => array($profileType, 'String'))
657 );
658 while ($removeContact->fetch()) {
659 unset($this->_contactIds[$removeContact->id]);
660 }
661 }
662 }
663 }
664
665 }