| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.7 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 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 | * This class stores logic for managing CiviCRM extensions. |
| 30 | * |
| 31 | * @package CRM |
| 32 | * @copyright CiviCRM LLC (c) 2004-2015 |
| 33 | * $Id$ |
| 34 | * |
| 35 | */ |
| 36 | class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base { |
| 37 | |
| 38 | /** |
| 39 | * @var CRM_Extension_Mapper |
| 40 | */ |
| 41 | protected $mapper; |
| 42 | |
| 43 | /** |
| 44 | * @param CRM_Extension_Mapper $mapper |
| 45 | */ |
| 46 | public function __construct(CRM_Extension_Mapper $mapper) { |
| 47 | parent::__construct(TRUE); |
| 48 | $this->mapper = $mapper; |
| 49 | } |
| 50 | |
| 51 | /** |
| 52 | * @inheritDoc |
| 53 | */ |
| 54 | public function onPreInstall(CRM_Extension_Info $info) { |
| 55 | $paymentProcessorTypes = $this->_getAllPaymentProcessorTypes('class_name'); |
| 56 | |
| 57 | if (array_key_exists($info->key, $paymentProcessorTypes)) { |
| 58 | CRM_Core_Error::fatal('This payment processor type is already installed.'); |
| 59 | } |
| 60 | |
| 61 | $ppByName = $this->_getAllPaymentProcessorTypes('name'); |
| 62 | if (array_key_exists($info->name, $ppByName)) { |
| 63 | CRM_Core_Error::fatal('This payment processor type already exists.'); |
| 64 | } |
| 65 | |
| 66 | $dao = new CRM_Financial_DAO_PaymentProcessorType(); |
| 67 | |
| 68 | $dao->is_active = 1; |
| 69 | $dao->class_name = trim($info->key); |
| 70 | $dao->title = trim($info->name) . ' (' . trim($info->key) . ')'; |
| 71 | $dao->name = trim($info->name); |
| 72 | $dao->description = trim($info->description); |
| 73 | |
| 74 | $dao->user_name_label = trim($info->typeInfo['userNameLabel']); |
| 75 | $dao->password_label = trim($info->typeInfo['passwordLabel']); |
| 76 | $dao->signature_label = trim($info->typeInfo['signatureLabel']); |
| 77 | $dao->subject_label = trim($info->typeInfo['subjectLabel']); |
| 78 | $dao->url_site_default = trim($info->typeInfo['urlSiteDefault']); |
| 79 | $dao->url_api_default = trim($info->typeInfo['urlApiDefault']); |
| 80 | $dao->url_recur_default = trim($info->typeInfo['urlRecurDefault']); |
| 81 | $dao->url_site_test_default = trim($info->typeInfo['urlSiteTestDefault']); |
| 82 | $dao->url_api_test_default = trim($info->typeInfo['urlApiTestDefault']); |
| 83 | $dao->url_recur_test_default = trim($info->typeInfo['urlRecurTestDefault']); |
| 84 | $dao->url_button_default = trim($info->typeInfo['urlButtonDefault']); |
| 85 | $dao->url_button_test_default = trim($info->typeInfo['urlButtonTestDefault']); |
| 86 | |
| 87 | switch (trim($info->typeInfo['billingMode'])) { |
| 88 | case 'form': |
| 89 | $dao->billing_mode = CRM_Core_Payment::BILLING_MODE_FORM; |
| 90 | break; |
| 91 | |
| 92 | case 'button': |
| 93 | $dao->billing_mode = CRM_Core_Payment::BILLING_MODE_BUTTON; |
| 94 | break; |
| 95 | |
| 96 | case 'notify': |
| 97 | $dao->billing_mode = CRM_Core_Payment::BILLING_MODE_NOTIFY; |
| 98 | break; |
| 99 | |
| 100 | default: |
| 101 | CRM_Core_Error::fatal('Billing mode in info file has wrong value.'); |
| 102 | } |
| 103 | |
| 104 | $dao->is_recur = trim($info->typeInfo['isRecur']); |
| 105 | $dao->payment_type = trim($info->typeInfo['paymentType']); |
| 106 | |
| 107 | $dao->save(); |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | * @inheritDoc |
| 112 | */ |
| 113 | public function onPostInstall(CRM_Extension_Info $info) { |
| 114 | $this->_runPaymentHook($info, 'install'); |
| 115 | } |
| 116 | |
| 117 | /** |
| 118 | * @inheritDoc |
| 119 | */ |
| 120 | public function onPreUninstall(CRM_Extension_Info $info) { |
| 121 | $paymentProcessorTypes = $this->_getAllPaymentProcessorTypes('class_name'); |
| 122 | if (!array_key_exists($info->key, $paymentProcessorTypes)) { |
| 123 | CRM_Core_Error::fatal('This payment processor type is not registered.'); |
| 124 | } |
| 125 | |
| 126 | $dao = new CRM_Financial_DAO_PaymentProcessor(); |
| 127 | $dao->payment_processor_type_id = $paymentProcessorTypes[$info->key]; |
| 128 | $dao->find(); |
| 129 | while ($dao->fetch()) { |
| 130 | throw new CRM_Extension_Exception_DependencyException('payment'); |
| 131 | } |
| 132 | |
| 133 | $this->_runPaymentHook($info, 'uninstall'); |
| 134 | return CRM_Financial_BAO_PaymentProcessorType::del($paymentProcessorTypes[$info->key]); |
| 135 | } |
| 136 | |
| 137 | /** |
| 138 | * @inheritDoc |
| 139 | */ |
| 140 | public function onPreDisable(CRM_Extension_Info $info) { |
| 141 | // HMM? // if ($this->type == 'payment' && $this->status != 'missing') { |
| 142 | $this->_runPaymentHook($info, 'disable'); |
| 143 | |
| 144 | $paymentProcessorTypes = $this->_getAllPaymentProcessorTypes('class_name'); |
| 145 | CRM_Financial_BAO_PaymentProcessorType::setIsActive($paymentProcessorTypes[$info->key], 0); |
| 146 | } |
| 147 | |
| 148 | /** |
| 149 | * @inheritDoc |
| 150 | */ |
| 151 | public function onPreEnable(CRM_Extension_Info $info) { |
| 152 | $paymentProcessorTypes = $this->_getAllPaymentProcessorTypes('class_name'); |
| 153 | CRM_Financial_BAO_PaymentProcessorType::setIsActive($paymentProcessorTypes[$info->key], 1); |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * @inheritDoc |
| 158 | */ |
| 159 | public function onPostEnable(CRM_Extension_Info $info) { |
| 160 | // HMM? // if ($this->type == 'payment' && $this->status != 'missing') { |
| 161 | $this->_runPaymentHook($info, 'enable'); |
| 162 | } |
| 163 | |
| 164 | /** |
| 165 | * @param string $attr |
| 166 | * The attribute used to key the array. |
| 167 | * @return array |
| 168 | * ($$attr => $id) |
| 169 | */ |
| 170 | private function _getAllPaymentProcessorTypes($attr) { |
| 171 | $ppt = array(); |
| 172 | $dao = new CRM_Financial_DAO_PaymentProcessorType(); |
| 173 | $dao->find(); |
| 174 | while ($dao->fetch()) { |
| 175 | $ppt[$dao->$attr] = $dao->id; |
| 176 | } |
| 177 | return $ppt; |
| 178 | } |
| 179 | |
| 180 | /** |
| 181 | * Run hooks in the payment processor class. |
| 182 | * Load requested payment processor and call the method specified. |
| 183 | * |
| 184 | * @param CRM_Extension_Info $info |
| 185 | * @param string $method |
| 186 | * The method to call in the payment processor class. |
| 187 | */ |
| 188 | private function _runPaymentHook(CRM_Extension_Info $info, $method) { |
| 189 | // Not concerned about performance at this stage, as these are seldom performed tasks |
| 190 | // (payment processor enable/disable/install/uninstall). May wish to implement some |
| 191 | // kind of registry/caching system if more hooks are added. |
| 192 | |
| 193 | try { |
| 194 | $paymentClass = $this->mapper->keyToClass($info->key, 'payment'); |
| 195 | $file = $this->mapper->classToPath($paymentClass); |
| 196 | if (!file_exists($file)) { |
| 197 | CRM_Core_Session::setStatus(ts('Failed to load file (%3) for payment processor (%1) while running "%2"', array( |
| 198 | 1 => $info->key, |
| 199 | 2 => $method, |
| 200 | 3 => $file, |
| 201 | )), '', 'error'); |
| 202 | return; |
| 203 | } |
| 204 | else { |
| 205 | require_once $file; |
| 206 | } |
| 207 | } |
| 208 | catch (CRM_Extension_Exception $e) { |
| 209 | CRM_Core_Session::setStatus(ts('Failed to determine file path for payment processor (%1) while running "%2"', array( |
| 210 | 1 => $info->key, |
| 211 | 2 => $method, |
| 212 | )), '', 'error'); |
| 213 | return; |
| 214 | } |
| 215 | |
| 216 | $processorDAO = CRM_Core_DAO::executeQuery( |
| 217 | " SELECT pp.id, ppt.class_name |
| 218 | FROM civicrm_extension ext |
| 219 | INNER JOIN civicrm_payment_processor_type ppt |
| 220 | ON ext.name = ppt.name |
| 221 | LEFT JOIN civicrm_payment_processor pp |
| 222 | ON ppt.id = pp.payment_processor_type_id |
| 223 | WHERE ext.type = 'payment' |
| 224 | AND ext.full_name = %1 |
| 225 | ", |
| 226 | array( |
| 227 | 1 => array($info->key, 'String'), |
| 228 | ) |
| 229 | ); |
| 230 | |
| 231 | while ($processorDAO->fetch()) { |
| 232 | $class_name = $processorDAO->class_name; |
| 233 | $processor_id = $processorDAO->id; |
| 234 | } |
| 235 | |
| 236 | if (empty($class_name)) { |
| 237 | CRM_Core_Error::fatal("Unable to find payment processor in " . __CLASS__ . '::' . __METHOD__); |
| 238 | } |
| 239 | |
| 240 | // In the case of uninstall, check for instances of PP first. |
| 241 | // Don't run hook if any are found. |
| 242 | if ($method == 'uninstall' && $processor_id > 0) { |
| 243 | return; |
| 244 | } |
| 245 | |
| 246 | switch ($method) { |
| 247 | case 'install': |
| 248 | case 'uninstall': |
| 249 | case 'enable': |
| 250 | case 'disable': |
| 251 | // Instantiate PP - the getClass function allows us to do this when no payment processor instances exist. |
| 252 | $processorInstance = Civi\Payment\System::singleton()->getByClass($class_name); |
| 253 | |
| 254 | // Does PP implement this method, and can we call it? |
| 255 | if (method_exists($processorInstance, $method) && is_callable(array( |
| 256 | $processorInstance, |
| 257 | $method, |
| 258 | )) |
| 259 | ) { |
| 260 | // If so, call it ... |
| 261 | $processorInstance->$method(); |
| 262 | } |
| 263 | break; |
| 264 | |
| 265 | default: |
| 266 | CRM_Core_Session::setStatus(ts("Unrecognized payment hook (%1) in %2::%3", |
| 267 | array(1 => $method, 2 => __CLASS__, 3 => __METHOD__)), |
| 268 | '', 'error'); |
| 269 | } |
| 270 | } |
| 271 | |
| 272 | } |