-
Notifications
You must be signed in to change notification settings - Fork 26
/
lib.php
485 lines (479 loc) · 21.1 KB
/
lib.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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Stripe enrolment plugin.
*
* This plugin allows you to set up paid courses.
*
* @package enrol_stripepayment
* @author DualCube <admin@dualcube.com>
* @copyright 2019 DualCube Team(https://dualcube.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->dirroot.'/lib/adminlib.php');
/**
* Stripe enrolment plugin implementation.
*
* @package enrol_stripepayment
* @author DualCube <admin@dualcube.com>
* @copyright 2019 DualCube Team(https://dualcube.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class enrol_stripepayment_plugin extends enrol_plugin {
/**
* Lists all currencies available for plugin.
* @return $currencies
*/
public function get_currencies() {
// See https://www.stripe.com/cgi-bin/webscr?cmd=p/sell/mc/mc_intro-outside,
// 3-character ISO-4217: https://cms.stripe.com/us/cgi-bin/?cmd=
// _render-content&content_ID=developer/e_howto_api_currency_codes.
$codes = [
'USD', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BIF', 'BMD',
'BND', 'BOB', 'BRL', 'BSD', 'BWP', 'BZD', 'CAD', 'CDF', 'CHF', 'CLP', 'CNY', 'COP', 'CRC', 'CVE', 'CZK', 'DJF', 'DKK',
'DOP', 'DZD', 'EGP', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK',
'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'ISK', 'JMD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF', 'KRW', 'KYD', 'KZT', 'LAK', 'LBP',
'LKR', 'LRD', 'LSL', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MUR', 'MVR', 'MWK', 'MXN', 'MYR', 'MZN',
'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB',
'RWF', 'SAR', 'SBD', 'SCR', 'SEK', 'SGD', 'SHP', 'SLL', 'SOS', 'SRD', 'STD', 'SZL', 'THB', 'TJS', 'TOP', 'TRY', 'TTD',
'TWD', 'TZS', 'UAH', 'UGX', 'UYU', 'UZS', 'VND', 'VUV', 'WST', 'XAF', 'XCD', 'XOF', 'XPF', 'YER', 'ZAR'];
$currencies = array();
foreach ($codes as $c) {
$currencies[$c] = new lang_string($c, 'core_currencies');
}
return $currencies;
}
/**
* Get stripe amount
* @return $Stripe ammount
*/
public function get_stripe_amount($cost, $currency, $reverse) {
$nodecimalcurrencies = array("bif", "clp", "djf", "gnf", "jpy", "kmf", "krw", "mga", "pyg",
"rwf", "ugx", "vnd", "vuv", "xaf", "xof", "xpf");
if (!$currency) {
$currency = 'USD';
}
if (in_array(strtolower($currency), $nodecimalcurrencies)) {
return abs($cost);
} else {
if ($reverse) {
return abs( (float) $cost / 100);
} else {
return abs( (float) $cost * 100);
}
}
}
/**
* Return Currency as per country code
*
* @param integer $currency the country code
* @return Country currency sign
*/
function show_currency_symbol( $currency ) {
$currencies = [
'aed' => 'AED', 'afn' => '؋', 'all' => 'Lek',
'amd' => 'AMD', 'ang' => 'ƒ', 'aoa' => 'AOA', 'ars' => '$',
'aud' => '$', 'awg' => 'ƒ', 'azn' => 'ман',
'bam' => 'KM', 'bbd' => '$', 'bdt' => 'BDT', 'bgn' => 'лв',
'bhd' => 'BHD', 'bif' => 'BIF', 'bmd' => '$', 'bnd' => '$',
'bob' => '$b', 'brl' => 'R$', 'bsd' => '$', 'btn' => 'BTN',
'bwp' => 'P', 'byr' => 'p.', 'bzd' => 'BZ$',
'cad' => '$', 'cdf' => 'CDF', 'chf' => 'CHF','clp' => '$',
'cny' => '¥', 'cop' => '$', 'crc' => '₡', 'cuc' => 'CUC', 'cup' => '₱',
'cve' => 'CVE', 'czk' => 'Kč', 'djf' => 'DJF', 'dkk' => 'kr',
'dop' => 'RD$', 'dzd' => 'DZD', 'egp' => '£','ern' => 'ERN','etb' => 'ETB',
'eur' => '€', 'fjd' => '$', 'fkp' => '£', 'gbp' => '£', 'gel' => 'GEL',
'ggp' => '£', 'ghs' => '¢', 'gip' => '£', 'gmd' => 'GMD', 'gnf' => 'GNF',
'gtq' => 'Q', 'gyd' => '$', 'hkd' => '$', 'hnl' => 'L', 'hrk' => 'kn',
'htg' => 'HTG', 'huf' => 'Ft', 'idr' => 'Rp', 'ils' => '₪',
'imp' => '£', 'inr' => '₹', 'iqd' => 'IQD', 'irr' => '﷼', 'isk' => 'kr',
'jep' => '£', 'jmd' => 'J$', 'jod' => 'JOD', 'jpy' => '¥',
'kes' => 'KES', 'kgs' => 'лв', 'khr' => '៛', 'kmf' => 'KMF', 'kpw' => '₩',
'krw' => '₩', 'kwd' => 'KWD', 'kyd' => '$', 'kzt' => 'лв',
'lak' => '₭', 'lbp' => '£', 'lkr' => '₨', 'lrd' => '$', 'lsl' => 'LSL',
'lyd' => 'LYD', 'mad' => 'MAD', 'mdl' => 'MDL', 'mga' => 'MGA', 'mkd' => 'ден',
'mmk' => 'MMK', 'mnt' => '₮', 'mop' => 'MOP', 'mro' => 'MRO', 'mur' => '₨',
'mvr' => 'MVR', 'mwk'=>'MWK', 'mxn' => '$', 'myr' => 'RM', 'mzn' => 'MT',
'nad' => '$', 'ngn' => '₦', 'nio' => 'C$', 'nok' => 'kr', 'npr' => '₨',
'nzd' => '$', 'omr' => '﷼', 'pab' => 'B/.', 'pen' => 'S/.',
'pgk' => 'PGK', 'php' => '₱', 'pkr' => '₨','pln' => 'zł', 'prb' => 'PRB',
'pyg' => 'Gs', 'qar' => '﷼', 'ron' => 'lei', 'rsd' => 'Дин.',
'rub' => 'руб', 'rwf' => 'RWF', 'sar' => '﷼', 'sbd' => '$', 'scr' => '₨',
'sdg' => 'SDG', 'sek' => 'kr', 'sgd' => '$', 'shp' => '£', 'sll' => 'SLL', 'sos' => 'S',
'srd' => '$', 'ssp' => 'SSP', 'std' => 'STD', 'syp' => '£', 'szl' => 'SZL', 'thb' => '฿', 'tjs' => 'TJS',
'tmt' => 'TMT', 'tnd' => 'TND', 'top' => 'TOP', 'try' => '₺', 'ttd' => 'TT$', 'twd' => 'NT$',
'tzs' => 'TZS', 'uah' => '₴', 'ugx' => 'UGX', 'usd' => '$', 'uyu' => '$U', 'uzs' => 'лв',
'vef' => 'Bs', 'vnd' => '₫', 'vuv' => 'VUV', 'wst' => 'WST', 'xaf' => 'XAF', 'xcd' => '$', 'xof' => 'XOF',
'xpf' => 'XPF', 'yer' => '﷼', 'zar' => 'R', 'zmw' => 'ZMW'
];
if ( array_key_exists( $currency, $currencies) ) {
$symbol = $currencies[$currency];
} else {
$symbol = $currency;
}
return $symbol;
}
/**
* Returns optional enrolment information icons.
*
* This is used in course list for quick overview of enrolment options.
*
* We are not using single instance parameter because sometimes
* we might want to prevent icon repetition when multiple instances
* of one type exist. One instance may also produce several icons.
*
* @param array $instances all enrol instances of this type in one course
* @return array of pix_icon
*/
public function get_info_icons(array $instances) {
$found = false;
foreach ($instances as $instance) {
if ($instance->enrolstartdate != 0 && $instance->enrolstartdate > time()) {
continue;
}
if ($instance->enrolenddate != 0 && $instance->enrolenddate < time()) {
continue;
}
$found = true;
break;
}
if ($found) {
return [new pix_icon('icon', get_string('pluginname', 'enrol_stripepayment'), 'enrol_stripepayment')];
}
return [];
}
/**
* Lists all protected user roles.
* @return bool(true or false)
*/
public function roles_protected() {
// Users with role assign cap may tweak the roles later.
return false;
}
/**
* Defines if user can be unenrolled.
* @param stdClass $instance of the plugin
* @return bool(true or false)
*/
public function allow_unenrol(stdClass $instance) {
// Users with unenrol cap may unenrol other users manually - requires enrol/stripe:unenrol.
return true;
}
/**
* Defines if user can be managed from admin.
* @param stdClass $instance of the plugin
* @return bool(true or false)
*/
public function allow_manage(stdClass $instance) {
// Users with manage cap may tweak period and status - requires enrol/stripe:manage.
return true;
}
/**
* Defines if 'enrol me' link will be shown on course page.
* @param stdClass $instance of the plugin
* @return bool(true or false)
*/
public function show_enrolme_link(stdClass $instance) {
return ($instance->status == ENROL_INSTANCE_ENABLED);
}
/**
* Sets up navigation entries.
*
* @param navigation_node $instancesnode
* @param stdClass $instance
* @return void
*/
public function add_course_navigation($instancesnode, stdClass $instance) {
if ($instance->enrol !== 'stripepayment') {
throw new coding_exception('Invalid enrol instance type!');
}
$context = context_course::instance($instance->courseid);
if (has_capability('enrol/stripepayment:config', $context)) {
$managelink = new moodle_url('/enrol/stripepayment/edit.php',
array('courseid' => $instance->courseid, 'id' => $instance->id));
$instancesnode->add($this->get_instance_name($instance), $managelink, navigation_node::TYPE_SETTING);
}
}
/**
* Returns edit icons for the page with list of instances
* @param stdClass $instance
* @return array
*/
public function get_action_icons(stdClass $instance) {
global $OUTPUT;
if ($instance->enrol !== 'stripepayment') {
throw new coding_exception('invalid enrol instance!');
}
$context = context_course::instance($instance->courseid);
$icons = array();
if (has_capability('enrol/stripepayment:config', $context)) {
$editlink = new moodle_url("/enrol/stripepayment/edit.php",
array('courseid' => $instance->courseid, 'id' => $instance->id));
$icons[] = $OUTPUT->action_icon($editlink, new pix_icon('t/edit', get_string('edit'), 'core',
array('class' => 'iconsmall')));
}
return $icons;
}
/**
* Returns link to page which may be used to add new instance of enrolment plugin in course.
* @param int $courseid
* @return moodle_url page url
*/
public function get_newinstance_link($courseid) {
$context = context_course::instance($courseid, MUST_EXIST);
if (!has_capability('moodle/course:enrolconfig', $context) or !has_capability('enrol/stripepayment:config', $context)) {
return null;
}
// Multiple instances supported - different cost for different roles.
return new moodle_url('/enrol/stripepayment/edit.php', array('courseid' => $courseid));
}
/**
* Creates course enrol form, checks if form submitted
* and enrols user if necessary. It can also redirect.
*
* @param stdClass $instance
* @return string html text, usually a form in a text box
*/
public function enrol_page_hook(stdClass $instance) {
global $CFG, $USER, $OUTPUT, $DB;
$enrolstatus = $this->can_stripepayment_enrol($instance);
if (!$enrolstatus) {
return get_string('maxenrolledreached', 'enrol_stripepayment');
}
ob_start();
if ($DB->record_exists('user_enrolments', array('userid' => $USER->id, 'enrolid' => $instance->id))) {
return ob_get_clean();
}
if ($instance->enrolstartdate != 0 && $instance->enrolstartdate > time()) {
return ob_get_clean();
}
if ($instance->enrolenddate != 0 && $instance->enrolenddate < time()) {
return ob_get_clean();
}
$course = $DB->get_record('course', array('id' => $instance->courseid));
$context = context_course::instance($course->id);
// Pass $view=true to filter hidden caps if the user cannot see them.
if ($users = get_users_by_capability($context, 'moodle/course:update', 'u.*', 'u.id ASC',
'', '', '', '', false, true)) {
$users = sort_by_roleassignment_authority($users, $context);
}
if ( (float) $instance->cost <= 0 ) {
$cost = (float) $this->get_config('cost');
} else {
$cost = (float) $instance->cost;
}
if (abs($cost) < 0.01) { // No cost, other enrolment methods (instances) should be used.
echo '<p>'.get_string('nocost', 'enrol_stripepayment').'</p>';
} else {
// Calculate localised and "." cost, make sure we send Stripe the same value,
// please note Stripe expects amount with 2 decimal places and "." separator.
$localisedcost = format_float($cost, 2, true);
$cost = format_float($cost, 2, false);
if (isguestuser()) { // Force login only for guest user, not real users with guest role.
if (empty($CFG->loginhttps)) {
$wwwroot = $CFG->wwwroot;
} else {
// This actually is not so secure ;-), 'cause we're
// in unencrypted connection...
$wwwroot = str_replace("http://", "https://", $CFG->wwwroot);
}
echo '<div class="mdl-align"><p>'.get_string('paymentrequired').'</p>';
echo '<p><b>'.get_string('cost').": $instance->currency $localisedcost".'</b></p>';
echo '<p><a href="'.$wwwroot.'/login/">'.get_string('loginsite').'</a></p>';
echo '</div>';
} else {
include($CFG->dirroot.'/enrol/stripepayment/enrol.php');
}
}
return $OUTPUT->box(ob_get_clean());
}
/**
* Creates can stripepayament enrol.
*
* @param stdClass $instance
* @return string html text, usually a form in a text box
*/
public function can_stripepayment_enrol(stdClass $instance) {
global $DB;
if ($instance->customint3 > 0) {
// Max enrol limit specified.
$count = $DB->count_records('user_enrolments', array('enrolid' => $instance->id));
if ($count >= $instance->customint3) {
// Bad luck, no more stripepayment enrolments here.
return false;
}
}
return true;
}
/**
* Returns localised name of enrol instance
*
* @param stdClass $instance (null is accepted too)
* @return string
*/
public function get_instance_name($instance) {
global $DB;
if (empty($instance->name)) {
if (!empty($instance->roleid) and $role = $DB->get_record('role', array('id' => $instance->roleid))) {
$role = ' (' . role_get_name($role, context_course::instance($instance->courseid, IGNORE_MISSING)) . ')';
} else {
$role = '';
}
$enrol = $this->get_name();
return get_string('pluginname', 'enrol_'.$enrol) . $role;
} else {
return format_string($instance->name);
}
}
/**
* Restore instance and map settings.
*
* @param restore_enrolments_structure_step $step
* @param stdClass $data
* @param stdClass $course
* @param int $oldid
*/
public function restore_instance(restore_enrolments_structure_step $step, stdClass $data, $course, $oldid) {
global $DB;
if ($step->get_task()->get_target() == backup::TARGET_NEW_COURSE) {
$merge = false;
} else {
$merge = array(
'courseid' => $data->courseid,
'enrol' => $this->get_name(),
'roleid' => $data->roleid,
'cost' => $data->cost,
'currency' => $data->currency,
);
}
if ($merge and $instances = $DB->get_records('enrol', $merge, 'id')) {
$instance = reset($instances);
$instanceid = $instance->id;
} else {
$instanceid = $this->add_instance($course, (array)$data);
}
$step->set_mapping('enrol', $oldid, $instanceid);
}
/**
* Restore user enrolment.
*
* @param restore_enrolments_structure_step $step
* @param stdClass $data
* @param stdClass $instance
* @param int $userid
* @param int $oldinstancestatus
*/
public function restore_user_enrolment(restore_enrolments_structure_step $step, $data, $instance, $userid, $oldinstancestatus) {
$this->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, $data->status);
}
/**
* Gets an array of the user enrolment actions
*
* @param course_enrolment_manager $manager
* @param stdClass $ue A user enrolment object
* @return array An array of user_enrolment_actions
*/
public function get_user_enrolment_actions(course_enrolment_manager $manager, $ue) {
$actions = [];
$context = $manager->get_context();
$instance = $ue->enrolmentinstance;
$params = $manager->get_moodlepage()->url->params();
$params['ue'] = $ue->id;
if ($this->allow_unenrol($instance) && has_capability("enrol/stripepayment:unenrol", $context)) {
$url = new moodle_url('/enrol/unenroluser.php', $params);
$actions[] = new user_enrolment_action(new pix_icon('t/delete', ''),
get_string('unenrol', 'enrol'), $url, array('class' => 'unenrollink', 'rel' => $ue->id));
}
if ($this->allow_manage($instance) && has_capability("enrol/stripepayment:manage", $context)) {
$url = new moodle_url('/enrol/editenrolment.php', $params);
$actions[] = new user_enrolment_action(new pix_icon('t/edit', ''),
get_string('edit'), $url, array('class' => 'editenrollink', 'rel' => $ue->id));
}
return $actions;
}
/**
* Set up cron for the plugin (if any).
*
*/
public function cron() {
$trace = new text_progress_trace();
$this->process_expirations($trace);
}
/**
* Execute synchronisation.
* @param progress_trace $trace
* @return int exit code, 0 means ok
*/
public function sync(progress_trace $trace) {
$this->process_expirations($trace);
return 0;
}
/**
* Is it possible to delete enrol instance via standard UI?
*
* @param stdClass $instance
* @return bool
*/
public function can_delete_instance($instance) {
$context = context_course::instance($instance->courseid);
return has_capability('enrol/stripepayment:config', $context);
}
/**
* Is it possible to hide/show enrol instance via standard UI?
*
* @param stdClass $instance
* @return bool
*/
public function can_hide_show_instance($instance) {
$context = context_course::instance($instance->courseid);
return has_capability('enrol/stripepayment:config', $context);
}
}
/**
* class for helping built the admin setting form
*/
class admin_enrol_stripepayment_configtext extends admin_setting_configtext {
public function write_setting($data) {
if ($this->name == 'webservice_token' && $data == '') {
return get_string('token_empty_error', 'enrol_stripepayment');
}
if ($this->paramtype === PARAM_INT and $data === '') {
// do not complain if '' used instead of 0
$data = 0;
}
// $data is a string
$validated = $this->validate($data);
if ($validated !== true) {
return $validated;
}
return ($this->config_write($this->name, $data) ? '' : get_string('errorsetting', 'admin'));
}
/**
* Validate data before storage.
*
* @param string $data The string to be validated.
* @return bool|string true for success or error string if invalid.
*/
public function validate($data) {
$cleaned = clean_param($data, PARAM_TEXT);
if ($cleaned === '') {
return get_string('required');
}
return parent::validate($data);
}
}