CRM/Contribute/Form/Contribution.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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 usefusul, 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-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for processing a contribution
  38  *
  39  */
  40 class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditPayment {
  41   /**
  42    * the id of the contribution that we are proceessing
  43    *
  44    * @var int
  45    * @public
  46    */
  47   public $_id;
  48
  49   /**
  50    * the id of the premium that we are proceessing
  51    *
  52    * @var int
  53    * @public
  54    */
  55   public $_premiumID = NULL;
  56   public $_productDAO = NULL;
  57
  58   /**
  59    * the id of the note
  60    *
  61    * @var int
  62    * @public
  63    */
  64   public $_noteID;
  65
  66   /**
  67    * the id of the contact associated with this contribution
  68    *
  69    * @var int
  70    * @public
  71    */
  72   public $_contactID;
  73
  74   /**
  75    * the id of the pledge payment that we are processing
  76    *
  77    * @var int
  78    * @public
  79    */
  80   public $_ppID;
  81
  82   /**
  83    * the id of the pledge that we are processing
  84    *
  85    * @var int
  86    * @public
  87    */
  88   public $_pledgeID;
  89
  90   /**
  91    * is this contribution associated with an online
  92    * financial transaction
  93    *
  94    * @var boolean
  95    * @public
  96    */
  97   public $_online = FALSE;
  98
  99   /**
 100    * Stores all product option
 101    *
 102    * @var array
 103    * @public
 104    */
 105   public $_options;
 106
 107   /**
 108    * stores the honor id
 109    *
 110    * @var int
 111    * @public
 112    */
 113   public $_honorID = NULL;
 114
 115   /**
 116    * Store the contribution Type ID
 117    *
 118    * @var array
 119    */
 120   public $_contributionType;
 121
 122   /**
 123    * The contribution values if an existing contribution
 124    */
 125   public $_values;
 126
 127   /**
 128    * The pledge values if this contribution is associated with pledge
 129    */
 130   public $_pledgeValues;
 131
 132   public $_contributeMode = 'direct';
 133
 134   public $_context;
 135
 136   public $_compId;
 137
 138   /*
 139    * Store the line items if price set used.
 140    */
 141   public $_lineItems;
 142
 143   /**
 144    * @var soft credit info
 145    */
 146   public $_softCreditInfo;
 147
 148   protected $_formType;
 149   protected $_cdType;
 150
 151   /**
 152    * Function to set variables up before form is built
 153    *
 154    * @return void
 155    * @access public
 156    */
 157   public function preProcess() {
 158
 159     //check permission for action.
 160     if (!CRM_Core_Permission::checkActionPermission('CiviContribute', $this->_action)) {
 161       CRM_Core_Error::fatal(ts('You do not have permission to access this page'));
 162     }
 163
 164     $this->_cdType = CRM_Utils_Array::value('type', $_GET);
 165
 166     $this->assign('cdType', FALSE);
 167     if ($this->_cdType) {
 168       $this->assign('cdType', TRUE);
 169       CRM_Custom_Form_CustomData::preProcess($this);
 170       return;
 171     }
 172
 173     $config = CRM_Core_Config::singleton();
 174     $resources = CRM_Core_Resources::singleton();
 175     $resources->addScriptFile('civicrm', 'templates/CRM/Contribute/Form/SoftCredit.js');
 176     $resources->addSetting(array('monetaryThousandSeparator' => $config->monetaryThousandSeparator));
 177
 178     $this->_formType = CRM_Utils_Array::value('formType', $_GET);
 179
 180     // get price set id.
 181     $this->_priceSetId = CRM_Utils_Array::value('priceSetId', $_GET);
 182     $this->set('priceSetId', $this->_priceSetId);
 183     $this->assign('priceSetId', $this->_priceSetId);
 184
 185     //get the pledge payment id
 186     $this->_ppID = CRM_Utils_Request::retrieve('ppid', 'Positive', $this);
 187
 188     //get the contact id
 189     $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 190
 191     //get the action.
 192     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
 193     $this->assign('action', $this->_action);
 194
 195     //get the contribution id if update
 196     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 197     if (!empty($this->_id)) {
 198       $this->assign('contribID', $this->_id);
 199     }
 200
 201     $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this);
 202     $this->assign('context', $this->_context);
 203
 204     $this->_compId = CRM_Utils_Request::retrieve('compId', 'Positive', $this);
 205
 206     $this->_compContext = CRM_Utils_Request::retrieve('compContext', 'String', $this);
 207
 208     //set the contribution mode.
 209     $this->_mode = CRM_Utils_Request::retrieve('mode', 'String', $this);
 210
 211     $this->assign('contributionMode', $this->_mode);
 212
 213     $this->_paymentProcessor = array('billing_mode' => 1);
 214
 215     $this->assign('showCheckNumber', TRUE);
 216
 217     $this->_fromEmails = CRM_Core_BAO_Email::getFromEmail();
 218     $this->assignProcessors();
 219
 220     if ($this->_contactID) {
 221       list($this->userDisplayName, $this->userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 222       $this->assign('displayName', $this->userDisplayName);
 223     }
 224
 225     // also check for billing information
 226     // get the billing location type
 227     $this->assignBillingType();
 228
 229     $this->_fields = array();
 230
 231     CRM_Core_Payment_Form::setPaymentFieldsByType(CRM_Utils_Array::value('payment_type', $this->_processors), $this);
 232
 233     if ($this->_action & CRM_Core_Action::DELETE) {
 234       return;
 235     }
 236
 237     if (in_array('CiviPledge', $config->enableComponents) && !$this->_formType) {
 238       $this->preProcessPledge();
 239     }
 240
 241     $this->_values = array();
 242
 243     // current contribution id
 244     if ($this->_id) {
 245       $this->assignPremiumProduct($this->_id);
 246       $this->buildValuesAndAssignOnline_Note_Type($this->_id, $this->_values);
 247     }
 248
 249     // when custom data is included in this page
 250     if (CRM_Utils_Array::value('hidden_custom', $_POST)) {
 251       $this->applyCustomData('Contribution', CRM_Utils_Array::value('financial_type_id', $_POST), $this->_id);
 252     }
 253
 254     $this->_lineItems = array();
 255     if ($this->_id) {
 256       if (!empty($this->_compId) && $this->_compContext == 'participant') {
 257         $this->assign('compId', $this->_compId);
 258         $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->_compId);
 259       }
 260       else {
 261         $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->_id, 'contribution', 1);
 262       }
 263       empty($lineItem) ? NULL : $this->_lineItems[] = $lineItem;
 264     }
 265
 266     $this->assign('lineItem', empty($this->_lineItems) ? FALSE : $this->_lineItems);
 267
 268     // Set title
 269     if ($this->_contactID) {
 270       $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactID);
 271
 272       // Check if this is default domain contact CRM-10482
 273       if (CRM_Contact_BAO_Contact::checkDomainContact($this->_contactID)) {
 274         $displayName .= ' (' . ts('default organization') . ')';
 275       }
 276
 277       // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
 278       CRM_Utils_System::setTitle(ts('Contribution from') . ' ' . $displayName);
 279     }
 280   }
 281
 282   function setDefaultValues() {
 283     if ($this->_cdType) {
 284       return CRM_Custom_Form_CustomData::setDefaultValues($this);
 285     }
 286
 287     $defaults = $this->_values;
 288
 289     //set defaults for pledge payment.
 290     if ($this->_ppID) {
 291       $defaults['total_amount'] = CRM_Utils_Array::value('scheduled_amount', $this->_pledgeValues['pledgePayment']);
 292       $defaults['honor_type_id'] = CRM_Utils_Array::value('honor_type_id', $this->_pledgeValues);
 293       $defaults['honor_contact_id'] = CRM_Utils_Array::value('honor_contact_id', $this->_pledgeValues);
 294       $defaults['financial_type_id'] = CRM_Utils_Array::value('financial_type_id', $this->_pledgeValues);
 295       $defaults['currency'] = CRM_Utils_Array::value('currency', $this->_pledgeValues);
 296       $defaults['option_type'] = 1;
 297     }
 298
 299     $fields = array();
 300     if ($this->_action & CRM_Core_Action::DELETE) {
 301       return $defaults;
 302     }
 303
 304     // set soft credit defaults
 305     CRM_Contribute_Form_SoftCredit::setDefaultValues($defaults, $this);
 306
 307     if ($this->_mode) {
 308       $config = CRM_Core_Config::singleton();
 309       // set default country from config if no country set
 310       if (!CRM_Utils_Array::value("billing_country_id-{$this->_bltID}", $defaults)) {
 311         $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry;
 312       }
 313
 314       if (!CRM_Utils_Array::value("billing_state_province_id-{$this->_bltID}", $defaults)) {
 315         $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince;
 316       }
 317
 318       $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID);
 319       $defaults = array_merge($defaults, $billingDefaults);
 320
 321       // now fix all state country selectors, set correct state based on country
 322       CRM_Core_BAO_Address::fixAllStateSelects($this, $defaults);
 323     }
 324
 325     if ($this->_id) {
 326       $this->_contactID = $defaults['contact_id'];
 327     }
 328
 329     // Set $newCredit variable in template to control whether link to credit card mode is included
 330     CRM_Core_Payment::allowBackofficeCreditCard($this);
 331
 332     // fix the display of the monetary value, CRM-4038
 333     if (isset($defaults['total_amount'])) {
 334       $defaults['total_amount'] = CRM_Utils_Money::format($defaults['total_amount'], NULL, '%a');
 335     }
 336
 337     if (isset($defaults['non_deductible_amount'])) {
 338       $defaults['non_deductible_amount'] = CRM_Utils_Money::format($defaults['non_deductible_amount'], NULL, '%a');
 339     }
 340
 341     if (isset($defaults['fee_amount'])) {
 342       $defaults['fee_amount'] = CRM_Utils_Money::format($defaults['fee_amount'], NULL, '%a');
 343     }
 344
 345     if (isset($defaults['net_amount'])) {
 346       $defaults['net_amount'] = CRM_Utils_Money::format($defaults['net_amount'], NULL, '%a');
 347     }
 348
 349     if ($this->_contributionType) {
 350       $defaults['financial_type_id'] = $this->_contributionType;
 351     }
 352
 353     if (!CRM_Utils_Array::value('payment_instrument_id', $defaults)) {
 354       $defaults['payment_instrument_id'] = key(CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
 355     }
 356
 357     if (CRM_Utils_Array::value('is_test', $defaults)) {
 358       $this->assign('is_test', TRUE);
 359     }
 360
 361     if (isset($defaults['honor_contact_id'])) {
 362       $honorDefault = $ids = array();
 363       $this->_honorID = $defaults['honor_contact_id'];
 364       $honorType = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'honor_type_id');
 365       $idParams = array(
 366         'id' => $defaults['honor_contact_id'],
 367         'contact_id' => $defaults['honor_contact_id'],
 368       );
 369       CRM_Contact_BAO_Contact::retrieve($idParams, $honorDefault, $ids);
 370
 371       $defaults['honor_prefix_id'] = CRM_Utils_Array::value('prefix_id', $honorDefault);
 372       $defaults['honor_first_name'] = CRM_Utils_Array::value('first_name', $honorDefault);
 373       $defaults['honor_last_name'] = CRM_Utils_Array::value('last_name', $honorDefault);
 374       $defaults['honor_email'] = CRM_Utils_Array::value('email', $honorDefault['email'][1]);
 375       $defaults['honor_type'] = $honorType[$defaults['honor_type_id']];
 376     }
 377
 378     $this->assign('showOption', TRUE);
 379     // for Premium section
 380     if ($this->_premiumID) {
 381       $this->assign('showOption', FALSE);
 382       $options = isset($this->_options[$this->_productDAO->product_id]) ? $this->_options[$this->_productDAO->product_id] : "";
 383       if (!$options) {
 384         $this->assign('showOption', TRUE);
 385       }
 386       $options_key = CRM_Utils_Array::key($this->_productDAO->product_option, $options);
 387       if ($options_key) {
 388         $defaults['product_name'] = array($this->_productDAO->product_id, trim($options_key));
 389       }
 390       else {
 391         $defaults['product_name'] = array($this->_productDAO->product_id);
 392       }
 393       if ($this->_productDAO->fulfilled_date) {
 394         list($defaults['fulfilled_date']) = CRM_Utils_Date::setDateDefaults($this->_productDAO->fulfilled_date);
 395       }
 396     }
 397
 398     if (isset($this->userEmail)) {
 399       $this->assign('email', $this->userEmail);
 400     }
 401
 402     if (CRM_Utils_Array::value('is_pay_later', $defaults)) {
 403       $this->assign('is_pay_later', TRUE);
 404     }
 405     $this->assign('contribution_status_id', CRM_Utils_Array::value('contribution_status_id', $defaults));
 406
 407     $dates = array('receive_date', 'receipt_date', 'cancel_date', 'thankyou_date');
 408     foreach ($dates as $key) {
 409       if (CRM_Utils_Array::value($key, $defaults)) {
 410         list($defaults[$key],
 411           $defaults[$key . '_time']
 412           ) = CRM_Utils_Date::setDateDefaults(CRM_Utils_Array::value($key, $defaults),
 413           'activityDateTime'
 414         );
 415       }
 416     }
 417
 418     if (!$this->_id && !CRM_Utils_Array::value('receive_date', $defaults)) {
 419       list($defaults['receive_date'],
 420         $defaults['receive_date_time']
 421         ) = CRM_Utils_Date::setDateDefaults(NULL, 'activityDateTime');
 422     }
 423
 424     $this->assign('receive_date', CRM_Utils_Date::processDate(CRM_Utils_Array::value('receive_date', $defaults),
 425       CRM_Utils_Array::value('receive_date_time', $defaults)
 426     ));
 427     $currency = CRM_Utils_Array::value('currency', $defaults);
 428     $this->assign('currency', $currency);
 429     // Hack to get currency info to the js layer. CRM-11440
 430     CRM_Utils_Money::format(1);
 431     $this->assign('currencySymbol', CRM_Utils_Array::value($currency, CRM_Utils_Money::$_currencySymbols));
 432     $this->assign('totalAmount', CRM_Utils_Array::value('total_amount', $defaults));
 433
 434     //inherit campaign from pledge.
 435     if ($this->_ppID && CRM_Utils_Array::value('campaign_id', $this->_pledgeValues)) {
 436       $defaults['campaign_id'] = $this->_pledgeValues['campaign_id'];
 437     }
 438
 439     $this->_defaults = $defaults;
 440     return $defaults;
 441   }
 442
 443   /**
 444    * Function to build the form
 445    *
 446    * @return void
 447    * @access public
 448    */
 449   public function buildQuickForm() {
 450     if ($this->_cdType) {
 451       CRM_Custom_Form_CustomData::buildQuickForm($this);
 452       return;
 453     }
 454
 455     // build price set form.
 456     $buildPriceSet = FALSE;
 457     if (empty($this->_lineItems) &&
 458       ($this->_priceSetId || CRM_Utils_Array::value('price_set_id', $_POST))
 459     ) {
 460       $buildPriceSet = TRUE;
 461       $getOnlyPriceSetElements = TRUE;
 462       if (!$this->_priceSetId) {
 463         $this->_priceSetId = $_POST['price_set_id'];
 464         $getOnlyPriceSetElements = FALSE;
 465       }
 466
 467       $this->set('priceSetId', $this->_priceSetId);
 468       CRM_Price_BAO_PriceSet::buildPriceSet($this);
 469
 470       // get only price set form elements.
 471       if ($getOnlyPriceSetElements) {
 472         return;
 473       }
 474     }
 475     // use to build form during form rule.
 476     $this->assign('buildPriceSet', $buildPriceSet);
 477
 478     $showAdditionalInfo = FALSE;
 479
 480     $defaults = $this->_values;
 481     $additionalDetailFields = array(
 482       'note',
 483       'thankyou_date',
 484       'invoice_id',
 485       'non_deductible_amount',
 486       'fee_amount',
 487       'net_amount',
 488     );
 489     foreach ($additionalDetailFields as $key) {
 490       if (!empty($defaults[$key])) {
 491         $defaults['hidden_AdditionalDetail'] = 1;
 492         break;
 493       }
 494     }
 495
 496     $honorFields = array(
 497       'honor_type_id',
 498       'honor_prefix_id',
 499       'honor_first_name',
 500       'honor_lastname',
 501       'honor_email',
 502     );
 503     foreach ($honorFields as $key) {
 504       if (!empty($defaults[$key])) {
 505         $defaults['hidden_Honoree'] = 1;
 506         break;
 507       }
 508     }
 509
 510     //check for honoree pane.
 511     if ($this->_ppID && CRM_Utils_Array::value('honor_contact_id', $this->_pledgeValues)) {
 512       $defaults['hidden_Honoree'] = 1;
 513     }
 514
 515     if ($this->_productDAO) {
 516       if ($this->_productDAO->product_id) {
 517         $defaults['hidden_Premium'] = 1;
 518       }
 519     }
 520
 521     if ($this->_noteID &&
 522       isset($this->_values['note'])
 523     ) {
 524       $defaults['hidden_AdditionalDetail'] = 1;
 525     }
 526
 527     $paneNames = array(
 528       ts('Additional Details') => 'AdditionalDetail',
 529       ts('Honoree Information') => 'Honoree'
 530     );
 531
 532     //Add Premium pane only if Premium is exists.
 533     $dao = new CRM_Contribute_DAO_Product();
 534     $dao->is_active = 1;
 535
 536     if ($dao->find(TRUE)) {
 537       $paneNames[ts('Premium Information')] = 'Premium';
 538     }
 539
 540     $ccPane = NULL;
 541     if ($this->_mode) {
 542       if (CRM_Utils_Array::value('payment_type', $this->_processors) & CRM_Core_Payment::PAYMENT_TYPE_DIRECT_DEBIT
 543       ) {
 544         $ccPane = array(ts('Direct Debit Information') => 'DirectDebit');
 545       }
 546       else {
 547         $ccPane = array(ts('Credit Card Information') => 'CreditCard');
 548       }
 549     }
 550     if (is_array($ccPane)) {
 551       $paneNames = array_merge($ccPane, $paneNames);
 552     }
 553
 554     $buildRecurBlock = FALSE;
 555     foreach ($paneNames as $name => $type) {
 556       $urlParams = "snippet=4&formType={$type}";
 557       if ($this->_mode) {
 558         $urlParams .= "&mode={$this->_mode}";
 559       }
 560
 561       $open = 'false';
 562       if ($type == 'CreditCard' ||
 563         $type == 'DirectDebit'
 564       ) {
 565         $open = 'true';
 566       }
 567
 568       $allPanes[$name] = array(
 569         'url' => CRM_Utils_System::url('civicrm/contact/view/contribution', $urlParams),
 570         'open' => $open,
 571         'id' => $type
 572       );
 573
 574       // see if we need to include this paneName in the current form
 575       if ($this->_formType == $type ||
 576         CRM_Utils_Array::value("hidden_{$type}", $_POST) ||
 577         CRM_Utils_Array::value("hidden_{$type}", $defaults)
 578       ) {
 579         $showAdditionalInfo = TRUE;
 580         $allPanes[$name]['open'] = 'true';
 581       }
 582
 583       if ($type == 'CreditCard') {
 584         $buildRecurBlock = TRUE;
 585         $this->add('hidden', 'hidden_CreditCard', 1);
 586         CRM_Core_Payment_Form::buildCreditCard($this, TRUE);
 587       }
 588       elseif ($type == 'DirectDebit') {
 589         $buildRecurBlock = TRUE;
 590         $this->add('hidden', 'hidden_DirectDebit', 1);
 591         CRM_Core_Payment_Form::buildDirectDebit($this, TRUE);
 592       }
 593       else {
 594         $additionalInfoFormFunction = 'build' . $type;
 595         CRM_Contribute_Form_AdditionalInfo::$additionalInfoFormFunction($this);
 596       }
 597     }
 598     if (empty($this->_recurPaymentProcessors)) {
 599       $buildRecurBlock = FALSE;
 600     }
 601     if ($buildRecurBlock) {
 602       CRM_Contribute_Form_Contribution_Main::buildRecur($this);
 603       $this->setDefaults(array('is_recur' => 0));
 604     }
 605     $this->assign('buildRecurBlock', $buildRecurBlock);
 606     $qfKey = $this->controller->_key;
 607     $this->assign('qfKey', $qfKey);
 608     $this->assign('allPanes', $allPanes);
 609     $this->assign('showAdditionalInfo', $showAdditionalInfo);
 610
 611     if ($this->_formType) {
 612       $this->assign('formType', $this->_formType);
 613       return;
 614     }
 615
 616     $this->applyFilter('__ALL__', 'trim');
 617
 618     if ($this->_action & CRM_Core_Action::DELETE) {
 619       $this->addButtons(array(
 620           array(
 621             'type' => 'next',
 622             'name' => ts('Delete'),
 623             'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 624             'isDefault' => TRUE,
 625           ),
 626           array(
 627             'type' => 'cancel',
 628             'name' => ts('Cancel')
 629           )
 630         )
 631       );
 632       return;
 633     }
 634
 635     //need to assign custom data type and subtype to the template
 636     $this->assign('customDataType', 'Contribution');
 637     $this->assign('customDataSubType', $this->_contributionType);
 638     $this->assign('entityID', $this->_id);
 639
 640     if ($this->_context == 'standalone') {
 641       CRM_Contact_Form_NewContact::buildQuickForm($this);
 642     }
 643
 644     $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution');
 645
 646     $financialType = $this->add('select', 'financial_type_id',
 647       ts('Financial Type'),
 648       array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::financialType(),
 649       TRUE,
 650       array('onChange' => "CRM.buildCustomData( 'Contribution', this.value );")
 651     );
 652
 653     if (!$this->_mode) {
 654       $paymentInstrument = $this->add('select', 'payment_instrument_id',
 655         ts('Paid By'),
 656         array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::paymentInstrument(),
 657         TRUE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
 658       );
 659     }
 660
 661     $trxnId = $this->add('text', 'trxn_id', ts('Transaction ID'), $attributes['trxn_id']);
 662
 663     //add receipt for offline contribution
 664     $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
 665
 666     $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails);
 667
 668     $status = CRM_Contribute_PseudoConstant::contributionStatus();
 669
 670     // suppressing contribution statuses that are NOT relevant to pledges (CRM-5169)
 671     $statusName = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 672     if ($this->_ppID) {
 673       foreach (array(
 674                  'Cancelled',
 675                  'Failed',
 676                  'In Progress'
 677                ) as $suppress) {
 678         unset($status[CRM_Utils_Array::key($suppress, $statusName)]);
 679       }
 680     }
 681     elseif ((!$this->_ppID && $this->_id) || !$this->_id) {
 682       foreach (array(
 683                  'Overdue',
 684                  'In Progress'
 685                ) as $suppress) {
 686         unset($status[CRM_Utils_Array::key($suppress, $statusName)]);
 687       }
 688     }
 689     if ($this->_id) {
 690       $contributionStatus = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_id, 'contribution_status_id');
 691       $name = CRM_Utils_Array::value($contributionStatus, $statusName);
 692       switch ($name) {
 693         case 'Completed':
 694         case 'Cancelled':
 695         case 'Refunded':
 696           unset($status[CRM_Utils_Array::key('Pending', $statusName)]);
 697           unset($status[CRM_Utils_Array::key('Failed', $statusName)]);
 698           break;
 699         case 'Pending':
 700           unset($status[CRM_Utils_Array::key('Refunded', $statusName)]);
 701           break;
 702         case 'Failed':
 703           foreach (array(
 704                      'Pending',
 705                      'Refunded',
 706                      'Completed',
 707                      'Cancelled'
 708                    ) as $suppress) {
 709             unset($status[CRM_Utils_Array::key($suppress, $statusName)]);
 710           }
 711           break;
 712       }
 713     }
 714     else {
 715       unset($status[CRM_Utils_Array::key('Refunded', $statusName)]);
 716     }
 717
 718     $this->add('select', 'contribution_status_id',
 719       ts('Contribution Status'),
 720       $status,
 721       FALSE
 722     );
 723
 724     // add various dates
 725     $this->addDateTime('receive_date', ts('Received'), FALSE, array('formatType' => 'activityDateTime'));
 726
 727     if ($this->_online) {
 728       $this->assign('hideCalender', TRUE);
 729     }
 730     $checkNumber = $this->add('text', 'check_number', ts('Check Number'), $attributes['check_number']);
 731
 732     $this->addDateTime('receipt_date', ts('Receipt Date'), FALSE, array('formatType' => 'activityDateTime'));
 733     $this->addDateTime('cancel_date', ts('Cancelled / Refunded Date'), FALSE, array('formatType' => 'activityDateTime'));
 734
 735     $this->add('textarea', 'cancel_reason', ts('Cancellation / Refund Reason'), $attributes['cancel_reason']);
 736
 737     $recurJs = NULL;
 738     if ($buildRecurBlock) {
 739       $recurJs = array('onChange' => "buildRecurBlock( this.value ); return false;");
 740     }
 741     $element = $this->add('select',
 742       'payment_processor_id',
 743       ts('Payment Processor'),
 744       $this->_processors,
 745       NULL,
 746       $recurJs
 747     );
 748
 749     if ($this->_online) {
 750       $element->freeze();
 751     }
 752     $totalAmount = NULL;
 753     if (empty($this->_lineItems)) {
 754       $buildPriceSet = FALSE;
 755       $priceSets = CRM_Price_BAO_PriceSet::getAssoc(FALSE, 'CiviContribute');
 756       if (!empty($priceSets) && !$this->_ppID) {
 757         $buildPriceSet = TRUE;
 758       }
 759
 760       // don't allow price set for contribution if it is related to participant, or if it is a pledge payment
 761       // and if we already have line items for that participant. CRM-5095
 762       if ($buildPriceSet && $this->_id) {
 763         $componentDetails = CRM_Contribute_BAO_Contribution::getComponentDetails($this->_id);
 764         $pledgePaymentId = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
 765           $this->_id,
 766           'id',
 767           'contribution_id'
 768         );
 769         if ($pledgePaymentId) {
 770           $buildPriceSet = FALSE;
 771         }
 772         if ($participantID = CRM_Utils_Array::value('participant', $componentDetails)) {
 773           $participantLI = CRM_Price_BAO_LineItem::getLineItems($participantID);
 774           if (!CRM_Utils_System::isNull($participantLI)) {
 775             $buildPriceSet = FALSE;
 776           }
 777         }
 778       }
 779
 780       $hasPriceSets = FALSE;
 781       if ($buildPriceSet) {
 782         $hasPriceSets = TRUE;
 783         $element = $this->add('select', 'price_set_id', ts('Choose price set'),
 784           array(
 785             '' => ts('Choose price set')
 786           ) + $priceSets,
 787           NULL, array('onchange' => "buildAmount( this.value );")
 788         );
 789         if ($this->_online && !($this->_action & CRM_Core_Action::UPDATE)) {
 790           $element->freeze();
 791         }
 792       }
 793       $this->assign('hasPriceSets', $hasPriceSets);
 794       $currencyFreeze = FALSE;
 795       if (!($this->_action & CRM_Core_Action::UPDATE)) {
 796         if ($this->_online || $this->_ppID) {
 797           $attributes['total_amount'] = array_merge($attributes['total_amount'], array(
 798             'READONLY' => TRUE,
 799             'style' => "background-color:#EBECE4"
 800           ));
 801           $optionTypes = array(
 802             '1' => ts('Adjust Pledge Payment Schedule?'),
 803             '2' => ts('Adjust Total Pledge Amount?'),
 804           );
 805           $this->addRadio('option_type',
 806             NULL,
 807             $optionTypes,
 808             array(), '<br/>'
 809           );
 810
 811           $currencyFreeze = TRUE;
 812         }
 813       }
 814
 815       $totalAmount = $this->addMoney('total_amount',
 816         ts('Total Amount'),
 817         ($hasPriceSets) ? FALSE : TRUE,
 818         $attributes['total_amount'],
 819         TRUE, 'currency', NULL, $currencyFreeze
 820       );
 821     }
 822
 823     $this->add('text', 'source', ts('Source'), CRM_Utils_Array::value('source', $attributes));
 824
 825     //CRM-7362 --add campaigns.
 826     CRM_Campaign_BAO_Campaign::addCampaign($this, CRM_Utils_Array::value('campaign_id', $this->_values));
 827
 828     CRM_Contribute_Form_SoftCredit::buildQuickForm($this);
 829
 830     $js = NULL;
 831     if (!$this->_mode) {
 832       $js = array('onclick' => "return verify( );");
 833     }
 834
 835     $mailingInfo = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
 836       'mailing_backend'
 837     );
 838     $this->assign('outBound_option', $mailingInfo['outBound_option']);
 839
 840     $this->addButtons(array(
 841         array(
 842           'type' => 'upload',
 843           'name' => ts('Save'),
 844           'js' => $js,
 845           'isDefault' => TRUE
 846         ),
 847         array(
 848           'type' => 'upload',
 849           'name' => ts('Save and New'),
 850           'js' => $js,
 851           'subName' => 'new'
 852         ),
 853         array(
 854           'type' => 'cancel',
 855           'name' => ts('Cancel')
 856         ),
 857       )
 858     );
 859
 860     // if status is Cancelled freeze Amount, Payment Instrument, Check #, Financial Type,
 861     // Net and Fee Amounts are frozen in AdditionalInfo::buildAdditionalDetail
 862     if ($this->_id && $this->_values['contribution_status_id'] == array_search('Cancelled', $statusName)) {
 863       if ($totalAmount) {
 864         $totalAmount->freeze();
 865       }
 866       $checkNumber->freeze();
 867       $paymentInstrument->freeze();
 868       $trxnId->freeze();
 869       $financialType->freeze();
 870     }
 871
 872     $this->addFormRule(array('CRM_Contribute_Form_Contribution', 'formRule'), $this);
 873
 874     if ($this->_action & CRM_Core_Action::VIEW) {
 875       $this->freeze();
 876     }
 877   }
 878
 879   /**
 880    * global form rule
 881    *
 882    * @param array $fields  the input form values
 883    * @param array $files   the uploaded files if any
 884    * @param array $options additional user data
 885    *
 886    * @return true if no errors, else array of errors
 887    * @access public
 888    * @static
 889    */
 890   static function formRule($fields, $files, $self) {
 891     $errors = array();
 892
 893     //check if contact is selected in standalone mode
 894     if (isset($fields['contact_select_id'][1]) && !$fields['contact_select_id'][1]) {
 895       $errors['contact[1]'] = ts('Please select a contact or create new contact');
 896     }
 897
 898     if (isset($fields['honor_type_id'])) {
 899       if (!((CRM_Utils_Array::value('honor_first_name', $fields) &&
 900         CRM_Utils_Array::value('honor_last_name', $fields)
 901       ) ||
 902         CRM_Utils_Array::value('honor_email', $fields)
 903       )
 904       ) {
 905         $errors['honor_first_name'] = ts('Honor First Name and Last Name OR an email should be set.');
 906       }
 907     }
 908
 909     //check for Credit Card Contribution.
 910     if ($self->_mode) {
 911       if (empty($fields['payment_processor_id'])) {
 912         $errors['payment_processor_id'] = ts('Payment Processor is a required field.');
 913       }
 914     }
 915
 916     // do the amount validations.
 917     if (!CRM_Utils_Array::value('total_amount', $fields) && empty($self->_lineItems)) {
 918       if ($priceSetId = CRM_Utils_Array::value('price_set_id', $fields)) {
 919         CRM_Price_BAO_PriceField::priceSetValidation($priceSetId, $fields, $errors);
 920       }
 921     }
 922
 923     $softErrors = CRM_Contribute_Form_SoftCredit::formRule($fields);
 924
 925     if (CRM_Utils_Array::value('total_amount', $fields) && (CRM_Utils_Array::value('net_amount', $fields) || CRM_Utils_Array::value('fee_amount', $fields))) {
 926       $sum = CRM_Utils_Rule::cleanMoney($fields['net_amount']) + CRM_Utils_Rule::cleanMoney($fields['fee_amount']);
 927       if (CRM_Utils_Rule::cleanMoney($fields['total_amount']) != $sum) {
 928         $errors['total_amount'] = ts('The sum of fee amount and net amount must be equal to total amount');
 929       }
 930     }
 931     //form rule for status http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
 932     if ($self->_id && $self->_values['contribution_status_id'] != $fields['contribution_status_id']) {
 933       CRM_Contribute_BAO_Contribution::checkStatusValidation($self->_values, $fields, $errors);
 934     }
 935
 936     //FIXME FOR NEW DATA FLOW http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
 937      if (CRM_Utils_Array::value('fee_amount', $fields)
 938       && $financialType = CRM_Contribute_BAO_Contribution::validateFinancialType($fields['financial_type_id'])) {
 939       $errors['financial_type_id'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
 940     }
 941
 942     $errors = array_merge($errors, $softErrors);
 943     return $errors;
 944   }
 945
 946   /**
 947    * Function to process the form
 948    *
 949    * @access public
 950    *
 951    * @return void
 952    */
 953   public function postProcess() {
 954     $session = CRM_Core_Session::singleton();
 955     if ($this->_action & CRM_Core_Action::DELETE) {
 956       CRM_Contribute_BAO_Contribution::deleteContribution($this->_id);
 957       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
 958         "reset=1&cid={$this->_contactID}&selectedChild=contribute"
 959       ));
 960       return;
 961     }
 962
 963     // get the submitted form values.
 964     $submittedValues = $this->controller->exportValues($this->_name);
 965     if (CRM_Utils_Array::value('price_set_id', $submittedValues) && $this->_action & CRM_Core_Action::UPDATE) {
 966       $line = CRM_Price_BAO_LineItem::getLineItems($this->_id, 'contribution');
 967       $lineID = key($line);
 968       $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array::value('price_field_id', $line[$lineID]), 'price_set_id');
 969       $quickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
 970       if ($quickConfig) {
 971         CRM_Price_BAO_LineItem::deleteLineItems($this->_id, 'civicrm_contribution');
 972       }
 973     }
 974
 975     // process price set and get total amount and line items.
 976     $lineItem = array();
 977     $priceSetId = $pId = NULL;
 978     $priceSetId = CRM_Utils_Array::value('price_set_id', $submittedValues);
 979     if (empty($priceSetId) && !$this->_id) {
 980       $this->_priceSetId = $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', 'default_contribution_amount', 'id', 'name');
 981       $this->_priceSet = current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId));
 982       $fieldID = key($this->_priceSet['fields']);
 983       $fieldValueId = key($this->_priceSet['fields'][$fieldID]['options']);
 984       $this->_priceSet['fields'][$fieldID]['options'][$fieldValueId]['amount'] = $submittedValues['total_amount'];
 985       $submittedValues['price_' . $fieldID] = 1;
 986     }
 987
 988     if ($priceSetId) {
 989       CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'],
 990         $submittedValues, $lineItem[$priceSetId]);
 991
 992       $submittedValues['total_amount'] = CRM_Utils_Array::value('amount', $submittedValues);
 993     }
 994     if ($this->_id) {
 995       //CRM-10964
 996       $pId = ($this->_compId && $this->_context == 'participant') ? $this->_compId : CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id, 'participant_id', 'contribution_id');
 997     }
 998     if (!$priceSetId && CRM_Utils_Array::value('total_amount', $submittedValues) && $this->_id) {
 999       // 10117 update th line items for participants
1000       if ($pId) {
1001         $entityTable = 'participant';
1002         $entityID = $pId;
1003         $participantParams = array(
1004           'fee_amount' => $submittedValues['total_amount'],
1005           'id' => $entityID
1006         );
1007         CRM_Event_BAO_Participant::add($participantParams);
1008         if (empty($this->_lineItems)) {
1009           $this->_lineItems = CRM_Price_BAO_LineItem::getLineItems($entityID, 'participant', 1);
1010         }
1011       }
1012       else {
1013         $entityTable = 'contribution';
1014         $entityID = $this->_id;
1015       }
1016
1017       $lineItems = CRM_Price_BAO_LineItem::getLineItems($entityID, $entityTable);
1018       foreach (array_keys($lineItems) as $id) {
1019         $lineItems[$id]['id'] = $id;
1020       }
1021       $itemId = key($lineItems);
1022       $fieldType = NULL;
1023       if ($itemId && CRM_Utils_Array::value('price_field_id', $lineItems[$itemId])) {
1024         $fieldType = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'html_type');
1025       }
1026       $lineItems[$itemId]['unit_price'] = $lineItems[$itemId]['line_total'] = CRM_Utils_Rule::cleanMoney(CRM_Utils_Array::value('total_amount', $submittedValues));
1027       // 10117 update th line items for participants
1028       if (!empty($lineItems[$itemId]['price_field_id'])) {
1029         $this->_priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1030         $lineItem[$this->_priceSetId] = $lineItems;
1031       }
1032     }
1033     $isQuickConfig = 0;
1034     if ($this->_priceSetId && CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config')) {
1035       $isQuickConfig = 1;
1036     }
1037     //CRM-11529 for quick config backoffice transactions
1038     //when financial_type_id is passed in form, update the
1039     //lineitems with the financial type selected in form
1040     if ($isQuickConfig && CRM_Utils_Array::value('financial_type_id', $submittedValues)
1041       && CRM_Utils_Array::value($this->_priceSetId, $lineItem)
1042     ) {
1043       foreach ($lineItem[$this->_priceSetId] as &$values) {
1044         $values['financial_type_id'] = $submittedValues['financial_type_id'];
1045       }
1046     }
1047
1048     if (!isset($submittedValues['total_amount'])) {
1049       $submittedValues['total_amount'] = CRM_Utils_Array::value('total_amount', $this->_values);
1050     }
1051     $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ? $lineItem : FALSE);
1052
1053     if (CRM_Utils_Array::value('pcp_made_through_id', $submittedValues)) {
1054       $pcp = array();
1055       $fields = array(
1056         'pcp_made_through_id',
1057         'pcp_display_in_roll',
1058         'pcp_roll_nickname',
1059         'pcp_personal_note',
1060       );
1061       foreach ($fields as $f) {
1062         $pcp[$f] = CRM_Utils_Array::value($f, $submittedValues);
1063       }
1064     }
1065     else {
1066       //build soft credit params
1067       if (!empty($submittedValues['soft_credit_contact_select_id'])) {
1068         $softParams = $softIDs =array();
1069         foreach ($submittedValues['soft_credit_contact_select_id'] as $key => $val) {
1070           if ($val && $submittedValues['soft_credit_amount'][$key]) {
1071             $softParams[$key]['contact_id'] = $val;
1072             $softParams[$key]['amount'] = CRM_Utils_Rule::cleanMoney($submittedValues['soft_credit_amount'][$key]);
1073             if (!empty($submittedValues['soft_credit_id'][$key])) {
1074               $softIDs[] = $softParams[$key]['id'] = $submittedValues['soft_credit_id'][$key];
1075             }
1076           }
1077         }
1078       }
1079     }
1080
1081     // set the contact, when contact is selected
1082     if (CRM_Utils_Array::value('contact_select_id', $submittedValues)) {
1083       $this->_contactID = $submittedValues['contact_select_id'][1];
1084     }
1085
1086     $config = CRM_Core_Config::singleton();
1087
1088     //Credit Card Contribution.
1089     if ($this->_mode) {
1090       $this->processCreditCard($submittedValues, $config, $session, $pId, $lineItem);
1091     }
1092     else {
1093       //Offline Contribution.
1094       $submittedValues = $this->unsetCreditCardFields($submittedValues);
1095
1096       // get the required field value only.
1097       $formValues = $submittedValues;
1098       $params = $ids = array();
1099
1100       $params['contact_id'] = $this->_contactID;
1101
1102       $params['currency'] = $this->getCurrency($submittedValues);
1103
1104       $fields = array(
1105         'financial_type_id',
1106         'contribution_status_id',
1107         'payment_instrument_id',
1108         'cancel_reason',
1109         'source',
1110         'check_number',
1111       );
1112       foreach ($fields as $f) {
1113         $params[$f] = CRM_Utils_Array::value($f, $formValues);
1114       }
1115
1116       if (!empty($pcp)) {
1117         $params['pcp'] = $pcp;
1118       }
1119       if (!empty($softParams)) {
1120         $params['soft_credit'] = $softParams;
1121         $params['soft_credit_ids'] = $softIDs;
1122       }
1123
1124       //if priceset is used, no need to cleanup money
1125       //CRM-5740
1126       if ($priceSetId) {
1127         $params['skipCleanMoney'] = 1;
1128       }
1129
1130       $dates = array(
1131         'receive_date',
1132         'receipt_date',
1133         'cancel_date',
1134       );
1135
1136       foreach ($dates as $d) {
1137         $params[$d] = CRM_Utils_Date::processDate($formValues[$d], $formValues[$d . '_time'], TRUE);
1138       }
1139
1140       if (CRM_Utils_Array::value('is_email_receipt', $formValues)) {
1141         $params['receipt_date'] = date("Y-m-d");
1142       }
1143
1144       if ($params['contribution_status_id'] == CRM_Core_OptionGroup::getValue('contribution_status', 'Cancelled', 'name')
1145         || $params['contribution_status_id'] == CRM_Core_OptionGroup::getValue('contribution_status', 'Refunded', 'name')
1146       ) {
1147         if (CRM_Utils_System::isNull(CRM_Utils_Array::value('cancel_date', $params))) {
1148           $params['cancel_date'] = date('Y-m-d');
1149         }
1150       }
1151       else {
1152         $params['cancel_date'] = $params['cancel_reason'] = 'null';
1153       }
1154
1155       // Set is_pay_later flag for back-office offline Pending status contributions CRM-8996
1156       if ($params['contribution_status_id'] == CRM_Core_OptionGroup::getValue('contribution_status', 'Pending', 'name')) {
1157         $params['is_pay_later'] = 1;
1158       }
1159
1160       $ids['contribution'] = $params['id'] = $this->_id;
1161
1162       //Add Additional common information  to formatted params
1163       CRM_Contribute_Form_AdditionalInfo::postProcessCommon($formValues, $params, $this);
1164       if ($pId) {
1165         $params['contribution_mode'] = 'participant';
1166         $params['participant_id'] = $pId;
1167         $params['skipLineItem'] = 1;
1168       }
1169       $params['line_item'] = $lineItem;
1170       $params['payment_processor_id'] = $params['payment_processor'] = CRM_Utils_Array::value('id', $this->_paymentProcessor);
1171       //create contribution.
1172       if ($isQuickConfig) {
1173         $params['is_quick_config'] = 1;
1174       }
1175
1176       // CRM-11956
1177       // if non_deductible_amount exists i.e. Additional Details fieldset was opened [and staff typed something] -> keep it.
1178       if (isset($params['non_deductible_amount']) && (!empty($params['non_deductible_amount']))) {
1179         $params['non_deductible_amount'] = $params['non_deductible_amount'];
1180       }
1181       // if non_deductible_amount does NOT exist - then calculate it depending on:
1182       // $ContributionType->is_deductible and whether there is a product (premium).
1183       else {
1184         $contributionType = new CRM_Financial_DAO_FinancialType();
1185         $contributionType->id = $params['financial_type_id'];
1186         if (!$contributionType->find(TRUE)) {
1187           CRM_Core_Error::fatal('Could not find a system table');
1188         }
1189         if ($contributionType->is_deductible) {
1190
1191           if (isset($formValues['product_name'][0])) {
1192             $selectProduct = $formValues['product_name'][0];
1193           }
1194           // if there is a product - compare the value to the contribution amount
1195           if (isset($selectProduct)) {
1196             $productDAO = new CRM_Contribute_DAO_Product();
1197             $productDAO->id = $selectProduct;
1198             $productDAO->find(TRUE);
1199             // product value exceeds contribution amount
1200             if ($params['total_amount'] < $productDAO->price) {
1201               $params['non_deductible_amount'] = $params['total_amount'];
1202             }
1203             // product value does NOT exceed contribution amount
1204             else {
1205               $params['non_deductible_amount'] = $productDAO->price;
1206             }
1207           }
1208           // contribution is deductible - but there is no product
1209           else {
1210             $params['non_deductible_amount'] = '0.00';
1211           }
1212         }
1213         // contribution is NOT deductible
1214         else {
1215           $params['non_deductible_amount'] = $params['total_amount'];
1216         }
1217       }
1218
1219       $contribution = CRM_Contribute_BAO_Contribution::create($params, $ids);
1220
1221       // process associated membership / participant, CRM-4395
1222       $relatedComponentStatusMsg = NULL;
1223       if ($contribution->id && $this->_action & CRM_Core_Action::UPDATE) {
1224         $relatedComponentStatusMsg = $this->updateRelatedComponent($contribution->id,
1225           $contribution->contribution_status_id,
1226           CRM_Utils_Array::value('contribution_status_id',
1227             $this->_values
1228           )
1229         );
1230       }
1231
1232       //process  note
1233       if ($contribution->id && isset($formValues['note'])) {
1234         CRM_Contribute_Form_AdditionalInfo::processNote($formValues, $this->_contactID, $contribution->id, $this->_noteID);
1235       }
1236
1237       //process premium
1238       if ($contribution->id && isset($formValues['product_name'][0])) {
1239         CRM_Contribute_Form_AdditionalInfo::processPremium($formValues, $contribution->id,
1240           $this->_premiumID, $this->_options
1241         );
1242       }
1243
1244       //send receipt mail.
1245       if ($contribution->id && CRM_Utils_Array::value('is_email_receipt', $formValues)) {
1246         $formValues['contact_id'] = $this->_contactID;
1247         $formValues['contribution_id'] = $contribution->id;
1248
1249         // to get 'from email id' for send receipt
1250         $this->fromEmailId = $formValues['from_email_address'];
1251         $sendReceipt = CRM_Contribute_Form_AdditionalInfo::emailReceipt($this, $formValues);
1252       }
1253
1254       $pledgePaymentId = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1255         $contribution->id,
1256         'id',
1257         'contribution_id'
1258       );
1259
1260       //update pledge payment status.
1261       if ((($this->_ppID && $contribution->id) && $this->_action & CRM_Core_Action::ADD) ||
1262         (($pledgePaymentId) && $this->_action & CRM_Core_Action::UPDATE)
1263       ) {
1264
1265         if ($this->_ppID) {
1266           //store contribution id in payment record.
1267           CRM_Core_DAO::setFieldValue('CRM_Pledge_DAO_PledgePayment', $this->_ppID, 'contribution_id', $contribution->id);
1268         }
1269         else {
1270           $this->_ppID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1271             $contribution->id,
1272             'id',
1273             'contribution_id'
1274           );
1275           $this->_pledgeID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
1276             $contribution->id,
1277             'pledge_id',
1278             'contribution_id'
1279           );
1280         }
1281
1282         $adjustTotalAmount = FALSE;
1283         if (CRM_Utils_Array::value('option_type', $formValues) == 2) {
1284           $adjustTotalAmount = TRUE;
1285         }
1286
1287         $updatePledgePaymentStatus = FALSE;
1288         //do only if either the status or the amount has changed
1289         if ($this->_action & CRM_Core_Action::ADD) {
1290           $updatePledgePaymentStatus = TRUE;
1291         }
1292         elseif ($this->_action & CRM_Core_Action::UPDATE && (($this->_defaults['contribution_status_id'] != $formValues['contribution_status_id']) ||
1293           ($this->_defaults['total_amount'] != $formValues['total_amount']))
1294         ) {
1295           $updatePledgePaymentStatus = TRUE;
1296         }
1297
1298         if ($updatePledgePaymentStatus) {
1299           CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($this->_pledgeID,
1300             array($this->_ppID),
1301             $contribution->contribution_status_id,
1302             NULL,
1303             $contribution->total_amount,
1304             $adjustTotalAmount
1305           );
1306         }
1307       }
1308
1309       $statusMsg = ts('The contribution record has been saved.');
1310       if (CRM_Utils_Array::value('is_email_receipt', $formValues) && $sendReceipt) {
1311         $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
1312       }
1313
1314       if ($relatedComponentStatusMsg) {
1315         $statusMsg .= ' ' . $relatedComponentStatusMsg;
1316       }
1317
1318       CRM_Core_Session::setStatus($statusMsg, ts('Saved'), 'success');
1319       //Offline Contribution ends.
1320     }
1321     $buttonName = $this->controller->getButtonName();
1322     if ($this->_context == 'standalone') {
1323       if ($buttonName == $this->getButtonName('upload', 'new')) {
1324         $session->replaceUserContext(CRM_Utils_System::url('civicrm/contribute/add',
1325           'reset=1&action=add&context=standalone'
1326         ));
1327       }
1328       else {
1329         $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
1330           "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1331         ));
1332       }
1333     }
1334     elseif ($this->_context == 'contribution' && $this->_mode && $buttonName == $this->getButtonName('upload', 'new')) {
1335       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view/contribution',
1336         "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}&mode={$this->_mode}"
1337       ));
1338     }
1339     elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1340       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view/contribution',
1341         "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}"
1342       ));
1343     }
1344   }
1345
1346   public function processCreditCard($submittedValues, $config, $session, $pId, $lineItem) {
1347     $unsetParams = array(
1348       'trxn_id',
1349       'payment_instrument_id',
1350       'contribution_status_id',
1351       'cancel_date',
1352       'cancel_reason',
1353     );
1354     foreach ($unsetParams as $key) {
1355       if (isset($submittedValues[$key])) {
1356         unset($submittedValues[$key]);
1357       }
1358     }
1359
1360     // CRM-12680 set $_lineItem if its not set
1361     if (empty($this->_lineItem) && !empty($lineItem)) {
1362       $this->_lineItem = $lineItem;
1363     }
1364
1365     //Get the rquire fields value only.
1366     $params = $this->_params = $submittedValues;
1367
1368     $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($this->_params['payment_processor_id'],
1369       $this->_mode
1370     );
1371
1372     //get the payment processor id as per mode.
1373     $this->_params['payment_processor'] = $params['payment_processor_id'] =
1374       $this->_params['payment_processor_id'] = $submittedValues['payment_processor_id'] = $this->_paymentProcessor['id'];
1375
1376     $now = date('YmdHis');
1377     $fields = array();
1378
1379     // we need to retrieve email address
1380     if ($this->_context == 'standalone' && CRM_Utils_Array::value('is_email_receipt', $submittedValues)) {
1381       list($this->userDisplayName,
1382         $this->userEmail
1383         ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
1384       $this->assign('displayName', $this->userDisplayName);
1385     }
1386
1387     //set email for primary location.
1388     $fields['email-Primary'] = 1;
1389     $params['email-Primary'] = $this->userEmail;
1390
1391     // now set the values for the billing location.
1392     foreach ($this->_fields as $name => $dontCare) {
1393       $fields[$name] = 1;
1394     }
1395
1396     // also add location name to the array
1397     $params["address_name-{$this->_bltID}"] = CRM_Utils_Array::value('billing_first_name', $params) . ' ' . CRM_Utils_Array::value('billing_middle_name', $params) . ' ' . CRM_Utils_Array::value('billing_last_name', $params);
1398     $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
1399     $fields["address_name-{$this->_bltID}"] = 1;
1400
1401     $ctype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
1402       $this->_contactID,
1403       'contact_type'
1404     );
1405
1406     $nameFields = array('first_name', 'middle_name', 'last_name');
1407     foreach ($nameFields as $name) {
1408       $fields[$name] = 1;
1409       if (array_key_exists("billing_$name", $params)) {
1410         $params[$name] = $params["billing_{$name}"];
1411         $params['preserveDBName'] = TRUE;
1412       }
1413     }
1414
1415     if (CRM_Utils_Array::value('source', $params)) {
1416       unset($params['source']);
1417     }
1418     $contactID = CRM_Contact_BAO_Contact::createProfileContact($params, $fields,
1419       $this->_contactID,
1420       NULL, NULL,
1421       $ctype
1422     );
1423
1424     // add all the additioanl payment params we need
1425     $this->_params["state_province-{$this->_bltID}"] = $this->_params["billing_state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant::stateProvinceAbbreviation($this->_params["billing_state_province_id-{$this->_bltID}"]);
1426     $this->_params["country-{$this->_bltID}"] = $this->_params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($this->_params["billing_country_id-{$this->_bltID}"]);
1427
1428     if ($this->_paymentProcessor['payment_type'] & CRM_Core_Payment::PAYMENT_TYPE_CREDIT_CARD) {
1429       $this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params);
1430       $this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params);
1431     }
1432     $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
1433     $this->_params['amount'] = $this->_params['total_amount'];
1434     $this->_params['amount_level'] = 0;
1435     $this->_params['currencyID'] = CRM_Utils_Array::value('currency',
1436       $this->_params,
1437       $config->defaultCurrency
1438     );
1439     $this->_params['payment_action'] = 'Sale';
1440     if (CRM_Utils_Array::value('receive_date', $this->_params)) {
1441       $this->_params['receive_date'] = CRM_Utils_Date::processDate($this->_params['receive_date'], $this->_params['receive_date_time']);
1442     }
1443
1444     if (CRM_Utils_Array::value('soft_credit_to', $params)) {
1445       $this->_params['soft_credit_to'] = $params['soft_credit_to'];
1446       $this->_params['pcp_made_through_id'] = $params['pcp_made_through_id'];
1447     }
1448
1449     $this->_params['pcp_display_in_roll'] = CRM_Utils_Array::value('pcp_display_in_roll', $params);
1450     $this->_params['pcp_roll_nickname'] = CRM_Utils_Array::value('pcp_roll_nickname', $params);
1451     $this->_params['pcp_personal_note'] = CRM_Utils_Array::value('pcp_personal_note', $params);
1452
1453     //Add common data to formatted params
1454     CRM_Contribute_Form_AdditionalInfo::postProcessCommon($params, $this->_params, $this);
1455
1456     if (empty($this->_params['invoice_id'])) {
1457       $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE));
1458     }
1459     else {
1460       $this->_params['invoiceID'] = $this->_params['invoice_id'];
1461     }
1462
1463     // at this point we've created a contact and stored its address etc
1464     // all the payment processors expect the name and address to be in the
1465     // so we copy stuff over to first_name etc.
1466     $paymentParams = $this->_params;
1467     $paymentParams['contactID'] = $this->_contactID;
1468     CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $paymentParams, TRUE);
1469
1470     $contributionType = new CRM_Financial_DAO_FinancialType();
1471     $contributionType->id = $params['financial_type_id'];
1472     if (!$contributionType->find(TRUE)) {
1473       CRM_Core_Error::fatal('Could not find a system table');
1474     }
1475
1476     // add some financial type details to the params list
1477     // if folks need to use it
1478     $paymentParams['contributionType_name'] = $this->_params['contributionType_name'] = $contributionType->name;
1479     $paymentParams['contributionPageID'] = NULL;
1480     if (CRM_Utils_Array::value('is_email_receipt', $this->_params)) {
1481       $paymentParams['email'] = $this->userEmail;
1482       $paymentParams['is_email_receipt'] = 1;
1483     }
1484     else {
1485       $paymentParams['is_email_receipt'] = 0;
1486       $this->_params['is_email_receipt'] = 0;
1487     }
1488     if (CRM_Utils_Array::value('receive_date', $this->_params)) {
1489       $paymentParams['receive_date'] = $this->_params['receive_date'];
1490     }
1491     if (CRM_Utils_Array::value('receive_date', $this->_params)) {
1492       $paymentParams['receive_date'] = $this->_params['receive_date'];
1493     }
1494
1495     $result = NULL;
1496
1497     // For recurring contribution, create Contribution Record first.
1498     // Contribution ID, Recurring ID and Contact ID needed
1499     // When we get a callback from the payment processor, CRM-7115
1500     if (CRM_Utils_Array::value('is_recur', $paymentParams)) {
1501       $contribution = CRM_Contribute_Form_Contribution_Confirm::processContribution($this,
1502         $this->_params,
1503         $result,
1504         $this->_contactID,
1505         $contributionType,
1506         FALSE,
1507         TRUE,
1508         FALSE
1509       );
1510       $paymentParams['contributionID'] = $contribution->id;
1511       $paymentParams['contributionTypeID'] = $contribution->financial_type_id;
1512       $paymentParams['contributionPageID'] = $contribution->contribution_page_id;
1513       $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id;
1514     }
1515
1516     if ($paymentParams['amount'] > 0.0) {
1517       // force a reget of the payment processor in case the form changed it, CRM-7179
1518       $payment = CRM_Core_Payment::singleton($this->_mode, $this->_paymentProcessor, $this, TRUE);
1519       $result = $payment->doDirectPayment($paymentParams);
1520     }
1521
1522     if (is_a($result, 'CRM_Core_Error')) {
1523       //make sure to cleanup db for recurring case.
1524       if (CRM_Utils_Array::value('contributionID', $paymentParams)) {
1525         CRM_Core_Error::debug_log_message(CRM_Core_Error::getMessages($result) . "contact id={$this->_contactID} (deleting contribution {$paymentParams['contributionID']}");
1526         CRM_Contribute_BAO_Contribution::deleteContribution($paymentParams['contributionID']);
1527       }
1528       if (CRM_Utils_Array::value('contributionRecurID', $paymentParams)) {
1529         CRM_Core_Error::debug_log_message(CRM_Core_Error::getMessages($result) . "contact id={$this->_contactID} (deleting recurring contribution {$paymentParams['contributionRecurID']}");
1530         CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($paymentParams['contributionRecurID']);
1531       }
1532
1533       //set the contribution mode.
1534       $urlParams = "action=add&cid={$this->_contactID}";
1535       if ($this->_mode) {
1536         $urlParams .= "&mode={$this->_mode}";
1537       }
1538       if (!empty($this->_ppID)) {
1539         $urlParams .= "&context=pledge&ppid={$this->_ppID}";
1540       }
1541       CRM_Core_Error::displaySessionError($result);
1542       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/contribution', $urlParams));
1543     }
1544
1545     if ($result) {
1546       $this->_params = array_merge($this->_params, $result);
1547     }
1548
1549     $this->_params['receive_date'] = $now;
1550
1551     if (CRM_Utils_Array::value('is_email_receipt', $this->_params)) {
1552       $this->_params['receipt_date'] = $now;
1553     }
1554     else {
1555       $this->_params['receipt_date'] = CRM_Utils_Date::processDate($this->_params['receipt_date'],
1556         $params['receipt_date_time'], TRUE
1557       );
1558     }
1559
1560     $this->set('params', $this->_params);
1561     $this->assign('trxn_id', $result['trxn_id']);
1562     $this->assign('receive_date', $this->_params['receive_date']);
1563
1564     // result has all the stuff we need
1565     // lets archive it to a financial transaction
1566     if ($contributionType->is_deductible) {
1567       $this->assign('is_deductible', TRUE);
1568       $this->set('is_deductible', TRUE);
1569     }
1570
1571     // set source if not set
1572     if (empty($this->_params['source'])) {
1573       $userID = $session->get('userID');
1574       $userSortName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $userID,
1575         'sort_name'
1576       );
1577       $this->_params['source'] = ts('Submit Credit Card Payment by: %1', array(1 => $userSortName));
1578     }
1579
1580     // build custom data getFields array
1581     $customFieldsContributionType = CRM_Core_BAO_CustomField::getFields('Contribution', FALSE, FALSE,
1582       CRM_Utils_Array::value('financial_type_id', $params)
1583     );
1584     $customFields = CRM_Utils_Array::crmArrayMerge($customFieldsContributionType,
1585       CRM_Core_BAO_CustomField::getFields('Contribution', FALSE, FALSE, NULL, NULL, TRUE)
1586     );
1587     $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
1588       $customFields,
1589       $this->_id,
1590       'Contribution'
1591     );
1592
1593
1594     if (!CRM_Utils_Array::value('is_recur', $paymentParams)) {
1595       $contribution = CRM_Contribute_Form_Contribution_Confirm::processContribution($this,
1596         $this->_params,
1597         $result,
1598         $this->_contactID,
1599         $contributionType,
1600         FALSE, FALSE, FALSE
1601       );
1602     }
1603
1604     //send receipt mail.
1605     if ($contribution->id &&
1606       CRM_Utils_Array::value('is_email_receipt', $this->_params)
1607     ) {
1608       $this->_params['trxn_id'] = CRM_Utils_Array::value('trxn_id', $result);
1609       $this->_params['contact_id'] = $this->_contactID;
1610       $this->_params['contribution_id'] = $contribution->id;
1611       $sendReceipt = CRM_Contribute_Form_AdditionalInfo::emailReceipt($this, $this->_params, TRUE);
1612     }
1613
1614     //process the note
1615     if ($contribution->id && isset($params['note'])) {
1616       CRM_Contribute_Form_AdditionalInfo::processNote($params, $contactID, $contribution->id, NULL);
1617     }
1618     //process premium
1619     if ($contribution->id && isset($params['product_name'][0])) {
1620       CRM_Contribute_Form_AdditionalInfo::processPremium($params, $contribution->id, NULL, $this->_options);
1621     }
1622
1623     //update pledge payment status.
1624     if ($this->_ppID && $contribution->id) {
1625       //store contribution id in payment record.
1626       CRM_Core_DAO::setFieldValue('CRM_Pledge_DAO_PledgePayment', $this->_ppID, 'contribution_id', $contribution->id);
1627
1628       CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($this->_pledgeID,
1629         array($this->_ppID),
1630         $contribution->contribution_status_id,
1631         NULL,
1632         $contribution->total_amount
1633       );
1634     }
1635
1636     if ($contribution->id) {
1637       $statusMsg = ts('The contribution record has been processed.');
1638       if (CRM_Utils_Array::value('is_email_receipt', $this->_params) && $sendReceipt) {
1639         $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
1640       }
1641       CRM_Core_Session::setStatus($statusMsg, ts('Complete'), 'success');
1642     }
1643   }
1644 }
1645