-
Notifications
You must be signed in to change notification settings - Fork 0
/
lib.php
273 lines (232 loc) · 8.35 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
<?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/>.
/**
* External plugin API.
*
* @package tool_managertokens
* @copyright 2017 "Valentin Popov" <info@valentineus.link>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined("MOODLE_INTERNAL") || die();
require_once(__DIR__ . "/locallib.php");
/**
* It checks the ability to activate the token and produces it.
*
* @param string $token
* @return object
*/
function tool_managertokens_activate_token($token = "") {
global $DB;
$selectlimited = "limited = 0 OR scope < limited";
$selecttimelimited = "timelimited = 0 OR (timecreated + timelimited) > " . time();
$select = "enabled = 1 AND token = '$token' AND ($selectlimited) AND ($selecttimelimited)";
if ($token = $DB->get_record_select("tool_managertokens_tokens", $select, null, "*", IGNORE_MISSING)) {
$token->scope = intval($token->scope) + 1;
$token->timelastuse = time();
$DB->update_record("tool_managertokens_tokens", $token, false);
}
return $token;
}
/**
* Toggles the status of an existing token.
*
* @param number|string $key
* @return boolean
*/
function tool_managertokens_change_status($key = "") {
global $DB;
$result = false;
$select = "id = '$key' OR token = '$key'";
if ($DB->record_exists_select("tool_managertokens_tokens", $select, null)) {
$enabled = $DB->get_field_select("tool_managertokens_tokens", "enabled", $select, null, IGNORE_MISSING);
$result = $DB->set_field_select("tool_managertokens_tokens", "enabled", !boolval($enabled), $select, null);
}
return boolval($result);
}
/**
* Creates a backup copy of the tokens.
*
* @return string
*/
function tool_managertokens_create_backup() {
$list = tool_managertokens_get_list(0, 0);
$archive = base64_encode(gzcompress(serialize($list), 9));
return $archive;
}
/**
* Creates an entry in the database.
*
* @param object $options
* @return number
*/
function tool_managertokens_create_record($options) {
global $DB;
$token = new stdClass();
$token->enabled = !empty($options->enabled) ? boolval($options->enabled) : false;
$token->limited = !empty($options->limited) ? intval($options->limited) : 0;
$token->targetid = !empty($options->targetid) ? intval($options->targetid) : 0;
$token->targettype = !empty($options->targettype) ? strval($options->targettype) : "null";
$token->timelimited = !empty($options->timelimited) ? intval($options->timelimited) : 0;
$token->token = !empty($options->token) ? strval($options->token) : generate_password(12);
$token->timecreated = time();
$token->timemodified = time();
if (!empty($options->extendedaction) && !empty($options->extendedoptions)) {
$token->extendedaction = strval($options->extendedaction);
$token->extendedoptions = strval($options->extendedoptions);
}
if ($DB->record_exists("tool_managertokens_tokens", array("token" => $token->token))) {
print_error("duplicatefieldname", "error", null, "token");
}
$recordid = $DB->insert_record("tool_managertokens_tokens", $token, true, false);
return $recordid;
}
/**
* Specifies the user for authorization.
*
* @param object $token
*/
function tool_managertokens_definition_user($token) {
$user = false;
if ($token->targettype == "user") {
$user = core_user::get_user($token->targetid);
}
return $user;
}
/**
* Removes all entries in the table.
* Attention! All current records are deleted!
*
* @return boolean
*/
function tool_managertokens_delete_all_records() {
global $DB;
$result = $DB->delete_records("tool_managertokens_tokens", null);
return boolval($result);
}
/**
* Deletes an entry by an ID or token.
*
* @param number|string $key
* @return boolean
*/
function tool_managertokens_delete_record($key = 0) {
global $DB;
$result = false;
if ($token = tool_managertokens_find_record($key)) {
$result = $DB->delete_records("tool_managertokens_tokens", array("id" => $token->id));
}
return boolval($result);
}
/**
* Searches for an id or token.
*
* @param number|string $key
* @return object|boolean
*/
function tool_managertokens_find_record($key = 0) {
global $DB;
$select = "id = '$key' OR token = '$key'";
$token = $DB->get_record_select("tool_managertokens_tokens", $select, null, "*", IGNORE_MISSING);
return $token;
}
/**
* Get the entire list of tokens.
*
* @param number $limitfrom
* @param number $limitnum
* @return array
*/
function tool_managertokens_get_list($limitfrom = 0, $limitnum = 0) {
global $DB;
$result = $DB->get_records("tool_managertokens_tokens", null, "id", "*", $limitfrom, $limitnum);
return $result;
}
/**
* Performs additional actions for the user.
*
* @param object $token
* @param object $user
*/
function tool_managertokens_perform_additional_action($token, $user) {
global $DB;
/* Redirect user */
if ($token->extendedaction == "redirect") {
$redirect = new moodle_url($token->extendedoptions);
redirect($redirect);
}
/* Enroll in the local group */
if ($token->extendedaction == "group") {
$groupid = intval($token->extendedoptions);
if ($DB->record_exists("groups", array("id" => $groupid))) {
tool_managertokens_enroll_user_for_group($user, $groupid);
}
}
/* Enroll in the global group */
if ($token->extendedaction == "cohort") {
$cohortid = intval($token->extendedoptions);
if ($DB->record_exists("cohort", array("id" => $cohortid))) {
tool_managertokens_enroll_user_for_cohort($user, $cohortid);
}
}
/* Enroll in the global course */
if ($token->extendedaction == "course") {
$courseid = intval($token->extendedoptions);
if ($DB->record_exists("course", array("id" => $courseid))) {
tool_managertokens_enroll_user_for_course($user, $courseid);
}
}
}
/**
* Restores data from a backup.
* Attention! All current records are deleted!
*
* @param string $backup
*/
function tool_managertokens_restore_backup($backup = "") {
global $DB;
if ($list = unserialize(gzuncompress(base64_decode($backup)))) {
tool_managertokens_delete_all_records();
$DB->insert_records("tool_managertokens_tokens", $list);
}
}
/**
* Updates the entry in the database.
*
* @param object $options
* @return boolean
*/
function tool_managertokens_update_record($options) {
global $DB;
$result = false;
if (!isset($options->id)) {
print_error("missingparam", "error", null, "id");
}
if ($token = $DB->get_record("tool_managertokens_tokens", array("id" => $options->id), "*", IGNORE_MISSING)) {
$token->enabled = !empty($options->enabled) ? boolval($options->enabled) : false;
$token->limited = !empty($options->limited) ? intval($options->limited) : $token->limited;
$token->targetid = !empty($options->targetid) ? intval($options->targetid) : $token->targetid;
$token->targettype = !empty($options->targettype) ? strval($options->targettype) : $token->targettype;
$token->timelimited = !empty($options->timelimited) ? intval($options->timelimited) : $token->timelimited;
$token->token = !empty($options->token) ? strval($options->token) : $token->token;
$token->timemodified = time();
if (!empty($options->extendedaction) && !empty($options->extendedoptions)) {
$token->extendedaction = strval($options->extendedaction);
$token->extendedoptions = strval($options->extendedoptions);
}
$result = $DB->update_record("tool_managertokens_tokens", $token, false);
}
return boolval($result);
}