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