MDL-55113 assign: Use PARAM_RAW in onlinetext text
[moodle.git] / mod / assign / submission / onlinetext / locallib.php
CommitLineData
bbd0e548
DW
1<?php
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * This file contains the definition for the library class for onlinetext submission plugin
19 *
20 * This class provides all the functionality for the new assign module.
21 *
22 * @package assignsubmission_onlinetext
23 * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 */
26
27defined('MOODLE_INTERNAL') || die();
e5403f8c 28// File area for online text submission assignment.
8ab7bb9f 29define('ASSIGNSUBMISSION_ONLINETEXT_FILEAREA', 'submissions_onlinetext');
bbd0e548
DW
30
31/**
32 * library class for onlinetext submission plugin extending submission plugin base class
33 *
34 * @package assignsubmission_onlinetext
35 * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
36 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37 */
38class assign_submission_onlinetext extends assign_submission_plugin {
39
40 /**
41 * Get the name of the online text submission plugin
42 * @return string
43 */
44 public function get_name() {
45 return get_string('onlinetext', 'assignsubmission_onlinetext');
46 }
47
48
e5403f8c
DW
49 /**
50 * Get onlinetext submission information from the database
51 *
52 * @param int $submissionid
53 * @return mixed
54 */
bbd0e548
DW
55 private function get_onlinetext_submission($submissionid) {
56 global $DB;
57
58 return $DB->get_record('assignsubmission_onlinetext', array('submission'=>$submissionid));
59 }
60
dc66404b
TB
61 /**
62 * Get the settings for onlinetext submission plugin
63 *
64 * @param MoodleQuickForm $mform The form to add elements to
65 * @return void
66 */
67 public function get_settings(MoodleQuickForm $mform) {
68 global $CFG, $COURSE;
69
70 $defaultwordlimit = $this->get_config('wordlimit') == 0 ? '' : $this->get_config('wordlimit');
71 $defaultwordlimitenabled = $this->get_config('wordlimitenabled');
72
73 $options = array('size' => '6', 'maxlength' => '6');
74 $name = get_string('wordlimit', 'assignsubmission_onlinetext');
75
76 // Create a text box that can be enabled/disabled for onlinetext word limit.
77 $wordlimitgrp = array();
78 $wordlimitgrp[] = $mform->createElement('text', 'assignsubmission_onlinetext_wordlimit', '', $options);
79 $wordlimitgrp[] = $mform->createElement('checkbox', 'assignsubmission_onlinetext_wordlimit_enabled',
80 '', get_string('enable'));
81 $mform->addGroup($wordlimitgrp, 'assignsubmission_onlinetext_wordlimit_group', $name, ' ', false);
82 $mform->addHelpButton('assignsubmission_onlinetext_wordlimit_group',
83 'wordlimit',
84 'assignsubmission_onlinetext');
85 $mform->disabledIf('assignsubmission_onlinetext_wordlimit',
86 'assignsubmission_onlinetext_wordlimit_enabled',
87 'notchecked');
88
89 // Add numeric rule to text field.
90 $wordlimitgrprules = array();
91 $wordlimitgrprules['assignsubmission_onlinetext_wordlimit'][] = array(null, 'numeric', null, 'client');
92 $mform->addGroupRule('assignsubmission_onlinetext_wordlimit_group', $wordlimitgrprules);
93
94 // Rest of group setup.
95 $mform->setDefault('assignsubmission_onlinetext_wordlimit', $defaultwordlimit);
96 $mform->setDefault('assignsubmission_onlinetext_wordlimit_enabled', $defaultwordlimitenabled);
97 $mform->setType('assignsubmission_onlinetext_wordlimit', PARAM_INT);
98 $mform->disabledIf('assignsubmission_onlinetext_wordlimit_group',
99 'assignsubmission_onlinetext_enabled',
100 'notchecked');
101 }
102
103 /**
104 * Save the settings for onlinetext submission plugin
105 *
106 * @param stdClass $data
107 * @return bool
108 */
109 public function save_settings(stdClass $data) {
110 if (empty($data->assignsubmission_onlinetext_wordlimit) || empty($data->assignsubmission_onlinetext_wordlimit_enabled)) {
111 $wordlimit = 0;
112 $wordlimitenabled = 0;
113 } else {
114 $wordlimit = $data->assignsubmission_onlinetext_wordlimit;
115 $wordlimitenabled = 1;
116 }
117
118 $this->set_config('wordlimit', $wordlimit);
119 $this->set_config('wordlimitenabled', $wordlimitenabled);
120
121 return true;
122 }
123
bbd0e548
DW
124 /**
125 * Add form elements for settings
126 *
127 * @param mixed $submission can be null
128 * @param MoodleQuickForm $mform
129 * @param stdClass $data
130 * @return true if elements were added to the form
131 */
132 public function get_form_elements($submission, MoodleQuickForm $mform, stdClass $data) {
133 $elements = array();
134
135 $editoroptions = $this->get_edit_options();
136 $submissionid = $submission ? $submission->id : 0;
137
138 if (!isset($data->onlinetext)) {
139 $data->onlinetext = '';
140 }
141 if (!isset($data->onlinetextformat)) {
142 $data->onlinetextformat = editors_get_preferred_format();
143 }
144
145 if ($submission) {
146 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
147 if ($onlinetextsubmission) {
148 $data->onlinetext = $onlinetextsubmission->onlinetext;
149 $data->onlinetextformat = $onlinetextsubmission->onlineformat;
150 }
151
152 }
153
e5403f8c
DW
154 $data = file_prepare_standard_editor($data,
155 'onlinetext',
156 $editoroptions,
157 $this->assignment->get_context(),
158 'assignsubmission_onlinetext',
159 ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
160 $submissionid);
3a5c3b3c 161 $mform->addElement('editor', 'onlinetext_editor', $this->get_name(), null, $editoroptions);
7e5be074 162
bbd0e548
DW
163 return true;
164 }
165
166 /**
167 * Editor format options
168 *
169 * @return array
170 */
171 private function get_edit_options() {
172 $editoroptions = array(
173 'noclean' => false,
174 'maxfiles' => EDITOR_UNLIMITED_FILES,
175 'maxbytes' => $this->assignment->get_course()->maxbytes,
c469b396
MG
176 'context' => $this->assignment->get_context(),
177 'return_types' => FILE_INTERNAL | FILE_EXTERNAL
bbd0e548
DW
178 );
179 return $editoroptions;
180 }
181
e5403f8c
DW
182 /**
183 * Save data to the database and trigger plagiarism plugin,
184 * if enabled, to scan the uploaded content via events trigger
185 *
186 * @param stdClass $submission
187 * @param stdClass $data
188 * @return bool
189 */
190 public function save(stdClass $submission, stdClass $data) {
48e5aacb 191 global $USER, $DB;
bbd0e548
DW
192
193 $editoroptions = $this->get_edit_options();
194
e5403f8c
DW
195 $data = file_postupdate_standard_editor($data,
196 'onlinetext',
197 $editoroptions,
198 $this->assignment->get_context(),
199 'assignsubmission_onlinetext',
200 ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
201 $submission->id);
bbd0e548
DW
202
203 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
48e5aacb
KG
204
205 $fs = get_file_storage();
e5403f8c
DW
206
207 $files = $fs->get_area_files($this->assignment->get_context()->id,
208 'assignsubmission_onlinetext',
209 ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
210 $submission->id,
211 'id',
212 false);
213
651b7f17
TB
214 // Check word count before submitting anything.
215 $exceeded = $this->check_word_count(trim($data->onlinetext));
216 if ($exceeded) {
217 $this->set_error($exceeded);
218 return false;
219 }
220
7dceb500
FM
221 $params = array(
222 'context' => context_module::instance($this->assignment->get_course_module()->id),
d7f05ad4 223 'courseid' => $this->assignment->get_course()->id,
7dceb500
FM
224 'objectid' => $submission->id,
225 'other' => array(
226 'pathnamehashes' => array_keys($files),
fb59d535
AG
227 'content' => trim($data->onlinetext),
228 'format' => $data->onlinetext_editor['format']
7dceb500
FM
229 )
230 );
5cfa441b
DW
231 if (!empty($submission->userid) && ($submission->userid != $USER->id)) {
232 $params['relateduserid'] = $submission->userid;
233 }
7dceb500
FM
234 $event = \assignsubmission_onlinetext\event\assessable_uploaded::create($params);
235 $event->trigger();
48e5aacb 236
d7f05ad4
AG
237 $groupname = null;
238 $groupid = 0;
239 // Get the group name as other fields are not transcribed in the logs and this information is important.
240 if (empty($submission->userid) && !empty($submission->groupid)) {
241 $groupname = $DB->get_field('groups', 'name', array('id' => $submission->groupid), '*', MUST_EXIST);
242 $groupid = $submission->groupid;
243 } else {
244 $params['relateduserid'] = $submission->userid;
245 }
246
247 $count = count_words($data->onlinetext);
248
249 // Unset the objectid and other field from params for use in submission events.
250 unset($params['objectid']);
251 unset($params['other']);
252 $params['other'] = array(
253 'submissionid' => $submission->id,
254 'submissionattempt' => $submission->attemptnumber,
255 'submissionstatus' => $submission->status,
256 'onlinetextwordcount' => $count,
257 'groupid' => $groupid,
258 'groupname' => $groupname
259 );
260
bbd0e548
DW
261 if ($onlinetextsubmission) {
262
263 $onlinetextsubmission->onlinetext = $data->onlinetext;
264 $onlinetextsubmission->onlineformat = $data->onlinetext_editor['format'];
d7f05ad4
AG
265 $params['objectid'] = $onlinetextsubmission->id;
266 $updatestatus = $DB->update_record('assignsubmission_onlinetext', $onlinetextsubmission);
267 $event = \assignsubmission_onlinetext\event\submission_updated::create($params);
4781ff2e 268 $event->set_assign($this->assignment);
d7f05ad4
AG
269 $event->trigger();
270 return $updatestatus;
bbd0e548
DW
271 } else {
272
273 $onlinetextsubmission = new stdClass();
274 $onlinetextsubmission->onlinetext = $data->onlinetext;
275 $onlinetextsubmission->onlineformat = $data->onlinetext_editor['format'];
276
277 $onlinetextsubmission->submission = $submission->id;
278 $onlinetextsubmission->assignment = $this->assignment->get_instance()->id;
d7f05ad4
AG
279 $onlinetextsubmission->id = $DB->insert_record('assignsubmission_onlinetext', $onlinetextsubmission);
280 $params['objectid'] = $onlinetextsubmission->id;
281 $event = \assignsubmission_onlinetext\event\submission_created::create($params);
4781ff2e 282 $event->set_assign($this->assignment);
d7f05ad4
AG
283 $event->trigger();
284 return $onlinetextsubmission->id > 0;
bbd0e548 285 }
bbd0e548
DW
286 }
287
df47b77f
DW
288 /**
289 * Return a list of the text fields that can be imported/exported by this plugin
290 *
291 * @return array An array of field names and descriptions. (name=>description, ...)
292 */
293 public function get_editor_fields() {
294 return array('onlinetext' => get_string('pluginname', 'assignsubmission_comments'));
295 }
296
bbd0e548
DW
297 /**
298 * Get the saved text content from the editor
299 *
300 * @param string $name
301 * @param int $submissionid
302 * @return string
303 */
304 public function get_editor_text($name, $submissionid) {
305 if ($name == 'onlinetext') {
306 $onlinetextsubmission = $this->get_onlinetext_submission($submissionid);
307 if ($onlinetextsubmission) {
308 return $onlinetextsubmission->onlinetext;
309 }
310 }
311
312 return '';
313 }
314
315 /**
316 * Get the content format for the editor
317 *
318 * @param string $name
319 * @param int $submissionid
320 * @return int
321 */
322 public function get_editor_format($name, $submissionid) {
323 if ($name == 'onlinetext') {
324 $onlinetextsubmission = $this->get_onlinetext_submission($submissionid);
325 if ($onlinetextsubmission) {
326 return $onlinetextsubmission->onlineformat;
327 }
328 }
329
e5403f8c 330 return 0;
bbd0e548
DW
331 }
332
333
334 /**
335 * Display onlinetext word count in the submission status table
336 *
337 * @param stdClass $submission
338 * @param bool $showviewlink - If the summary has been truncated set this to true
339 * @return string
340 */
7ee1548a 341 public function view_summary(stdClass $submission, & $showviewlink) {
48e5aacb 342 global $CFG;
bbd0e548
DW
343
344 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
e5403f8c 345 // Always show the view link.
bbd0e548
DW
346 $showviewlink = true;
347
348 if ($onlinetextsubmission) {
e4288042
DW
349 $text = $this->assignment->render_editor_content(ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
350 $onlinetextsubmission->submission,
351 $this->get_type(),
352 'onlinetext',
353 'assignsubmission_onlinetext');
354
bbd0e548 355 $shorttext = shorten_text($text, 140);
48e5aacb 356 $plagiarismlinks = '';
e5403f8c 357
48e5aacb
KG
358 if (!empty($CFG->enableplagiarism)) {
359 require_once($CFG->libdir . '/plagiarismlib.php');
e5403f8c 360
48e5aacb 361 $plagiarismlinks .= plagiarism_get_links(array('userid' => $submission->userid,
e5403f8c 362 'content' => trim($text),
48e5aacb
KG
363 'cmid' => $this->assignment->get_course_module()->id,
364 'course' => $this->assignment->get_course()->id,
365 'assignment' => $submission->assignment));
366 }
bbd0e548 367 if ($text != $shorttext) {
e5403f8c
DW
368 $wordcount = get_string('numwords', 'assignsubmission_onlinetext', count_words($text));
369
fbbb33a2 370 return $plagiarismlinks . $wordcount . $shorttext;
bbd0e548 371 } else {
fbbb33a2 372 return $plagiarismlinks . $shorttext;
bbd0e548
DW
373 }
374 }
375 return '';
376 }
377
378 /**
e5403f8c 379 * Produce a list of files suitable for export that represent this submission.
bbd0e548
DW
380 *
381 * @param stdClass $submission - For this is the submission data
2406815b 382 * @param stdClass $user - This is the user record for this submission
bbd0e548
DW
383 * @return array - return an array of files indexed by filename
384 */
2406815b 385 public function get_files(stdClass $submission, stdClass $user) {
bbd0e548 386 global $DB;
e5403f8c 387
bbd0e548
DW
388 $files = array();
389 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
e5403f8c 390
bbd0e548 391 if ($onlinetextsubmission) {
2406815b 392 $finaltext = $this->assignment->download_rewrite_pluginfile_urls($onlinetextsubmission->onlinetext, $user, $this);
e5403f8c
DW
393 $formattedtext = format_text($finaltext,
394 $onlinetextsubmission->onlineformat,
395 array('context'=>$this->assignment->get_context()));
b887c262
TB
396 $head = '<head><meta charset="UTF-8"></head>';
397 $submissioncontent = '<!DOCTYPE html><html>' . $head . '<body>'. $formattedtext . '</body></html>';
e5403f8c
DW
398
399 $filename = get_string('onlinetextfilename', 'assignsubmission_onlinetext');
400 $files[$filename] = array($submissioncontent);
bbd0e548
DW
401
402 $fs = get_file_storage();
403
e5403f8c
DW
404 $fsfiles = $fs->get_area_files($this->assignment->get_context()->id,
405 'assignsubmission_onlinetext',
406 ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
407 $submission->id,
408 'timemodified',
409 false);
bbd0e548
DW
410
411 foreach ($fsfiles as $file) {
412 $files[$file->get_filename()] = $file;
413 }
414 }
415
416 return $files;
417 }
418
419 /**
420 * Display the saved text content from the editor in the view table
421 *
422 * @param stdClass $submission
423 * @return string
424 */
425 public function view(stdClass $submission) {
acf9e300 426 global $CFG;
bbd0e548
DW
427 $result = '';
428
429 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
430
bbd0e548
DW
431 if ($onlinetextsubmission) {
432
e5403f8c
DW
433 // Render for portfolio API.
434 $result .= $this->assignment->render_editor_content(ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
435 $onlinetextsubmission->submission,
436 $this->get_type(),
437 'onlinetext',
438 'assignsubmission_onlinetext');
bbd0e548 439
acf9e300 440 $plagiarismlinks = '';
441
442 if (!empty($CFG->enableplagiarism)) {
443 require_once($CFG->libdir . '/plagiarismlib.php');
444
445 $plagiarismlinks .= plagiarism_get_links(array('userid' => $submission->userid,
446 'content' => trim($result),
447 'cmid' => $this->assignment->get_course_module()->id,
448 'course' => $this->assignment->get_course()->id,
449 'assignment' => $submission->assignment));
450 }
bbd0e548
DW
451 }
452
fbbb33a2 453 return $plagiarismlinks . $result;
bbd0e548
DW
454 }
455
e5403f8c 456 /**
bbd0e548
DW
457 * Return true if this plugin can upgrade an old Moodle 2.2 assignment of this type and version.
458 *
459 * @param string $type old assignment subtype
460 * @param int $version old assignment version
461 * @return bool True if upgrade is possible
462 */
463 public function can_upgrade($type, $version) {
464 if ($type == 'online' && $version >= 2011112900) {
465 return true;
466 }
467 return false;
468 }
469
470
471 /**
472 * Upgrade the settings from the old assignment to the new plugin based one
473 *
474 * @param context $oldcontext - the database for the old assignment context
475 * @param stdClass $oldassignment - the database for the old assignment instance
476 * @param string $log record log events here
477 * @return bool Was it a success?
478 */
479 public function upgrade_settings(context $oldcontext, stdClass $oldassignment, & $log) {
e5403f8c 480 // No settings to upgrade.
bbd0e548
DW
481 return true;
482 }
483
484 /**
485 * Upgrade the submission from the old assignment to the new one
486 *
487 * @param context $oldcontext - the database for the old assignment context
488 * @param stdClass $oldassignment The data record for the old assignment
489 * @param stdClass $oldsubmission The data record for the old submission
490 * @param stdClass $submission The data record for the new submission
491 * @param string $log Record upgrade messages in the log
492 * @return bool true or false - false will trigger a rollback
493 */
e5403f8c
DW
494 public function upgrade(context $oldcontext,
495 stdClass $oldassignment,
496 stdClass $oldsubmission,
497 stdClass $submission,
498 & $log) {
bbd0e548
DW
499 global $DB;
500
501 $onlinetextsubmission = new stdClass();
502 $onlinetextsubmission->onlinetext = $oldsubmission->data1;
503 $onlinetextsubmission->onlineformat = $oldsubmission->data2;
504
505 $onlinetextsubmission->submission = $submission->id;
506 $onlinetextsubmission->assignment = $this->assignment->get_instance()->id;
d82bb44d
DW
507
508 if ($onlinetextsubmission->onlinetext === null) {
509 $onlinetextsubmission->onlinetext = '';
510 }
511
512 if ($onlinetextsubmission->onlineformat === null) {
513 $onlinetextsubmission->onlineformat = editors_get_preferred_format();
514 }
515
bbd0e548
DW
516 if (!$DB->insert_record('assignsubmission_onlinetext', $onlinetextsubmission) > 0) {
517 $log .= get_string('couldnotconvertsubmission', 'mod_assign', $submission->userid);
518 return false;
519 }
520
e5403f8c 521 // Now copy the area files.
bbd0e548
DW
522 $this->assignment->copy_area_files_for_upgrade($oldcontext->id,
523 'mod_assignment',
524 'submission',
525 $oldsubmission->id,
bbd0e548
DW
526 $this->assignment->get_context()->id,
527 'assignsubmission_onlinetext',
8ab7bb9f 528 ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
bbd0e548
DW
529 $submission->id);
530 return true;
531 }
532
533 /**
534 * Formatting for log info
535 *
536 * @param stdClass $submission The new submission
537 * @return string
538 */
539 public function format_for_log(stdClass $submission) {
e5403f8c 540 // Format the info for each submission plugin (will be logged).
bbd0e548
DW
541 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
542 $onlinetextloginfo = '';
e5403f8c
DW
543 $onlinetextloginfo .= get_string('numwordsforlog',
544 'assignsubmission_onlinetext',
fb59d535 545 count_words($onlinetextsubmission->onlinetext));
bbd0e548
DW
546
547 return $onlinetextloginfo;
548 }
549
550 /**
551 * The assignment has been deleted - cleanup
552 *
553 * @return bool
554 */
555 public function delete_instance() {
556 global $DB;
e5403f8c
DW
557 $DB->delete_records('assignsubmission_onlinetext',
558 array('assignment'=>$this->assignment->get_instance()->id));
bbd0e548
DW
559
560 return true;
561 }
562
563 /**
564 * No text is set for this plugin
565 *
566 * @param stdClass $submission
567 * @return bool
568 */
569 public function is_empty(stdClass $submission) {
7a9fd6da
DW
570 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
571
572 return empty($onlinetextsubmission->onlinetext);
bbd0e548
DW
573 }
574
575 /**
576 * Get file areas returns a list of areas this plugin stores files
577 * @return array - An array of fileareas (keys) and descriptions (values)
578 */
579 public function get_file_areas() {
8ab7bb9f 580 return array(ASSIGNSUBMISSION_ONLINETEXT_FILEAREA=>$this->get_name());
bbd0e548
DW
581 }
582
df211804
DW
583 /**
584 * Copy the student's submission from a previous submission. Used when a student opts to base their resubmission
585 * on the last submission.
586 * @param stdClass $sourcesubmission
587 * @param stdClass $destsubmission
588 */
589 public function copy_submission(stdClass $sourcesubmission, stdClass $destsubmission) {
590 global $DB;
591
592 // Copy the files across (attached via the text editor).
593 $contextid = $this->assignment->get_context()->id;
594 $fs = get_file_storage();
595 $files = $fs->get_area_files($contextid, 'assignsubmission_onlinetext',
596 ASSIGNSUBMISSION_ONLINETEXT_FILEAREA, $sourcesubmission->id, 'id', false);
597 foreach ($files as $file) {
598 $fieldupdates = array('itemid' => $destsubmission->id);
599 $fs->create_file_from_storedfile($fieldupdates, $file);
600 }
601
602 // Copy the assignsubmission_onlinetext record.
603 $onlinetextsubmission = $this->get_onlinetext_submission($sourcesubmission->id);
604 if ($onlinetextsubmission) {
605 unset($onlinetextsubmission->id);
606 $onlinetextsubmission->submission = $destsubmission->id;
607 $DB->insert_record('assignsubmission_onlinetext', $onlinetextsubmission);
608 }
609 return true;
610 }
05a6445a
DW
611
612 /**
613 * Return a description of external params suitable for uploading an onlinetext submission from a webservice.
614 *
615 * @return external_description|null
616 */
617 public function get_external_parameters() {
5609da91 618 $editorparams = array('text' => new external_value(PARAM_RAW, 'The text for this submission.'),
05a6445a
DW
619 'format' => new external_value(PARAM_INT, 'The format for this submission'),
620 'itemid' => new external_value(PARAM_INT, 'The draft area id for files attached to the submission'));
69115a5a 621 $editorstructure = new external_single_structure($editorparams, 'Editor structure', VALUE_OPTIONAL);
05a6445a
DW
622 return array('onlinetext_editor' => $editorstructure);
623 }
624
651b7f17
TB
625 /**
626 * Compare word count of onlinetext submission to word limit, and return result.
627 *
628 * @param string $submissiontext Onlinetext submission text from editor
629 * @return string Error message if limit is enabled and exceeded, otherwise null
630 */
631 public function check_word_count($submissiontext) {
632 global $OUTPUT;
633
634 $wordlimitenabled = $this->get_config('wordlimitenabled');
635 $wordlimit = $this->get_config('wordlimit');
636
637 if ($wordlimitenabled == 0) {
638 return null;
639 }
640
641 // Count words and compare to limit.
642 $wordcount = count_words($submissiontext);
643 if ($wordcount <= $wordlimit) {
644 return null;
645 } else {
646 $errormsg = get_string('wordlimitexceeded', 'assignsubmission_onlinetext',
647 array('limit' => $wordlimit, 'count' => $wordcount));
648 return $OUTPUT->error_text($errormsg);
649 }
650 }
651
bbd0e548
DW
652}
653
654