2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * This file contains the definition for the library class for onlinetext submission plugin
20 * This class provides all the functionality for the new assign module.
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
27 defined('MOODLE_INTERNAL') || die();
28 // File area for online text submission assignment.
29 define('ASSIGNSUBMISSION_ONLINETEXT_FILEAREA', 'submissions_onlinetext');
32 * library class for onlinetext submission plugin extending submission plugin base class
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
38 class assign_submission_onlinetext extends assign_submission_plugin {
41 * Get the name of the online text submission plugin
44 public function get_name() {
45 return get_string('onlinetext', 'assignsubmission_onlinetext');
50 * Get onlinetext submission information from the database
52 * @param int $submissionid
55 private function get_onlinetext_submission($submissionid) {
58 return $DB->get_record('assignsubmission_onlinetext', array('submission'=>$submissionid));
62 * Get the settings for onlinetext submission plugin
64 * @param MoodleQuickForm $mform The form to add elements to
67 public function get_settings(MoodleQuickForm $mform) {
70 $defaultwordlimit = $this->get_config('wordlimit') == 0 ? '' : $this->get_config('wordlimit');
71 $defaultwordlimitenabled = $this->get_config('wordlimitenabled');
73 $options = array('size' => '6', 'maxlength' => '6');
74 $name = get_string('wordlimit', 'assignsubmission_onlinetext');
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',
84 'assignsubmission_onlinetext');
85 $mform->disabledIf('assignsubmission_onlinetext_wordlimit',
86 'assignsubmission_onlinetext_wordlimit_enabled',
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);
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',
104 * Save the settings for onlinetext submission plugin
106 * @param stdClass $data
109 public function save_settings(stdClass $data) {
110 if (empty($data->assignsubmission_onlinetext_wordlimit) || empty($data->assignsubmission_onlinetext_wordlimit_enabled)) {
112 $wordlimitenabled = 0;
114 $wordlimit = $data->assignsubmission_onlinetext_wordlimit;
115 $wordlimitenabled = 1;
118 $this->set_config('wordlimit', $wordlimit);
119 $this->set_config('wordlimitenabled', $wordlimitenabled);
125 * Add form elements for settings
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
132 public function get_form_elements($submission, MoodleQuickForm $mform, stdClass $data) {
135 $editoroptions = $this->get_edit_options();
136 $submissionid = $submission ? $submission->id : 0;
138 if (!isset($data->onlinetext)) {
139 $data->onlinetext = '';
141 if (!isset($data->onlinetextformat)) {
142 $data->onlinetextformat = editors_get_preferred_format();
146 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
147 if ($onlinetextsubmission) {
148 $data->onlinetext = $onlinetextsubmission->onlinetext;
149 $data->onlinetextformat = $onlinetextsubmission->onlineformat;
154 $data = file_prepare_standard_editor($data,
157 $this->assignment->get_context(),
158 'assignsubmission_onlinetext',
159 ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
161 $mform->addElement('editor', 'onlinetext_editor', $this->get_name(), null, $editoroptions);
167 * Editor format options
171 private function get_edit_options() {
172 $editoroptions = array(
174 'maxfiles' => EDITOR_UNLIMITED_FILES,
175 'maxbytes' => $this->assignment->get_course()->maxbytes,
176 'context' => $this->assignment->get_context(),
177 'return_types' => (FILE_INTERNAL | FILE_EXTERNAL | FILE_CONTROLLED_LINK),
178 'removeorphaneddrafts' => true // Whether or not to remove any draft files which aren't referenced in the text.
180 return $editoroptions;
184 * Save data to the database and trigger plagiarism plugin,
185 * if enabled, to scan the uploaded content via events trigger
187 * @param stdClass $submission
188 * @param stdClass $data
191 public function save(stdClass $submission, stdClass $data) {
194 $editoroptions = $this->get_edit_options();
196 $data = file_postupdate_standard_editor($data,
199 $this->assignment->get_context(),
200 'assignsubmission_onlinetext',
201 ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
204 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
206 $fs = get_file_storage();
208 $files = $fs->get_area_files($this->assignment->get_context()->id,
209 'assignsubmission_onlinetext',
210 ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
215 // Check word count before submitting anything.
216 $exceeded = $this->check_word_count(trim($data->onlinetext));
218 $this->set_error($exceeded);
223 'context' => context_module::instance($this->assignment->get_course_module()->id),
224 'courseid' => $this->assignment->get_course()->id,
225 'objectid' => $submission->id,
227 'pathnamehashes' => array_keys($files),
228 'content' => trim($data->onlinetext),
229 'format' => $data->onlinetext_editor['format']
232 if (!empty($submission->userid) && ($submission->userid != $USER->id)) {
233 $params['relateduserid'] = $submission->userid;
235 $event = \assignsubmission_onlinetext\event\assessable_uploaded::create($params);
240 // Get the group name as other fields are not transcribed in the logs and this information is important.
241 if (empty($submission->userid) && !empty($submission->groupid)) {
242 $groupname = $DB->get_field('groups', 'name', array('id' => $submission->groupid), MUST_EXIST);
243 $groupid = $submission->groupid;
245 $params['relateduserid'] = $submission->userid;
248 $count = count_words($data->onlinetext);
250 // Unset the objectid and other field from params for use in submission events.
251 unset($params['objectid']);
252 unset($params['other']);
253 $params['other'] = array(
254 'submissionid' => $submission->id,
255 'submissionattempt' => $submission->attemptnumber,
256 'submissionstatus' => $submission->status,
257 'onlinetextwordcount' => $count,
258 'groupid' => $groupid,
259 'groupname' => $groupname
262 if ($onlinetextsubmission) {
264 $onlinetextsubmission->onlinetext = $data->onlinetext;
265 $onlinetextsubmission->onlineformat = $data->onlinetext_editor['format'];
266 $params['objectid'] = $onlinetextsubmission->id;
267 $updatestatus = $DB->update_record('assignsubmission_onlinetext', $onlinetextsubmission);
268 $event = \assignsubmission_onlinetext\event\submission_updated::create($params);
269 $event->set_assign($this->assignment);
271 return $updatestatus;
274 $onlinetextsubmission = new stdClass();
275 $onlinetextsubmission->onlinetext = $data->onlinetext;
276 $onlinetextsubmission->onlineformat = $data->onlinetext_editor['format'];
278 $onlinetextsubmission->submission = $submission->id;
279 $onlinetextsubmission->assignment = $this->assignment->get_instance()->id;
280 $onlinetextsubmission->id = $DB->insert_record('assignsubmission_onlinetext', $onlinetextsubmission);
281 $params['objectid'] = $onlinetextsubmission->id;
282 $event = \assignsubmission_onlinetext\event\submission_created::create($params);
283 $event->set_assign($this->assignment);
285 return $onlinetextsubmission->id > 0;
290 * Return a list of the text fields that can be imported/exported by this plugin
292 * @return array An array of field names and descriptions. (name=>description, ...)
294 public function get_editor_fields() {
295 return array('onlinetext' => get_string('pluginname', 'assignsubmission_onlinetext'));
299 * Get the saved text content from the editor
301 * @param string $name
302 * @param int $submissionid
305 public function get_editor_text($name, $submissionid) {
306 if ($name == 'onlinetext') {
307 $onlinetextsubmission = $this->get_onlinetext_submission($submissionid);
308 if ($onlinetextsubmission) {
309 return $onlinetextsubmission->onlinetext;
317 * Get the content format for the editor
319 * @param string $name
320 * @param int $submissionid
323 public function get_editor_format($name, $submissionid) {
324 if ($name == 'onlinetext') {
325 $onlinetextsubmission = $this->get_onlinetext_submission($submissionid);
326 if ($onlinetextsubmission) {
327 return $onlinetextsubmission->onlineformat;
336 * Display onlinetext word count in the submission status table
338 * @param stdClass $submission
339 * @param bool $showviewlink - If the summary has been truncated set this to true
342 public function view_summary(stdClass $submission, & $showviewlink) {
345 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
346 // Always show the view link.
347 $showviewlink = true;
349 if ($onlinetextsubmission) {
350 // This contains the shortened version of the text plus an optional 'Export to portfolio' button.
351 $text = $this->assignment->render_editor_content(ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
352 $onlinetextsubmission->submission,
355 'assignsubmission_onlinetext', true);
357 // The actual submission text.
358 $onlinetext = trim($onlinetextsubmission->onlinetext);
359 // The shortened version of the submission text.
360 $shorttext = shorten_text($onlinetext, 140);
362 $plagiarismlinks = '';
364 if (!empty($CFG->enableplagiarism)) {
365 require_once($CFG->libdir . '/plagiarismlib.php');
367 $plagiarismlinks .= plagiarism_get_links(array('userid' => $submission->userid,
368 'content' => $onlinetext,
369 'cmid' => $this->assignment->get_course_module()->id,
370 'course' => $this->assignment->get_course()->id,
371 'assignment' => $submission->assignment));
373 // We compare the actual text submission and the shortened version. If they are not equal, we show the word count.
374 if ($onlinetext != $shorttext) {
375 $wordcount = get_string('numwords', 'assignsubmission_onlinetext', count_words($onlinetext));
377 return $plagiarismlinks . $wordcount . $text;
379 return $plagiarismlinks . $text;
386 * Produce a list of files suitable for export that represent this submission.
388 * @param stdClass $submission - For this is the submission data
389 * @param stdClass $user - This is the user record for this submission
390 * @return array - return an array of files indexed by filename
392 public function get_files(stdClass $submission, stdClass $user) {
396 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
398 // Note that this check is the same logic as the result from the is_empty function but we do
399 // not call it directly because we already have the submission record.
400 if ($onlinetextsubmission && !empty($onlinetextsubmission->onlinetext)) {
401 $finaltext = $this->assignment->download_rewrite_pluginfile_urls($onlinetextsubmission->onlinetext, $user, $this);
402 $formattedtext = format_text($finaltext,
403 $onlinetextsubmission->onlineformat,
404 array('context'=>$this->assignment->get_context()));
405 $head = '<head><meta charset="UTF-8"></head>';
406 $submissioncontent = '<!DOCTYPE html><html>' . $head . '<body>'. $formattedtext . '</body></html>';
408 $filename = get_string('onlinetextfilename', 'assignsubmission_onlinetext');
409 $files[$filename] = array($submissioncontent);
411 $fs = get_file_storage();
413 $fsfiles = $fs->get_area_files($this->assignment->get_context()->id,
414 'assignsubmission_onlinetext',
415 ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
420 foreach ($fsfiles as $file) {
421 $files[$file->get_filename()] = $file;
429 * Display the saved text content from the editor in the view table
431 * @param stdClass $submission
434 public function view(stdClass $submission) {
438 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
440 if ($onlinetextsubmission) {
442 // Render for portfolio API.
443 $result .= $this->assignment->render_editor_content(ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
444 $onlinetextsubmission->submission,
447 'assignsubmission_onlinetext');
449 $plagiarismlinks = '';
451 if (!empty($CFG->enableplagiarism)) {
452 require_once($CFG->libdir . '/plagiarismlib.php');
454 $plagiarismlinks .= plagiarism_get_links(array('userid' => $submission->userid,
455 'content' => trim($onlinetextsubmission->onlinetext),
456 'cmid' => $this->assignment->get_course_module()->id,
457 'course' => $this->assignment->get_course()->id,
458 'assignment' => $submission->assignment));
462 return $plagiarismlinks . $result;
466 * Return true if this plugin can upgrade an old Moodle 2.2 assignment of this type and version.
468 * @param string $type old assignment subtype
469 * @param int $version old assignment version
470 * @return bool True if upgrade is possible
472 public function can_upgrade($type, $version) {
473 if ($type == 'online' && $version >= 2011112900) {
481 * Upgrade the settings from the old assignment to the new plugin based one
483 * @param context $oldcontext - the database for the old assignment context
484 * @param stdClass $oldassignment - the database for the old assignment instance
485 * @param string $log record log events here
486 * @return bool Was it a success?
488 public function upgrade_settings(context $oldcontext, stdClass $oldassignment, & $log) {
489 // No settings to upgrade.
494 * Upgrade the submission from the old assignment to the new one
496 * @param context $oldcontext - the database for the old assignment context
497 * @param stdClass $oldassignment The data record for the old assignment
498 * @param stdClass $oldsubmission The data record for the old submission
499 * @param stdClass $submission The data record for the new submission
500 * @param string $log Record upgrade messages in the log
501 * @return bool true or false - false will trigger a rollback
503 public function upgrade(context $oldcontext,
504 stdClass $oldassignment,
505 stdClass $oldsubmission,
506 stdClass $submission,
510 $onlinetextsubmission = new stdClass();
511 $onlinetextsubmission->onlinetext = $oldsubmission->data1;
512 $onlinetextsubmission->onlineformat = $oldsubmission->data2;
514 $onlinetextsubmission->submission = $submission->id;
515 $onlinetextsubmission->assignment = $this->assignment->get_instance()->id;
517 if ($onlinetextsubmission->onlinetext === null) {
518 $onlinetextsubmission->onlinetext = '';
521 if ($onlinetextsubmission->onlineformat === null) {
522 $onlinetextsubmission->onlineformat = editors_get_preferred_format();
525 if (!$DB->insert_record('assignsubmission_onlinetext', $onlinetextsubmission) > 0) {
526 $log .= get_string('couldnotconvertsubmission', 'mod_assign', $submission->userid);
530 // Now copy the area files.
531 $this->assignment->copy_area_files_for_upgrade($oldcontext->id,
535 $this->assignment->get_context()->id,
536 'assignsubmission_onlinetext',
537 ASSIGNSUBMISSION_ONLINETEXT_FILEAREA,
543 * Formatting for log info
545 * @param stdClass $submission The new submission
548 public function format_for_log(stdClass $submission) {
549 // Format the info for each submission plugin (will be logged).
550 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
551 $onlinetextloginfo = '';
552 $onlinetextloginfo .= get_string('numwordsforlog',
553 'assignsubmission_onlinetext',
554 count_words($onlinetextsubmission->onlinetext));
556 return $onlinetextloginfo;
560 * The assignment has been deleted - cleanup
564 public function delete_instance() {
566 $DB->delete_records('assignsubmission_onlinetext',
567 array('assignment'=>$this->assignment->get_instance()->id));
573 * No text is set for this plugin
575 * @param stdClass $submission
578 public function is_empty(stdClass $submission) {
579 $onlinetextsubmission = $this->get_onlinetext_submission($submission->id);
582 if (isset($onlinetextsubmission->onlinetext)) {
583 $wordcount = count_words(trim($onlinetextsubmission->onlinetext));
586 return $wordcount == 0;
590 * Determine if a submission is empty
592 * This is distinct from is_empty in that it is intended to be used to
593 * determine if a submission made before saving is empty.
595 * @param stdClass $data The submission data
598 public function submission_is_empty(stdClass $data) {
599 if (!isset($data->onlinetext_editor)) {
604 if (isset($data->onlinetext_editor['text'])) {
605 $wordcount = count_words(trim((string)$data->onlinetext_editor['text']));
608 return $wordcount == 0;
612 * Get file areas returns a list of areas this plugin stores files
613 * @return array - An array of fileareas (keys) and descriptions (values)
615 public function get_file_areas() {
616 return array(ASSIGNSUBMISSION_ONLINETEXT_FILEAREA=>$this->get_name());
620 * Copy the student's submission from a previous submission. Used when a student opts to base their resubmission
621 * on the last submission.
622 * @param stdClass $sourcesubmission
623 * @param stdClass $destsubmission
625 public function copy_submission(stdClass $sourcesubmission, stdClass $destsubmission) {
628 // Copy the files across (attached via the text editor).
629 $contextid = $this->assignment->get_context()->id;
630 $fs = get_file_storage();
631 $files = $fs->get_area_files($contextid, 'assignsubmission_onlinetext',
632 ASSIGNSUBMISSION_ONLINETEXT_FILEAREA, $sourcesubmission->id, 'id', false);
633 foreach ($files as $file) {
634 $fieldupdates = array('itemid' => $destsubmission->id);
635 $fs->create_file_from_storedfile($fieldupdates, $file);
638 // Copy the assignsubmission_onlinetext record.
639 $onlinetextsubmission = $this->get_onlinetext_submission($sourcesubmission->id);
640 if ($onlinetextsubmission) {
641 unset($onlinetextsubmission->id);
642 $onlinetextsubmission->submission = $destsubmission->id;
643 $DB->insert_record('assignsubmission_onlinetext', $onlinetextsubmission);
649 * Return a description of external params suitable for uploading an onlinetext submission from a webservice.
651 * @return external_description|null
653 public function get_external_parameters() {
654 $editorparams = array('text' => new external_value(PARAM_RAW, 'The text for this submission.'),
655 'format' => new external_value(PARAM_INT, 'The format for this submission'),
656 'itemid' => new external_value(PARAM_INT, 'The draft area id for files attached to the submission'));
657 $editorstructure = new external_single_structure($editorparams, 'Editor structure', VALUE_OPTIONAL);
658 return array('onlinetext_editor' => $editorstructure);
662 * Compare word count of onlinetext submission to word limit, and return result.
664 * @param string $submissiontext Onlinetext submission text from editor
665 * @return string Error message if limit is enabled and exceeded, otherwise null
667 public function check_word_count($submissiontext) {
670 $wordlimitenabled = $this->get_config('wordlimitenabled');
671 $wordlimit = $this->get_config('wordlimit');
673 if ($wordlimitenabled == 0) {
677 // Count words and compare to limit.
678 $wordcount = count_words($submissiontext);
679 if ($wordcount <= $wordlimit) {
682 $errormsg = get_string('wordlimitexceeded', 'assignsubmission_onlinetext',
683 array('limit' => $wordlimit, 'count' => $wordcount));
684 return $OUTPUT->error_text($errormsg);
689 * Return the plugin configs for external functions.
691 * @return array the list of settings
694 public function get_config_for_external() {
695 return (array) $this->get_config();