-
Notifications
You must be signed in to change notification settings - Fork 0
/
scanpay.php
372 lines (349 loc) · 15.7 KB
/
scanpay.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
<?php
if (!defined('_PS_VERSION_')) {
exit();
}
define('SCANPAY_VERSION', '1.1.3');
require_once(dirname(__FILE__) . '/classes/spdb.php');
class Scanpay extends PaymentModule
{
protected $_html = '';
protected $_postErrors = array();
const DFLT_TITLE = 'Credit/Debit Card';
public function __construct()
{
$this->name = 'scanpay';
$this->tab = 'payments_gateways';
$this->version = SCANPAY_VERSION;
$this->ps_versions_compliancy = array('min' => '1.6', 'max' => _PS_VERSION_);
$this->author = 'Scanpay ApS';
$this->need_instance = 0;
$this->is_eu_compatible = 1;
$this->bootstrap = true;
parent::__construct();
$this->displayName = $this->l('Scanpay');
$this->description = $this->l('Accept payments using the Scanpay payment gateway');
$this->confirmUninstall = $this->l('Are you sure?');
}
public function install()
{
if (!SPDB_Seq::mktable()) {
return false;
}
if (!SPDB_Carts::mktable()) {
return false;
}
if (Shop::isFeatureActive()) { Shop::setContext(Shop::CONTEXT_ALL); }
return parent::install() &&
$this->registerHook('paymentReturn') &&
$this->registerHook('payment') &&
$this->registerHook('postUpdateOrderStatus') &&
/* Unused hooks */
$this->registerHook('adminOrder') &&
$this->registerHook('PDFInvoice');
}
public function uninstall()
{
return parent::uninstall();
}
/* Unused hooks */
public function hookAdminOrder() { return; }
public function hookPDFInvoice() { return; }
public function log($msg, $severity = 0, $objectType = null, $objectId = null)
{
Logger::addLog($msg, $severity, 0, $objectType, $objectId);
error_log('Scanpay module error: ' . $msg);
}
/* Extract the shopid from an apikey */
public function extractshopid($apikey)
{
$shopid = explode(':', $apikey)[0];
if (!ctype_digit($shopid)) {
return false;
}
return (int)$shopid;
}
/* Create array of payment options to be shown in checkout */
public function hookPayment($params)
{
if (!$this->active) {
return;
}
$title = Configuration::get('SCANPAY_TITLE');
if (!$title) {
$title = self::DFLT_TITLE;
}
$this->context->smarty->assign([
'cards_title' => $title,
'cards_link' => $this->context->link->getModuleLink($this->name, 'newurl', [], true),
'mobilepay_enabled' => Configuration::get('SCANPAY_MOBILEPAY'),
'mobilepay_link' => $this->context->link->getModuleLink($this->name, 'newurl', ['paymentmethod' => 'mobilepay'], true),
]);
$this->context->controller->addCSS($this->getPathUri() . 'views/css/payment.css');
return $this->context->smarty->fetch($this->getLocalPath() . 'views/templates/hook/payment.tpl');
}
/* Handle the order confirmation page (post-payment) */
public function hookPaymentReturn($params)
{
if (!isset($params['objOrder']) || ($params['objOrder']->module !== $this->name)) {
return false;
}
$order = $params['objOrder'];
if (Validate::isLoadedObject($order) && isset($order->valid)) {
$this->context->smarty->assign([
'id_order' => $order->id,
'valid' => $order->valid,
]);
}
if (isset($order->reference) && !empty($order->reference)) {
$this->smarty->assign('reference', $order->reference);
}
$langId = $this->context->language->id;
$this->context->smarty->assign([
'shop_name' => $this->context->shop->name,
'reference' => $order->reference,
'contact_url' => $this->context->link->getPageLink('contact', true),
'order_url' => $this->context->link->getPageLink('order-detail', 1, $langId, array('id_order' => $order->id)),
'order_state' => $order->getCurrentOrderState()->name[$langId],
]);
return $this->context->smarty->fetch($this->getLocalPath() . 'views/templates/hook/payment_return.tpl');
}
/* Order status change hook */
public function hookPostUpdateOrderStatus($params)
{
$states = Configuration::get('SCANPAY_CAPTURE_ON_ORDER_STATUS');
if (!empty($states)) {
$order = new Order($params['id_order']);
$states = explode(',', $states);
$doCapture = false;
foreach ($states as $state) {
if ($params['newOrderStatus']->id === intval($state)) {
$doCapture = true;
break;
}
}
if (!$doCapture) {
return;
}
$spdata = SPDB_Carts::load($order->id_cart);
if (!$spdata) {
$this->context->controller->errors[] = Tools::displayError($this->l('Failed to load scanpay transaction data'));
return;
}
/* Already captured */
if ((float)$spdata['captured'] > 0) {
$this->context->controller->informations[] = $this->l('Order is already captured');
return;
}
$currency = new Currency((int)$order->id_currency);
$capturedata = [
'total' => "{$order->total_paid} {$currency->iso_code}",
'index' => $spdata['nacts'],
];
require_once(dirname(__FILE__) . '/classes/libscanpay.php');
$cl = new Scanpay\Scanpay(Configuration::get('SCANPAY_APIKEY'), [
'headers' => [
'X-Shop-Plugin' => 'prestashop/' . _PS_VERSION_ . '/' . SCANPAY_VERSION,
],
]);
try {
$cl->capture($spdata['trnid'], $capturedata);
$this->context->controller->confirmations[] = $this->l('Order was successfully captured');
} catch (\Exception $e) {
$this->context->controller->errors[] = Tools::displayError($this->l('Order capture failed: ') . $e->getMessage());
$this->log('capture failed: ' . $e->getMessage());
return;
}
}
}
/* Configuration handling (Settings) */
public function getContent()
{
$output = null;
$settings = [
'SCANPAY_TITLE' => Configuration::get('SCANPAY_TITLE'),
'SCANPAY_APIKEY' => Configuration::get('SCANPAY_APIKEY'),
'SCANPAY_LANGUAGE' => Configuration::get('SCANPAY_LANGUAGE'),
'SCANPAY_AUTOCAPTURE' => Configuration::get('SCANPAY_AUTOCAPTURE'),
'SCANPAY_CAPTURE_ON_ORDER_STATUS[]' => empty(Configuration::get('SCANPAY_CAPTURE_ON_ORDER_STATUS')) ?
[] : explode(',', Configuration::get('SCANPAY_CAPTURE_ON_ORDER_STATUS')),
'SCANPAY_MOBILEPAY' => Configuration::get('SCANPAY_MOBILEPAY'),
];
/* Update configuration if config is submitted */
if (Tools::isSubmit('submit' . $this->name))
{
$settings = [
'SCANPAY_TITLE' => strval(Tools::getValue('SCANPAY_TITLE')),
'SCANPAY_APIKEY' => strval(Tools::getValue('SCANPAY_APIKEY')),
'SCANPAY_LANGUAGE' => strval(Tools::getValue('SCANPAY_LANGUAGE')),
'SCANPAY_AUTOCAPTURE' => intval(Tools::getValue('SCANPAY_AUTOCAPTURE')),
'SCANPAY_CAPTURE_ON_ORDER_STATUS[]' => empty(Tools::getValue('SCANPAY_CAPTURE_ON_ORDER_STATUS')) ?
[] : Tools::getValue('SCANPAY_CAPTURE_ON_ORDER_STATUS'),
'SCANPAY_MOBILEPAY' => intval(Tools::getValue('SCANPAY_MOBILEPAY')),
];
foreach($settings as $key => $value) {
if (substr($key, -2) === '[]') {
$key = substr($key, 0, -2);
$value = implode(',', $value);
}
Configuration::updateValue($key, $value);
}
}
if (!$settings['SCANPAY_TITLE']) {
$settings['SCANPAY_TITLE'] = self::DFLT_TITLE;
}
/* Setup the configuration form */
$helper = new HelperForm();
$helper->table = $this->table;
$helper->module = $this;
$helper->default_form_language = $this->context->language->id;
$helper->allow_employee_form_lang = Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG', 0);
$helper->identifier = $this->identifier;
$helper->submit_action = 'submit'.$this->name;
$helper->currentIndex = $this->context->link->getAdminLink('AdminModules', false) . '&configure=' . $this->name . '&tab_module=' . $this->tab . '&module_name=' . $this->name;
$helper->token = Tools::getAdminTokenLite('AdminModules');
/* Create Ping URL graphic */
$shopid = $this->extractshopid($settings['SCANPAY_APIKEY']);
if ($shopid) {
$lastpingtime = SPDB_Seq::load($shopid)['mtime'];
} else {
$lastpingtime = 0;
}
$pingurl = $this->context->link->getModuleLink($this->name, 'ping', [], true);
ob_start();
include($this->local_path . 'views/pingurl/pingurl.php');
$pingUrlContent = ob_get_contents();
ob_end_clean();
$this->context->controller->addCSS($this->local_path . 'views/pingurl/pingurl.css');
$this->context->controller->addJS($this->local_path . 'views/pingurl/pingurl.js');
/* Create the capture on order status UI */
ob_start();
include($this->local_path . 'views/captureonorderstatus/captureonorderstatus.php');
$captureOnOrderStatusContent = ob_get_contents();
ob_end_clean();
$this->context->controller->addCSS($this->local_path . 'views/captureonorderstatus/captureonorderstatus.css');
$this->context->controller->addJS($this->local_path . 'views/captureonorderstatus/captureonorderstatus.js');
foreach (OrderState::getOrderStates($this->context->language->id) as $status) {
$captureOnOrderStatusList[] = ['status' => $status['id_order_state'], 'name' => $status['name']];
}
/* Define the configuration form inputs */
$formdata[0]['form'] = [
'legend' => [
'title' => $this->l('Settings'),
],
'input' => [
[
'type' => 'text',
'label' => $this->l('Title'),
'name' => 'SCANPAY_TITLE',
'desc' => $this->l('This controls the title which the user sees during checkout'),
'required' => true,
],
[
'type' => 'text',
'label' => $this->l('API-key'),
'name' => 'SCANPAY_APIKEY',
'desc' => $this->l('Copy your API key from the <a href="https://dashboard.scanpay.dk/settings/api">dashboard API settings</a>'),
'required' => true,
],
[
'type' => 'html',
'label' => $this->l('Ping URL'),
'name' => 'pingurl',
'desc' => $this->l('This is the URL Scanpay can use to notify Magento of changes in transaction status.'),
'id' => 'scanpay--pingurl--input',
'readonly' => true,
'html_content' => $pingUrlContent,
],
[
'type' => 'select',
'label' => $this->l('Language'),
'name' => 'SCANPAY_LANGUAGE',
'desc' => $this->l('Set the payment window language. \'Automatic\' allows Scanpay to choose a language based on the browser of the customer.'),
'options' => [
'id' => 'language',
'name' => 'name',
'query' => [
[
'language' => '',
'name' => $this->l('Automatic'),
],
[
'language' => 'da',
'name' => $this->l('Danish'),
],
[
'language' => 'en',
'name' => $this->l('English'),
],
],
],
],
[
'type' => 'switch',
'label' => $this->l('Auto-capture'),
'name' => 'SCANPAY_AUTOCAPTURE',
'desc' => $this->l('Automatically capture transactions upon authorization. Only enable this if you sell services or immaterial goods.'),
'is_bool' => true,
'values' => [
[
'id' => 'on',
'value' => 1,
'name' => $this->l('Enabled'),
],
[
'id' => 'off',
'value' => 0,
'name' => $this->l('Disabled'),
],
],
],
[
'type' => 'select',
'label' => '',
'name' => 'SCANPAY_CAPTURE_ON_ORDER_STATUS[]',
'multiple' => true,
'options' => [
'query' => $captureOnOrderStatusList,
'id' => 'status',
'name' => 'name'
],
'class' => 'scanpay--hide'
],
[
'type' => 'html',
'label' => $this->l('Capture on order status'),
'name' => 'SCANPAY_CAPTURE_ON_ORDER_STATUS_DUMMY',
'desc' => $this->l('Automatically capture orders when order status changes to one of the statuses selected above.'),
'html_content' => $captureOnOrderStatusContent,
],
[
'type' => 'switch',
'label' => $this->l('MobilePay'),
'name' => 'SCANPAY_MOBILEPAY',
'desc' => $this->l('Enable MobilePay in checkout. You must also enable MobilePay in the Scanpay dashboard.'),
'is_bool' => true,
'values' => [
[
'id' => 'on',
'value' => 1,
'name' => $this->l('Enabled'),
],
[
'id' => 'off',
'value' => 0,
'name' => $this->l('Disabled'),
],
],
],
],
'submit' => [
'title' => $this->l('Save'),
'class' => 'btn btn-default pull-right'
],
];
foreach($settings as $key => $value) {
$helper->fields_value[$key] = $value;
}
return $helper->generateForm($formdata);
}
}