forked from elearning-univie/moodle-mod_wordcloud
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathexternallib.php
325 lines (280 loc) · 12.3 KB
/
externallib.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
<?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/>.
/**
* Interface implementation of the external Webservices
*
* @package mod_wordcloud
* @copyright 2020 University of Vienna
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir . '/externallib.php');
require_once(__DIR__ . '/locallib.php');
/**
* Class mod_wordcloud_external
*
* @copyright 2020 University of Vienna
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class mod_wordcloud_external extends external_api {
/**
* Returns description of method parameters
*
* @return external_function_parameters
*/
public static function add_word_parameters() {
return new external_function_parameters(
array(
'aid' => new external_value(PARAM_INT, 'id of the wordcloud activity'),
'word' => new external_value(PARAM_TEXT, 'word to be added'),
'groupid' => new external_value(PARAM_INT, 'id of the wordcloud activity', VALUE_DEFAULT, 0),
'listview' => new external_value(PARAM_INT, 'display cloud as list')
)
);
}
/**
* Returns description of method parameters
*
* @return external_function_parameters
*/
public static function get_words_parameters() {
return new external_function_parameters(
array(
'aid' => new external_value(PARAM_INT, 'id of the wordcloud activity'),
'timestamphtml' => new external_value(PARAM_INT, 'timestamp of the last wordcloud change'),
'listview' => new external_value(PARAM_INT, 'display cloud as list')
)
);
}
/**
* Returns description of method parameters
*
* @return external_function_parameters
*/
public static function update_entry_parameters() {
return new external_function_parameters(
array(
'aid' => new external_value(PARAM_INT, 'id of the wordcloud activity'),
'entry' => new external_multiple_structure(
new external_single_structure(
array(
'wordid' => new external_value(PARAM_TEXT, 'id of the word to change'),
'newword' => new external_value(PARAM_TEXT, 'new word to change to'),
'newcount' => new external_value(PARAM_INT, 'new word count to change to')
)
)
)
)
);
}
/**
* Add a new word or increase the count of the word
*
* @param int $aid
* @param string $word
* @param int $groupid
* @param int $listview
* @return array|null
*/
public static function add_word($aid, $word, $groupid, $listview) {
global $DB;
$warnings = [];
$params = self::validate_parameters(self::add_word_parameters(),
array('aid' => $aid, 'word' => $word, 'groupid' => $groupid, 'listview' => $listview));
$cm = get_coursemodule_from_instance('wordcloud', $params['aid'], 0, false, MUST_EXIST);
$course = $DB->get_record('course', ['id' => $cm->course], '*', MUST_EXIST);
$context = context_module::instance($cm->id);
self::validate_context($context);
require_login($course, false, $cm);
require_capability('mod/wordcloud:submit', $context);
$wordcloud = $DB->get_record('wordcloud', array('id' => $params['aid']));
$groupmode = groups_get_activity_groupmode($cm);
$servergroupid = 0;
if ($groupmode) {
$servergroupid = $params['groupid'] ?: groups_get_activity_group($cm);
}
$cansubmit = mod_wordcloud_can_submit($wordcloud, $context, $servergroupid);
if (!$cansubmit['writeaccess']) {
return ['cloudhtml' => '', 'sumcount' => 0, 'warnings' => $warnings];
}
$params['word'] = trim($params['word']);
if (mb_strlen($params['word'], 'UTF-8') > WORDCLOUD_WORD_LENGTH) {
$warnings[] = [
'warningcode' => 'errorwordoverflow',
'message' => get_string('errorwordoverflow', 'mod_wordcloud')
];
return ['cloudhtml' => '', 'sumcount' => 0, 'warnings' => $warnings];
} else if (strlen($params['word']) == 0) {
return ['cloudhtml' => '', 'sumcount' => 0, 'warnings' => $warnings];
}
$record = $DB->get_record('wordcloud_map', ['wordcloudid' => $params['aid'], 'groupid' => $servergroupid,
'word' => $params['word']]);
if (!$record) {
$wordscount = $DB->count_records('wordcloud_map', ['wordcloudid' => $params['aid'], 'groupid' => $servergroupid]);
if ($wordscount > WORDCLOUD_MAX_WORDS) {
$warnings[] = [
'warningcode' => 'errortoomanywords',
'message' => get_string('errortoomanywords', 'mod_wordcloud')
];
return ['cloudhtml' => '', 'sumcount' => 0, 'warnings' => $warnings];
}
$DB->insert_record('wordcloud_map', ['wordcloudid' => $params['aid'], 'groupid' => $servergroupid,
'word' => $params['word'], 'count' => 1]);
} else {
$record->count++;
$DB->update_record('wordcloud_map', $record);
}
$DB->set_field('wordcloud', 'lastwordchange', time(), ['id' => $params['aid']]);
$cloudhtml = mod_wordcloud_get_cloudhtml($params['aid'], $groupmode, $servergroupid, $params['listview']);
return ['cloudhtml' => $cloudhtml['cloudhtml'],
'sumcount' => $cloudhtml['sumcount'],
'warnings' => $warnings];
}
/**
* Get the latest wordcloud html
*
* @param int $aid
* @param int $timestamphtml
* @param int $listview
* @return array|null
*/
public static function get_words($aid, $timestamphtml, $listview) {
global $DB;
$warnings = [];
$params = self::validate_parameters(self::get_words_parameters(), array('aid' => $aid, 'timestamphtml' => $timestamphtml, 'listview' => $listview));
$cm = get_coursemodule_from_instance('wordcloud', $params['aid'], 0, false, MUST_EXIST);
$course = $DB->get_record('course', ['id' => $cm->course], '*', MUST_EXIST);
$context = context_module::instance($cm->id);
$groupid = 0;
self::validate_context($context);
require_login($course, false, $cm);
require_capability('mod/wordcloud:view', $context);
if ($groupmode = groups_get_activity_groupmode($cm)) {
$groupid = groups_get_activity_group($cm, true);
if ($groupmode != VISIBLEGROUPS &&
!has_capability('moodle/site:accessallgroups', $context) &&
!groups_is_member($groupid)) {
return ['cloudhtml' => '', 'sumcount' => 0, 'timestamphtml' => 0, 'warnings' => $warnings];
}
}
$record = $DB->get_record('wordcloud', ['id' => $params['aid']]);
if ($record->lastwordchange > $timestamphtml) {
$cloudhtml = mod_wordcloud_get_cloudhtml($params['aid'], $groupmode, $groupid, $params['listview']);
return ['cloudhtml' => $cloudhtml['cloudhtml'],
'sumcount' => $cloudhtml['sumcount'],
'timestamphtml' => $record->lastwordchange,
'warnings' => $warnings];
}
return ['cloudhtml' => '', 'sumcount' => 0, 'timestamphtml' => 0, 'warnings' => $warnings];
}
/**
* Add a new word or increase the count of the word
*
* @param int $aid
* @param object $entry
* @return array
*/
public static function update_entry($aid, $entry) {
global $DB;
$warnings = [];
$errentries = '';
$success = true;
$params = self::validate_parameters(self::update_entry_parameters(),
array('aid' => $aid, 'entry' => $entry));
$cm = get_coursemodule_from_instance('wordcloud', $params['aid'], 0, false, MUST_EXIST);
$course = $DB->get_record('course', ['id' => $cm->course], '*', MUST_EXIST);
$context = context_module::instance($cm->id);
self::validate_context($context);
require_login($course, false, $cm);
require_capability('mod/wordcloud:editentry', $context);
$groupmode = groups_get_activity_groupmode($cm);
$groupid = $groupmode ? groups_get_activity_group($cm) : 0;
if ($groupmode && $groupid === 0) {
return ['success' => false, 'warnings' => $warnings];
}
foreach ($params['entry'] as $updateentry) {
$updateentry['newword'] = trim($updateentry['newword']);
if (mb_strlen($updateentry['newword'], 'UTF-8') > WORDCLOUD_WORD_LENGTH) {
$warnings[] = [
'warningcode' => 'errorwordoverflow',
'message' => get_string('errorwordoverflow', 'mod_wordcloud')
];
$success = false;
continue;
} else if (strlen($updateentry['newword']) == 0) {
$success = false;
continue;
}
$record = $DB->get_record('wordcloud_map', ['id' => $updateentry['wordid'], 'groupid' => $groupid]);
if ($record) {
$checkrec = $DB->get_record('wordcloud_map',
['word' => $updateentry['newword'], 'wordcloudid' => $params['aid'], 'groupid' => $groupid]);
if ($checkrec) {
if ($checkrec->id != $updateentry['wordid']) {
$DB->delete_records('wordcloud_map', ['id' => $checkrec->id]);
$updateentry['newcount'] = $updateentry['newcount'] + $checkrec->count;
}
}
$record->word = $updateentry['newword'];
$record->count = $updateentry['newcount'];
$DB->update_record('wordcloud_map', $record);
}
}
if (!$success) {
$warnings[] = [
'warningcode' => 'errorwordoverflow',
'message' => get_string('errorupdateentries', 'mod_wordcloud') . $errentries
];
}
return ['success' => $success, 'warnings' => $warnings];
}
/**
* Returns return value description
*
* @return external_value
*/
public static function add_word_returns() {
return new external_single_structure(array(
'cloudhtml' => new external_value(PARAM_RAW, 'wordcloud html code'),
'sumcount' => new external_value(PARAM_INT, 'total number of words submitted'),
'warnings' => new external_warnings()
));
}
/**
* Returns return value description
*
* @return external_value
*/
public static function get_words_returns() {
return new external_single_structure(array(
'cloudhtml' => new external_value(PARAM_RAW, 'wordcloud html code'),
'sumcount' => new external_value(PARAM_INT, 'total number of words submitted'),
'timestamphtml' => new external_value(PARAM_INT, 'timestamp of the last wordcloud change'),
'warnings' => new external_warnings()
));
}
/**
* Returns return value description
*
* @return external_value
*/
public static function update_entry_returns() {
return new external_single_structure(array(
'success' => new external_value(PARAM_BOOL, 'true if successful, false otherwise'),
'warnings' => new external_warnings()
));
}
}