CRM/PCP/Form/Campaign.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  * This class generates form components for processing a pcp page creati
  38  *
  39  */
  40 class CRM_PCP_Form_Campaign extends CRM_Core_Form {
  41   public $_context;
  42   public $_component;
  43
  44   public function preProcess() {
  45     // we do not want to display recently viewed items, so turn off
  46     $this->assign('displayRecent', FALSE);
  47
  48     // component null in controller object - fix? dgg
  49     // $this->_component = $this->controller->get('component');
  50     $this->_component = CRM_Utils_Request::retrieve('component', 'String', $this);
  51     $this->assign('component', $this->_component);
  52
  53     $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this);
  54     $this->assign('context', $this->_context);
  55
  56     $this->_pageId = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE);
  57     $title = ts('Setup a Personal Campaign Page - Step 2');
  58
  59     if ($this->_pageId) {
  60       $title = ts('Edit Your Personal Campaign Page');
  61     }
  62
  63     CRM_Utils_System::setTitle($title);
  64     parent::preProcess();
  65   }
  66
  67   public function setDefaultValues() {
  68     $dafaults = array();
  69     $dao = new CRM_PCP_DAO_PCP();
  70
  71     if ($this->_pageId) {
  72       $dao->id = $this->_pageId;
  73       if ($dao->find(TRUE)) {
  74         CRM_Core_DAO::storeValues($dao, $defaults);
  75       }
  76       // fix the display of the monetary value, CRM-4038
  77       if (isset($defaults['goal_amount'])) {
  78         $defaults['goal_amount'] = CRM_Utils_Money::format($defaults['goal_amount'], NULL, '%a');
  79       }
  80
  81       $defaults['pcp_title'] = CRM_Utils_Array::value('title', $defaults);
  82       $defaults['pcp_intro_text'] = CRM_Utils_Array::value('intro_text', $defaults);
  83     }
  84
  85     if ($this->get('action') & CRM_Core_Action::ADD) {
  86       $defaults['is_active'] = 1;
  87       $defaults['is_honor_roll'] = 1;
  88       $defaults['is_thermometer'] = 1;
  89       $defaults['is_notify'] = 1;
  90     }
  91
  92     $this->_contactID = CRM_Utils_Array::value('contact_id', $defaults);
  93     $this->_contriPageId = CRM_Utils_Array::value('page_id', $defaults);
  94
  95     return $defaults;
  96   }
  97
  98   /**
  99    * Build the form object
 100    *
 101    * @return void
 102    */
 103   public function buildQuickForm() {
 104     $this->add('text', 'pcp_title', ts('Title'), NULL, TRUE);
 105     $this->add('textarea', 'pcp_intro_text', ts('Welcome'), NULL, TRUE);
 106     $this->add('text', 'goal_amount', ts('Your Goal'), NULL, TRUE);
 107     $this->addRule('goal_amount', ts('Goal Amount should be a numeric value'), 'money');
 108
 109     $attributes = array();
 110     if ($this->_component == 'event') {
 111       if ($this->get('action') & CRM_Core_Action::ADD) {
 112         $attributes = array('value' => ts('Join Us'), 'onClick' => 'select();');
 113       }
 114       $this->add('text', 'donate_link_text', ts('Sign up Button'), $attributes);
 115     }
 116     else {
 117       if ($this->get('action') & CRM_Core_Action::ADD) {
 118         $attributes = array('value' => ts('Donate Now'), 'onClick' => 'select();');
 119       }
 120       $this->add('text', 'donate_link_text', ts('Donation Button'), $attributes);
 121     }
 122
 123     $attrib = array('rows' => 8, 'cols' => 60);
 124     $this->add('textarea', 'page_text', ts('Your Message'), NULL, FALSE);
 125
 126     $maxAttachments = 1;
 127     CRM_Core_BAO_File::buildAttachment($this, 'civicrm_pcp', $this->_pageId, $maxAttachments);
 128
 129     $this->addElement('checkbox', 'is_thermometer', ts('Progress Bar'));
 130     $this->addElement('checkbox', 'is_honor_roll', ts('Honor Roll'), NULL);
 131     if ($this->_pageId) {
 132       $params = array('id' => $this->_pageId);
 133       CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo);
 134       $owner_notification_option = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCPBlock', $pcpInfo['pcp_block_id'], 'owner_notify_id');
 135     }
 136     else {
 137       $owner_notification_option = CRM_PCP_BAO_PCP::getOwnerNotificationId($this->controller->get('component_page_id'), $this->_component ? $this->_component : 'contribute');
 138     }
 139     if ($owner_notification_option == CRM_Core_OptionGroup::getValue('pcp_owner_notify', 'owner_chooses', 'name')) {
 140       $this->assign('owner_notification_option', TRUE);
 141       $this->addElement('checkbox', 'is_notify', ts('Notify me via email when someone donates to my page'), NULL);
 142     }
 143
 144     $this->addElement('checkbox', 'is_active', ts('Active'));
 145
 146     $this->addButtons(
 147       array(
 148         array(
 149           'type' => 'upload',
 150           'name' => ts('Save'),
 151           'isDefault' => TRUE,
 152         ),
 153         array(
 154           'type' => 'cancel',
 155           'name' => ts('Cancel'),
 156         ),
 157       )
 158     );
 159     $this->addFormRule(array('CRM_PCP_Form_Campaign', 'formRule'), $this);
 160   }
 161
 162   /**
 163    * Global form rule
 164    *
 165    * @param array $fields
 166    *   The input form values.
 167    * @param array $files
 168    *   The uploaded files if any.
 169    * @param $self
 170    *
 171    *
 172    * @return bool|array
 173    *   true if no errors, else array of errors
 174    */
 175   public static function formRule($fields, $files, $self) {
 176     $errors = array();
 177     if ($fields['goal_amount'] <= 0) {
 178       $errors['goal_amount'] = ts('Goal Amount should be a numeric value greater than zero.');
 179     }
 180     if (strlen($fields['donate_link_text']) >= 64) {
 181       $errors['donate_link_text'] = ts('Button Text must be less than 64 characters.');
 182     }
 183     return $errors;
 184   }
 185
 186   /**
 187    * Process the form submission
 188    *
 189    *
 190    * @return void
 191    */
 192   public function postProcess() {
 193     $params = $this->controller->exportValues($this->_name);
 194     $checkBoxes = array('is_thermometer', 'is_honor_roll', 'is_active');
 195
 196     foreach ($checkBoxes as $key) {
 197       if (!isset($params[$key])) {
 198         $params[$key] = 0;
 199       }
 200     }
 201     $session = CRM_Core_Session::singleton();
 202     $contactID = isset($this->_contactID) ? $this->_contactID : $session->get('userID');
 203     if (!$contactID) {
 204       $contactID = $this->get('contactID');
 205     }
 206     $params['title'] = $params['pcp_title'];
 207     $params['intro_text'] = $params['pcp_intro_text'];
 208     $params['contact_id'] = $contactID;
 209     $params['page_id'] = $this->get('component_page_id') ? $this->get('component_page_id') : $this->_contriPageId;
 210     $params['page_type'] = $this->_component;
 211
 212     // since we are allowing html input from the user
 213     // we also need to purify it, so lets clean it up
 214     $htmlFields = array('intro_text', 'page_text', 'title');
 215     foreach ($htmlFields as $field) {
 216       if (!empty($params[$field])) {
 217         $params[$field] = CRM_Utils_String::purifyHTML($params[$field]);
 218       }
 219     }
 220
 221     $entity_table = CRM_PCP_BAO_PCP::getPcpEntityTable($params['page_type']);
 222
 223     $pcpBlock = new CRM_PCP_DAO_PCPBlock();
 224     $pcpBlock->entity_table = $entity_table;
 225     $pcpBlock->entity_id = $params['page_id'];
 226     $pcpBlock->find(TRUE);
 227
 228     $params['pcp_block_id'] = $pcpBlock->id;
 229
 230     $params['goal_amount'] = CRM_Utils_Rule::cleanMoney($params['goal_amount']);
 231
 232     $approval_needed = $pcpBlock->is_approval_needed;
 233     $approvalMessage = NULL;
 234
 235     if ($this->get('action') & CRM_Core_Action::ADD) {
 236       $params['status_id'] = $approval_needed ? 1 : 2;
 237       $approvalMessage = $approval_needed ? ts('but requires administrator review before you can begin promoting your campaign. You will receive an email confirmation shortly which includes a link to return to this page.') : ts('and is ready to use.');
 238     }
 239
 240     $params['id'] = $this->_pageId;
 241
 242     $pcp = CRM_PCP_BAO_PCP::add($params, FALSE);
 243
 244     // add attachments as needed
 245     CRM_Core_BAO_File::formatAttachment($params,
 246       $params,
 247       'civicrm_pcp',
 248       $pcp->id
 249     );
 250
 251     $pageStatus = isset($this->_pageId) ? ts('updated') : ts('created');
 252     $statusId = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $pcp->id, 'status_id');
 253
 254     //send notification of PCP create/update.
 255     $pcpParams = array('entity_table' => $entity_table, 'entity_id' => $pcp->page_id);
 256     $notifyParams = array();
 257     $notifyStatus = "";
 258     CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCPBlock', $pcpParams, $notifyParams, array('notify_email'));
 259
 260     if ($emails = $pcpBlock->notify_email) {
 261       $this->assign('pcpTitle', $pcp->title);
 262
 263       if ($this->_pageId) {
 264         $this->assign('mode', 'Update');
 265       }
 266       else {
 267         $this->assign('mode', 'Add');
 268       }
 269       $pcpStatus = CRM_Core_OptionGroup::getLabel('pcp_status', $statusId);
 270       $this->assign('pcpStatus', $pcpStatus);
 271
 272       $this->assign('pcpId', $pcp->id);
 273
 274       $supporterUrl = CRM_Utils_System::url('civicrm/contact/view',
 275         "reset=1&cid={$pcp->contact_id}",
 276         TRUE, NULL, FALSE,
 277         FALSE
 278       );
 279       $this->assign('supporterUrl', $supporterUrl);
 280       $supporterName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $pcp->contact_id, 'display_name');
 281       $this->assign('supporterName', $supporterName);
 282
 283       if ($this->_component == 'contribute') {
 284         $pageUrl = CRM_Utils_System::url('civicrm/contribute/transact',
 285           "reset=1&id={$pcpBlock->entity_id}",
 286           TRUE, NULL, FALSE,
 287           TRUE
 288         );
 289         $contribPageTitle = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $pcpBlock->entity_id, 'title');
 290       }
 291       elseif ($this->_component == 'event') {
 292         $pageUrl = CRM_Utils_System::url('civicrm/event',
 293           "reset=1&id={$pcpBlock->entity_id}",
 294           TRUE, NULL, FALSE,
 295           TRUE
 296         );
 297         $contribPageTitle = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $pcpBlock->entity_id, 'title');
 298       }
 299
 300       $this->assign('contribPageUrl', $pageUrl);
 301       $this->assign('contribPageTitle', $contribPageTitle);
 302
 303       $managePCPUrl = CRM_Utils_System::url('civicrm/admin/pcp',
 304         "reset=1",
 305         TRUE, NULL, FALSE,
 306         FALSE
 307       );
 308       $this->assign('managePCPUrl', $managePCPUrl);
 309
 310       //get the default domain email address.
 311       list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain::getNameAndEmail();
 312
 313       if (!$domainEmailAddress || $domainEmailAddress == 'info@EXAMPLE.ORG') {
 314         $fixUrl = CRM_Utils_System::url('civicrm/admin/domain', 'action=update&reset=1');
 315         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)));
 316       }
 317
 318       //if more than one email present for PCP notification ,
 319       //first email take it as To and other as CC and First email
 320       //address should be sent in users email receipt for
 321       //support purpose.
 322       $emailArray = explode(',', $emails);
 323       $to = $emailArray[0];
 324       unset($emailArray[0]);
 325       $cc = implode(',', $emailArray);
 326
 327       list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate(
 328         array(
 329           'groupName' => 'msg_tpl_workflow_contribution',
 330           'valueName' => 'pcp_notify',
 331           'contactId' => $contactID,
 332           'from' => "$domainEmailName <$domainEmailAddress>",
 333           'toEmail' => $to,
 334           'cc' => $cc,
 335         )
 336       );
 337
 338       if ($sent) {
 339         $notifyStatus = ts('A notification email has been sent to the site administrator.');
 340       }
 341     }
 342
 343     CRM_Core_BAO_File::processAttachment($params, 'civicrm_pcp', $pcp->id);
 344
 345     // send email notification to supporter, if initial setup / add mode.
 346     if (!$this->_pageId) {
 347       CRM_PCP_BAO_PCP::sendStatusUpdate($pcp->id, $statusId, TRUE, $this->_component);
 348       if ($approvalMessage && CRM_Utils_Array::value('status_id', $params) == 1) {
 349         $notifyStatus .= ts(' You will receive a second email as soon as the review process is complete.');
 350       }
 351     }
 352
 353     //check if pcp created by anonymous user
 354     $anonymousPCP = 0;
 355     if (!$session->get('userID')) {
 356       $anonymousPCP = 1;
 357     }
 358
 359     CRM_Core_Session::setStatus(ts("Your Personal Campaign Page has been %1 %2 %3",
 360       array(1 => $pageStatus, 2 => $approvalMessage, 3 => $notifyStatus)
 361     ), '', 'info');
 362     if (!$this->_pageId) {
 363       $session->pushUserContext(CRM_Utils_System::url('civicrm/pcp/info', "reset=1&id={$pcp->id}&ap={$anonymousPCP}"));
 364     }
 365     elseif ($this->_context == 'dashboard') {
 366       $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/pcp', 'reset=1'));
 367     }
 368   }
 369
 370 }