3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
33 class CRM_Campaign_BAO_Petition
extends CRM_Campaign_BAO_Survey
{
37 public function __construct() {
38 parent
::__construct();
39 // expire cookie in one day
40 $this->cookieExpire
= (1 * 60 * 60 * 24);
44 * Get Petition Details for dashboard.
46 * @param array $params
47 * @param bool $onlyCount
51 public static function getPetitionSummary($params = array(), $onlyCount = FALSE) {
52 //build the limit and order clause.
53 $limitClause = $orderByClause = $lookupTableJoins = NULL;
56 'sort' => 'created_date',
59 'sortOrder' => 'desc',
61 foreach ($sortParams as $name => $default) {
62 if (!empty($params[$name])) {
63 $sortParams[$name] = $params[$name];
67 //need to lookup tables.
68 $orderOnPetitionTable = TRUE;
69 if ($sortParams['sort'] == 'campaign') {
70 $orderOnPetitionTable = FALSE;
72 LEFT JOIN civicrm_campaign campaign ON ( campaign.id = petition.campaign_id )';
73 $orderByClause = "ORDER BY campaign.title {$sortParams['sortOrder']}";
75 elseif ($sortParams['sort'] == 'activity_type') {
76 $orderOnPetitionTable = FALSE;
78 LEFT JOIN civicrm_option_value activity_type ON ( activity_type.value = petition.activity_type_id
79 OR petition.activity_type_id IS NULL )
80 INNER JOIN civicrm_option_group grp ON ( activity_type.option_group_id = grp.id AND grp.name = 'activity_type' )";
81 $orderByClause = "ORDER BY activity_type.label {$sortParams['sortOrder']}";
83 elseif ($sortParams['sort'] == 'isActive') {
84 $sortParams['sort'] = 'is_active';
86 if ($orderOnPetitionTable) {
87 $orderByClause = "ORDER BY petition.{$sortParams['sort']} {$sortParams['sortOrder']}";
89 $limitClause = "LIMIT {$sortParams['offset']}, {$sortParams['rowCount']}";
92 //build the where clause.
93 $queryParams = $where = array();
95 //we only have activity type as a
96 //difference between survey and petition.
97 $petitionTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Petition');
98 if ($petitionTypeID) {
99 $where[] = "( petition.activity_type_id = %1 )";
100 $queryParams[1] = array($petitionTypeID, 'Positive');
102 if (!empty($params['title'])) {
103 $where[] = "( petition.title LIKE %2 )";
104 $queryParams[2] = array('%' . trim($params['title']) . '%', 'String');
106 if (!empty($params['campaign_id'])) {
107 $where[] = '( petition.campaign_id = %3 )';
108 $queryParams[3] = array($params['campaign_id'], 'Positive');
111 if (!empty($where)) {
112 $whereClause = ' WHERE ' . implode(" \nAND ", $where);
116 SELECT petition.id as id,
117 petition.title as title,
118 petition.is_active as is_active,
119 petition.result_id as result_id,
120 petition.is_default as is_default,
121 petition.campaign_id as campaign_id,
122 petition.activity_type_id as activity_type_id';
125 $selectClause = 'SELECT COUNT(*)';
127 $fromClause = 'FROM civicrm_survey petition';
129 $query = "{$selectClause} {$fromClause} {$whereClause} {$orderByClause} {$limitClause}";
132 return (int) CRM_Core_DAO
::singleValueQuery($query, $queryParams);
135 $petitions = array();
146 $petition = CRM_Core_DAO
::executeQuery($query, $queryParams);
147 while ($petition->fetch()) {
148 foreach ($properties as $property) {
149 $petitions[$petition->id
][$property] = $petition->$property;
157 * Get the petition count.
160 public static function getPetitionCount() {
161 $whereClause = 'WHERE ( 1 )';
162 $queryParams = array();
163 $petitionTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Petition');
164 if ($petitionTypeID) {
165 $whereClause = "WHERE ( petition.activity_type_id = %1 )";
166 $queryParams[1] = array($petitionTypeID, 'Positive');
168 $query = "SELECT COUNT(*) FROM civicrm_survey petition {$whereClause}";
170 return (int) CRM_Core_DAO
::singleValueQuery($query, $queryParams);
174 * Takes an associative array and creates a petition signature activity.
176 * @param array $params
177 * (reference ) an assoc array of name/value pairs.
179 * @return CRM_Campaign_BAO_Petition
181 public function createSignature(&$params) {
182 if (empty($params)) {
186 if (!isset($params['sid'])) {
187 $statusMsg = ts('No survey sid parameter. Cannot process signature.');
188 CRM_Core_Session
::setStatus($statusMsg, ts('Sorry'), 'error');
192 if (isset($params['contactId'])) {
194 // add signature as activity with survey id as source id
195 // get the activity type id associated with this survey
196 $surveyInfo = CRM_Campaign_BAO_Petition
::getSurveyInfo($params['sid']);
199 // 1-Schedule, 2-Completed
201 $activityParams = array(
202 'source_contact_id' => $params['contactId'],
203 'target_contact_id' => $params['contactId'],
204 'source_record_id' => $params['sid'],
205 'subject' => $surveyInfo['title'],
206 'activity_type_id' => $surveyInfo['activity_type_id'],
207 'activity_date_time' => date("YmdHis"),
208 'status_id' => $params['statusId'],
209 'activity_campaign_id' => $params['activity_campaign_id'],
213 // *** check for activity using source id - if already signed
214 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
216 // save activity custom data
217 if (!empty($params['custom']) &&
218 is_array($params['custom'])
220 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_activity', $activity->id
);
223 // Set browser cookie to indicate this petition was already signed.
224 $config = CRM_Core_Config
::singleton();
225 $url_parts = parse_url($config->userFrameworkBaseURL
);
226 setcookie('signed_' . $params['sid'], $activity->id
, time() +
$this->cookieExpire
, $url_parts['path'], $url_parts['host'], CRM_Utils_System
::isSSL());
233 * @param int $activity_id
234 * @param int $contact_id
235 * @param int $petition_id
239 public function confirmSignature($activity_id, $contact_id, $petition_id) {
240 // change activity status to completed (status_id = 2)
241 // I wonder why do we need contact_id when we have activity_id anyway? [chastell]
242 $sql = 'UPDATE civicrm_activity SET status_id = 2 WHERE id = %1';
243 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
244 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
246 1 => array($activity_id, 'Integer'),
247 2 => array($contact_id, 'Integer'),
248 3 => array($sourceID, 'Integer'),
250 CRM_Core_DAO
::executeQuery($sql, $params);
252 $sql = 'UPDATE civicrm_activity_contact SET contact_id = %2 WHERE activity_id = %1 AND record_type_id = %3';
253 CRM_Core_DAO
::executeQuery($sql, $params);
254 // remove 'Unconfirmed' tag for this contact
255 $tag_name = Civi
::settings()->get('tag_unconfirmed');
258 DELETE FROM civicrm_entity_tag
259 WHERE entity_table = 'civicrm_contact'
261 AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )";
263 1 => array($contact_id, 'Integer'),
264 2 => array($tag_name, 'String'),
266 CRM_Core_DAO
::executeQuery($sql, $params);
267 // validate arguments to setcookie are numeric to prevent header manipulation
268 if (isset($petition_id) && is_numeric($petition_id)
269 && isset($activity_id) && is_numeric($activity_id)) {
270 // set permanent cookie to indicate this users email address now confirmed
271 $config = CRM_Core_Config
::singleton();
272 $url_parts = parse_url($config->userFrameworkBaseURL
);
273 setcookie("confirmed_{$petition_id}",
275 time() +
$this->cookieExpire
,
278 CRM_Utils_System
::isSSL()
283 CRM_Core_Error
::fatal(ts('Petition Id and/or Activity Id is not of the type Positive.'));
289 * Get Petition Signature Total.
291 * @param int $surveyId
295 public static function getPetitionSignatureTotalbyCountry($surveyId) {
296 $countries = array();
298 SELECT count(civicrm_address.country_id) as total,
299 IFNULL(country_id,'') as country_id,IFNULL(iso_code,'') as country_iso, IFNULL(civicrm_country.name,'') as country
300 FROM ( civicrm_activity a, civicrm_survey, civicrm_contact )
301 LEFT JOIN civicrm_address ON civicrm_address.contact_id = civicrm_contact.id AND civicrm_address.is_primary = 1
302 LEFT JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id
303 LEFT JOIN civicrm_activity_contact ac ON ( ac.activity_id = a.id AND ac.record_type_id = %2 )
305 ac.contact_id = civicrm_contact.id AND
306 a.activity_type_id = civicrm_survey.activity_type_id AND
307 civicrm_survey.id = %1 AND
308 a.source_record_id = %1 ";
310 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
311 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
313 1 => array($surveyId, 'Integer'),
314 2 => array($sourceID, 'Integer'),
316 $sql .= " GROUP BY civicrm_address.country_id";
317 $fields = array('total', 'country_id', 'country_iso', 'country');
319 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
320 while ($dao->fetch()) {
322 foreach ($fields as $field) {
323 $row[$field] = $dao->$field;
331 * Get Petition Signature Total.
333 * @param int $surveyId
337 public static function getPetitionSignatureTotal($surveyId) {
338 $surveyInfo = CRM_Campaign_BAO_Petition
::getSurveyInfo((int) $surveyId);
339 //$activityTypeID = $surveyInfo['activity_type_id'];
342 status_id,count(id) as total
343 FROM civicrm_activity
345 source_record_id = " . (int) $surveyId . " AND activity_type_id = " . (int) $surveyInfo['activity_type_id'] . " GROUP BY status_id";
347 $statusTotal = array();
349 $dao = CRM_Core_DAO
::executeQuery($sql);
350 while ($dao->fetch()) {
351 $total +
= $dao->total
;
352 $statusTotal['status'][$dao->status_id
] = $dao->total
;
354 $statusTotal['count'] = $total;
360 * @param int $surveyId
364 public static function getSurveyInfo($surveyId = NULL) {
365 $surveyInfo = array();
368 SELECT activity_type_id,
371 ov.label AS activity_type
372 FROM civicrm_survey s, civicrm_option_value ov, civicrm_option_group og
373 WHERE s.id = " . (int) $surveyId . "
374 AND s.activity_type_id = ov.value
375 AND ov.option_group_id = og.id
376 AND og.name = 'activity_type'";
378 $dao = CRM_Core_DAO
::executeQuery($sql);
379 while ($dao->fetch()) {
380 //$survey['campaign_id'] = $dao->campaign_id;
381 //$survey['campaign_name'] = $dao->campaign_name;
382 $surveyInfo['activity_type'] = $dao->activity_type
;
383 $surveyInfo['activity_type_id'] = $dao->activity_type_id
;
384 $surveyInfo['title'] = $dao->title
;
391 * Get Petition Signature Details.
393 * @param int $surveyId
394 * @param int $status_id
398 public static function getPetitionSignature($surveyId, $status_id = NULL) {
400 // sql injection protection
401 $surveyId = (int) $surveyId;
402 $signature = array();
406 a.source_record_id as survey_id,
407 a.activity_date_time,
409 civicrm_contact.id as contact_id,
410 civicrm_contact.contact_type,civicrm_contact.contact_sub_type,image_URL,
411 first_name,last_name,sort_name,
412 employer_id,organization_name,
414 IFNULL(gender_id,'') AS gender_id,
415 IFNULL(state_province_id,'') AS state_province_id,
416 IFNULL(country_id,'') as country_id,IFNULL(iso_code,'') as country_iso, IFNULL(civicrm_country.name,'') as country
417 FROM (civicrm_activity a, civicrm_survey, civicrm_contact )
418 LEFT JOIN civicrm_activity_contact ac ON ( ac.activity_id = a.id AND ac.record_type_id = %3 )
419 LEFT JOIN civicrm_address ON civicrm_address.contact_id = civicrm_contact.id AND civicrm_address.is_primary = 1
420 LEFT JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id
422 ac.contact_id = civicrm_contact.id AND
423 a.activity_type_id = civicrm_survey.activity_type_id AND
424 civicrm_survey.id = %1 AND
425 a.source_record_id = %1 ";
427 $params = array(1 => array($surveyId, 'Integer'));
430 $sql .= " AND status_id = %2";
431 $params[2] = array($status_id, 'Integer');
433 $sql .= " ORDER BY a.activity_date_time";
435 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
436 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
437 $params[3] = array($sourceID, 'Integer');
443 'activity_date_time',
456 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
457 while ($dao->fetch()) {
459 foreach ($fields as $field) {
460 $row[$field] = $dao->$field;
468 * This function returns all entities assigned to a specific tag.
471 * An object of a tag.
474 * array of contact ids
476 public function getEntitiesByTag($tag) {
477 $contactIds = array();
478 $entityTagDAO = new CRM_Core_DAO_EntityTag();
479 $entityTagDAO->tag_id
= $tag['id'];
480 $entityTagDAO->find();
482 while ($entityTagDAO->fetch()) {
483 $contactIds[] = $entityTagDAO->entity_id
;
489 * Check if contact has signed this petition.
491 * @param int $surveyId
492 * @param int $contactId
496 public static function checkSignature($surveyId, $contactId) {
498 $surveyInfo = CRM_Campaign_BAO_Petition
::getSurveyInfo($surveyId);
499 $signature = array();
500 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
501 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
505 a.source_record_id AS source_record_id,
506 ac.contact_id AS source_contact_id,
507 a.activity_date_time AS activity_date_time,
508 a.activity_type_id AS activity_type_id,
509 a.status_id AS status_id,
511 FROM civicrm_activity a
512 INNER JOIN civicrm_activity_contact ac ON (ac.activity_id = a.id AND ac.record_type_id = %5)
513 WHERE a.source_record_id = %2
514 AND a.activity_type_id = %3
515 AND ac.contact_id = %4
518 1 => array($surveyInfo['title'], 'String'),
519 2 => array($surveyId, 'Integer'),
520 3 => array($surveyInfo['activity_type_id'], 'Integer'),
521 4 => array($contactId, 'Integer'),
522 5 => array($sourceID, 'Integer'),
525 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
526 while ($dao->fetch()) {
527 $signature[$dao->id
]['id'] = $dao->id
;
528 $signature[$dao->id
]['source_record_id'] = $dao->source_record_id
;
529 $signature[$dao->id
]['source_contact_id'] = CRM_Contact_BAO_Contact
::displayName($dao->source_contact_id
);
530 $signature[$dao->id
]['activity_date_time'] = $dao->activity_date_time
;
531 $signature[$dao->id
]['activity_type_id'] = $dao->activity_type_id
;
532 $signature[$dao->id
]['status_id'] = $dao->status_id
;
533 $signature[$dao->id
]['survey_title'] = $dao->survey_title
;
534 $signature[$dao->id
]['contactId'] = $dao->source_contact_id
;
541 * Takes an associative array and sends a thank you or email verification email.
543 * @param array $params
544 * (reference ) an assoc array of name/value pairs.
546 * @param int $sendEmailMode
550 public static function sendEmail($params, $sendEmailMode) {
553 * CRM_Campaign_Form_Petition_Signature::EMAIL_THANK
554 * connected user via login/pwd - thank you
555 * or dedupe contact matched who doesn't have a tag CIVICRM_TAG_UNCONFIRMED - thank you
556 * or login using fb connect - thank you + click to add msg to fb wall
558 * CRM_Campaign_Form_Petition_Signature::EMAIL_CONFIRM
559 * send a confirmation request email
562 // check if the group defined by CIVICRM_PETITION_CONTACTS exists, else create it
563 $petitionGroupName = Civi
::settings()->get('petition_contacts');
565 $dao = new CRM_Contact_DAO_Group();
566 $dao->title
= $petitionGroupName;
567 if (!$dao->find(TRUE)) {
569 $dao->visibility
= 'User and User Admin Only';
572 $group_id = $dao->id
;
575 $petitionParams['id'] = $params['sid'];
576 $petitionInfo = array();
577 CRM_Campaign_BAO_Survey
::retrieve($petitionParams, $petitionInfo);
578 if (empty($petitionInfo)) {
579 CRM_Core_Error
::fatal('Petition doesn\'t exist.');
582 //get the default domain email address.
583 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain
::getNameAndEmail();
585 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
587 $toName = CRM_Contact_BAO_Contact
::displayName($params['contactId']);
589 $replyTo = CRM_Core_BAO_Domain
::getNoReplyEmailAddress();
591 // set additional general message template params (custom tokens to use in email msg templates)
592 // tokens then available in msg template as {$petition.title}, etc
593 $petitionTokens['title'] = $petitionInfo['title'];
594 $petitionTokens['petitionId'] = $params['sid'];
595 $tplParams['petition'] = $petitionTokens;
597 switch ($sendEmailMode) {
598 case CRM_Campaign_Form_Petition_Signature
::EMAIL_THANK
:
600 // add this contact to the CIVICRM_PETITION_CONTACTS group
601 // Cannot pass parameter 1 by reference
602 $p = array($params['contactId']);
603 CRM_Contact_BAO_GroupContact
::addContactsToGroup($p, $group_id, 'API');
605 if ($params['email-Primary']) {
606 CRM_Core_BAO_MessageTemplate
::sendTemplate(
608 'groupName' => 'msg_tpl_workflow_petition',
609 'valueName' => 'petition_sign',
610 'contactId' => $params['contactId'],
611 'tplParams' => $tplParams,
612 'from' => "\"{$domainEmailName}\" <{$domainEmailAddress}>",
614 'toEmail' => $params['email-Primary'],
615 'replyTo' => $replyTo,
616 'petitionId' => $params['sid'],
617 'petitionTitle' => $petitionInfo['title'],
623 case CRM_Campaign_Form_Petition_Signature
::EMAIL_CONFIRM
:
624 // create mailing event subscription record for this contact
625 // this will allow using a hash key to confirm email address by sending a url link
626 $se = CRM_Mailing_Event_BAO_Subscribe
::subscribe($group_id,
627 $params['email-Primary'],
628 $params['contactId'],
632 // require_once 'CRM/Core/BAO/Domain.php';
633 // $domain = CRM_Core_BAO_Domain::getDomain();
634 $config = CRM_Core_Config
::singleton();
635 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
637 $replyTo = implode($config->verpSeparator
,
646 $confirmUrl = CRM_Utils_System
::url('civicrm/petition/confirm',
647 "reset=1&cid={$se->contact_id}&sid={$se->id}&h={$se->hash}&a={$params['activityId']}&pid={$params['sid']}",
650 $confirmUrlPlainText = CRM_Utils_System
::url('civicrm/petition/confirm',
651 "reset=1&cid={$se->contact_id}&sid={$se->id}&h={$se->hash}&a={$params['activityId']}&pid={$params['sid']}",
657 // set email specific message template params and assign to tplParams
658 $petitionTokens['confirmUrl'] = $confirmUrl;
659 $petitionTokens['confirmUrlPlainText'] = $confirmUrlPlainText;
660 $tplParams['petition'] = $petitionTokens;
662 if ($params['email-Primary']) {
663 CRM_Core_BAO_MessageTemplate
::sendTemplate(
665 'groupName' => 'msg_tpl_workflow_petition',
666 'valueName' => 'petition_confirmation_needed',
667 'contactId' => $params['contactId'],
668 'tplParams' => $tplParams,
669 'from' => "\"{$domainEmailName}\" <{$domainEmailAddress}>",
671 'toEmail' => $params['email-Primary'],
672 'replyTo' => $replyTo,
673 'petitionId' => $params['sid'],
674 'petitionTitle' => $petitionInfo['title'],
675 'confirmUrl' => $confirmUrl,