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