CRM/Contribute/Form/UpdateBilling.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 ontribution
  38  *
  39  */
  40 class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form {
  41   protected $_crid = NULL;
  42   protected $_coid = NULL;
  43   protected $_mode = NULL;
  44
  45   protected $_subscriptionDetails = NULL;
  46
  47   protected $_selfService = FALSE;
  48
  49   public $_bltID = NULL;
  50   public $_paymentProcessor = NULL;
  51
  52   public $_paymentProcessorObj = NULL;
  53
  54   /**
  55    * Function to set variables up before form is built
  56    *
  57    * @return void
  58    * @access public
  59    */
  60   public function preProcess() {
  61     $this->_mid = CRM_Utils_Request::retrieve('mid', 'Integer', $this, FALSE);
  62     $this->_crid = CRM_Utils_Request::retrieve('crid', 'Integer', $this, FALSE);
  63     if ($this->_crid) {
  64       $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_crid, 'recur', 'info');
  65       $this->_paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_crid, 'recur', 'obj');
  66       $this->_subscriptionDetails = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($this->_crid);
  67
  68       // Are we cancelling a recurring contribution that is linked to an auto-renew membership?
  69       if ($this->_subscriptionDetails->membership_id) {
  70         $this->_mid = $this->_subscriptionDetails->membership_id;
  71       }
  72     }
  73
  74     $this->_coid = CRM_Utils_Request::retrieve('coid', 'Integer', $this, FALSE);
  75     if ($this->_coid) {
  76       $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_coid, 'contribute', 'info');
  77       $this->_paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_coid, 'contribute', 'obj');
  78       $this->_subscriptionDetails = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($this->_coid, 'contribution');
  79     }
  80
  81     if ($this->_mid) {
  82       $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_mid, 'membership', 'info');
  83       $this->_paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_mid, 'membership', 'obj');
  84       $this->_subscriptionDetails = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($this->_mid, 'membership');
  85       $membershipTypes = CRM_Member_PseudoConstant::membershipType();
  86       $membershipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_mid, 'membership_type_id');
  87       $this->assign('membershipType', CRM_Utils_Array::value($membershipTypeId, $membershipTypes));
  88       $this->_mode = 'auto_renew';
  89     }
  90
  91     if ((!$this->_crid && !$this->_coid && !$this->_mid) ||
  92       ($this->_subscriptionDetails == CRM_Core_DAO::$_nullObject)
  93     ) {
  94       CRM_Core_Error::fatal('Required information missing.');
  95     }
  96     if (!CRM_Core_Permission::check('edit contributions')) {
  97       $userChecksum = CRM_Utils_Request::retrieve('cs', 'String', $this, FALSE);
  98       if (!CRM_Contact_BAO_Contact_Utils::validChecksum($this->_subscriptionDetails->contact_id, $userChecksum)) {
  99         CRM_Core_Error::fatal(ts('You do not have permission to cancel subscription.'));
 100       }
 101       $this->_selfService = TRUE;
 102     }
 103
 104     if (!$this->_paymentProcessorObj->isSupported('updateSubscriptionBillingInfo')) {
 105       CRM_Core_Error::fatal(ts("%1 processor doesn't support updating subscription billing details.",
 106           array(1 => $this->_paymentProcessorObj->_processorName)
 107         ));
 108     }
 109     $this->assign('paymentProcessor', $this->_paymentProcessor);
 110
 111     // get the billing location type
 112     $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id', array(), 'validate');
 113     $this->_bltID = array_search('Billing', $locationTypes);
 114     $this->assign('bltID', $this->_bltID);
 115     if (!$this->_bltID) {
 116       CRM_Core_Error::fatal(ts('Please set a location type of %1', array(1 => 'Billing')));
 117     }
 118
 119     $this->assign('frequency_unit', $this->_subscriptionDetails->frequency_unit);
 120     $this->assign('frequency_interval', $this->_subscriptionDetails->frequency_interval);
 121     $this->assign('amount', $this->_subscriptionDetails->amount);
 122     $this->assign('installments', $this->_subscriptionDetails->installments);
 123     $this->assign('mode', $this->_mode);
 124
 125     // handle context redirection
 126     CRM_Contribute_BAO_ContributionRecur::setSubscriptionContext();
 127   }
 128
 129   /**
 130    * This virtual function is used to set the default values of
 131    * various form elements
 132    *
 133    * access        public
 134    *
 135    * @return array reference to the array of default values
 136    *
 137    */
 138   /**
 139    * @return array
 140    */
 141   function setDefaultValues() {
 142     $this->_defaults = array();
 143
 144     if ($this->_subscriptionDetails->contact_id) {
 145       $options = array();
 146       $fields  = array();
 147       $names   = array(
 148         'first_name', 'middle_name', 'last_name', "street_address-{$this->_bltID}", "city-{$this->_bltID}",
 149         "postal_code-{$this->_bltID}", "country_id-{$this->_bltID}", "state_province_id-{$this->_bltID}",
 150       );
 151       foreach ($names as $name) {
 152         $fields[$name] = 1;
 153       }
 154       $fields["state_province-{$this->_bltID}"] = 1;
 155       $fields["country-{$this->_bltID}"] = 1;
 156       $fields["email-{$this->_bltID}"] = 1;
 157       $fields['email-Primary'] = 1;
 158
 159       CRM_Core_BAO_UFGroup::setProfileDefaults($this->_subscriptionDetails->contact_id, $fields, $this->_defaults);
 160
 161       // use primary email address if billing email address is empty
 162       if (empty($this->_defaults["email-{$this->_bltID}"]) &&
 163         !empty($this->_defaults['email-Primary'])
 164       ) {
 165         $this->_defaults["email-{$this->_bltID}"] = $this->_defaults['email-Primary'];
 166       }
 167
 168       foreach ($names as $name) {
 169         if (!empty($this->_defaults[$name])) {
 170           $this->_defaults['billing_' . $name] = $this->_defaults[$name];
 171         }
 172       }
 173     }
 174
 175
 176     $config = CRM_Core_Config::singleton();
 177     // set default country from config if no country set
 178     if (empty($this->_defaults["billing_country_id-{$this->_bltID}"])) {
 179       $this->_defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry;
 180     }
 181
 182     // now fix all state country selectors
 183     CRM_Core_BAO_Address::fixAllStateSelects($this, $this->_defaults);
 184
 185     return $this->_defaults;
 186   }
 187
 188   /**
 189    * Function to build the form
 190    *
 191    * @return void
 192    * @access public
 193    */
 194   public function buildQuickForm() {
 195     $type = 'next';
 196     if ( $this->_selfService ) {
 197       $type = 'submit';
 198     }
 199
 200     $this->addButtons(array(
 201         array(
 202           'type' => $type,
 203           'name' => ts('Save'),
 204           'isDefault' => TRUE,
 205         ),
 206         array(
 207           'type' => 'cancel',
 208           'name' => ts('Cancel'),
 209         ),
 210       )
 211     );
 212
 213     CRM_Core_Payment_Form::buildCreditCard($this);
 214     $this->addFormRule(array('CRM_Contribute_Form_UpdateBilling', 'formRule'), $this);
 215   }
 216
 217   /**
 218    * global form rule
 219    *
 220    * @param array $fields the input form values
 221    * @param array $files the uploaded files if any
 222    * @param $self
 223    *
 224    * @internal param array $options additional user data
 225    *
 226    * @return true if no errors, else array of errors
 227    * @access public
 228    * @static
 229    */
 230   static function formRule($fields, $files, $self) {
 231     $errors = array();
 232     CRM_Core_Form::validateMandatoryFields($self->_fields, $fields, $errors);
 233
 234     // make sure that credit card number and cvv are valid
 235     CRM_Core_Payment_Form::validateCreditCard($fields, $errors);
 236
 237     return empty($errors) ? TRUE : $errors;
 238   }
 239
 240   /**
 241    * Process the form
 242    *
 243    * @return void
 244    * @access public
 245    */
 246   public function postProcess() {
 247     $params = $this->controller->exportValues($this->_name);
 248     $status = NULL;
 249
 250     // now set the values for the billing location.
 251     foreach ($this->_fields as $name => $value) {
 252       $fields[$name] = 1;
 253     }
 254     $fields["email-{$this->_bltID}"] = 1;
 255
 256     $processorParams = array();
 257     foreach ($params as $key => $val) {
 258       $key = str_replace('billing_', '', $key);
 259       list($key) = explode('-', $key);
 260       $processorParams[$key] = $val;
 261     }
 262     $processorParams['state_province'] = CRM_Core_PseudoConstant::stateProvince($params["billing_state_province_id-{$this->_bltID}"], FALSE);
 263     $processorParams['country'] = CRM_Core_PseudoConstant::country($params["billing_country_id-{$this->_bltID}"], FALSE);
 264     $processorParams['month'] = $processorParams['credit_card_exp_date']['M'];
 265     $processorParams['year'] = $processorParams['credit_card_exp_date']['Y'];
 266     $processorParams['subscriptionId'] = $this->_subscriptionDetails->subscription_id;
 267     $processorParams['amount'] = $this->_subscriptionDetails->amount;
 268
 269     $updateSubscription = $this->_paymentProcessorObj->updateSubscriptionBillingInfo($message, $processorParams);
 270
 271     if (is_a($updateSubscription, 'CRM_Core_Error')) {
 272       CRM_Core_Error::displaySessionError($updateSubscription);
 273     }
 274     elseif ($updateSubscription) {
 275       $ctype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_subscriptionDetails->contact_id, 'contact_type');
 276       $contact = &CRM_Contact_BAO_Contact::createProfileContact($params,
 277         $fields,
 278         $this->_subscriptionDetails->contact_id,
 279         NULL,
 280         NULL,
 281         $ctype
 282       );
 283
 284       // build tpl params
 285       if ($this->_subscriptionDetails->membership_id) {
 286         $inputParams = array('id' => $this->_subscriptionDetails->membership_id);
 287         CRM_Member_BAO_Membership::getValues($inputParams, $tplParams);
 288         $tplParams = $tplParams[$this->_subscriptionDetails->membership_id];
 289         $tplParams['membership_status'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
 290         $tplParams['membershipType'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
 291         $status = ts('Billing details for your automatically renewed %1 membership have been updated.',
 292           array(1 => $tplParams['membershipType'])
 293         );
 294         $msgTitle = ts('Details Updated');
 295         $msgType = 'success';
 296       }
 297       else {
 298         $status = ts('Billing details for the recurring contribution of %1, every %2 %3 have been updated.',
 299           array(
 300             1 => $this->_subscriptionDetails->amount,
 301             2 => $this->_subscriptionDetails->frequency_interval,
 302             3 => $this->_subscriptionDetails->frequency_unit
 303           )
 304         );
 305         $msgTitle = ts('Details Updated');
 306         $msgType = 'success';
 307
 308         $tplParams = array(
 309           'recur_frequency_interval' => $this->_subscriptionDetails->frequency_interval,
 310           'recur_frequency_unit' => $this->_subscriptionDetails->frequency_unit,
 311           'amount' => $this->_subscriptionDetails->amount,
 312         );
 313       }
 314
 315       // format new address for display
 316       $addressParts = array("street_address", "city", "postal_code", "state_province", "country");
 317       foreach ($addressParts as $part) {
 318         $addressParts[$part] = CRM_Utils_Array::value($part, $processorParams);
 319       }
 320       $tplParams['address'] = CRM_Utils_Address::format($addressParts);
 321
 322       // format old address to store in activity details
 323       $this->_defaults["state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant::stateProvince($this->_defaults["state_province-{$this->_bltID}"], FALSE);
 324       $this->_defaults["country-{$this->_bltID}"] = CRM_Core_PseudoConstant::country($this->_defaults["country-{$this->_bltID}"], FALSE);
 325       $addressParts = array("street_address", "city", "postal_code", "state_province", "country");
 326       foreach ($addressParts as $part) {
 327         $key = "{$part}-{$this->_bltID}";
 328         $addressParts[$part] = CRM_Utils_Array::value($key, $this->_defaults);
 329       }
 330       $this->_defaults['address'] = CRM_Utils_Address::format($addressParts);
 331
 332       // format new billing name
 333       $name = $processorParams['first_name'];
 334       if (!empty($processorParams['middle_name'])) {
 335         $name .= " {$processorParams['middle_name']}";
 336       }
 337       $name .= ' ' . $processorParams['last_name'];
 338       $name = trim($name);
 339       $tplParams['billingName'] = $name;
 340
 341       // format old billing name
 342       $name = $this->_defaults['first_name'];
 343       if (!empty($this->_defaults['middle_name'])) {
 344         $name .= " {$this->_defaults['middle_name']}";
 345       }
 346       $name .= ' ' . $this->_defaults['last_name'];
 347       $name = trim($name);
 348       $this->_defaults['billingName'] = $name;
 349
 350       $message .= "
 351 <br/><br/>New Billing Name and Address
 352 <br/>==============================
 353 <br/>{$tplParams['billingName']}
 354 <br/>{$tplParams['address']}
 355
 356 <br/><br/>Previous Billing Name and Address
 357 <br/>==================================
 358 <br/>{$this->_defaults['billingName']}
 359 <br/>{$this->_defaults['address']}";
 360
 361       $activityParams = array(
 362         'source_contact_id' => $this->_subscriptionDetails->contact_id,
 363         'activity_type_id' => CRM_Core_OptionGroup::getValue('activity_type',
 364           'Update Recurring Contribution Billing Details',
 365           'name'
 366         ),
 367         'subject' => ts('Recurring Contribution Billing Details Updated'),
 368         'details' => $message,
 369         'activity_date_time' => date('YmdHis'),
 370         'status_id' => CRM_Core_OptionGroup::getValue('activity_status',
 371           'Completed',
 372           'name'
 373         ),
 374       );
 375       $session = CRM_Core_Session::singleton();
 376       $cid = $session->get('userID');
 377       if ($cid) {
 378         $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
 379         $activityParams['source_contact_id'] = $cid;
 380       }
 381       CRM_Activity_BAO_Activity::create($activityParams);
 382
 383       // send notification
 384       if ($this->_subscriptionDetails->contribution_page_id) {
 385         CRM_Core_DAO::commonRetrieveAll('CRM_Contribute_DAO_ContributionPage', 'id',
 386           $this->_subscriptionDetails->contribution_page_id, $value, array(
 387             'title',
 388             'receipt_from_name',
 389             'receipt_from_email',
 390           )
 391         );
 392         $receiptFrom = '"' . CRM_Utils_Array::value('receipt_from_name', $value[$this->_subscriptionDetails->contribution_page_id]) . '" <' . $value[$this->_subscriptionDetails->contribution_page_id]['receipt_from_email'] . '>';
 393       }
 394       else {
 395         $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
 396         $receiptFrom = "$domainValues[0] <$domainValues[1]>";
 397       }
 398       list($donorDisplayName, $donorEmail) = CRM_Contact_BAO_Contact::getContactDetails($this->_subscriptionDetails->contact_id);
 399       $tplParams['contact'] = array('display_name' => $donorDisplayName);
 400
 401       $date = CRM_Utils_Date::format($processorParams['credit_card_exp_date']);
 402       $tplParams['credit_card_exp_date'] = CRM_Utils_Date::mysqlToIso($date);
 403       $tplParams['credit_card_number'] = CRM_Utils_System::mungeCreditCard($processorParams['credit_card_number']);
 404       $tplParams['credit_card_type'] = $processorParams['credit_card_type'];
 405
 406       $sendTemplateParams = array(
 407         'groupName' => $this->_subscriptionDetails->membership_id ? 'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
 408         'valueName' => $this->_subscriptionDetails->membership_id ? 'membership_autorenew_billing' : 'contribution_recurring_billing',
 409         'contactId' => $this->_subscriptionDetails->contact_id,
 410         'tplParams' => $tplParams,
 411         'isTest' => $this->_subscriptionDetails->is_test,
 412         'PDFFilename' => 'receipt.pdf',
 413         'from' => $receiptFrom,
 414         'toName' => $donorDisplayName,
 415         'toEmail' => $donorEmail,
 416       );
 417       list($sent) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
 418     }
 419     else {
 420       $status = ts('There was some problem updating the billing details.');
 421       $msgTitle = ts('Update Error');
 422       $msgType = 'error';
 423     }
 424
 425     $session = CRM_Core_Session::singleton();
 426     $userID  = $session->get('userID');
 427     if ( $userID && $status) {
 428       $session->setStatus($status, $msgTitle, $msgType);
 429     } else if (!$userID) {
 430       if ($status)
 431         CRM_Utils_System::setUFMessage($status);
 432       $result = (int) ($updateSubscription && isset($ctype));
 433       if (isset($tplParams))
 434         $session->set('resultParams', $tplParams);
 435       return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/subscriptionstatus',
 436                                                               "reset=1&task=billing&result={$result}"));
 437     }
 438   }
 439 }
 440