3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Campaign_BAO_Petition
extends CRM_Campaign_BAO_Survey
{
38 public function __construct() {
39 parent
::__construct();
40 // expire cookie in one day
41 $this->cookieExpire
= (1 * 60 * 60 * 24);
45 * Get Petition Details for dashboard.
48 public static function getPetitionSummary($params = array(), $onlyCount = FALSE) {
49 //build the limit and order clause.
50 $limitClause = $orderByClause = $lookupTableJoins = NULL;
53 'sort' => 'created_date',
56 'sortOrder' => 'desc',
58 foreach ($sortParams as $name => $default) {
59 if (!empty($params[$name])) {
60 $sortParams[$name] = $params[$name];
64 //need to lookup tables.
65 $orderOnPetitionTable = TRUE;
66 if ($sortParams['sort'] == 'campaign') {
67 $orderOnPetitionTable = FALSE;
69 LEFT JOIN civicrm_campaign campaign ON ( campaign.id = petition.campaign_id )';
70 $orderByClause = "ORDER BY campaign.title {$sortParams['sortOrder']}";
72 elseif ($sortParams['sort'] == 'activity_type') {
73 $orderOnPetitionTable = FALSE;
75 LEFT JOIN civicrm_option_value activity_type ON ( activity_type.value = petition.activity_type_id
76 OR petition.activity_type_id IS NULL )
77 INNER JOIN civicrm_option_group grp ON ( activity_type.option_group_id = grp.id AND grp.name = 'activity_type' )";
78 $orderByClause = "ORDER BY activity_type.label {$sortParams['sortOrder']}";
80 elseif ($sortParams['sort'] == 'isActive') {
81 $sortParams['sort'] = 'is_active';
83 if ($orderOnPetitionTable) {
84 $orderByClause = "ORDER BY petition.{$sortParams['sort']} {$sortParams['sortOrder']}";
86 $limitClause = "LIMIT {$sortParams['offset']}, {$sortParams['rowCount']}";
89 //build the where clause.
90 $queryParams = $where = array();
92 //we only have activity type as a
93 //difference between survey and petition.
94 $petitionTypeID = CRM_Core_OptionGroup
::getValue('activity_type', 'petition', 'name');
95 if ($petitionTypeID) {
96 $where[] = "( petition.activity_type_id = %1 )";
97 $queryParams[1] = array($petitionTypeID, 'Positive');
99 if (!empty($params['title'])) {
100 $where[] = "( petition.title LIKE %2 )";
101 $queryParams[2] = array('%' . trim($params['title']) . '%', 'String');
103 if (!empty($params['campaign_id'])) {
104 $where[] = '( petition.campaign_id = %3 )';
105 $queryParams[3] = array($params['campaign_id'], 'Positive');
108 if (!empty($where)) {
109 $whereClause = ' WHERE ' . implode(" \nAND ", $where);
113 SELECT petition.id as id,
114 petition.title as title,
115 petition.is_active as is_active,
116 petition.result_id as result_id,
117 petition.is_default as is_default,
118 petition.campaign_id as campaign_id,
119 petition.activity_type_id as activity_type_id';
122 $selectClause = 'SELECT COUNT(*)';
124 $fromClause = 'FROM civicrm_survey petition';
126 $query = "{$selectClause} {$fromClause} {$whereClause} {$orderByClause} {$limitClause}";
129 return (int) CRM_Core_DAO
::singleValueQuery($query, $queryParams);
132 $petitions = array();
143 $petition = CRM_Core_DAO
::executeQuery($query, $queryParams);
144 while ($petition->fetch()) {
145 foreach ($properties as $property) {
146 $petitions[$petition->id
][$property] = $petition->$property;
154 * Get the petition count.
157 public static function getPetitionCount() {
158 $whereClause = 'WHERE ( 1 )';
159 $queryParams = array();
160 $petitionTypeID = CRM_Core_OptionGroup
::getValue('activity_type', 'petition', 'name');
161 if ($petitionTypeID) {
162 $whereClause = "WHERE ( petition.activity_type_id = %1 )";
163 $queryParams[1] = array($petitionTypeID, 'Positive');
165 $query = "SELECT COUNT(*) FROM civicrm_survey petition {$whereClause}";
167 return (int) CRM_Core_DAO
::singleValueQuery($query, $queryParams);
171 * Takes an associative array and creates a petition signature activity
173 * @param array $params
174 * (reference ) an assoc array of name/value pairs.
176 * @return CRM_Campaign_BAO_Petition
178 public function createSignature(&$params) {
179 if (empty($params)) {
183 if (!isset($params['sid'])) {
184 $statusMsg = ts('No survey sid parameter. Cannot process signature.');
185 CRM_Core_Session
::setStatus($statusMsg, ts('Sorry'), 'error');
189 if (isset($params['contactId'])) {
191 // add signature as activity with survey id as source id
192 // get the activity type id associated with this survey
193 $surveyInfo = CRM_Campaign_BAO_Petition
::getSurveyInfo($params['sid']);
196 // 1-Schedule, 2-Completed
198 $activityParams = array(
199 'source_contact_id' => $params['contactId'],
200 'target_contact_id' => $params['contactId'],
201 'source_record_id' => $params['sid'],
202 'subject' => $surveyInfo['title'],
203 'activity_type_id' => $surveyInfo['activity_type_id'],
204 'activity_date_time' => date("YmdHis"),
205 'status_id' => $params['statusId'],
206 'activity_campaign_id' => $params['activity_campaign_id'],
210 // *** check for activity using source id - if already signed
211 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
213 // save activity custom data
214 if (!empty($params['custom']) &&
215 is_array($params['custom'])
217 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_activity', $activity->id
);
220 // set permanent cookie to indicate this petition already signed on the computer
221 setcookie('signed_' . $params['sid'], $activity->id
, time() +
$this->cookieExpire
, '/');
228 * @param int $activity_id
229 * @param int $contact_id
230 * @param int $petition_id
234 public function confirmSignature($activity_id, $contact_id, $petition_id) {
235 // change activity status to completed (status_id = 2)
236 // I wonder why do we need contact_id when we have activity_id anyway? [chastell]
237 $sql = 'UPDATE civicrm_activity SET status_id = 2 WHERE id = %1';
238 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
239 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
241 1 => array($activity_id, 'Integer'),
242 2 => array($contact_id, 'Integer'),
243 3 => array($sourceID, 'Integer'),
245 CRM_Core_DAO
::executeQuery($sql, $params);
247 $sql = 'UPDATE civicrm_activity_contact SET contact_id = %2 WHERE activity_id = %1 AND record_type_id = %3';
248 CRM_Core_DAO
::executeQuery($sql, $params);
249 // remove 'Unconfirmed' tag for this contact
250 $tag_name = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
257 DELETE FROM civicrm_entity_tag
258 WHERE entity_table = 'civicrm_contact'
260 AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )";
262 1 => array($contact_id, 'Integer'),
263 2 => array($tag_name, 'String'),
265 CRM_Core_DAO
::executeQuery($sql, $params);
267 // set permanent cookie to indicate this users email address now confirmed
268 setcookie("confirmed_{$petition_id}",
270 time() +
$this->cookieExpire
,
278 * Get Petition Signature Total
280 * @param int $surveyId
284 public static function getPetitionSignatureTotalbyCountry($surveyId) {
285 $countries = array();
287 SELECT count(civicrm_address.country_id) as total,
288 IFNULL(country_id,'') as country_id,IFNULL(iso_code,'') as country_iso, IFNULL(civicrm_country.name,'') as country
289 FROM ( civicrm_activity a, civicrm_survey, civicrm_contact )
290 LEFT JOIN civicrm_address ON civicrm_address.contact_id = civicrm_contact.id AND civicrm_address.is_primary = 1
291 LEFT JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id
292 LEFT JOIN civicrm_activity_contact ac ON ( ac.activity_id = a.id AND ac.record_type_id = %2 )
294 ac.contact_id = civicrm_contact.id AND
295 a.activity_type_id = civicrm_survey.activity_type_id AND
296 civicrm_survey.id = %1 AND
297 a.source_record_id = %1 ";
299 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
300 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
302 1 => array($surveyId, 'Integer'),
303 2 => array($sourceID, 'Integer'),
305 $sql .= " GROUP BY civicrm_address.country_id";
306 $fields = array('total', 'country_id', 'country_iso', 'country');
308 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
309 while ($dao->fetch()) {
311 foreach ($fields as $field) {
312 $row[$field] = $dao->$field;
320 * Get Petition Signature Total
322 * @param int $surveyId
326 public static function getPetitionSignatureTotal($surveyId) {
327 $surveyInfo = CRM_Campaign_BAO_Petition
::getSurveyInfo((int) $surveyId);
328 //$activityTypeID = $surveyInfo['activity_type_id'];
331 status_id,count(id) as total
332 FROM civicrm_activity
334 source_record_id = " . (int) $surveyId . " AND activity_type_id = " . (int) $surveyInfo['activity_type_id'] . " GROUP BY status_id";
336 $statusTotal = array();
338 $dao = CRM_Core_DAO
::executeQuery($sql);
339 while ($dao->fetch()) {
340 $total +
= $dao->total
;
341 $statusTotal['status'][$dao->status_id
] = $dao->total
;
343 $statusTotal['count'] = $total;
349 * @param int $surveyId
353 public static function getSurveyInfo($surveyId = NULL) {
354 $surveyInfo = array();
357 SELECT activity_type_id,
360 ov.label AS activity_type
361 FROM civicrm_survey s, civicrm_option_value ov, civicrm_option_group og
362 WHERE s.id = " . (int) $surveyId . "
363 AND s.activity_type_id = ov.value
364 AND ov.option_group_id = og.id
365 AND og.name = 'activity_type'";
367 $dao = CRM_Core_DAO
::executeQuery($sql);
368 while ($dao->fetch()) {
369 //$survey['campaign_id'] = $dao->campaign_id;
370 //$survey['campaign_name'] = $dao->campaign_name;
371 $surveyInfo['activity_type'] = $dao->activity_type
;
372 $surveyInfo['activity_type_id'] = $dao->activity_type_id
;
373 $surveyInfo['title'] = $dao->title
;
380 * Get Petition Signature Details
382 * @param int $surveyId
383 * @param int $status_id
387 public static function getPetitionSignature($surveyId, $status_id = NULL) {
389 // sql injection protection
390 $surveyId = (int) $surveyId;
391 $signature = array();
395 a.source_record_id as survey_id,
396 a.activity_date_time,
398 civicrm_contact.id as contact_id,
399 civicrm_contact.contact_type,civicrm_contact.contact_sub_type,image_URL,
400 first_name,last_name,sort_name,
401 employer_id,organization_name,
403 IFNULL(gender_id,'') AS gender_id,
404 IFNULL(state_province_id,'') AS state_province_id,
405 IFNULL(country_id,'') as country_id,IFNULL(iso_code,'') as country_iso, IFNULL(civicrm_country.name,'') as country
406 FROM (civicrm_activity a, civicrm_survey, civicrm_contact )
407 LEFT JOIN civicrm_activity_contact ac ON ( ac.activity_id = a.id AND ac.record_type_id = %3 )
408 LEFT JOIN civicrm_address ON civicrm_address.contact_id = civicrm_contact.id AND civicrm_address.is_primary = 1
409 LEFT JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id
411 ac.contact_id = civicrm_contact.id AND
412 a.activity_type_id = civicrm_survey.activity_type_id AND
413 civicrm_survey.id = %1 AND
414 a.source_record_id = %1 ";
416 $params = array(1 => array($surveyId, 'Integer'));
419 $sql .= " AND status_id = %2";
420 $params[2] = array($status_id, 'Integer');
422 $sql .= " ORDER BY a.activity_date_time";
424 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
425 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
426 $params[3] = array($sourceID, 'Integer');
432 'activity_date_time',
445 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
446 while ($dao->fetch()) {
448 foreach ($fields as $field) {
449 $row[$field] = $dao->$field;
457 * This function returns all entities assigned to a specific tag
460 * An object of a tag.
463 * array of contact ids
465 public function getEntitiesByTag($tag) {
466 $contactIds = array();
467 $entityTagDAO = new CRM_Core_DAO_EntityTag();
468 $entityTagDAO->tag_id
= $tag['id'];
469 $entityTagDAO->find();
471 while ($entityTagDAO->fetch()) {
472 $contactIds[] = $entityTagDAO->entity_id
;
478 * Check if contact has signed this petition
480 * @param int $surveyId
481 * @param int $contactId
485 public static function checkSignature($surveyId, $contactId) {
487 $surveyInfo = CRM_Campaign_BAO_Petition
::getSurveyInfo($surveyId);
488 $signature = array();
489 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
490 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
494 a.source_record_id AS source_record_id,
495 ac.contact_id AS source_contact_id,
496 a.activity_date_time AS activity_date_time,
497 a.activity_type_id AS activity_type_id,
498 a.status_id AS status_id,
500 FROM civicrm_activity a
501 INNER JOIN civicrm_activity_contact ac ON (ac.activity_id = a.id AND ac.record_type_id = %5)
502 WHERE a.source_record_id = %2
503 AND a.activity_type_id = %3
504 AND ac.contact_id = %4
507 1 => array($surveyInfo['title'], 'String'),
508 2 => array($surveyId, 'Integer'),
509 3 => array($surveyInfo['activity_type_id'], 'Integer'),
510 4 => array($contactId, 'Integer'),
511 5 => array($sourceID, 'Integer'),
514 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
515 while ($dao->fetch()) {
516 $signature[$dao->id
]['id'] = $dao->id
;
517 $signature[$dao->id
]['source_record_id'] = $dao->source_record_id
;
518 $signature[$dao->id
]['source_contact_id'] = CRM_Contact_BAO_Contact
::displayName($dao->source_contact_id
);
519 $signature[$dao->id
]['activity_date_time'] = $dao->activity_date_time
;
520 $signature[$dao->id
]['activity_type_id'] = $dao->activity_type_id
;
521 $signature[$dao->id
]['status_id'] = $dao->status_id
;
522 $signature[$dao->id
]['survey_title'] = $dao->survey_title
;
523 $signature[$dao->id
]['contactId'] = $dao->source_contact_id
;
530 * Takes an associative array and sends a thank you or email verification email
532 * @param array $params
533 * (reference ) an assoc array of name/value pairs.
535 * @param $sendEmailMode
540 public static function sendEmail($params, $sendEmailMode) {
543 * CRM_Campaign_Form_Petition_Signature::EMAIL_THANK
544 * connected user via login/pwd - thank you
545 * or dedupe contact matched who doesn't have a tag CIVICRM_TAG_UNCONFIRMED - thank you
546 * or login using fb connect - thank you + click to add msg to fb wall
548 * CRM_Campaign_Form_Petition_Signature::EMAIL_CONFIRM
549 * send a confirmation request email
552 // check if the group defined by CIVICRM_PETITION_CONTACTS exists, else create it
553 $petitionGroupName = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
559 $dao = new CRM_Contact_DAO_Group();
560 $dao->title
= $petitionGroupName;
561 if (!$dao->find(TRUE)) {
563 $dao->visibility
= 'User and User Admin Only';
566 $group_id = $dao->id
;
569 $petitionParams['id'] = $params['sid'];
570 $petitionInfo = array();
571 CRM_Campaign_BAO_Survey
::retrieve($petitionParams, $petitionInfo);
572 if (empty($petitionInfo)) {
573 CRM_Core_Error
::fatal('Petition doesn\'t exist.');
576 //get the default domain email address.
577 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain
::getNameAndEmail();
579 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
581 $toName = CRM_Contact_BAO_Contact
::displayName($params['contactId']);
583 $replyTo = "do-not-reply@$emailDomain";
585 // set additional general message template params (custom tokens to use in email msg templates)
586 // tokens then available in msg template as {$petition.title}, etc
587 $petitionTokens['title'] = $petitionInfo['title'];
588 $petitionTokens['petitionId'] = $params['sid'];
589 $tplParams['petition'] = $petitionTokens;
591 switch ($sendEmailMode) {
592 case CRM_Campaign_Form_Petition_Signature
::EMAIL_THANK
:
594 // add this contact to the CIVICRM_PETITION_CONTACTS group
595 // Cannot pass parameter 1 by reference
596 $p = array($params['contactId']);
597 CRM_Contact_BAO_GroupContact
::addContactsToGroup($p, $group_id, 'API');
599 if ($params['email-Primary']) {
600 CRM_Core_BAO_MessageTemplate
::sendTemplate(
602 'groupName' => 'msg_tpl_workflow_petition',
603 'valueName' => 'petition_sign',
604 'contactId' => $params['contactId'],
605 'tplParams' => $tplParams,
606 'from' => "\"{$domainEmailName}\" <{$domainEmailAddress}>",
608 'toEmail' => $params['email-Primary'],
609 'replyTo' => $replyTo,
610 'petitionId' => $params['sid'],
611 'petitionTitle' => $petitionInfo['title'],
617 case CRM_Campaign_Form_Petition_Signature
::EMAIL_CONFIRM
:
618 // create mailing event subscription record for this contact
619 // this will allow using a hash key to confirm email address by sending a url link
620 $se = CRM_Mailing_Event_BAO_Subscribe
::subscribe($group_id,
621 $params['email-Primary'],
622 $params['contactId'],
626 // require_once 'CRM/Core/BAO/Domain.php';
627 // $domain = CRM_Core_BAO_Domain::getDomain();
628 $config = CRM_Core_Config
::singleton();
629 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
631 $replyTo = implode($config->verpSeparator
,
641 $confirmUrl = CRM_Utils_System
::url('civicrm/petition/confirm',
642 "reset=1&cid={$se->contact_id}&sid={$se->id}&h={$se->hash}&a={$params['activityId']}&pid={$params['sid']}",
645 $confirmUrlPlainText = CRM_Utils_System
::url('civicrm/petition/confirm',
646 "reset=1&cid={$se->contact_id}&sid={$se->id}&h={$se->hash}&a={$params['activityId']}&pid={$params['sid']}",
652 // set email specific message template params and assign to tplParams
653 $petitionTokens['confirmUrl'] = $confirmUrl;
654 $petitionTokens['confirmUrlPlainText'] = $confirmUrlPlainText;
655 $tplParams['petition'] = $petitionTokens;
657 if ($params['email-Primary']) {
658 CRM_Core_BAO_MessageTemplate
::sendTemplate(
660 'groupName' => 'msg_tpl_workflow_petition',
661 'valueName' => 'petition_confirmation_needed',
662 'contactId' => $params['contactId'],
663 'tplParams' => $tplParams,
664 'from' => "\"{$domainEmailName}\" <{$domainEmailAddress}>",
666 'toEmail' => $params['email-Primary'],
667 'replyTo' => $replyTo,
668 'petitionId' => $params['sid'],
669 'petitionTitle' => $petitionInfo['title'],
670 'confirmUrl' => $confirmUrl,