CRM/Admin/Form/PaymentProcessor.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  32  */
  33
  34 /**
  35  * This class generates form components for Payment Processor.
  36  */
  37 class CRM_Admin_Form_PaymentProcessor extends CRM_Admin_Form {
  38   protected $_id = NULL;
  39
  40   protected $_testID = NULL;
  41
  42   protected $_fields = NULL;
  43
  44   protected $_ppDAO;
  45
  46   public function preProcess() {
  47     if (!CRM_Core_Permission::check('administer payment processors')) {
  48       CRM_Core_Error::statusBounce('The \'administer payment processors\' permission is required to add or edit a payment processor.');
  49     }
  50     parent::preProcess();
  51
  52     CRM_Utils_System::setTitle(ts('Settings - Payment Processor'));
  53
  54     // get the payment processor meta information
  55
  56     if ($this->_id) {
  57       $this->_ppType = CRM_Utils_Request::retrieve('pp', 'String', $this, FALSE, NULL);
  58       if (!$this->_ppType) {
  59         $this->_ppType = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessor',
  60           $this->_id,
  61           'payment_processor_type_id'
  62         );
  63       }
  64       $this->set('pp', $this->_ppType);
  65     }
  66     else {
  67       $this->_ppType = CRM_Utils_Request::retrieve('pp', 'String', $this, TRUE, NULL);
  68     }
  69
  70     $this->assign('ppType', $this->_ppType);
  71     $ppTypeName = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType',
  72       $this->_ppType,
  73       'name'
  74     );
  75     $this->assign('ppTypeName', $ppTypeName);
  76
  77     $this->_ppDAO = new CRM_Financial_DAO_PaymentProcessorType();
  78     $this->_ppDAO->id = $this->_ppType;
  79
  80     if (!$this->_ppDAO->find(TRUE)) {
  81       CRM_Core_Error::fatal(ts('Could not find payment processor meta information'));
  82     }
  83
  84     if ($this->_id) {
  85       $refreshURL = CRM_Utils_System::url('civicrm/admin/paymentProcessor',
  86         "reset=1&action=update&id={$this->_id}",
  87         FALSE, NULL, FALSE
  88       );
  89     }
  90     else {
  91       $refreshURL = CRM_Utils_System::url('civicrm/admin/paymentProcessor',
  92         "reset=1&action=add",
  93         FALSE, NULL, FALSE
  94       );
  95     }
  96
  97     //CRM-4129
  98     $destination = CRM_Utils_Request::retrieve('civicrmDestination', 'String', $this);
  99     if ($destination) {
 100       $destination = urlencode($destination);
 101       $refreshURL .= "&civicrmDestination=$destination";
 102     }
 103
 104     $this->assign('refreshURL', $refreshURL);
 105
 106     $this->assign('is_recur', $this->_ppDAO->is_recur);
 107
 108     $this->_fields = array(
 109       array(
 110         'name' => 'user_name',
 111         'label' => $this->_ppDAO->user_name_label,
 112       ),
 113       array(
 114         'name' => 'password',
 115         'label' => $this->_ppDAO->password_label,
 116       ),
 117       array(
 118         'name' => 'signature',
 119         'label' => $this->_ppDAO->signature_label,
 120       ),
 121       array(
 122         'name' => 'subject',
 123         'label' => $this->_ppDAO->subject_label,
 124       ),
 125       array(
 126         'name' => 'url_site',
 127         'label' => ts('Site URL'),
 128         'rule' => 'url',
 129         'msg' => ts('Enter a valid URL'),
 130       ),
 131     );
 132
 133     if ($this->_ppDAO->is_recur) {
 134       $this->_fields[] = array(
 135         'name' => 'url_recur',
 136         'label' => ts('Recurring Payments URL'),
 137         'rule' => 'url',
 138         'msg' => ts('Enter a valid URL'),
 139       );
 140     }
 141
 142     if (!empty($this->_ppDAO->url_button_default)) {
 143       $this->_fields[] = array(
 144         'name' => 'url_button',
 145         'label' => ts('Button URL'),
 146         'rule' => 'url',
 147         'msg' => ts('Enter a valid URL'),
 148       );
 149     }
 150
 151     if (!empty($this->_ppDAO->url_api_default)) {
 152       $this->_fields[] = array(
 153         'name' => 'url_api',
 154         'label' => ts('API URL'),
 155         'rule' => 'url',
 156         'msg' => ts('Enter a valid URL'),
 157       );
 158     }
 159   }
 160
 161   /**
 162    * Build the form object.
 163    *
 164    * @param bool $check
 165    */
 166   public function buildQuickForm($check = FALSE) {
 167     parent::buildQuickForm();
 168
 169     if ($this->_action & CRM_Core_Action::DELETE) {
 170       return;
 171     }
 172
 173     $attributes = CRM_Core_DAO::getAttribute('CRM_Financial_DAO_PaymentProcessor');
 174
 175     $this->add('text', 'name', ts('Name'),
 176       $attributes['name'], TRUE
 177     );
 178
 179     $this->addRule('name', ts('Name already exists in Database.'), 'objectExists', array(
 180         'CRM_Financial_DAO_PaymentProcessor',
 181         $this->_id,
 182         'name',
 183         CRM_Core_Config::domainID(),
 184       ));
 185
 186     $this->add('text', 'description', ts('Description'),
 187       $attributes['description']
 188     );
 189
 190     $types = CRM_Core_PseudoConstant::paymentProcessorType();
 191     $this->add('select', 'payment_processor_type_id', ts('Payment Processor Type'), $types, TRUE,
 192       array('onchange' => "reload(true)")
 193     );
 194
 195     // Financial Account of account type asset CRM-11515
 196     $accountType = CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name = 'Asset' ");
 197     $financialAccount = CRM_Contribute_PseudoConstant::financialAccount(NULL, key($accountType));
 198     if ($fcount = count($financialAccount)) {
 199       $this->assign('financialAccount', $fcount);
 200     }
 201     $this->add('select', 'financial_account_id', ts('Financial Account'),
 202       array('' => ts('- select -')) + $financialAccount,
 203       TRUE
 204     );
 205     $this->addSelect('payment_instrument_id',
 206       array(
 207         'entity' => 'contribution',
 208         'label' => ts('Payment Method'),
 209         'placeholder'  => NULL,
 210       )
 211     );
 212
 213     // is this processor active ?
 214     $this->add('checkbox', 'is_active', ts('Is this Payment Processor active?'));
 215     $this->add('checkbox', 'is_default', ts('Is this Payment Processor the default?'));
 216     $creditCardTypes = CRM_Contribute_PseudoConstant::creditCard();
 217     $this->addCheckBox('accept_credit_cards', ts('Accepted Credit Card Type(s)'),
 218       $creditCardTypes, NULL, NULL, NULL, NULL, '&nbsp;&nbsp;&nbsp;');
 219     foreach ($this->_fields as $field) {
 220       if (empty($field['label'])) {
 221         continue;
 222       }
 223
 224       $this->add('text', $field['name'],
 225         $field['label'], $attributes[$field['name']]
 226       );
 227       $this->add('text', "test_{$field['name']}",
 228         $field['label'], $attributes[$field['name']]
 229       );
 230       if (!empty($field['rule'])) {
 231         $this->addRule($field['name'], $field['msg'], $field['rule']);
 232         $this->addRule("test_{$field['name']}", $field['msg'], $field['rule']);
 233       }
 234     }
 235
 236     $this->addFormRule(array('CRM_Admin_Form_PaymentProcessor', 'formRule'));
 237   }
 238
 239   /**
 240    * @param $fields
 241    *
 242    * @return array|bool
 243    */
 244   public static function formRule($fields) {
 245
 246     // make sure that at least one of live or test is present
 247     // and we have at least name and url_site
 248     // would be good to make this processor specific
 249     $errors = array();
 250
 251     if (!(self::checkSection($fields, $errors) ||
 252       self::checkSection($fields, $errors, 'test')
 253     )
 254     ) {
 255       $errors['_qf_default'] = ts('You must have at least the test or live section filled');
 256     }
 257
 258     if (!empty($errors)) {
 259       return $errors;
 260     }
 261
 262     return empty($errors) ? TRUE : $errors;
 263   }
 264
 265   /**
 266    * @param $fields
 267    * @param $errors
 268    * @param null $section
 269    *
 270    * @return bool
 271    */
 272   public static function checkSection(&$fields, &$errors, $section = NULL) {
 273     $names = array('user_name');
 274
 275     $present = FALSE;
 276     $allPresent = TRUE;
 277     foreach ($names as $name) {
 278       if ($section) {
 279         $name = "{$section}_$name";
 280       }
 281       if (!empty($fields[$name])) {
 282         $present = TRUE;
 283       }
 284       else {
 285         $allPresent = FALSE;
 286       }
 287     }
 288
 289     if ($present) {
 290       if (!$allPresent) {
 291         $errors['_qf_default'] = ts('You must have at least the user_name specified');
 292       }
 293     }
 294     return $present;
 295   }
 296
 297   /**
 298    * @return array
 299    */
 300   public function setDefaultValues() {
 301     $defaults = array();
 302
 303     if (!$this->_id) {
 304       $defaults['is_active'] = $defaults['is_default'] = 1;
 305       $defaults['url_site'] = $this->_ppDAO->url_site_default;
 306       $defaults['url_api'] = $this->_ppDAO->url_api_default;
 307       $defaults['url_recur'] = $this->_ppDAO->url_recur_default;
 308       $defaults['url_button'] = $this->_ppDAO->url_button_default;
 309       $defaults['test_url_site'] = $this->_ppDAO->url_site_test_default;
 310       $defaults['test_url_api'] = $this->_ppDAO->url_api_test_default;
 311       $defaults['test_url_recur'] = $this->_ppDAO->url_recur_test_default;
 312       $defaults['test_url_button'] = $this->_ppDAO->url_button_test_default;
 313       $defaults['payment_instrument_id'] = $this->_ppDAO->payment_instrument_id;
 314       // When user changes payment processor type, it is passed in via $this->_ppType so update defaults array.
 315       if ($this->_ppType) {
 316         $defaults['payment_processor_type_id'] = $this->_ppType;
 317       }
 318       return $defaults;
 319     }
 320     $domainID = CRM_Core_Config::domainID();
 321
 322     $dao = new CRM_Financial_DAO_PaymentProcessor();
 323     $dao->id = $this->_id;
 324     $dao->domain_id = $domainID;
 325     if (!$dao->find(TRUE)) {
 326       return $defaults;
 327     }
 328
 329     CRM_Core_DAO::storeValues($dao, $defaults);
 330     // When user changes payment processor type, it is passed in via $this->_ppType so update defaults array.
 331     if ($this->_ppType) {
 332       $defaults['payment_processor_type_id'] = $this->_ppType;
 333     }
 334     $cards = json_decode(CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessor',
 335           $this->_id,
 336           'accepted_credit_cards'
 337         ), TRUE);
 338     $acceptedCards = array();
 339     if (!empty($cards)) {
 340       foreach ($cards as $card => $val) {
 341         $acceptedCards[$card] = 1;
 342       }
 343     }
 344     $defaults['accept_credit_cards'] = $acceptedCards;
 345     unset($defaults['accepted_credit_cards']);
 346     // now get testID
 347     $testDAO = new CRM_Financial_DAO_PaymentProcessor();
 348     $testDAO->name = $dao->name;
 349     $testDAO->is_test = 1;
 350     $testDAO->domain_id = $domainID;
 351     if ($testDAO->find(TRUE)) {
 352       $this->_testID = $testDAO->id;
 353
 354       foreach ($this->_fields as $field) {
 355         $testName = "test_{$field['name']}";
 356         $defaults[$testName] = $testDAO->{$field['name']};
 357       }
 358     }
 359     $defaults['financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($dao->id, 'civicrm_payment_processor', 'financial_account_id');
 360
 361     return $defaults;
 362   }
 363
 364   /**
 365    * Process the form submission.
 366    */
 367   public function postProcess() {
 368
 369     if ($this->_action & CRM_Core_Action::DELETE) {
 370       CRM_Financial_BAO_PaymentProcessor::del($this->_id);
 371       CRM_Core_Session::setStatus("", ts('Payment Processor Deleted.'), "success");
 372       return NULL;
 373     }
 374
 375     $values = $this->controller->exportValues($this->_name);
 376     $domainID = CRM_Core_Config::domainID();
 377
 378     if (!empty($values['is_default'])) {
 379       $query = "UPDATE civicrm_payment_processor SET is_default = 0 WHERE domain_id = $domainID";
 380       CRM_Core_DAO::executeQuery($query);
 381     }
 382
 383     $this->updatePaymentProcessor($values, $domainID, FALSE);
 384     $this->updatePaymentProcessor($values, $domainID, TRUE);
 385     CRM_Core_Session::setStatus(ts('Payment processor %1 has been saved.', array(1 => "<em>{$values['name']}</em>")), ts('Saved'), 'success');
 386   }
 387
 388   /**
 389    * Save a payment processor.
 390    *
 391    * @param array $values
 392    * @param int $domainID
 393    * @param bool $test
 394    */
 395   public function updatePaymentProcessor(&$values, $domainID, $test) {
 396     if ($test) {
 397       foreach (array('user_name', 'password', 'signature', 'url_site', 'url_recur', 'url_api', 'url_button', 'subject') as $field) {
 398         $values[$field] = empty($values["test_{$field}"]) ? CRM_Utils_Array::value($field, $values) : $values["test_{$field}"];
 399       }
 400     }
 401     if (!empty($values['accept_credit_cards'])) {
 402       $creditCards = array();
 403       $accptedCards = array_keys($values['accept_credit_cards']);
 404       $creditCardTypes = CRM_Contribute_PseudoConstant::creditCard();
 405       foreach ($creditCardTypes as $type => $val) {
 406         if (in_array($type, $accptedCards)) {
 407           $creditCards[$type] = $creditCardTypes[$type];
 408         }
 409       }
 410       $creditCards = json_encode($creditCards);
 411     }
 412     else {
 413       $creditCards = "NULL";
 414     }
 415     $params  = array_merge(array(
 416       'id' => $test ? $this->_testID : $this->_id,
 417       'domain_id' => $domainID,
 418       'is_test' => $test,
 419       'is_active' => 0,
 420       'is_default' => 0,
 421       'is_recur' => $this->_ppDAO->is_recur,
 422       'billing_mode' => $this->_ppDAO->billing_mode,
 423       'class_name' => $this->_ppDAO->class_name,
 424       'payment_type' => $this->_ppDAO->payment_type,
 425       'payment_instrument_id' => $this->_ppDAO->payment_instrument_id,
 426       'financial_account_id' => $values['financial_account_id'],
 427       'accepted_credit_cards' => $creditCards,
 428     ), $values);
 429
 430     civicrm_api3('PaymentProcessor', 'create', $params);
 431   }
 432
 433 }