CRM/Contribute/BAO/ContributionRecur.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_ContributionRecur {
  36
  37   /**
  38    * Create recurring contribution
  39    *
  40    * @param array  $params           (reference ) an assoc array of name/value pairs
  41    *
  42    * @return object activity contact object
  43    *
  44    */
  45   public static function create(&$params) {
  46     return self::add($params);
  47   }
  48
  49   /**
  50    * Takes an associative array and creates a contribution object
  51    *
  52    * the function extract all the params it needs to initialize the create a
  53    * contribution object. the params array could contain additional unused name/value
  54    * pairs
  55    *
  56    * @param array $params (reference ) an assoc array of name/value pairs
  57    *
  58    * @return CRM_Contribute_BAO_Contribution object
  59    * @static
  60    * @todo move hook calls / extended logic to create - requires changing calls to call create not add
  61    */
  62   public static function add(&$params) {
  63     if (!empty($params['id'])) {
  64       CRM_Utils_Hook::pre('edit', 'ContributionRecur', $params['id'], $params);
  65     }
  66     else {
  67       CRM_Utils_Hook::pre('create', 'ContributionRecur', NULL, $params);
  68     }
  69
  70     // make sure we're not creating a new recurring contribution with the same transaction ID
  71     // or invoice ID as an existing recurring contribution
  72     $duplicates = array();
  73     if (self::checkDuplicate($params, $duplicates)) {
  74       $error = CRM_Core_Error::singleton();
  75       $d = implode(', ', $duplicates);
  76       $error->push(CRM_Core_Error::DUPLICATE_CONTRIBUTION,
  77         'Fatal',
  78         array($d),
  79         "Found matching recurring contribution(s): $d"
  80       );
  81       return $error;
  82     }
  83
  84     $recurring = new CRM_Contribute_BAO_ContributionRecur();
  85     $recurring->copyValues($params);
  86     $recurring->id = CRM_Utils_Array::value('id', $params);
  87
  88     // set currency for CRM-1496
  89     if (!isset($recurring->currency)) {
  90       $config = CRM_Core_Config::singleton();
  91       $recurring->currency = $config->defaultCurrency;
  92     }
  93     $result = $recurring->save();
  94
  95     if (!empty($params['id'])) {
  96       CRM_Utils_Hook::post('edit', 'ContributionRecur', $recurring->id, $recurring);
  97     }
  98     else {
  99       CRM_Utils_Hook::post('create', 'ContributionRecur', $recurring->id, $recurring);
 100     }
 101
 102     return $result;
 103   }
 104
 105   /**
 106    * Check if there is a recurring contribution with the same trxn_id or invoice_id
 107    *
 108    * @param array  $params (reference ) an assoc array of name/value pairs
 109    * @param array  $duplicates (reference ) store ids of duplicate contribs
 110    *
 111    * @return boolean true if duplicate, false otherwise
 112    * static
 113    */
 114   public static function checkDuplicate($params, &$duplicates) {
 115     $id         = CRM_Utils_Array::value('id', $params);
 116     $trxn_id    = CRM_Utils_Array::value('trxn_id', $params);
 117     $invoice_id = CRM_Utils_Array::value('invoice_id', $params);
 118
 119     $clause = array();
 120     $params = array();
 121
 122     if ($trxn_id) {
 123       $clause[] = "trxn_id = %1";
 124       $params[1] = array($trxn_id, 'String');
 125     }
 126
 127     if ($invoice_id) {
 128       $clause[] = "invoice_id = %2";
 129       $params[2] = array($invoice_id, 'String');
 130     }
 131
 132     if (empty($clause)) {
 133       return FALSE;
 134     }
 135
 136     $clause = implode(' OR ', $clause);
 137     if ($id) {
 138       $clause = "( $clause ) AND id != %3";
 139       $params[3] = array($id, 'Integer');
 140     }
 141
 142     $query  = "SELECT id FROM civicrm_contribution_recur WHERE $clause";
 143     $dao    = CRM_Core_DAO::executeQuery($query, $params);
 144     $result = FALSE;
 145     while ($dao->fetch()) {
 146       $duplicates[] = $dao->id;
 147       $result = TRUE;
 148     }
 149     return $result;
 150   }
 151
 152   /**
 153    * @param int $id
 154    * @param $mode
 155    *
 156    * @return array|null
 157    */
 158   public static function getPaymentProcessor($id, $mode) {
 159     //FIX ME:
 160     $sql = "
 161 SELECT r.payment_processor_id
 162   FROM civicrm_contribution_recur r
 163  WHERE r.id = %1";
 164     $params = array(1 => array($id, 'Integer'));
 165     $paymentProcessorID = &CRM_Core_DAO::singleValueQuery($sql,
 166       $params
 167     );
 168     if (!$paymentProcessorID) {
 169       return NULL;
 170     }
 171
 172     return CRM_Financial_BAO_PaymentProcessor::getPayment($paymentProcessorID, $mode);
 173   }
 174
 175   /**
 176    * Get the number of installment done/completed for each recurring contribution
 177    *
 178    * @param array  $ids (reference ) an array of recurring contribution ids
 179    *
 180    * @return array $totalCount an array of recurring ids count
 181    * static
 182    */
 183   public static function getCount(&$ids) {
 184     $recurID = implode(',', $ids);
 185     $totalCount = array();
 186
 187     $query = "
 188          SELECT contribution_recur_id, count( contribution_recur_id ) as commpleted
 189          FROM civicrm_contribution
 190          WHERE contribution_recur_id IN ( {$recurID}) AND is_test = 0
 191          GROUP BY contribution_recur_id";
 192
 193     $res = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
 194
 195     while ($res->fetch()) {
 196       $totalCount[$res->contribution_recur_id] = $res->commpleted;
 197     }
 198     return $totalCount;
 199   }
 200
 201   /**
 202    * Delete Recurring contribution.
 203    *
 204    * @param int $recurId
 205    *
 206    * @return bool
 207    * @static
 208    */
 209   public static function deleteRecurContribution($recurId) {
 210     $result = FALSE;
 211     if (!$recurId) {
 212       return $result;
 213     }
 214
 215     $recur     = new CRM_Contribute_DAO_ContributionRecur();
 216     $recur->id = $recurId;
 217     $result    = $recur->delete();
 218
 219     return $result;
 220   }
 221
 222   /**
 223    * Cancel Recurring contribution.
 224    *
 225    * @param integer $recurId recur contribution id.
 226    * @param array $objects an array of objects that is to be cancelled like
 227    *                          contribution, membership, event. At least contribution object is a must.
 228    *
 229    * @param array $activityParams
 230    *
 231    * @return bool
 232    * @static
 233    */
 234   public static function cancelRecurContribution($recurId, $objects, $activityParams = array()) {
 235     if (!$recurId) {
 236       return FALSE;
 237     }
 238
 239     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 240     $canceledId         = array_search('Cancelled', $contributionStatus);
 241     $recur              = new CRM_Contribute_DAO_ContributionRecur();
 242     $recur->id          = $recurId;
 243     $recur->whereAdd("contribution_status_id != $canceledId");
 244
 245     if ($recur->find(TRUE)) {
 246       $transaction = new CRM_Core_Transaction();
 247       $recur->contribution_status_id = $canceledId;
 248       $recur->start_date = CRM_Utils_Date::isoToMysql($recur->start_date);
 249       $recur->create_date = CRM_Utils_Date::isoToMysql($recur->create_date);
 250       $recur->modified_date = CRM_Utils_Date::isoToMysql($recur->modified_date);
 251       $recur->cancel_date = date('YmdHis');
 252       $recur->save();
 253
 254       $dao = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($recurId);
 255       if ($dao && $dao->recur_id) {
 256         $details = CRM_Utils_Array::value('details', $activityParams);
 257         if ($dao->auto_renew && $dao->membership_id) {
 258           // its auto-renewal membership mode
 259           $membershipTypes = CRM_Member_PseudoConstant::membershipType();
 260           $membershipType  = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $dao->membership_id, 'membership_type_id');
 261           $membershipType  = CRM_Utils_Array::value($membershipType, $membershipTypes);
 262           $details .= '
 263 <br/>' . ts('Automatic renewal of %1 membership cancelled.', array(1 => $membershipType));
 264         }
 265         else {
 266           $details .= '
 267 <br/>' . ts('The recurring contribution of %1, every %2 %3 has been cancelled.', array(
 268   1 => $dao->amount,
 269               2 => $dao->frequency_interval,
 270               3 => $dao->frequency_unit
 271             ));
 272         }
 273         $activityParams = array(
 274           'source_contact_id' => $dao->contact_id,
 275           'source_record_id' => CRM_Utils_Array::value('source_record_id', $activityParams),
 276           'activity_type_id' => CRM_Core_OptionGroup::getValue('activity_type',
 277             'Cancel Recurring Contribution',
 278             'name'
 279           ),
 280           'subject' => CRM_Utils_Array::value('subject', $activityParams, ts('Recurring contribution cancelled')),
 281           'details' => $details,
 282           'activity_date_time' => date('YmdHis'),
 283           'status_id' => CRM_Core_OptionGroup::getValue('activity_status',
 284             'Completed',
 285             'name'
 286           ),
 287         );
 288         $session = CRM_Core_Session::singleton();
 289         $cid = $session->get('userID');
 290         if ($cid) {
 291           $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
 292           $activityParams['source_contact_id'] = $cid;
 293         }
 294         CRM_Activity_BAO_Activity::create($activityParams);
 295       }
 296
 297       // if there are associated objects, cancel them as well
 298       if ($objects == CRM_Core_DAO::$_nullObject) {
 299         $transaction->commit();
 300         return TRUE;
 301       }
 302       else {
 303         $baseIPN = new CRM_Core_Payment_BaseIPN();
 304         return $baseIPN->cancelled($objects, $transaction);
 305       }
 306     }
 307     else {
 308       // if already cancelled, return true
 309       $recur->whereAdd();
 310       $recur->whereAdd("contribution_status_id = $canceledId");
 311       if ($recur->find(TRUE)) {
 312         return TRUE;
 313       }
 314     }
 315
 316     return FALSE;
 317   }
 318
 319   /**
 320    * Get list of recurring contribution of contact Ids
 321    *
 322    * @param int $contactId Contact ID
 323    *
 324    * @return array list of recurring contribution fields
 325    *
 326    * @static
 327    */
 328   public static function getRecurContributions($contactId) {
 329     $params = array();
 330     $recurDAO = new CRM_Contribute_DAO_ContributionRecur();
 331     $recurDAO->contact_id = $contactId;
 332     $recurDAO->find();
 333     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus();
 334
 335     while ($recurDAO->fetch()) {
 336       $params[$recurDAO->id]['id'] = $recurDAO->id;
 337       $params[$recurDAO->id]['contactId'] = $recurDAO->contact_id;
 338       $params[$recurDAO->id]['start_date'] = $recurDAO->start_date;
 339       $params[$recurDAO->id]['end_date'] = $recurDAO->end_date;
 340       $params[$recurDAO->id]['next_sched_contribution_date'] = $recurDAO->next_sched_contribution_date;
 341       $params[$recurDAO->id]['amount'] = $recurDAO->amount;
 342       $params[$recurDAO->id]['currency'] = $recurDAO->currency;
 343       $params[$recurDAO->id]['frequency_unit'] = $recurDAO->frequency_unit;
 344       $params[$recurDAO->id]['frequency_interval'] = $recurDAO->frequency_interval;
 345       $params[$recurDAO->id]['installments'] = $recurDAO->installments;
 346       $params[$recurDAO->id]['contribution_status_id'] = $recurDAO->contribution_status_id;
 347       $params[$recurDAO->id]['contribution_status'] = CRM_Utils_Array::value($recurDAO->contribution_status_id, $contributionStatus);
 348       $params[$recurDAO->id]['is_test'] = $recurDAO->is_test;
 349       $params[$recurDAO->id]['payment_processor_id'] = $recurDAO->payment_processor_id;
 350     }
 351
 352     return $params;
 353   }
 354
 355   /**
 356    * @param int $entityID
 357    * @param string $entity
 358    *
 359    * @return null|Object
 360    */
 361   public static function getSubscriptionDetails($entityID, $entity = 'recur') {
 362     $sql = "
 363 SELECT rec.id                   as recur_id,
 364        rec.processor_id         as subscription_id,
 365        rec.frequency_interval,
 366        rec.installments,
 367        rec.frequency_unit,
 368        rec.amount,
 369        rec.is_test,
 370        rec.auto_renew,
 371        rec.currency,
 372        con.id                   as contribution_id,
 373        con.contribution_page_id,
 374        rec.contact_id,
 375        mp.membership_id";
 376
 377     if ($entity == 'recur') {
 378       $sql .= "
 379       FROM civicrm_contribution_recur rec
 380 LEFT JOIN civicrm_contribution       con ON ( con.contribution_recur_id = rec.id )
 381 LEFT  JOIN civicrm_membership_payment mp  ON ( mp.contribution_id = con.id )
 382      WHERE rec.id = %1
 383   GROUP BY rec.id";
 384     }
 385     elseif ($entity == 'contribution') {
 386       $sql .= "
 387       FROM civicrm_contribution       con
 388 INNER JOIN civicrm_contribution_recur rec ON ( con.contribution_recur_id = rec.id )
 389 LEFT  JOIN civicrm_membership_payment mp  ON ( mp.contribution_id = con.id )
 390      WHERE con.id = %1";
 391     }
 392     elseif ($entity == 'membership') {
 393       $sql .= "
 394       FROM civicrm_membership_payment mp
 395 INNER JOIN civicrm_membership         mem ON ( mp.membership_id = mem.id )
 396 INNER JOIN civicrm_contribution_recur rec ON ( mem.contribution_recur_id = rec.id )
 397 INNER JOIN civicrm_contribution       con ON ( con.id = mp.contribution_id )
 398      WHERE mp.membership_id = %1";
 399     }
 400
 401     $dao = CRM_Core_DAO::executeQuery($sql, array(1 => array($entityID, 'Integer')));
 402     if ($dao->fetch()) {
 403       return $dao;
 404     }
 405     else {
 406       return CRM_Core_DAO::$_nullObject;
 407     }
 408   }
 409
 410   public static function setSubscriptionContext() {
 411     // handle context redirection for subscription url
 412     $session = CRM_Core_Session::singleton();
 413     if ($session->get('userID')) {
 414       $url = FALSE;
 415       $cid = CRM_Utils_Request::retrieve('cid', 'Integer');
 416       $mid = CRM_Utils_Request::retrieve('mid', 'Integer');
 417       $qfkey = CRM_Utils_Request::retrieve('key', 'String');
 418       $context = CRM_Utils_Request::retrieve('context', 'String');
 419       if ($cid) {
 420         switch ($context) {
 421           case 'contribution':
 422             $url = CRM_Utils_System::url('civicrm/contact/view',
 423               "reset=1&selectedChild=contribute&cid={$cid}"
 424             );
 425             break;
 426
 427           case 'membership':
 428             $url = CRM_Utils_System::url('civicrm/contact/view',
 429               "reset=1&selectedChild=member&cid={$cid}"
 430             );
 431             break;
 432
 433           case 'dashboard':
 434             $url = CRM_Utils_System::url('civicrm/user', "reset=1&id={$cid}");
 435             break;
 436         }
 437       }
 438       if ($mid) {
 439         switch ($context) {
 440           case 'dashboard':
 441             $url = CRM_Utils_System::url('civicrm/member', "force=1&context={$context}&key={$qfkey}");
 442             break;
 443
 444           case 'search':
 445             $url = CRM_Utils_System::url('civicrm/member/search', "force=1&context={$context}&key={$qfkey}");
 446             break;
 447         }
 448       }
 449       if ($url) {
 450         $session->pushUserContext($url);
 451       }
 452     }
 453   }
 454 }