CRM/Financial/BAO/PaymentProcessor.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
  36 /**
  37  * This class contains payment processor related functions.
  38  */
  39 class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProcessor {
  40   /**
  41    * Static holder for the default payment processor
  42    */
  43   static $_defaultPaymentProcessor = NULL;
  44
  45   /**
  46    * Create Payment Processor.
  47    *
  48    * @param array $params
  49    *   Parameters for Processor entity.
  50    *
  51    * @return CRM_Financial_DAO_PaymentProcessor
  52    * @throws Exception
  53    */
  54   public static function create($params) {
  55     // FIXME Reconcile with CRM_Admin_Form_PaymentProcessor::updatePaymentProcessor
  56     $processor = new CRM_Financial_DAO_PaymentProcessor();
  57     $processor->copyValues($params);
  58
  59     $ppTypeDAO = new CRM_Financial_DAO_PaymentProcessorType();
  60     $ppTypeDAO->id = $params['payment_processor_type_id'];
  61     if (!$ppTypeDAO->find(TRUE)) {
  62       CRM_Core_Error::fatal(ts('Could not find payment processor meta information'));
  63     }
  64
  65     // also copy meta fields from the info DAO
  66     $processor->is_recur = $ppTypeDAO->is_recur;
  67     $processor->billing_mode = $ppTypeDAO->billing_mode;
  68     $processor->class_name = $ppTypeDAO->class_name;
  69     $processor->payment_type = $ppTypeDAO->payment_type;
  70
  71     $processor->save();
  72     // CRM-11826, add entry in civicrm_entity_financial_account
  73     // if financial_account_id is not NULL
  74     if (!empty($params['financial_account_id'])) {
  75       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
  76       $values = array(
  77         'entity_table' => 'civicrm_payment_processor',
  78         'entity_id' => $processor->id,
  79         'account_relationship' => $relationTypeId,
  80         'financial_account_id' => $params['financial_account_id'],
  81       );
  82       CRM_Financial_BAO_FinancialTypeAccount::add($values);
  83     }
  84     return $processor;
  85   }
  86
  87   /**
  88    * Class constructor.
  89    */
  90   public function __construct() {
  91     parent::__construct();
  92   }
  93
  94   /**
  95    * Retrieve DB object based on input parameters.
  96    *
  97    * It also stores all the retrieved values in the default array.
  98    *
  99    * @param array $params
 100    *   (reference ) an assoc array of name/value pairs.
 101    * @param array $defaults
 102    *   (reference ) an assoc array to hold the flattened values.
 103    *
 104    * @return CRM_Financial_DAO_PaymentProcessor|null
 105    *   object on success, null otherwise
 106    */
 107   public static function retrieve(&$params, &$defaults) {
 108     $paymentProcessor = new CRM_Financial_DAO_PaymentProcessor();
 109     $paymentProcessor->copyValues($params);
 110     if ($paymentProcessor->find(TRUE)) {
 111       CRM_Core_DAO::storeValues($paymentProcessor, $defaults);
 112       return $paymentProcessor;
 113     }
 114     return NULL;
 115   }
 116
 117   /**
 118    * Update the is_active flag in the db.
 119    *
 120    * @param int $id
 121    *   Id of the database record.
 122    * @param bool $is_active
 123    *   Value we want to set the is_active field.
 124    *
 125    * @return CRM_Financial_DAO_PaymentProcessor|null
 126    *   DAO object on success, null otherwise
 127    *
 128    */
 129   public static function setIsActive($id, $is_active) {
 130     return CRM_Core_DAO::setFieldValue('CRM_Financial_DAO_PaymentProcessor', $id, 'is_active', $is_active);
 131   }
 132
 133   /**
 134    * Retrieve the default payment processor.
 135    *
 136    * @return CRM_Financial_DAO_PaymentProcessor|null
 137    *   The default payment processor object on success,
 138    *   null otherwise
 139    */
 140   public static function &getDefault() {
 141     if (self::$_defaultPaymentProcessor == NULL) {
 142       $params = array('is_default' => 1);
 143       $defaults = array();
 144       self::$_defaultPaymentProcessor = self::retrieve($params, $defaults);
 145     }
 146     return self::$_defaultPaymentProcessor;
 147   }
 148
 149   /**
 150    * Delete payment processor.
 151    *
 152    * @param int $paymentProcessorID
 153    *
 154    * @return null
 155    */
 156   public static function del($paymentProcessorID) {
 157     if (!$paymentProcessorID) {
 158       CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
 159     }
 160
 161     $dao = new CRM_Financial_DAO_PaymentProcessor();
 162     $dao->id = $paymentProcessorID;
 163     if (!$dao->find(TRUE)) {
 164       return NULL;
 165     }
 166
 167     $testDAO = new CRM_Financial_DAO_PaymentProcessor();
 168     $testDAO->name = $dao->name;
 169     $testDAO->is_test = 1;
 170     $testDAO->delete();
 171
 172     $dao->delete();
 173   }
 174
 175   /**
 176    * Get the payment processor details.
 177    *
 178    * @param int $paymentProcessorID
 179    *   Payment processor id.
 180    * @param string $mode
 181    *   Payment mode ie test or live.
 182    *
 183    * @return array
 184    *   associated array with payment processor related fields
 185    */
 186   public static function getPayment($paymentProcessorID, $mode) {
 187     if (!$paymentProcessorID) {
 188       CRM_Core_Error::fatal(ts('Invalid value passed to getPayment function'));
 189     }
 190
 191     $dao = new CRM_Financial_DAO_PaymentProcessor();
 192     $dao->id = $paymentProcessorID;
 193     $dao->is_active = 1;
 194     if (!$dao->find(TRUE)) {
 195       return NULL;
 196     }
 197
 198     if ($mode == 'test') {
 199       $testDAO = new CRM_Financial_DAO_PaymentProcessor();
 200       $testDAO->name = $dao->name;
 201       $testDAO->is_active = 1;
 202       $testDAO->is_test = 1;
 203       if (!$testDAO->find(TRUE)) {
 204         CRM_Core_Error::fatal(ts('Could not retrieve payment processor details'));
 205       }
 206       return self::buildPayment($testDAO, $mode);
 207     }
 208     else {
 209       return self::buildPayment($dao, $mode);
 210     }
 211   }
 212
 213   /**
 214    * @param $paymentProcessorIDs
 215    * @param $mode
 216    *
 217    * @return array
 218    * @throws Exception
 219    */
 220   public static function getPayments($paymentProcessorIDs, $mode) {
 221     if (!$paymentProcessorIDs) {
 222       CRM_Core_Error::fatal(ts('Invalid value passed to getPayment function'));
 223     }
 224
 225     $payments = array();
 226     foreach ($paymentProcessorIDs as $paymentProcessorID) {
 227       $payment = self::getPayment($paymentProcessorID, $mode);
 228       $payments[$payment['id']] = $payment;
 229     }
 230
 231     uasort($payments, 'self::defaultComparison');
 232     return $payments;
 233   }
 234
 235   /**
 236    * Compare 2 payment processors to see which should go first based on is_default
 237    * (sort function for sortDefaultFirst)
 238    * @param array $processor1
 239    * @param array $processor2
 240    *
 241    * @return int
 242    */
 243   public static function defaultComparison($processor1, $processor2) {
 244     $p1 = CRM_Utils_Array::value('is_default', $processor1);
 245     $p2 = CRM_Utils_Array::value('is_default', $processor2);
 246     if ($p1 == $p2) {
 247       return 0;
 248     }
 249     return ($p1 > $p2) ? -1 : 1;
 250   }
 251
 252   /**
 253    * Build payment processor details.
 254    *
 255    * @param object $dao
 256    *   Payment processor object.
 257    * @param string $mode
 258    *   Payment mode ie test or live.
 259    *
 260    * @return array
 261    *   associated array with payment processor related fields
 262    */
 263   public static function buildPayment($dao, $mode) {
 264     $fields = array(
 265       'id',
 266       'name',
 267       'payment_processor_type_id',
 268       'user_name',
 269       'password',
 270       'signature',
 271       'url_site',
 272       'url_api',
 273       'url_recur',
 274       'url_button',
 275       'subject',
 276       'class_name',
 277       'is_recur',
 278       'billing_mode',
 279       'is_test',
 280       'payment_type',
 281       'is_default',
 282     );
 283     $result = array();
 284     foreach ($fields as $name) {
 285       $result[$name] = $dao->$name;
 286     }
 287     $result['payment_processor_type'] = CRM_Core_PseudoConstant::paymentProcessorType(FALSE, $dao->payment_processor_type_id, 'name');
 288
 289     $result['instance'] = $result['object'] =& CRM_Core_Payment::singleton($mode, $result);
 290
 291     return $result;
 292   }
 293
 294   /**
 295    * Get all payment processors as an array of objects.
 296    *
 297    * @param string|NULL $mode
 298    * only return this mode - test|live or NULL for all
 299    * @param bool $reset
 300    *
 301    * @throws CiviCRM_API3_Exception
 302    * @return array
 303    */
 304   public static function getAllPaymentProcessors($mode, $reset = FALSE) {
 305     /*
 306      * $cacheKey = 'CRM_Financial_BAO_Payment_Processor_' . ($mode ? 'test' : 'all');
 307      * if (!$reset) {
 308      *   $processors = CRM_Utils_Cache::singleton()->get($cacheKey);
 309      *   if (!empty($processors)) {
 310      *     return $processors;
 311      *   }
 312      * }
 313      */
 314     $retrievalParameters = array(
 315       'is_active' => TRUE,
 316       'options' => array('sort' => 'is_default DESC, name'),
 317       'api.payment_processor_type.getsingle' => 1,
 318     );
 319     if ($mode == 'test') {
 320       $retrievalParameters['is_test'] = 1;
 321     }
 322     elseif ($mode == 'live') {
 323       $retrievalParameters['is_test'] = 0;
 324     }
 325     $processors = civicrm_api3('payment_processor', 'get', $retrievalParameters);
 326     foreach ($processors['values'] as $processor) {
 327       $fieldsToProvide = array('user_name', 'password', 'signature', 'subject');
 328       foreach ($fieldsToProvide as $field) {
 329         //prevent e-notices in processor classes when not configured
 330         if (!isset($processor[$field])) {
 331           $processor[$field] = NULL;
 332         }
 333       }
 334       $processors['values'][$processor['id']]['payment_processor_type'] = $processor['payment_processor_type'] = $processors['values'][$processor['id']]['api.payment_processor_type.getsingle']['name'];
 335       $mode = empty($processor['is_test']) ? 'live' : 'test';
 336       $processors['values'][$processor['id']]['object'] = CRM_Core_Payment::singleton($mode, $processor);
 337     }
 338     /*
 339     CRM_Utils_Cache::singleton()->set($cacheKey, $processors);
 340      */
 341     return $processors['values'];
 342   }
 343
 344   /**
 345    * Get Payment processors with specified capabilities.
 346    * Note that both the singleton & the pseudoconstant function have caching so we don't add
 347    * arguably this could go on the pseudoconstant class
 348    *
 349    * @param array $capabilities
 350    *   capabilities of processor e.g
 351    *   - BackOffice
 352    *   - TestMode
 353    *   - LiveMode
 354    *   - FutureStartDate
 355    *
 356    * @param array $ids
 357    *
 358    * @return array
 359    *   available processors
 360    */
 361   public static function getPaymentProcessors($capabilities = array(), $ids = array()) {
 362     $mode = NULL;
 363     if (in_array('TestMode', $capabilities)) {
 364       $mode = 'test';
 365     }
 366     elseif (in_array('LiveMode', $capabilities)) {
 367       $mode = 'live';
 368     }
 369     $processors = self::getAllPaymentProcessors($mode);
 370     if ($capabilities) {
 371       foreach ($processors as $index => $processor) {
 372         if (!empty($ids) && !in_array($processor['id'], $ids)) {
 373           unset ($processors[$index]);
 374           continue;
 375         }
 376         if (($error = $processor['object']->checkConfig()) != NULL) {
 377           unset ($processors[$index]);
 378           continue;
 379         }
 380         foreach ($capabilities as $capability) {
 381           if (($processor['object']->supports($capability)) == FALSE) {
 382             unset ($processors[$index]);
 383           }
 384         }
 385       }
 386     }
 387     return $processors;
 388   }
 389
 390   /**
 391    * Is there a processor on this site with the specified capability.
 392    * @param array $capabilities
 393    * @param bool $isIncludeTest
 394    *
 395    * @return bool
 396    */
 397   public static function hasPaymentProcessorSupporting($capabilities = array(), $isIncludeTest = FALSE) {
 398     $mode = $isIncludeTest ? 'Test' : 'Live';
 399     $capabilities[] = $mode . 'Mode';
 400     $result = self::getPaymentProcessors($capabilities);
 401     return (!empty($result)) ? TRUE : FALSE;
 402   }
 403
 404   /**
 405    * Retrieve payment processor id / info/ object based on component-id.
 406    *
 407    * @param int $entityID
 408    * @param string $component
 409    *   Component.
 410    * @param string $type
 411    *   Type of payment information to be retrieved.
 412    *
 413    * @return int|array|object
 414    */
 415   public static function getProcessorForEntity($entityID, $component = 'contribute', $type = 'id') {
 416     $result = NULL;
 417     if (!in_array($component, array(
 418       'membership',
 419       'contribute',
 420       'recur',
 421     ))
 422     ) {
 423       return $result;
 424     }
 425     //FIXME:
 426     if ($component == 'membership') {
 427       $sql = "
 428     SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test
 429       FROM civicrm_membership mem
 430 INNER JOIN civicrm_membership_payment mp  ON ( mem.id = mp.membership_id )
 431 INNER JOIN civicrm_contribution       con ON ( mp.contribution_id = con.id )
 432  LEFT JOIN civicrm_contribution_recur cr  ON ( mem.contribution_recur_id = cr.id )
 433  LEFT JOIN civicrm_contribution_page  cp  ON ( con.contribution_page_id  = cp.id )
 434      WHERE mp.membership_id = %1";
 435     }
 436     elseif ($component == 'contribute') {
 437       $sql = "
 438     SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test
 439       FROM civicrm_contribution       con
 440  LEFT JOIN civicrm_contribution_recur cr  ON ( con.contribution_recur_id = cr.id )
 441  LEFT JOIN civicrm_contribution_page  cp  ON ( con.contribution_page_id  = cp.id )
 442      WHERE con.id = %1";
 443     }
 444     elseif ($component == 'recur') {
 445       $sql = "
 446     SELECT cr.payment_processor_id as ppID1, NULL as ppID2, cr.is_test
 447       FROM civicrm_contribution_recur cr
 448      WHERE cr.id = %1";
 449     }
 450
 451     //we are interesting in single record.
 452     $sql .= ' LIMIT 1';
 453
 454     $params = array(1 => array($entityID, 'Integer'));
 455     $dao = CRM_Core_DAO::executeQuery($sql, $params);
 456
 457     if (!$dao->fetch()) {
 458
 459       return $result;
 460
 461     }
 462
 463     $ppID = (isset($dao->ppID1) && $dao->ppID1) ? $dao->ppID1 : (isset($dao->ppID2) ? $dao->ppID2 : NULL);
 464     $mode = (isset($dao->is_test) && $dao->is_test) ? 'test' : 'live';
 465     if (!$ppID || $type == 'id') {
 466       $result = $ppID;
 467     }
 468     elseif ($type == 'info') {
 469       $result = self::getPayment($ppID, $mode);
 470     }
 471     elseif ($type == 'obj') {
 472       $payment = self::getPayment($ppID, $mode);
 473       $result = CRM_Core_Payment::singleton($mode, $payment);
 474     }
 475
 476     return $result;
 477   }
 478
 479 }