CRM/PCP/Form/Campaign.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
  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   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     }
  90
  91     $this->_contactID = CRM_Utils_Array::value('contact_id', $defaults);
  92     $this->_contriPageId = CRM_Utils_Array::value('page_id', $defaults);
  93
  94     return $defaults;
  95   }
  96
  97   /**
  98    * Function to build the form
  99    *
 100    * @return void
 101    * @access public
 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     $this->addElement('checkbox', 'is_active', ts('Active'));
 132
 133     $this->addButtons(
 134       array(
 135         array(
 136           'type' => 'upload',
 137           'name' => ts('Save'),
 138           'isDefault' => TRUE,
 139         ),
 140         array(
 141           'type' => 'cancel',
 142           'name' => ts('Cancel'),
 143         ),
 144       )
 145     );
 146     $this->addFormRule(array('CRM_PCP_Form_Campaign', 'formRule'), $this);
 147   }
 148
 149   /**
 150    * global form rule
 151    *
 152    * @param array $fields  the input form values
 153    * @param array $files   the uploaded files if any
 154    * @param array $options additional user data
 155    *
 156    * @return true if no errors, else array of errors
 157    * @access public
 158    * @static
 159    */
 160   static function formRule($fields, $files, $self) {
 161     $errors = array();
 162     if ($fields['goal_amount'] <= 0) {
 163       $errors['goal_amount'] = ts('Goal Amount should be a numeric value greater than zero.');
 164     }
 165     if (strlen($fields['donate_link_text']) >= 64) {
 166       $errors['donate_link_text'] = ts('Button Text must be less than 64 characters.');
 167     }
 168     return $errors;
 169   }
 170
 171   /**
 172    * Function to process the form
 173    *
 174    * @access public
 175    *
 176    * @return void
 177    */
 178   public function postProcess() {
 179     $params  = $this->controller->exportValues( $this->_name );
 180     $checkBoxes = array('is_thermometer', 'is_honor_roll', 'is_active');
 181
 182     foreach ($checkBoxes as $key) {
 183       if (!isset($params[$key])) {
 184         $params[$key] = 0;
 185       }
 186     }
 187     $session = CRM_Core_Session::singleton();
 188     $contactID = isset($this->_contactID) ? $this->_contactID : $session->get('userID');
 189     if (!$contactID) {
 190       $contactID = $this->get('contactID');
 191     }
 192     $params['title'] = $params['pcp_title'];
 193     $params['intro_text'] = $params['pcp_intro_text'];
 194     $params['contact_id'] = $contactID;
 195     $params['page_id'] = $this->get('component_page_id') ? $this->get('component_page_id') : $this->_contriPageId;
 196     $params['page_type'] = $this->_component;
 197
 198     // since we are allowing html input from the user
 199     // we also need to purify it, so lets clean it up
 200     $htmlFields = array( 'intro_text', 'page_text', 'title' );
 201     foreach ( $htmlFields as $field ) {
 202       if ( ! empty($params[$field]) ) {
 203         $params[$field] = CRM_Utils_String::purifyHTML($params[$field]);
 204       }
 205     }
 206
 207     $entity_table = CRM_PCP_BAO_PCP::getPcpEntityTable($params['page_type']);
 208
 209     $pcpBlock = new CRM_PCP_DAO_PCPBlock();
 210     $pcpBlock->entity_table = $entity_table;
 211     $pcpBlock->entity_id = $params['page_id'];
 212     $pcpBlock->find(TRUE);
 213
 214     $params['pcp_block_id'] = $pcpBlock->id;
 215
 216     $params['goal_amount'] = CRM_Utils_Rule::cleanMoney($params['goal_amount']);
 217
 218     $approval_needed = $pcpBlock->is_approval_needed;
 219     $approvalMessage = NULL;
 220
 221     if ($this->get('action') & CRM_Core_Action::ADD) {
 222       $params['status_id'] = $approval_needed ? 1 : 2;
 223       $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.');
 224     }
 225
 226     $params['id'] = $this->_pageId;
 227
 228     $pcp = CRM_PCP_BAO_PCP::add($params, FALSE);
 229
 230
 231     // add attachments as needed
 232     CRM_Core_BAO_File::formatAttachment($params,
 233       $params,
 234       'civicrm_pcp',
 235       $pcp->id
 236     );
 237
 238     $pageStatus = isset($this->_pageId) ? ts('updated') : ts('created');
 239     $statusId = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $pcp->id, 'status_id');
 240
 241     //send notification of PCP create/update.
 242     $pcpParams    = array('entity_table' => $entity_table, 'entity_id' => $pcp->page_id);
 243     $notifyParams = array();
 244     $notifyStatus = "";
 245     CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCPBlock', $pcpParams, $notifyParams, array('notify_email'));
 246
 247     if ($emails = $pcpBlock->notify_email) {
 248       $this->assign('pcpTitle', $pcp->title);
 249
 250       if ($this->_pageId) {
 251         $this->assign('mode', 'Update');
 252       }
 253       else {
 254         $this->assign('mode', 'Add');
 255       }
 256       $pcpStatus = CRM_Core_OptionGroup::getLabel('pcp_status', $statusId);
 257       $this->assign('pcpStatus', $pcpStatus);
 258
 259       $this->assign('pcpId', $pcp->id);
 260
 261       $supporterUrl = CRM_Utils_System::url('civicrm/contact/view',
 262         "reset=1&cid={$pcp->contact_id}",
 263         TRUE, NULL, FALSE,
 264         FALSE
 265       );
 266       $this->assign('supporterUrl', $supporterUrl);
 267       $supporterName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $pcp->contact_id, 'display_name');
 268       $this->assign('supporterName', $supporterName);
 269
 270
 271       if ($this->_component == 'contribute') {
 272         $pageUrl = CRM_Utils_System::url('civicrm/contribute/transact',
 273           "reset=1&id={$pcpBlock->entity_id}",
 274           TRUE, NULL, FALSE,
 275           TRUE
 276         );
 277         $contribPageTitle = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $pcpBlock->entity_id, 'title');
 278       }
 279       elseif ($this->_component == 'event') {
 280         $pageUrl = CRM_Utils_System::url('civicrm/event',
 281           "reset=1&id={$pcpBlock->entity_id}",
 282           TRUE, NULL, FALSE,
 283           TRUE
 284         );
 285         $contribPageTitle = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $pcpBlock->entity_id, 'title');
 286       }
 287
 288       $this->assign('contribPageUrl', $pageUrl);
 289       $this->assign('contribPageTitle', $contribPageTitle);
 290
 291       $managePCPUrl = CRM_Utils_System::url('civicrm/admin/pcp',
 292         "reset=1",
 293         TRUE, NULL, FALSE,
 294         FALSE
 295       );
 296       $this->assign('managePCPUrl', $managePCPUrl);
 297
 298       //get the default domain email address.
 299       list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain::getNameAndEmail();
 300
 301       if (!$domainEmailAddress || $domainEmailAddress == 'info@EXAMPLE.ORG') {
 302         $fixUrl = CRM_Utils_System::url('civicrm/admin/domain', 'action=update&reset=1');
 303         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)));
 304       }
 305
 306       //if more than one email present for PCP notification ,
 307       //first email take it as To and other as CC and First email
 308       //address should be sent in users email receipt for
 309       //support purpose.
 310       $emailArray = explode(',', $emails);
 311       $to = $emailArray[0];
 312       unset($emailArray[0]);
 313       $cc = implode(',', $emailArray);
 314
 315       list($sent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate(
 316         array(
 317           'groupName' => 'msg_tpl_workflow_contribution',
 318           'valueName' => 'pcp_notify',
 319           'contactId' => $contactID,
 320           'from' => "$domainEmailName <$domainEmailAddress>",
 321           'toEmail' => $to,
 322           'cc' => $cc,
 323         )
 324       );
 325
 326       if ($sent) {
 327         $notifyStatus = ts('A notification email has been sent to the site administrator.');
 328       }
 329     }
 330
 331     CRM_Core_BAO_File::processAttachment($params, 'civicrm_pcp', $pcp->id);
 332
 333     // send email notification to supporter, if initial setup / add mode.
 334     if (!$this->_pageId) {
 335       CRM_PCP_BAO_PCP::sendStatusUpdate($pcp->id, $statusId, TRUE, $this->_component);
 336       if ($approvalMessage && CRM_Utils_Array::value('status_id', $params) == 1) {
 337         $notifyStatus .= ts(' You will receive a second email as soon as the review process is complete.');
 338       }
 339     }
 340
 341     //check if pcp created by anonymous user
 342     $anonymousPCP = 0;
 343     if (!$session->get('userID')) {
 344       $anonymousPCP = 1;
 345     }
 346
 347     CRM_Core_Session::setStatus(ts("Your Personal Campaign Page has been %1 %2 %3",
 348         array(1 => $pageStatus, 2 => $approvalMessage, 3 => $notifyStatus)
 349       ), '', 'info');
 350     if (!$this->_pageId) {
 351       $session->pushUserContext(CRM_Utils_System::url('civicrm/pcp/info', "reset=1&id={$pcp->id}&ap={$anonymousPCP}"));
 352     }
 353     elseif ($this->_context == 'dashboard') {
 354       $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/pcp', 'reset=1'));
 355     }
 356   }
 357 }
 358