CRM/PCP/BAO/PCP.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP {
  36
  37   /**
  38    * The action links that we need to display for the browse screen
  39    *
  40    * @var array
  41    * @static
  42    */
  43   static $_pcpLinks = NULL;
  44
  45   /**
  46    *
  47    */
  48   function __construct() {
  49     parent::__construct();
  50   }
  51
  52   /**
  53    * function to add or update either a Personal Campaign Page OR a PCP Block
  54    *
  55    * @param array $params reference array contains the values submitted by the form
  56    * @param bool $pcpBlock if true, create or update PCPBlock, else PCP
  57    * @access public
  58    * @static
  59    *
  60    * @return object
  61    */
  62   static function add(&$params, $pcpBlock = TRUE) {
  63     if ($pcpBlock) {
  64       // action is taken depending upon the mode
  65       $dao = new CRM_PCP_DAO_PCPBlock();
  66       $dao->copyValues($params);
  67       $dao->save();
  68       return $dao;
  69     }
  70
  71     $dao = new CRM_PCP_DAO_PCP();
  72     $dao->copyValues($params);
  73
  74     // ensure we set status_id since it is a not null field
  75     // we should change the schema and allow this to be null
  76     if (!$dao->id && !isset($dao->status_id)) {
  77       $dao->status_id = 0;
  78     }
  79
  80     // set currency for CRM-1496
  81     if (!isset($dao->currency)) {
  82       $config = & CRM_Core_Config::singleton();
  83       $dao->currency = $config->defaultCurrency;
  84     }
  85
  86     $dao->save();
  87     return $dao;
  88   }
  89
  90   /**
  91    * function to get the Display  name of a contact for a PCP
  92    *
  93    * @param  int $id      id for the PCP
  94    *
  95    * @return null|string     Dispaly name of the contact if found
  96    * @static
  97    * @access public
  98    */
  99   static function displayName($id) {
 100     $id = CRM_Utils_Type::escape($id, 'Integer');
 101
 102     $query = "
 103 SELECT civicrm_contact.display_name
 104 FROM   civicrm_pcp, civicrm_contact
 105 WHERE  civicrm_pcp.contact_id = civicrm_contact.id
 106   AND  civicrm_pcp.id = {$id}
 107 ";
 108     return CRM_Core_DAO::singleValueQuery($query, CRM_Core_DAO::$_nullArray);
 109   }
 110
 111   /**
 112    * Function to return PCP  Block info for dashboard
 113    *
 114    * @param $contactId
 115    *
 116    * @return array     array of Pcp if found
 117    * @access public
 118    * @static
 119    */
 120   static function getPcpDashboardInfo($contactId) {
 121     $links = self::pcpLinks();
 122
 123     $query = "
 124 SELECT * FROM civicrm_pcp pcp
 125 WHERE pcp.is_active = 1
 126   AND pcp.contact_id = %1
 127 ORDER BY page_type, page_id";
 128
 129     $params = array(1 => array($contactId, 'Integer'));
 130
 131     $pcpInfoDao = CRM_Core_DAO::executeQuery($query, $params);
 132     $pcpInfo = array();
 133     $hide = $mask = array_sum(array_keys($links['all']));
 134     $contactPCPPages = array();
 135
 136     $event = CRM_Event_PseudoConstant::event(NULL, FALSE, "( is_template IS NULL OR is_template != 1 )");
 137     $contribute = CRM_Contribute_PseudoConstant::contributionPage();
 138     $pcpStatus = CRM_Contribute_PseudoConstant::pcpStatus();
 139     $approved = CRM_Utils_Array::key('Approved', $pcpStatus);
 140
 141     while ($pcpInfoDao->fetch()) {
 142       $mask = $hide;
 143       if ($links) {
 144         $replace = array(
 145           'pcpId' => $pcpInfoDao->id,
 146           'pcpBlock' => $pcpInfoDao->pcp_block_id,
 147           'pageComponent' => $pcpInfoDao->page_type,
 148         );
 149       }
 150
 151       $pcpLink = $links['all'];
 152       $class = '';
 153
 154       if ($pcpInfoDao->status_id != $approved || $pcpInfoDao->is_active != 1) {
 155         $class = 'disabled';
 156         if (!$pcpInfoDao->tellfriend) {
 157           $mask -= CRM_Core_Action::DETACH;
 158         }
 159       }
 160
 161       if ($pcpInfoDao->is_active == 1) {
 162         $mask -= CRM_Core_Action::ENABLE;
 163       }
 164       else {
 165         $mask -= CRM_Core_Action::DISABLE;
 166       }
 167       $action = CRM_Core_Action::formLink($pcpLink, $mask, $replace, ts('more'),
 168         FALSE, 'pcp.dashboard.active', 'PCP', $pcpInfoDao->id);
 169       $component = $pcpInfoDao->page_type;
 170       $pageTitle = CRM_Utils_Array::value($pcpInfoDao->page_id, $$component);
 171
 172       $pcpInfo[] = array(
 173         'pageTitle' => $pageTitle,
 174         'pcpId' => $pcpInfoDao->id,
 175         'pcpTitle' => $pcpInfoDao->title,
 176         'pcpStatus' => $pcpStatus[$pcpInfoDao->status_id],
 177         'action' => $action,
 178         'class' => $class,
 179       );
 180       $contactPCPPages[$pcpInfoDao->page_type][] = $pcpInfoDao->page_id;
 181     }
 182
 183     $excludePageClause = $clause = NULL;
 184     if (!empty($contactPCPPages)) {
 185       foreach ($contactPCPPages as $component => $entityIds) {
 186         $excludePageClause[] = "
 187 ( target_entity_type = '{$component}'
 188 AND target_entity_id NOT IN ( " . implode(',', $entityIds) . ") )";
 189       }
 190
 191       $clause = ' AND ' . implode(' OR ', $excludePageClause);
 192     }
 193
 194     $query = "
 195 SELECT *
 196 FROM civicrm_pcp_block block
 197 LEFT JOIN civicrm_pcp pcp ON pcp.pcp_block_id = block.id
 198 WHERE block.is_active = 1
 199 {$clause}
 200 GROUP BY block.id
 201 ORDER BY target_entity_type, target_entity_id
 202 ";
 203     $pcpBlockDao = CRM_Core_DAO::executeQuery($query);
 204     $pcpBlock = array();
 205     $mask = 0;
 206
 207     while ($pcpBlockDao->fetch()) {
 208       if ($links) {
 209         $replace = array(
 210           'pageId' => $pcpBlockDao->target_entity_id,
 211           'pageComponent' => $pcpBlockDao->target_entity_type,
 212         );
 213       }
 214       $pcpLink = $links['add'];
 215       $action = CRM_Core_Action::formLink($pcpLink, $mask, $replace, ts('more'),
 216         FALSE, 'pcp.dashboard.other', "{$pcpBlockDao->target_entity_type}_PCP", $pcpBlockDao->target_entity_id);
 217       $component = $pcpBlockDao->target_entity_type;
 218       $pageTitle = CRM_Utils_Array::value($pcpBlockDao->target_entity_id, $$component);
 219       $pcpBlock[] = array(
 220         'pageId' => $pcpBlockDao->target_entity_id,
 221         'pageTitle' => $pageTitle,
 222         'action' => $action,
 223       );
 224     }
 225
 226     return array($pcpBlock, $pcpInfo);
 227   }
 228
 229   /**
 230    * function to show the total amount for Personal Campaign Page on thermometer
 231    *
 232    * @param array $pcpId  contains the pcp ID
 233    *
 234    * @access public
 235    * @static
 236    *
 237    * @return total amount
 238    */
 239   static function thermoMeter($pcpId) {
 240     $query = "
 241 SELECT SUM(cc.total_amount) as total
 242 FROM civicrm_pcp pcp
 243 LEFT JOIN civicrm_contribution_soft cs ON ( pcp.id = cs.pcp_id )
 244 LEFT JOIN civicrm_contribution cc ON ( cs.contribution_id = cc.id)
 245 WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
 246
 247     $params = array(1 => array($pcpId, 'Integer'));
 248     return CRM_Core_DAO::singleValueQuery($query, $params);
 249   }
 250
 251   /**
 252    * function to show the amount, nickname on honor roll
 253    *
 254    * @param array $pcpId contains the pcp ID
 255    *
 256    * @access public
 257    * @static
 258    *
 259    * @return array $honor
 260    */
 261   static function honorRoll($pcpId) {
 262     $query = "
 263             SELECT cc.id, cs.pcp_roll_nickname, cs.pcp_personal_note,
 264                    cc.total_amount, cc.currency
 265             FROM civicrm_contribution cc
 266                  LEFT JOIN civicrm_contribution_soft cs ON cc.id = cs.contribution_id
 267             WHERE cs.pcp_id = {$pcpId}
 268                   AND cs.pcp_display_in_roll = 1
 269                   AND contribution_status_id = 1
 270                   AND is_test = 0";
 271     $dao = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
 272     $honor = array();
 273     while ($dao->fetch()) {
 274       $honor[$dao->id]['nickname'] = ucwords($dao->pcp_roll_nickname);
 275       $honor[$dao->id]['total_amount'] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
 276       $honor[$dao->id]['personal_note'] = $dao->pcp_personal_note;
 277     }
 278     return $honor;
 279   }
 280
 281   /**
 282    * Get action links
 283    *
 284    * @return array (reference) of action links
 285    * @static
 286    */
 287   static function &pcpLinks() {
 288     if (!(self::$_pcpLinks)) {
 289       $deleteExtra = ts('Are you sure you want to delete this Personal Campaign Page?') . '\n' . ts('This action cannot be undone.');
 290
 291       self::$_pcpLinks['add'] = array(
 292         CRM_Core_Action::ADD => array(
 293           'name' => ts('Create a Personal Campaign Page'),
 294           'class' => 'no-popup',
 295           'url' => 'civicrm/contribute/campaign',
 296           'qs' => 'action=add&reset=1&pageId=%%pageId%%&component=%%pageComponent%%',
 297           'title' => ts('Configure'),
 298         ),
 299       );
 300
 301       self::$_pcpLinks['all'] = array(
 302         CRM_Core_Action::UPDATE => array(
 303           'name' => ts('Edit Your Page'),
 304           'url' => 'civicrm/pcp/info',
 305           'qs' => 'action=update&reset=1&id=%%pcpId%%&component=%%pageComponent%%',
 306           'title' => ts('Configure'),
 307         ),
 308         CRM_Core_Action::DETACH => array(
 309           'name' => ts('Tell Friends'),
 310           'url' => 'civicrm/friend',
 311           'qs' => 'eid=%%pcpId%%&blockId=%%pcpBlock%%&reset=1&pcomponent=pcp&component=%%pageComponent%%',
 312           'title' => ts('Tell Friends'),
 313         ),
 314         CRM_Core_Action::VIEW => array(
 315           'name' => ts('URL for this Page'),
 316           'url' => 'civicrm/pcp/info',
 317           'qs' => 'reset=1&id=%%pcpId%%&component=%%pageComponent%%',
 318           'title' => ts('URL for this Page'),
 319         ),
 320         CRM_Core_Action::BROWSE => array(
 321           'name' => ts('Update Contact Information'),
 322           'url' => 'civicrm/pcp/info',
 323           'qs' => 'action=browse&reset=1&id=%%pcpId%%&component=%%pageComponent%%',
 324           'title' => ts('Update Contact Information'),
 325         ),
 326         CRM_Core_Action::ENABLE => array(
 327           'name' => ts('Enable'),
 328           'url' => 'civicrm/pcp',
 329           'qs' => 'action=enable&reset=1&id=%%pcpId%%&component=%%pageComponent%%',
 330           'title' => ts('Enable'),
 331         ),
 332         CRM_Core_Action::DISABLE => array(
 333           'name' => ts('Disable'),
 334           'url' => 'civicrm/pcp',
 335           'qs' => 'action=disable&reset=1&id=%%pcpId%%&component=%%pageComponent%%',
 336           'title' => ts('Disable'),
 337         ),
 338         CRM_Core_Action::DELETE => array(
 339           'name' => ts('Delete'),
 340           'url' => 'civicrm/pcp',
 341           'qs' => 'action=delete&reset=1&id=%%pcpId%%&component=%%pageComponent%%',
 342           'extra' => 'onclick = "return confirm(\'' . $deleteExtra . '\');"',
 343           'title' => ts('Delete'),
 344         ),
 345       );
 346     }
 347     return self::$_pcpLinks;
 348   }
 349
 350   /**
 351    * Function to Delete the campaign page
 352    *
 353    * @param int $id campaign page id
 354    *
 355    * @return null
 356    * @access public
 357    * @static
 358    *
 359    */
 360   public static function deleteById($id) {
 361     CRM_Utils_Hook::pre('delete', 'Campaign', $id, CRM_Core_DAO::$_nullArray);
 362
 363     $transaction = new CRM_Core_Transaction();
 364
 365     // delete from pcp table
 366     $pcp = new CRM_PCP_DAO_PCP();
 367     $pcp->id = $id;
 368     $pcp->delete();
 369
 370     $transaction->commit();
 371
 372     CRM_Utils_Hook::post('delete', 'Campaign', $id, $pcp);
 373   }
 374
 375   /**
 376    * Function to build the form
 377    *
 378    * @param object $form form object
 379    *
 380    * @return void
 381    * @access public
 382    */
 383   public static function buildPCPForm($form) {
 384     $form->addElement('checkbox', 'pcp_active', ts('Enable Personal Campaign Pages?'), NULL, array('onclick' => "return showHideByValue('pcp_active',true,'pcpFields','block','radio',false);"));
 385
 386     $form->addElement('checkbox', 'is_approval_needed', ts('Approval required'));
 387
 388     $profile = array();
 389     $isUserRequired = NULL;
 390     $config = CRM_Core_Config::singleton();
 391     if ($config->userFramework != 'Standalone') {
 392       $isUserRequired = 2;
 393     }
 394     CRM_Core_DAO::commonRetrieveAll('CRM_Core_DAO_UFGroup', 'is_cms_user', $isUserRequired, $profiles, array(
 395       'title',
 396       'is_active'
 397     ));
 398     if (!empty($profiles)) {
 399       foreach ($profiles as $key => $value) {
 400         if ($value['is_active']) {
 401           $profile[$key] = $value['title'];
 402         }
 403       }
 404       $form->assign('profile', $profile);
 405     }
 406
 407     $form->add('select', 'supporter_profile_id', ts('Supporter profile'), array('' => ts('- select -')) + $profile, TRUE);
 408
 409     $form->addElement('checkbox', 'is_tellfriend_enabled', ts("Allow 'Tell a friend' functionality"), NULL, array('onclick' => "return showHideByValue('is_tellfriend_enabled',true,'tflimit','table-row','radio',false);"));
 410
 411     $form->add('text',
 412       'tellfriend_limit',
 413       ts("'Tell a friend' maximum recipients limit"),
 414       CRM_Core_DAO::getAttribute('CRM_PCP_DAO_PCPBlock', 'tellfriend_limit')
 415     );
 416     $form->addRule('tellfriend_limit', ts('Please enter a valid limit.'), 'integer');
 417
 418     $form->add('text',
 419       'link_text',
 420       ts("'Create Personal Campaign Page' link text"),
 421       CRM_Core_DAO::getAttribute('CRM_PCP_DAO_PCPBlock', 'link_text')
 422     );
 423
 424     $form->add('text', 'notify_email', ts('Notify Email'), CRM_Core_DAO::getAttribute('CRM_PCP_DAO_PCPBlock', 'notify_email'));
 425   }
 426
 427
 428   /*
 429    * Add PCP form elements to a form
 430    */
 431   /**
 432    * @param $pcpId
 433    * @param $page
 434    * @param null $elements
 435    */
 436   function buildPcp($pcpId, &$page, &$elements = NULL) {
 437
 438     $prms = array('id' => $pcpId);
 439     CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $prms, $pcpInfo);
 440     if ($pcpSupporter = CRM_PCP_BAO_PCP::displayName($pcpId)) {
 441       if ($pcpInfo['page_type'] == 'event') {
 442         $pcp_supporter_text = ts('This event registration is being made thanks to effort of <strong>%1</strong>, who supports our campaign. ', array(1 => $pcpSupporter));
 443         $text = CRM_PCP_BAO_PCP::getPcpBlockStatus($pcpInfo['page_id'], 'event');
 444         if(!empty($text)) {
 445           $pcp_supporter_text .= "You can support it as well - once you complete the registration, you will be able to create your own Personal Campaign Page!";
 446         }
 447       }
 448       else {
 449         $pcp_supporter_text = ts('This contribution is being made thanks to effort of <strong>%1</strong>, who supports our campaign. ', array(1 => $pcpSupporter));
 450         $text = CRM_PCP_BAO_PCP::getPcpBlockStatus($pcpInfo['page_id'], 'contribute');
 451         if(!empty($text)) {
 452           $pcp_supporter_text .= "You can support it as well - once you complete the donation, you will be able to create your own Personal Campaign Page!";
 453         }
 454       }
 455
 456       $page->assign('pcpSupporterText', $pcp_supporter_text);
 457     }
 458     $page->assign('pcp', TRUE);
 459
 460     // build honor roll fields for registration form if supporter has honor roll enabled for their PCP
 461     if ($pcpInfo['is_honor_roll']) {
 462       $page->assign('is_honor_roll', TRUE);
 463       $page->add('checkbox', 'pcp_display_in_roll', ts('Show my support in the public honor roll'), NULL, NULL,
 464         array('onclick' => "showHideByValue('pcp_display_in_roll','','nameID|nickID|personalNoteID','block','radio',false); pcpAnonymous( );")
 465       );
 466       $extraOption = array('onclick' => "return pcpAnonymous( );");
 467       $elements = array();
 468       $elements[] = & $page->createElement('radio', NULL, '', ts('Include my name and message'), 0, $extraOption);
 469       $elements[] = & $page->createElement('radio', NULL, '', ts('List my support anonymously'), 1, $extraOption);
 470       $page->addGroup($elements, 'pcp_is_anonymous', NULL, '&nbsp;&nbsp;&nbsp;');
 471       $page->_defaults['pcp_is_anonymous'] = 0;
 472
 473       $page->add('text', 'pcp_roll_nickname', ts('Name'), array('maxlength' => 30));
 474       $page->add('textarea', "pcp_personal_note", ts('Personal Note'), array('style' => 'height: 3em; width: 40em;'));
 475     }
 476     else {
 477       $page->assign('is_honor_roll', FALSE);
 478     }
 479   }
 480
 481   /*
 482    * Process a PCP contribution/
 483    */
 484   /**
 485    * @param $pcpId
 486    * @param $component
 487    * @param $entity
 488    *
 489    * @return array
 490    */
 491   public static function handlePcp($pcpId, $component, $entity) {
 492
 493     self::getPcpEntityTable($component);
 494
 495     if (!$pcpId) {
 496       return FALSE;
 497     }
 498
 499     $approvedId = CRM_Core_OptionGroup::getValue('pcp_status', 'Approved', 'name');
 500
 501     $pcpStatus = CRM_Core_OptionGroup::values("pcp_status");
 502
 503     $params = array('id' => $pcpId);
 504     CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo);
 505
 506     $params = array('id' => $pcpInfo['pcp_block_id']);
 507     CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCPBlock', $params, $pcpBlock);
 508
 509     $params = array('id' => $pcpInfo['page_id']);
 510     $now = time();
 511
 512     if ($component == 'event') {
 513       // figure out where to redirect if an exception occurs below based on target entity
 514       $urlBase = 'civicrm/event/register';
 515
 516       // ignore startDate for events - PCP's can be active long before event start date
 517       $startDate = 0;
 518       $endDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('end_date', $entity));
 519     }
 520     elseif ($component == 'contribute') {
 521       $urlBase = 'civicrm/contribute/transact';
 522       //start and end date of the contribution page
 523       $startDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('start_date', $entity));
 524       $endDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('end_date', $entity));
 525     }
 526
 527     // define redirect url back to contrib page or event if needed
 528     $url = CRM_Utils_System::url($urlBase, "reset=1&id={$pcpBlock['entity_id']}", FALSE, NULL, FALSE, TRUE );
 529
 530     if ($pcpBlock['target_entity_id'] != $entity['id']) {
 531       $statusMessage = ts('This page is not related to the Personal Campaign Page you have just visited. However you can still make a contribution here.');
 532       CRM_Core_Error::statusBounce($statusMessage, $url);
 533     }
 534     elseif ($pcpInfo['status_id'] != $approvedId) {
 535       $statusMessage = ts('The Personal Campaign Page you have just visited is currently %1. However you can still support the campaign here.', array(1 => $pcpStatus[$pcpInfo['status_id']]));
 536       CRM_Core_Error::statusBounce($statusMessage, $url);
 537     }
 538     elseif (empty($pcpBlock['is_active'])) {
 539       $statusMessage = ts('Personal Campaign Pages are currently not enabled for this contribution page. However you can still support the campaign here.');
 540       CRM_Core_Error::statusBounce($statusMessage, $url);
 541     }
 542     elseif (empty($pcpInfo['is_active'])) {
 543       $statusMessage = ts('The Personal Campaign Page you have just visited is currently inactive. However you can still support the campaign here.');
 544       CRM_Core_Error::statusBounce($statusMessage, $url);
 545     }
 546     // Check if we're in range for contribution page start and end dates. for events, check if after event end date
 547     elseif (($startDate && $startDate > $now) || ($endDate && $endDate < $now)) {
 548       $customStartDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('start_date', $entity));
 549       $customEndDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('end_date', $entity));
 550       if ($startDate && $endDate) {
 551         $statusMessage = ts('The Personal Campaign Page you have just visited is only active from %1 to %2. However you can still support the campaign here.',
 552           array(1 => $customStartDate, 2 => $customEndDate)
 553         );
 554         CRM_Core_Error::statusBounce($statusMessage, $url);
 555       }
 556       elseif ($startDate) {
 557         $statusMessage = ts('The Personal Campaign Page you have just visited will be active beginning on %1. However you can still support the campaign here.', array(1 => $customStartDate));
 558         CRM_Core_Error::statusBounce($statusMessage, $url);
 559       }
 560       elseif ($endDate) {
 561         if ($component == 'event') {
 562           // Target_entity is an event and the event is over, redirect to event info instead of event registration page.
 563           $url = CRM_Utils_System::url('civicrm/event/info',
 564             "reset=1&id={$pcpBlock['entity_id']}",
 565             FALSE, NULL, FALSE, TRUE
 566           );
 567           $statusMessage = ts('The event linked to the Personal Campaign Page you have just visited is over (as of %1).', array(1 => $customEndDate));
 568           CRM_Core_Error::statusBounce($statusMessage, $url);
 569         }
 570         else {
 571           $statusMessage = ts('The Personal Campaign Page you have just visited is no longer active (as of %1). However you can still support the campaign here.', array(1 => $customEndDate));
 572           CRM_Core_Error::statusBounce($statusMessage, $url);
 573         }
 574       }
 575     }
 576
 577     return array(
 578       'pcpId' => $pcpId,
 579       'pcpBlock' => $pcpBlock,
 580       'pcpInfo' => $pcpInfo,
 581     );
 582   }
 583
 584   /**
 585    * Function to Approve / Reject the campaign page
 586    *
 587    * @param int $id campaign page id
 588    *
 589    * @param $is_active
 590    *
 591    * @return null
 592    * @access public
 593    * @static
 594    */
 595   static function setIsActive($id, $is_active) {
 596     switch ($is_active) {
 597       case 0:
 598         $is_active = 3;
 599         break;
 600
 601       case 1:
 602         $is_active = 2;
 603         break;
 604     }
 605
 606     CRM_Core_DAO::setFieldValue('CRM_PCP_DAO_PCP', $id, 'status_id', $is_active);
 607
 608     $pcpTitle = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $id, 'title');
 609     $pcpPageType = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $id, 'page_type');
 610
 611     $pcpStatus = CRM_Core_OptionGroup::values("pcp_status");
 612     $pcpStatus = $pcpStatus[$is_active];
 613
 614     CRM_Core_Session::setStatus(ts("%1 status has been updated to %2.", array(
 615       1 => $pcpTitle,
 616       2 => $pcpStatus
 617     )), 'Status Updated', 'success');
 618
 619     // send status change mail
 620     $result = self::sendStatusUpdate($id, $is_active, FALSE, $pcpPageType);
 621
 622     if ($result) {
 623       CRM_Core_Session::setStatus(ts("A notification email has been sent to the supporter."), ts('Email Sent'), 'success');
 624     }
 625   }
 626
 627   /**
 628    * Function to send notfication email to supporter
 629    * 1. when their PCP status is changed by site admin.
 630    * 2. when supporter initially creates a Personal Campaign Page ($isInitial set to true).
 631    *
 632    * @param int $pcpId campaign page id
 633    * @param int $newStatus pcp status id
 634    * @param bool|int $isInitial is it the first time, campaign page has been created by the user
 635    *
 636    * @param string $component
 637    *
 638    * @throws Exception
 639    * @return null
 640    * @access public
 641    * @static
 642    */
 643   static function sendStatusUpdate($pcpId, $newStatus, $isInitial = FALSE, $component = 'contribute') {
 644     $pcpStatusName = CRM_Core_OptionGroup::values("pcp_status", FALSE, FALSE, FALSE, NULL, 'name');
 645     $pcpStatus = CRM_Core_OptionGroup::values("pcp_status");
 646     $config = CRM_Core_Config::singleton();
 647
 648     if (!isset($pcpStatus[$newStatus])) {
 649       return FALSE;
 650     }
 651
 652     require_once 'Mail/mime.php';
 653
 654     //set loginUrl
 655     $loginURL = $config->userSystem->getLoginURL();
 656
 657     // used in subject templates
 658     $contribPageTitle = self::getPcpPageTitle($pcpId, $component);
 659
 660     $tplParams = array(
 661       'loginUrl' => $loginURL,
 662       'contribPageTitle' => $contribPageTitle,
 663       'pcpId' => $pcpId,
 664     );
 665
 666     //get the default domain email address.
 667     list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain::getNameAndEmail();
 668
 669     if (!$domainEmailAddress || $domainEmailAddress == 'info@EXAMPLE.ORG') {
 670       $fixUrl = CRM_Utils_System::url("civicrm/admin/domain", 'action=update&reset=1');
 671       CRM_Core_Error::fatal(ts('The site administrator needs to enter a valid \'FROM Email Address\' in <a href="%1">Administer CiviCRM &raquo; Communications &raquo; FROM Email Addresses</a>. The email address used may need to be a valid mail account with your email service provider.', array(1 => $fixUrl)));
 672     }
 673
 674     $receiptFrom = '"' . $domainEmailName . '" <' . $domainEmailAddress . '>';
 675
 676     // get recipient (supporter) name and email
 677     $params = array('id' => $pcpId);
 678     CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo);
 679     list($name, $address) = CRM_Contact_BAO_Contact_Location::getEmailDetails($pcpInfo['contact_id']);
 680
 681     // get pcp block info
 682     list($blockId, $eid) = self::getPcpBlockEntityId($pcpId, $component);
 683     $params = array('id' => $blockId);
 684     CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCPBlock', $params, $pcpBlockInfo);
 685
 686     // assign urls required in email template
 687     if ($pcpStatusName[$newStatus] == 'Approved') {
 688       $tplParams['isTellFriendEnabled'] = $pcpBlockInfo['is_tellfriend_enabled'];
 689       if ($pcpBlockInfo['is_tellfriend_enabled']) {
 690         $pcpTellFriendURL = CRM_Utils_System::url('civicrm/friend',
 691           "reset=1&eid=$pcpId&blockId=$blockId&pcomponent=pcp",
 692           TRUE, NULL, FALSE, TRUE
 693         );
 694         $tplParams['pcpTellFriendURL'] = $pcpTellFriendURL;
 695       }
 696     }
 697     $pcpInfoURL = CRM_Utils_System::url('civicrm/pcp/info',
 698       "reset=1&id=$pcpId",
 699       TRUE, NULL, FALSE, TRUE
 700     );
 701     $tplParams['pcpInfoURL'] = $pcpInfoURL;
 702     $tplParams['contribPageTitle'] = $contribPageTitle;
 703     if ($emails = CRM_Utils_Array::value('notify_email', $pcpBlockInfo)) {
 704       $emailArray = explode(',', $emails);
 705       $tplParams['pcpNotifyEmailAddress'] = $emailArray[0];
 706     }
 707     // get appropriate message based on status
 708     $tplParams['pcpStatus'] = $pcpStatus[$newStatus];
 709
 710     $tplName = $isInitial ? 'pcp_supporter_notify' : 'pcp_status_change';
 711
 712     list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate(
 713       array(
 714         'groupName' => 'msg_tpl_workflow_contribution',
 715         'valueName' => $tplName,
 716         'contactId' => $pcpInfo['contact_id'],
 717         'tplParams' => $tplParams,
 718         'from' => $receiptFrom,
 719         'toName' => $name,
 720         'toEmail' => $address,
 721       )
 722     );
 723     return $sent;
 724   }
 725
 726   /**
 727    * Function to Enable / Disable the campaign page
 728    *
 729    * @param int $id campaign page id
 730    *
 731    * @param $is_active
 732    * @return null
 733    * @access public
 734    * @static
 735    */
 736   static function setDisable($id, $is_active) {
 737     return CRM_Core_DAO::setFieldValue('CRM_PCP_DAO_PCP', $id, 'is_active', $is_active);
 738   }
 739
 740   /**
 741    * Function to get pcp block is active
 742    *
 743    * @param $pcpId
 744    * @param $component
 745    * @internal param int $id campaign page id
 746    *
 747    * @return int
 748    * @access public
 749    * @static
 750    */
 751   static function getStatus($pcpId, $component) {
 752     $query = "
 753          SELECT pb.is_active
 754          FROM civicrm_pcp pcp
 755          LEFT JOIN civicrm_pcp_block pb ON ( pcp.page_id = pb.entity_id )
 756          WHERE pcp.id = %1
 757          AND pb.entity_table = %2";
 758
 759     $entity_table = self::getPcpEntityTable($component);
 760
 761     $params = array(1 => array($pcpId, 'Integer'), 2 => array($entity_table, 'String'));
 762     return CRM_Core_DAO::singleValueQuery($query, $params);
 763   }
 764
 765   /**
 766    * Function to get pcp block is enabled for component page
 767    *
 768    * @param $pageId
 769    * @param $component
 770    * @internal param int $id contribution page id
 771    *
 772    * @return String
 773    * @access public
 774    * @static
 775    */
 776   static function getPcpBlockStatus($pageId, $component) {
 777     $query = "
 778      SELECT pb.link_text as linkText
 779      FROM civicrm_pcp_block pb
 780      WHERE pb.is_active = 1 AND
 781      pb.entity_id = %1 AND
 782      pb.entity_table = %2";
 783
 784     $entity_table = self::getPcpEntityTable($component);
 785
 786     $params = array(1 => array($pageId, 'Integer'), 2 => array($entity_table, 'String'));
 787     return CRM_Core_DAO::singleValueQuery($query, $params);
 788   }
 789
 790   /**
 791    * Function to find out if the PCP block is in use by one or more PCP page
 792    *
 793    * @param int $id pcp block id
 794    *
 795    * @return Boolean
 796    * @access public
 797    * @static
 798    *
 799    */
 800   static function getPcpBlockInUse($id) {
 801     $query = "
 802      SELECT count(*)
 803      FROM civicrm_pcp pcp
 804      WHERE pcp.pcp_block_id = %1";
 805
 806     $params = array(1 => array($id, 'Integer'));
 807     $result = CRM_Core_DAO::singleValueQuery($query, $params);
 808     return $result > 0;
 809   }
 810
 811   /**
 812    * Function to get email is enabled for supporter's profile
 813    *
 814    * @param $profileId
 815    *
 816    * @internal param int $id supporter's profile id
 817    *
 818    * @return boolean
 819    * @access public
 820    * @static
 821    */
 822   static function checkEmailProfile($profileId) {
 823     $query = "
 824 SELECT field_name
 825 FROM civicrm_uf_field
 826 WHERE field_name like 'email%' And is_active = 1 And uf_group_id = %1";
 827
 828     $params = array(1 => array($profileId, 'Integer'));
 829     $dao = CRM_Core_DAO::executeQuery($query, $params);
 830     if (!$dao->fetch()) {
 831       return TRUE;
 832     }
 833     return FALSE;
 834   }
 835
 836   /**
 837    * Function to obtain the title of page associated with a pcp
 838    *
 839    * @param $pcpId
 840    * @param $component
 841    *
 842    * @internal param int $id campaign page id
 843    *
 844    * @return int
 845    * @access public
 846    * @static
 847    */
 848   static function getPcpPageTitle($pcpId, $component) {
 849     if ($component == 'contribute') {
 850       $query = "
 851   SELECT cp.title
 852   FROM civicrm_pcp pcp
 853   LEFT JOIN civicrm_contribution_page as cp ON ( cp.id =  pcp.page_id )
 854   WHERE pcp.id = %1";
 855     }
 856     elseif ($component == 'event') {
 857       $query = "
 858   SELECT ce.title
 859   FROM civicrm_pcp pcp
 860   LEFT JOIN civicrm_event as ce ON ( ce.id =  pcp.page_id )
 861   WHERE pcp.id = %1";
 862     }
 863
 864     $params = array(1 => array($pcpId, 'Integer'));
 865     return CRM_Core_DAO::singleValueQuery($query, $params);
 866   }
 867
 868   /**
 869    * Function to get pcp block & entity id given pcp id
 870    *
 871    * @param $pcpId
 872    * @param $component
 873    *
 874    * @internal param int $id campaign page id
 875    *
 876    * @return String
 877    * @access public
 878    * @static
 879    */
 880   static function getPcpBlockEntityId($pcpId, $component) {
 881     $entity_table = self::getPcpEntityTable($component);
 882
 883     $query = "
 884 SELECT pb.id as pcpBlockId, pb.entity_id
 885 FROM civicrm_pcp pcp
 886 LEFT JOIN civicrm_pcp_block pb ON ( pb.entity_id = pcp.page_id AND pb.entity_table = %2 )
 887 WHERE pcp.id = %1";
 888
 889     $params = array(1 => array($pcpId, 'Integer'), 2 => array($entity_table, 'String'));
 890     $dao = CRM_Core_DAO::executeQuery($query, $params);
 891     if ($dao->fetch()) {
 892       return array($dao->pcpBlockId, $dao->entity_id);
 893     }
 894
 895     return array();
 896   }
 897
 898   /**
 899    * Function to get pcp entity table given a component.
 900    *
 901    * @param $component
 902    *
 903    * @internal param int $id campaign page id
 904    *
 905    * @return String
 906    * @access public
 907    * @static
 908    */
 909   static function getPcpEntityTable($component) {
 910     $entity_table_map = array(
 911       'event' => 'civicrm_event',
 912       'civicrm_event' => 'civicrm_event',
 913       'contribute' => 'civicrm_contribution_page',
 914       'civicrm_contribution_page' => 'civicrm_contribution_page',
 915     );
 916     return isset($entity_table_map[$component]) ? $entity_table_map[$component] : FALSE;
 917   }
 918
 919   /**
 920    * Function to get supporter profile id
 921    *
 922    * @param $component_id
 923    * @param string $component
 924    *
 925    * @internal param int $contributionPageId contribution page id
 926    *
 927    * @return int
 928    * @access public
 929    * @static
 930    */
 931   public static function getSupporterProfileId($component_id, $component = 'contribute') {
 932     $entity_table = self::getPcpEntityTable($component);
 933
 934     $query = "
 935 SELECT pcp.supporter_profile_id
 936 FROM civicrm_pcp_block pcp
 937 INNER JOIN civicrm_uf_group ufgroup
 938       ON pcp.supporter_profile_id = ufgroup.id
 939       WHERE pcp.entity_id = %1
 940       AND pcp.entity_table = %2
 941       AND ufgroup.is_active = 1";
 942
 943     $params = array(1 => array($component_id, 'Integer'), 2 => array($entity_table, 'String'));
 944     if (!$supporterProfileId = CRM_Core_DAO::singleValueQuery($query, $params)) {
 945       CRM_Core_Error::fatal(ts('Supporter profile is not set for this Personal Campaign Page or the profile is disabled. Please contact the site administrator if you need assistance.'));
 946     }
 947     else {
 948       return $supporterProfileId;
 949     }
 950   }
 951 }
 952