CRM/Contribute/Form/Task/Status.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33
  34 /**
  35  * This class provides the functionality to email a group of contacts.
  36  */
  37 class CRM_Contribute_Form_Task_Status extends CRM_Contribute_Form_Task {
  38
  39   /**
  40    * Are we operating in "single mode", i.e. updating the task of only
  41    * one specific contribution?
  42    *
  43    * @var boolean
  44    */
  45   public $_single = FALSE;
  46
  47   protected $_rows;
  48
  49   /**
  50    * Build all the data structures needed to build the form.
  51    */
  52   public function preProcess() {
  53     $id = CRM_Utils_Request::retrieve('id', 'Positive',
  54       $this, FALSE
  55     );
  56
  57     if ($id) {
  58       $this->_contributionIds = array($id);
  59       $this->_componentClause = " civicrm_contribution.id IN ( $id ) ";
  60       $this->_single = TRUE;
  61       $this->assign('totalSelectedContributions', 1);
  62     }
  63     else {
  64       parent::preProcess();
  65     }
  66
  67     // check that all the contribution ids have pending status
  68     $query = "
  69 SELECT count(*)
  70 FROM   civicrm_contribution
  71 WHERE  contribution_status_id != 2
  72 AND    {$this->_componentClause}";
  73     $count = CRM_Core_DAO::singleValueQuery($query,
  74       CRM_Core_DAO::$_nullArray
  75     );
  76     if ($count != 0) {
  77       CRM_Core_Error::statusBounce(ts('Please select only online contributions with Pending status.'));
  78     }
  79
  80     // we have all the contribution ids, so now we get the contact ids
  81     parent::setContactIDs();
  82     $this->assign('single', $this->_single);
  83   }
  84
  85   /**
  86    * Build the form object.
  87    */
  88   public function buildQuickForm() {
  89     $status = CRM_Contribute_PseudoConstant::contributionStatus();
  90     unset($status[2]);
  91     unset($status[5]);
  92     unset($status[6]);
  93     $this->add('select', 'contribution_status_id',
  94       ts('Contribution Status'),
  95       $status,
  96       TRUE
  97     );
  98
  99     $contribIDs = implode(',', $this->_contributionIds);
 100     $query = "
 101 SELECT c.id            as contact_id,
 102        co.id           as contribution_id,
 103        c.display_name  as display_name,
 104        co.total_amount as amount,
 105        co.receive_date as receive_date,
 106        co.source       as source,
 107        co.payment_instrument_id as paid_by,
 108        co.check_number as check_no
 109 FROM   civicrm_contact c,
 110        civicrm_contribution co
 111 WHERE  co.contact_id = c.id
 112 AND    co.id IN ( $contribIDs )";
 113     $dao = CRM_Core_DAO::executeQuery($query,
 114       CRM_Core_DAO::$_nullArray
 115     );
 116
 117     // build a row for each contribution id
 118     $this->_rows = array();
 119     $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution');
 120     $defaults = array();
 121     $now = date("Y-m-d");
 122     $paidByOptions = array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::paymentInstrument();
 123
 124     while ($dao->fetch()) {
 125       $row['contact_id'] = $dao->contact_id;
 126       $row['contribution_id'] = $dao->contribution_id;
 127       $row['display_name'] = $dao->display_name;
 128       $row['amount'] = $dao->amount;
 129       $row['source'] = $dao->source;
 130       $row['trxn_id'] = &$this->addElement('text', "trxn_id_{$row['contribution_id']}", ts('Transaction ID'));
 131       $this->addRule("trxn_id_{$row['contribution_id']}",
 132         ts('This Transaction ID already exists in the database. Include the account number for checks.'),
 133         'objectExists',
 134         array('CRM_Contribute_DAO_Contribution', $dao->contribution_id, 'trxn_id')
 135       );
 136
 137       $row['fee_amount'] = &$this->add('text', "fee_amount_{$row['contribution_id']}", ts('Fee Amount'),
 138         $attributes['fee_amount']
 139       );
 140       $this->addRule("fee_amount_{$row['contribution_id']}", ts('Please enter a valid amount.'), 'money');
 141       $defaults["fee_amount_{$row['contribution_id']}"] = 0.0;
 142
 143       $row['trxn_date'] = $this->add('datepicker', "trxn_date_{$row['contribution_id']}", ts('Transaction Date'), [], FALSE, ['time' => FALSE]);
 144       $defaults["trxn_date_{$row['contribution_id']}"] = $now;
 145
 146       $this->add("text", "check_number_{$row['contribution_id']}", ts('Check Number'));
 147       $defaults["check_number_{$row['contribution_id']}"] = $dao->check_no;
 148
 149       $this->add("select", "payment_instrument_id_{$row['contribution_id']}", ts('Payment Method'), $paidByOptions);
 150       $defaults["payment_instrument_id_{$row['contribution_id']}"] = $dao->paid_by;
 151
 152       $this->_rows[] = $row;
 153     }
 154
 155     $this->assign_by_ref('rows', $this->_rows);
 156     $this->setDefaults($defaults);
 157     $this->addButtons(array(
 158         array(
 159           'type' => 'next',
 160           'name' => ts('Update Pending Status'),
 161           'isDefault' => TRUE,
 162         ),
 163         array(
 164           'type' => 'back',
 165           'name' => ts('Cancel'),
 166         ),
 167       )
 168     );
 169
 170     $this->addFormRule(array('CRM_Contribute_Form_Task_Status', 'formRule'));
 171   }
 172
 173   /**
 174    * Global validation rules for the form.
 175    *
 176    * @param array $fields
 177    *   Posted values of the form.
 178    *
 179    * @return array
 180    *   list of errors to be posted back to the form
 181    */
 182   public static function formRule($fields) {
 183     $seen = $errors = array();
 184     foreach ($fields as $name => $value) {
 185       if (strpos($name, 'trxn_id_') !== FALSE) {
 186         if ($fields[$name]) {
 187           if (array_key_exists($value, $seen)) {
 188             $errors[$name] = ts('Transaction ID\'s must be unique. Include the account number for checks.');
 189           }
 190           $seen[$value] = 1;
 191         }
 192       }
 193
 194       if ((strpos($name, 'check_number_') !== FALSE) && $value) {
 195         $contribID = substr($name, 13);
 196
 197         if ($fields["payment_instrument_id_{$contribID}"] != CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'payment_instrument_id', 'Check')) {
 198           $errors["payment_instrument_id_{$contribID}"] = ts("Payment Method should be Check when a check number is entered for a contribution.");
 199         }
 200       }
 201     }
 202     return empty($errors) ? TRUE : $errors;
 203   }
 204
 205   /**
 206    * Process the form after the input has been submitted and validated.
 207    */
 208   public function postProcess() {
 209     $params = $this->controller->exportValues($this->_name);
 210
 211     // submit the form with values.
 212     self::processForm($this, $params);
 213
 214     CRM_Core_Session::setStatus(ts('Contribution status has been updated for selected record(s).'), ts('Status Updated'), 'success');
 215   }
 216
 217   /**
 218    * Process the form with submitted params.
 219    *
 220    * Also supports unit test.
 221    *
 222    * @param CRM_Core_Form $form
 223    * @param array $params
 224    *
 225    * @throws \Exception
 226    */
 227   public static function processForm($form, $params) {
 228     $statusID = CRM_Utils_Array::value('contribution_status_id', $params);
 229     $baseIPN = new CRM_Core_Payment_BaseIPN();
 230
 231     $transaction = new CRM_Core_Transaction();
 232
 233     // get the missing pieces for each contribution
 234     $contribIDs = implode(',', $form->_contributionIds);
 235     $details = self::getDetails($contribIDs);
 236     $template = CRM_Core_Smarty::singleton();
 237
 238     // for each contribution id, we just call the baseIPN stuff
 239     foreach ($form->_rows as $row) {
 240       $input = $ids = $objects = array();
 241       $input['component'] = $details[$row['contribution_id']]['component'];
 242
 243       $ids['contact'] = $row['contact_id'];
 244       $ids['contribution'] = $row['contribution_id'];
 245       $ids['contributionRecur'] = NULL;
 246       $ids['contributionPage'] = NULL;
 247       $ids['membership'] = CRM_Utils_Array::value('membership', $details[$row['contribution_id']]);
 248       $ids['participant'] = CRM_Utils_Array::value('participant', $details[$row['contribution_id']]);
 249       $ids['event'] = CRM_Utils_Array::value('event', $details[$row['contribution_id']]);
 250
 251       if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
 252         CRM_Core_Error::fatal();
 253       }
 254
 255       $contribution = &$objects['contribution'];
 256
 257       $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL,
 258         'name'
 259       );
 260
 261       if ($statusID == array_search('Cancelled', $contributionStatuses)) {
 262         $baseIPN->cancelled($objects, $transaction);
 263         $transaction->commit();
 264         continue;
 265       }
 266       elseif ($statusID == array_search('Failed', $contributionStatuses)) {
 267         $baseIPN->failed($objects, $transaction);
 268         $transaction->commit();
 269         continue;
 270       }
 271
 272       // status is not pending
 273       if ($contribution->contribution_status_id != array_search('Pending',
 274           $contributionStatuses
 275         )
 276       ) {
 277         $transaction->commit();
 278         continue;
 279       }
 280
 281       // set some fake input values so we can reuse IPN code
 282       $input['amount'] = $contribution->total_amount;
 283       $input['is_test'] = $contribution->is_test;
 284       $input['fee_amount'] = $params["fee_amount_{$row['contribution_id']}"];
 285       $input['check_number'] = $params["check_number_{$row['contribution_id']}"];
 286       $input['payment_instrument_id'] = $params["payment_instrument_id_{$row['contribution_id']}"];
 287       $input['net_amount'] = $contribution->total_amount - $input['fee_amount'];
 288
 289       if (!empty($params["trxn_id_{$row['contribution_id']}"])) {
 290         $input['trxn_id'] = trim($params["trxn_id_{$row['contribution_id']}"]);
 291       }
 292       else {
 293         $input['trxn_id'] = $contribution->invoice_id;
 294       }
 295       $input['trxn_date'] = $params["trxn_date_{$row['contribution_id']}"] . ' ' .  date('H:i:s');
 296
 297       // @todo calling baseIPN like this is a pattern in it's last gasps. Call contribute.completetransaction api.
 298       $baseIPN->completeTransaction($input, $ids, $objects, $transaction, FALSE);
 299
 300       // reset template values before processing next transactions
 301       $template->clearTemplateVars();
 302     }
 303   }
 304
 305   /**
 306    * @param string $contributionIDs
 307    *
 308    * @return array
 309    */
 310   public static function &getDetails($contributionIDs) {
 311     if (empty($contributionIDs)) {
 312       return [];
 313     }
 314     $query = "
 315 SELECT    c.id              as contribution_id,
 316           c.contact_id      as contact_id     ,
 317           mp.membership_id  as membership_id  ,
 318           pp.participant_id as participant_id ,
 319           p.event_id        as event_id
 320 FROM      civicrm_contribution c
 321 LEFT JOIN civicrm_membership_payment  mp ON mp.contribution_id = c.id
 322 LEFT JOIN civicrm_participant_payment pp ON pp.contribution_id = c.id
 323 LEFT JOIN civicrm_participant         p  ON pp.participant_id  = p.id
 324 WHERE     c.id IN ( $contributionIDs )";
 325
 326     $rows = array();
 327     $dao = CRM_Core_DAO::executeQuery($query,
 328       CRM_Core_DAO::$_nullArray
 329     );
 330
 331     while ($dao->fetch()) {
 332       $rows[$dao->contribution_id]['component'] = $dao->participant_id ? 'event' : 'contribute';
 333       $rows[$dao->contribution_id]['contact'] = $dao->contact_id;
 334       if ($dao->membership_id) {
 335         if (!array_key_exists('membership', $rows[$dao->contribution_id])) {
 336           $rows[$dao->contribution_id]['membership'] = array();
 337         }
 338         $rows[$dao->contribution_id]['membership'][] = $dao->membership_id;
 339       }
 340       if ($dao->participant_id) {
 341         $rows[$dao->contribution_id]['participant'] = $dao->participant_id;
 342       }
 343       if ($dao->event_id) {
 344         $rows[$dao->contribution_id]['event'] = $dao->event_id;
 345       }
 346     }
 347     return $rows;
 348   }
 349
 350 }