CRM/PCP/Page/PCPInfo.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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
  36 /**
  37  * PCP Info Page - Summary about the PCP
  38  */
  39 class CRM_PCP_Page_PCPInfo extends CRM_Core_Page {
  40   public $_component;
  41
  42   /**
  43    * Run the page.
  44    *
  45    * This method is called after the page is created. It checks for the
  46    * type of action and executes that action.
  47    * Finally it calls the parent's run method.
  48    *
  49    * @return void
  50    *
  51    */
  52   public function run() {
  53     $session         = CRM_Core_Session::singleton();
  54     $config          = CRM_Core_Config::singleton();
  55     $permissionCheck = FALSE;
  56     $statusMessage   = '';
  57     if ($config->userFramework != 'Joomla') {
  58       $permissionCheck = CRM_Core_Permission::check('administer CiviCRM');
  59     }
  60     //get the pcp id.
  61     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
  62
  63     $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE);
  64
  65     $prms = array('id' => $this->_id);
  66
  67     CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $prms, $pcpInfo);
  68     $this->_component = $pcpInfo['page_type'];
  69
  70     if (empty($pcpInfo)) {
  71       $statusMessage = ts('The personal campaign page you requested is currently unavailable.');
  72       CRM_Core_Error::statusBounce($statusMessage,
  73         $config->userFrameworkBaseURL
  74       );
  75     }
  76
  77     CRM_Utils_System::setTitle($pcpInfo['title']);
  78     $this->assign('pcp', $pcpInfo);
  79
  80     $pcpStatus = CRM_Core_OptionGroup::values("pcp_status");
  81     $approvedId = CRM_Core_OptionGroup::getValue('pcp_status', 'Approved', 'name');
  82
  83     // check if PCP is created by anonymous user
  84     $anonymousPCP = CRM_Utils_Request::retrieve('ap', 'Boolean', $this);
  85     if ($anonymousPCP) {
  86       $loginURL = $config->userSystem->getLoginURL();
  87       $anonMessage = ts('Once you\'ve received your new account welcome email, you can <a href=%1>click here</a> to login and promote your campaign page.', array(1 => $loginURL));
  88       CRM_Core_Session::setStatus($anonMessage, ts('Success'), 'success');
  89     }
  90     else {
  91       $statusMessage = ts('The personal campaign page you requested is currently unavailable. However you can still support the campaign by making a contribution here.');
  92     }
  93
  94     $pcpBlock = new CRM_PCP_DAO_PCPBlock();
  95     $pcpBlock->entity_table = CRM_PCP_BAO_PCP::getPcpEntityTable($pcpInfo['page_type']);
  96     $pcpBlock->entity_id = $pcpInfo['page_id'];
  97     $pcpBlock->find(TRUE);
  98
  99     // Redirect back to source page in case of error.
 100     if ($pcpInfo['page_type'] == 'contribute') {
 101       $urlBase = 'civicrm/contribute/transact';
 102     }
 103     elseif ($pcpInfo['page_type'] == 'event') {
 104       $urlBase = 'civicrm/event/register';
 105     }
 106
 107     if ($pcpInfo['status_id'] != $approvedId || !$pcpInfo['is_active']) {
 108       if ($pcpInfo['contact_id'] != $session->get('userID') && !$permissionCheck) {
 109         CRM_Core_Error::statusBounce($statusMessage, CRM_Utils_System::url($urlBase,
 110             "reset=1&id=" . $pcpInfo['page_id'],
 111             FALSE, NULL, FALSE, TRUE
 112           ));
 113       }
 114     }
 115     else {
 116       $getStatus = CRM_PCP_BAO_PCP::getStatus($this->_id, $this->_component);
 117       if (!$getStatus) {
 118         // PCP not enabled for this contribution page. Forward everyone to source page
 119         CRM_Core_Error::statusBounce($statusMessage, CRM_Utils_System::url($urlBase,
 120             "reset=1&id=" . $pcpInfo['page_id'],
 121             FALSE, NULL, FALSE, TRUE
 122           ));
 123       }
 124     }
 125
 126     $default = array();
 127
 128     if ($pcpBlock->target_entity_type == 'contribute') {
 129       $urlBase = 'civicrm/contribute/transact';
 130     }
 131     elseif ($pcpBlock->target_entity_type == 'event') {
 132       $urlBase = 'civicrm/event/register';
 133     }
 134
 135     if ($pcpBlock->entity_table == 'civicrm_event') {
 136       $page_class = 'CRM_Event_DAO_Event';
 137       $this->assign('pageName', CRM_Event_PseudoConstant::event($pcpInfo['page_id']));
 138       CRM_Core_DAO::commonRetrieveAll($page_class, 'id',
 139         $pcpInfo['page_id'], $default, array('start_date', 'end_date', 'registration_start_date', 'registration_end_date')
 140       );
 141     }
 142     elseif ($pcpBlock->entity_table == 'civicrm_contribution_page') {
 143       $page_class = 'CRM_Contribute_DAO_ContributionPage';
 144       $this->assign('pageName', CRM_Contribute_PseudoConstant::contributionPage($pcpInfo['page_id'], TRUE));
 145       CRM_Core_DAO::commonRetrieveAll($page_class, 'id',
 146         $pcpInfo['page_id'], $default, array('start_date', 'end_date')
 147       );
 148     }
 149
 150     $pageInfo = $default[$pcpInfo['page_id']];
 151
 152     if ($pcpInfo['contact_id'] == $session->get('userID')) {
 153       $owner = $pageInfo;
 154       $owner['status'] = CRM_Utils_Array::value($pcpInfo['status_id'], $pcpStatus);
 155
 156       $this->assign('owner', $owner);
 157
 158       $link = CRM_PCP_BAO_PCP::pcpLinks();
 159
 160       $hints = array(
 161         CRM_Core_Action::UPDATE => ts('Change the content and appearance of your page'),
 162         CRM_Core_Action::DETACH => ts('Send emails inviting your friends to support your campaign!'),
 163         CRM_Core_Action::VIEW => ts('Copy this link to share directly with your network!'),
 164         CRM_Core_Action::BROWSE => ts('Update your personal contact information'),
 165         CRM_Core_Action::DISABLE => ts('De-activate the page (you can re-activate it later)'),
 166         CRM_Core_Action::ENABLE => ts('Activate the page (you can de-activate it later)'),
 167         CRM_Core_Action::DELETE => ts('Remove the page (this cannot be undone!)'),
 168       );
 169
 170       $replace = array(
 171         'id' => $this->_id,
 172         'block' => $pcpBlock->id,
 173         'pageComponent' => $this->_component,
 174       );
 175
 176       if (!$pcpBlock->is_tellfriend_enabled || CRM_Utils_Array::value('status_id', $pcpInfo) != $approvedId) {
 177         unset($link['all'][CRM_Core_Action::DETACH]);
 178       }
 179
 180       switch ($pcpInfo['is_active']) {
 181         case 1:
 182           unset($link['all'][CRM_Core_Action::ENABLE]);
 183           break;
 184
 185         case 0:
 186           unset($link['all'][CRM_Core_Action::DISABLE]);
 187           break;
 188       }
 189
 190       $this->assign('links', $link['all']);
 191       $this->assign('hints', $hints);
 192       $this->assign('replace', $replace);
 193     }
 194
 195     $honor = CRM_PCP_BAO_PCP::honorRoll($this->_id);
 196
 197     $entityFile = CRM_Core_BAO_File::getEntityFile('civicrm_pcp', $this->_id);
 198     if (!empty($entityFile)) {
 199       $fileInfo = reset($entityFile);
 200       $fileId = $fileInfo['fileID'];
 201       $image = '<img src="' . CRM_Utils_System::url('civicrm/file',
 202         "reset=1&id=$fileId&eid={$this->_id}"
 203       ) . '" />';
 204       $this->assign('image', $image);
 205     }
 206
 207     $totalAmount = CRM_PCP_BAO_PCP::thermoMeter($this->_id);
 208     $achieved = round($totalAmount / $pcpInfo['goal_amount'] * 100, 2);
 209
 210     if ($pcpBlock->is_active == 1) {
 211       $linkTextUrl = CRM_Utils_System::url('civicrm/contribute/campaign',
 212         "action=add&reset=1&pageId={$pcpInfo['page_id']}&component={$pcpInfo['page_type']}",
 213         TRUE, NULL, TRUE,
 214         TRUE
 215       );
 216       $this->assign('linkTextUrl', $linkTextUrl);
 217       $this->assign('linkText', $pcpBlock->link_text);
 218     }
 219
 220     $this->assign('honor', $honor);
 221     $this->assign('total', $totalAmount ? $totalAmount : '0.0');
 222     $this->assign('achieved', $achieved <= 100 ? $achieved : 100);
 223
 224     if ($achieved <= 100) {
 225       $this->assign('remaining', 100 - $achieved);
 226     }
 227     // make sure that we are between contribution page start and end dates OR registration start date and end dates if they are set
 228     if ($pcpBlock->entity_table == 'civicrm_event') {
 229       $startDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('registration_start_date', $pageInfo));
 230       $endDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('registration_end_date', $pageInfo));
 231     }
 232     else {
 233       $startDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('start_date', $pageInfo));
 234       $endDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('end_date', $pageInfo));
 235     }
 236
 237     $now = time();
 238     $validDate = TRUE;
 239     if ($startDate && $startDate >= $now) {
 240       $validDate = FALSE;
 241     }
 242     if ($endDate && $endDate < $now) {
 243       $validDate = FALSE;
 244     }
 245
 246     $this->assign('validDate', $validDate);
 247
 248     // form parent page url
 249     if ($action == CRM_Core_Action::PREVIEW) {
 250       $parentUrl = CRM_Utils_System::url($urlBase,
 251         "id={$pcpInfo['page_id']}&reset=1&action=preview",
 252         TRUE, NULL, TRUE,
 253         TRUE
 254       );
 255     }
 256     else {
 257       $parentUrl = CRM_Utils_System::url($urlBase,
 258         "id={$pcpInfo['page_id']}&reset=1",
 259         TRUE, NULL, TRUE,
 260         TRUE
 261       );
 262     }
 263
 264     $this->assign('parentURL', $parentUrl);
 265
 266     if ($validDate) {
 267
 268       $contributionText = ts('Contribute Now');
 269       if (!empty($pcpInfo['donate_link_text'])) {
 270         $contributionText = $pcpInfo['donate_link_text'];
 271       }
 272
 273       $this->assign('contributionText', $contributionText);
 274
 275       // we always generate urls for the front end in joomla
 276       if ($action == CRM_Core_Action::PREVIEW) {
 277         $url = CRM_Utils_System::url($urlBase,
 278           "id=" . $pcpBlock->target_entity_id . "&pcpId={$this->_id}&reset=1&action=preview",
 279           TRUE, NULL, TRUE,
 280           TRUE
 281         );
 282       }
 283       else {
 284         $url = CRM_Utils_System::url($urlBase,
 285           "id=" . $pcpBlock->target_entity_id . "&pcpId={$this->_id}&reset=1",
 286           TRUE, NULL, TRUE,
 287           TRUE
 288         );
 289       }
 290       $this->assign('contributeURL', $url);
 291     }
 292
 293     // we do not want to display recently viewed items, so turn off
 294     $this->assign('displayRecent', FALSE);
 295
 296     $single = $permission = FALSE;
 297     switch ($action) {
 298       case CRM_Core_Action::BROWSE:
 299         $subForm = 'PCPAccount';
 300         $form    = "CRM_PCP_Form_$subForm";
 301         $single  = TRUE;
 302         break;
 303
 304       case CRM_Core_Action::UPDATE:
 305         $subForm = 'Campaign';
 306         $form    = "CRM_PCP_Form_$subForm";
 307         $single  = TRUE;
 308         break;
 309     }
 310
 311     $userID = $session->get('userID');
 312     //make sure the user has "administer CiviCRM" permission
 313     //OR has created the PCP
 314     if (CRM_Core_Permission::check('administer CiviCRM') ||
 315       ($userID && (CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $this->_id, 'contact_id') == $userID))
 316     ) {
 317       $permission = TRUE;
 318     }
 319     if ($single && $permission) {
 320       $controller = new CRM_Core_Controller_Simple($form, $subForm, $action);
 321       $controller->set('id', $this->_id);
 322       $controller->set('single', TRUE);
 323       $controller->process();
 324       return $controller->run();
 325     }
 326     $session->pushUserContext(CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'reset=1&id=' . $this->_id));
 327     parent::run();
 328   }
 329
 330   /**
 331    * @return string
 332    */
 333   public function getTemplateFileName() {
 334     if ($this->_id) {
 335       $templateFile = "CRM/PCP/Page/{$this->_id}/PCPInfo.tpl";
 336       $template = &CRM_Core_Page::getTemplate();
 337       if ($template->template_exists($templateFile)) {
 338         return $templateFile;
 339       }
 340     }
 341     return parent::getTemplateFileName();
 342   }
 343 }