3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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
{
36 function __construct() {
37 parent
::__construct();
38 // expire cookie in one day
39 $this->cookieExpire
= (1 * 60 * 60 * 24);
43 * Function to get Petition Details for dashboard.
47 static function getPetitionSummary($params = array(), $onlyCount = FALSE) {
48 //build the limit and order clause.
49 $limitClause = $orderByClause = $lookupTableJoins = NULL;
52 'sort' => 'created_date',
55 'sortOrder' => 'desc',
57 foreach ($sortParams as $name => $default) {
58 if (!empty($params[$name])) {
59 $sortParams[$name] = $params[$name];
63 //need to lookup tables.
64 $orderOnPetitionTable = TRUE;
65 if ($sortParams['sort'] == 'campaign') {
66 $orderOnPetitionTable = FALSE;
68 LEFT JOIN civicrm_campaign campaign ON ( campaign.id = petition.campaign_id )';
69 $orderByClause = "ORDER BY campaign.title {$sortParams['sortOrder']}";
71 elseif ($sortParams['sort'] == 'activity_type') {
72 $orderOnPetitionTable = FALSE;
74 LEFT JOIN civicrm_option_value activity_type ON ( activity_type.value = petition.activity_type_id
75 OR petition.activity_type_id IS NULL )
76 INNER JOIN civicrm_option_group grp ON ( activity_type.option_group_id = grp.id AND grp.name = 'activity_type' )";
77 $orderByClause = "ORDER BY activity_type.label {$sortParams['sortOrder']}";
79 elseif ($sortParams['sort'] == 'isActive') {
80 $sortParams['sort'] = 'is_active';
82 if ($orderOnPetitionTable) {
83 $orderByClause = "ORDER BY petition.{$sortParams['sort']} {$sortParams['sortOrder']}";
85 $limitClause = "LIMIT {$sortParams['offset']}, {$sortParams['rowCount']}";
88 //build the where clause.
89 $queryParams = $where = array();
91 //we only have activity type as a
92 //difference between survey and petition.
93 $petitionTypeID = CRM_Core_OptionGroup
::getValue('activity_type', 'petition', 'name');
94 if ($petitionTypeID) {
95 $where[] = "( petition.activity_type_id = %1 )";
96 $queryParams[1] = array($petitionTypeID, 'Positive');
98 if (!empty($params['title'])) {
99 $where[] = "( petition.title LIKE %2 )";
100 $queryParams[2] = array('%' . trim($params['title']) . '%', 'String');
102 if (!empty($params['campaign_id'])) {
103 $where[] = '( petition.campaign_id = %3 )';
104 $queryParams[3] = array($params['campaign_id'], 'Positive');
107 if (!empty($where)) {
108 $whereClause = ' WHERE ' . implode(" \nAND ", $where);
112 SELECT petition.id as id,
113 petition.title as title,
114 petition.is_active as is_active,
115 petition.result_id as result_id,
116 petition.is_default as is_default,
117 petition.campaign_id as campaign_id,
118 petition.activity_type_id as activity_type_id';
121 $selectClause = 'SELECT COUNT(*)';
123 $fromClause = 'FROM civicrm_survey petition';
125 $query = "{$selectClause} {$fromClause} {$whereClause} {$orderByClause} {$limitClause}";
128 return (int) CRM_Core_DAO
::singleValueQuery($query, $queryParams);
131 $petitions = array();
142 $petition = CRM_Core_DAO
::executeQuery($query, $queryParams);
143 while ($petition->fetch()) {
144 foreach ($properties as $property) {
145 $petitions[$petition->id
][$property] = $petition->$property;
153 * Get the petition count.
157 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 (reference ) an assoc array of name/value pairs
175 * @return object CRM_Campaign_BAO_Petition
179 function createSignature(&$params) {
180 if (empty($params)) {
184 if (!isset($params['sid'])) {
185 $statusMsg = ts('No survey sid parameter. Cannot process signature.');
186 CRM_Core_Session
::setStatus($statusMsg, ts('Sorry'), 'error');
190 if (isset($params['contactId'])) {
192 // add signature as activity with survey id as source id
193 // get the activity type id associated with this survey
194 $surveyInfo = CRM_Campaign_BAO_Petition
::getSurveyInfo($params['sid']);
197 // 1-Schedule, 2-Completed
199 $activityParams = array(
200 'source_contact_id' => $params['contactId'],
201 'target_contact_id' => $params['contactId'],
202 'source_record_id' => $params['sid'],
203 'subject' => $surveyInfo['title'],
204 'activity_type_id' => $surveyInfo['activity_type_id'],
205 'activity_date_time' => date("YmdHis"),
206 'status_id' => $params['statusId'],
207 'activity_campaign_id' => $params['activity_campaign_id'],
211 // *** check for activity using source id - if already signed
212 $activity = CRM_Activity_BAO_Activity
::create($activityParams);
214 // save activity custom data
215 if (!empty($params['custom']) &&
216 is_array($params['custom'])
218 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_activity', $activity->id
);
221 // set permanent cookie to indicate this petition already signed on the computer
222 setcookie('signed_' . $params['sid'], $activity->id
, time() +
$this->cookieExpire
, '/');
228 function confirmSignature($activity_id, $contact_id, $petition_id) {
229 // change activity status to completed (status_id = 2)
230 // I wonder why do we need contact_id when we have activity_id anyway? [chastell]
231 $sql = 'UPDATE civicrm_activity SET status_id = 2 WHERE id = %1';
232 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
233 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
235 1 => array($activity_id, 'Integer'),
236 2 => array($contact_id, 'Integer'),
237 3 => array($sourceID, 'Integer')
239 CRM_Core_DAO
::executeQuery($sql, $params);
241 $sql = 'UPDATE civicrm_activity_contact SET contact_id = %2 WHERE activity_id = %1 AND record_type_id = %3';
242 CRM_Core_DAO
::executeQuery($sql, $params);
243 // remove 'Unconfirmed' tag for this contact
244 $tag_name = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
251 DELETE FROM civicrm_entity_tag
252 WHERE entity_table = 'civicrm_contact'
254 AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )";
256 1 => array($contact_id, 'Integer'),
257 2 => array($tag_name, 'String'),
259 CRM_Core_DAO
::executeQuery($sql, $params);
261 // set permanent cookie to indicate this users email address now confirmed
262 setcookie("confirmed_{$petition_id}",
264 time() +
$this->cookieExpire
,
272 * Function to get Petition Signature Total
274 * @param boolean $all
278 static function getPetitionSignatureTotalbyCountry($surveyId) {
279 $countries = array();
281 SELECT count(civicrm_address.country_id) as total,
282 IFNULL(country_id,'') as country_id,IFNULL(iso_code,'') as country_iso, IFNULL(civicrm_country.name,'') as country
283 FROM ( civicrm_activity a, civicrm_survey, civicrm_contact )
284 LEFT JOIN civicrm_address ON civicrm_address.contact_id = civicrm_contact.id AND civicrm_address.is_primary = 1
285 LEFT JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id
286 LEFT JOIN civicrm_activity_contact ac ON ( ac.activity_id = a.id AND ac.record_type_id = %2 )
288 ac.contact_id = civicrm_contact.id AND
289 a.activity_type_id = civicrm_survey.activity_type_id AND
290 civicrm_survey.id = %1 AND
291 a.source_record_id = %1 ";
293 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
294 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
296 1 => array($surveyId, 'Integer'),
297 2 => array($sourceID, 'Integer')
299 $sql .= " GROUP BY civicrm_address.country_id";
300 $fields = array('total', 'country_id', 'country_iso', 'country');
302 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
303 while ($dao->fetch()) {
305 foreach ($fields as $field) {
306 $row[$field] = $dao->$field;
314 * Function to get Petition Signature Total
316 * @param boolean $all
320 static function getPetitionSignatureTotal($surveyId) {
321 $surveyInfo = CRM_Campaign_BAO_Petition
::getSurveyInfo((int) $surveyId);
322 //$activityTypeID = $surveyInfo['activity_type_id'];
325 status_id,count(id) as total
326 FROM civicrm_activity
328 source_record_id = " . (int) $surveyId . " AND activity_type_id = " . (int) $surveyInfo['activity_type_id'] . " GROUP BY status_id";
330 $statusTotal = array();
332 $dao = CRM_Core_DAO
::executeQuery($sql);
333 while ($dao->fetch()) {
334 $total +
= $dao->total
;
335 $statusTotal['status'][$dao->status_id
] = $dao->total
;
337 $statusTotal['count'] = $total;
342 public static function getSurveyInfo($surveyId = NULL) {
343 $surveyInfo = array();
346 SELECT activity_type_id,
349 ov.label AS activity_type
350 FROM civicrm_survey s, civicrm_option_value ov, civicrm_option_group og
351 WHERE s.id = " . (int) $surveyId . "
352 AND s.activity_type_id = ov.value
353 AND ov.option_group_id = og.id
354 AND og.name = 'activity_type'";
356 $dao = CRM_Core_DAO
::executeQuery($sql);
357 while ($dao->fetch()) {
358 //$survey['campaign_id'] = $dao->campaign_id;
359 //$survey['campaign_name'] = $dao->campaign_name;
360 $surveyInfo['activity_type'] = $dao->activity_type
;
361 $surveyInfo['activity_type_id'] = $dao->activity_type_id
;
362 $surveyInfo['title'] = $dao->title
;
369 * Function to get Petition Signature Details
371 * @param boolean $all
375 static function getPetitionSignature($surveyId, $status_id = NULL) {
377 // sql injection protection
378 $surveyId = (int) $surveyId;
379 $signature = array();
383 a.source_record_id as survey_id,
384 a.activity_date_time,
386 civicrm_contact.id as contact_id,
387 civicrm_contact.contact_type,civicrm_contact.contact_sub_type,image_URL,
388 first_name,last_name,sort_name,
389 employer_id,organization_name,
391 IFNULL(gender_id,'') AS gender_id,
392 IFNULL(state_province_id,'') AS state_province_id,
393 IFNULL(country_id,'') as country_id,IFNULL(iso_code,'') as country_iso, IFNULL(civicrm_country.name,'') as country
394 FROM (civicrm_activity a, civicrm_survey, civicrm_contact )
395 LEFT JOIN civicrm_activity_contact ac ON ( ac.activity_id = a.id AND ac.record_type_id = %3 )
396 LEFT JOIN civicrm_address ON civicrm_address.contact_id = civicrm_contact.id AND civicrm_address.is_primary = 1
397 LEFT JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id
399 ac.contact_id = civicrm_contact.id AND
400 a.activity_type_id = civicrm_survey.activity_type_id AND
401 civicrm_survey.id = %1 AND
402 a.source_record_id = %1 ";
404 $params = array(1 => array($surveyId, 'Integer'));
407 $sql .= " AND status_id = %2";
408 $params[2] = array($status_id, 'Integer');
410 $sql .= " ORDER BY a.activity_date_time";
412 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
413 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
414 $params[3] = array($sourceID, 'Integer');
420 'activity_date_time',
433 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
434 while ($dao->fetch()) {
436 foreach ($fields as $field) {
437 $row[$field] = $dao->$field;
445 * This function returns all entities assigned to a specific tag
447 * @param object $tag an object of a tag.
449 * @return array $contactIds array of contact ids
452 function getEntitiesByTag($tag) {
453 $contactIds = array();
454 $entityTagDAO = new CRM_Core_DAO_EntityTag();
455 $entityTagDAO->tag_id
= $tag['id'];
456 $entityTagDAO->find();
458 while ($entityTagDAO->fetch()) {
459 $contactIds[] = $entityTagDAO->entity_id
;
465 * Function to check if contact has signed this petition
467 * @param int $surveyId
468 * @param int $contactId
471 static function checkSignature($surveyId, $contactId) {
473 $surveyInfo = CRM_Campaign_BAO_Petition
::getSurveyInfo($surveyId);
474 $signature = array();
475 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
476 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
480 a.source_record_id AS source_record_id,
481 ac.contact_id AS source_contact_id,
482 a.activity_date_time AS activity_date_time,
483 a.activity_type_id AS activity_type_id,
484 a.status_id AS status_id,
486 FROM civicrm_activity a
487 INNER JOIN civicrm_activity_contact ac ON (ac.activity_id = a.id AND ac.record_type_id = %5)
488 WHERE a.source_record_id = %2
489 AND a.activity_type_id = %3
490 AND ac.contact_id = %4
493 1 => array($surveyInfo['title'], 'String'),
494 2 => array($surveyId, 'Integer'),
495 3 => array($surveyInfo['activity_type_id'], 'Integer'),
496 4 => array($contactId, 'Integer'),
497 5 => array($sourceID, 'Integer')
500 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
501 while ($dao->fetch()) {
502 $signature[$dao->id
]['id'] = $dao->id
;
503 $signature[$dao->id
]['source_record_id'] = $dao->source_record_id
;
504 $signature[$dao->id
]['source_contact_id'] = CRM_Contact_BAO_Contact
::displayName($dao->source_contact_id
);
505 $signature[$dao->id
]['activity_date_time'] = $dao->activity_date_time
;
506 $signature[$dao->id
]['activity_type_id'] = $dao->activity_type_id
;
507 $signature[$dao->id
]['status_id'] = $dao->status_id
;
508 $signature[$dao->id
]['survey_title'] = $dao->survey_title
;
509 $signature[$dao->id
]['contactId'] = $dao->source_contact_id
;
516 * takes an associative array and sends a thank you or email verification email
518 * @param array $params (reference ) an assoc array of name/value pairs
524 public static function sendEmail($params, $sendEmailMode) {
527 * CRM_Campaign_Form_Petition_Signature::EMAIL_THANK
528 * connected user via login/pwd - thank you
529 * or dedupe contact matched who doesn't have a tag CIVICRM_TAG_UNCONFIRMED - thank you
530 * or login using fb connect - thank you + click to add msg to fb wall
532 * CRM_Campaign_Form_Petition_Signature::EMAIL_CONFIRM
533 * send a confirmation request email
536 // check if the group defined by CIVICRM_PETITION_CONTACTS exists, else create it
537 $petitionGroupName = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
543 $dao = new CRM_Contact_DAO_Group();
544 $dao->title
= $petitionGroupName;
545 if (!$dao->find(TRUE)) {
547 $dao->visibility
= 'User and User Admin Only';
550 $group_id = $dao->id
;
553 $petitionParams['id'] = $params['sid'];
554 $petitionInfo = array();
555 CRM_Campaign_BAO_Survey
::retrieve($petitionParams, $petitionInfo);
556 if (empty($petitionInfo)) {
557 CRM_Core_Error
::fatal('Petition doesn\'t exist.');
560 //get the default domain email address.
561 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain
::getNameAndEmail();
563 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
565 $toName = CRM_Contact_BAO_Contact
::displayName($params['contactId']);
567 $replyTo = "do-not-reply@$emailDomain";
569 // set additional general message template params (custom tokens to use in email msg templates)
570 // tokens then available in msg template as {$petition.title}, etc
571 $petitionTokens['title'] = $petitionInfo['title'];
572 $petitionTokens['petitionId'] = $params['sid'];
573 $tplParams['petition'] = $petitionTokens;
575 switch ($sendEmailMode) {
576 case CRM_Campaign_Form_Petition_Signature
::EMAIL_THANK
:
578 // add this contact to the CIVICRM_PETITION_CONTACTS group
579 // Cannot pass parameter 1 by reference
580 $p = array($params['contactId']);
581 CRM_Contact_BAO_GroupContact
::addContactsToGroup($p, $group_id, 'API');
583 if ($params['email-Primary']) {
584 CRM_Core_BAO_MessageTemplate
::sendTemplate(
586 'groupName' => 'msg_tpl_workflow_petition',
587 'valueName' => 'petition_sign',
588 'contactId' => $params['contactId'],
589 'tplParams' => $tplParams,
590 'from' => "\"{$domainEmailName}\" <{$domainEmailAddress}>",
592 'toEmail' => $params['email-Primary'],
593 'replyTo' => $replyTo,
594 'petitionId' => $params['sid'],
595 'petitionTitle' => $petitionInfo['title'],
601 case CRM_Campaign_Form_Petition_Signature
::EMAIL_CONFIRM
:
602 // create mailing event subscription record for this contact
603 // this will allow using a hash key to confirm email address by sending a url link
604 $se = CRM_Mailing_Event_BAO_Subscribe
::subscribe($group_id,
605 $params['email-Primary'],
606 $params['contactId'],
610 // require_once 'CRM/Core/BAO/Domain.php';
611 // $domain = CRM_Core_BAO_Domain::getDomain();
612 $config = CRM_Core_Config
::singleton();
613 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
615 $replyTo = implode($config->verpSeparator
,
625 $confirmUrl = CRM_Utils_System
::url('civicrm/petition/confirm',
626 "reset=1&cid={$se->contact_id}&sid={$se->id}&h={$se->hash}&a={$params['activityId']}&p={$params['sid']}",
629 $confirmUrlPlainText = CRM_Utils_System
::url('civicrm/petition/confirm',
630 "reset=1&cid={$se->contact_id}&sid={$se->id}&h={$se->hash}&a={$params['activityId']}&p={$params['sid']}",
636 // set email specific message template params and assign to tplParams
637 $petitionTokens['confirmUrl'] = $confirmUrl;
638 $petitionTokens['confirmUrlPlainText'] = $confirmUrlPlainText;
639 $tplParams['petition'] = $petitionTokens;
641 if ($params['email-Primary']) {
642 CRM_Core_BAO_MessageTemplate
::sendTemplate(
644 'groupName' => 'msg_tpl_workflow_petition',
645 'valueName' => 'petition_confirmation_needed',
646 'contactId' => $params['contactId'],
647 'tplParams' => $tplParams,
648 'from' => "\"{$domainEmailName}\" <{$domainEmailAddress}>",
650 'toEmail' => $params['email-Primary'],
651 'replyTo' => $replyTo,
652 'petitionId' => $params['sid'],
653 'petitionTitle' => $petitionInfo['title'],
654 'confirmUrl' => $confirmUrl,