mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 14:27:22 +01:00
MDL-27520 assignfeedback_comments: allow files in the comments feedback
Also use new API to add files to gradebook.
This commit is contained in:
Mark Nelson
parent
faa438bad6
commit
ea241998e6
82
mod/assign/feedback/comments/lib.php
Normal file
82
mod/assign/feedback/comments/lib.php
Normal file
@ -0,0 +1,82 @@
|
||||
<?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/>.
|
||||
|
||||
/**
|
||||
* This file contains the moodle hooks for the comments feedback plugin
|
||||
*
|
||||
* @package assignfeedback_comments
|
||||
* @copyright 2018 Mark Nelson <markn@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
/**
|
||||
* Serves assignment comment feedback files.
|
||||
*
|
||||
* @param mixed $course course or id of the course
|
||||
* @param mixed $cm course module or id of the course module
|
||||
* @param context $context
|
||||
* @param string $filearea
|
||||
* @param array $args
|
||||
* @param bool $forcedownload
|
||||
* @param array $options - List of options affecting file serving.
|
||||
* @return bool false if file not found, does not return if found - just send the file
|
||||
*/
|
||||
function assignfeedback_comments_pluginfile(
|
||||
$course,
|
||||
$cm,
|
||||
context $context,
|
||||
$filearea,
|
||||
$args,
|
||||
$forcedownload,
|
||||
array $options = []) {
|
||||
global $CFG, $DB;
|
||||
|
||||
require_once($CFG->dirroot . '/mod/assign/locallib.php');
|
||||
|
||||
if ($context->contextlevel != CONTEXT_MODULE) {
|
||||
return false;
|
||||
}
|
||||
|
||||
require_login($course, false, $cm);
|
||||
$itemid = (int)array_shift($args);
|
||||
$record = $DB->get_record('assign_grades', array('id' => $itemid), 'userid,assignment', MUST_EXIST);
|
||||
$userid = $record->userid;
|
||||
|
||||
$assign = new assign($context, $cm, $course);
|
||||
$instance = $assign->get_instance();
|
||||
|
||||
if ($instance->id != $record->assignment) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!$assign->can_view_submission($userid)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$relativepath = implode('/', $args);
|
||||
|
||||
$fullpath = "/{$context->id}/assignfeedback_comments/$filearea/$itemid/$relativepath";
|
||||
|
||||
$fs = get_file_storage();
|
||||
|
||||
if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Download MUST be forced - security!
|
||||
send_stored_file($file, 0, 0, true, $options);
|
||||
}
|
||||
@ -24,6 +24,12 @@
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
// File component for feedback comments.
|
||||
define('ASSIGNFEEDBACK_COMMENTS_COMPONENT', 'assignfeedback_comments');
|
||||
|
||||
// File area for feedback comments.
|
||||
define('ASSIGNFEEDBACK_COMMENTS_FILEAREA', 'feedback');
|
||||
|
||||
/**
|
||||
* Library class for comment feedback plugin extending feedback plugin base class.
|
||||
*
|
||||
@ -306,8 +312,8 @@ class assign_feedback_comments extends assign_feedback_plugin {
|
||||
}
|
||||
|
||||
if ($feedbackcomments && !empty($feedbackcomments->commenttext)) {
|
||||
$data->assignfeedbackcomments_editor['text'] = $feedbackcomments->commenttext;
|
||||
$data->assignfeedbackcomments_editor['format'] = $feedbackcomments->commentformat;
|
||||
$data->assignfeedbackcomments = $feedbackcomments->commenttext;
|
||||
$data->assignfeedbackcommentsformat = $feedbackcomments->commentformat;
|
||||
} else {
|
||||
// No feedback given yet - maybe we need to copy the text from the submission?
|
||||
if (!empty($commentinlinenabled) && $submission) {
|
||||
@ -315,7 +321,16 @@ class assign_feedback_comments extends assign_feedback_plugin {
|
||||
}
|
||||
}
|
||||
|
||||
$mform->addElement('editor', 'assignfeedbackcomments_editor', $this->get_name(), null, null);
|
||||
file_prepare_standard_editor(
|
||||
$data,
|
||||
'assignfeedbackcomments',
|
||||
$this->get_editor_options(),
|
||||
$this->assignment->get_context(),
|
||||
ASSIGNFEEDBACK_COMMENTS_COMPONENT,
|
||||
ASSIGNFEEDBACK_COMMENTS_FILEAREA,
|
||||
$grade->id
|
||||
);
|
||||
$mform->addElement('editor', 'assignfeedbackcomments_editor', $this->get_name(), null, $this->get_editor_options());
|
||||
|
||||
return true;
|
||||
}
|
||||
@ -329,15 +344,27 @@ class assign_feedback_comments extends assign_feedback_plugin {
|
||||
*/
|
||||
public function save(stdClass $grade, stdClass $data) {
|
||||
global $DB;
|
||||
|
||||
// Save the files.
|
||||
$data = file_postupdate_standard_editor(
|
||||
$data,
|
||||
'assignfeedbackcomments',
|
||||
$this->get_editor_options(),
|
||||
$this->assignment->get_context(),
|
||||
ASSIGNFEEDBACK_COMMENTS_COMPONENT,
|
||||
ASSIGNFEEDBACK_COMMENTS_FILEAREA,
|
||||
$grade->id
|
||||
);
|
||||
|
||||
$feedbackcomment = $this->get_feedback_comments($grade->id);
|
||||
if ($feedbackcomment) {
|
||||
$feedbackcomment->commenttext = $data->assignfeedbackcomments_editor['text'];
|
||||
$feedbackcomment->commentformat = $data->assignfeedbackcomments_editor['format'];
|
||||
$feedbackcomment->commenttext = $data->assignfeedbackcomments;
|
||||
$feedbackcomment->commentformat = $data->assignfeedbackcommentsformat;
|
||||
return $DB->update_record('assignfeedback_comments', $feedbackcomment);
|
||||
} else {
|
||||
$feedbackcomment = new stdClass();
|
||||
$feedbackcomment->commenttext = $data->assignfeedbackcomments_editor['text'];
|
||||
$feedbackcomment->commentformat = $data->assignfeedbackcomments_editor['format'];
|
||||
$feedbackcomment->commenttext = $data->assignfeedbackcomments;
|
||||
$feedbackcomment->commentformat = $data->assignfeedbackcommentsformat;
|
||||
$feedbackcomment->grade = $grade->id;
|
||||
$feedbackcomment->assignment = $this->assignment->get_instance()->id;
|
||||
return $DB->insert_record('assignfeedback_comments', $feedbackcomment) > 0;
|
||||
@ -354,12 +381,17 @@ class assign_feedback_comments extends assign_feedback_plugin {
|
||||
public function view_summary(stdClass $grade, & $showviewlink) {
|
||||
$feedbackcomments = $this->get_feedback_comments($grade->id);
|
||||
if ($feedbackcomments) {
|
||||
$text = format_text($feedbackcomments->commenttext,
|
||||
$feedbackcomments->commentformat,
|
||||
array('context' => $this->assignment->get_context()));
|
||||
$short = shorten_text($text, 140);
|
||||
$text = $this->rewrite_feedback_comments_urls($feedbackcomments->commenttext, $grade->id);
|
||||
$text = format_text(
|
||||
$text,
|
||||
$feedbackcomments->commentformat,
|
||||
[
|
||||
'context' => $this->assignment->get_context()
|
||||
]
|
||||
);
|
||||
|
||||
// Show the view all link if the text has been shortened.
|
||||
$short = shorten_text($text, 140);
|
||||
$showviewlink = $short != $text;
|
||||
return $short;
|
||||
}
|
||||
@ -375,9 +407,16 @@ class assign_feedback_comments extends assign_feedback_plugin {
|
||||
public function view(stdClass $grade) {
|
||||
$feedbackcomments = $this->get_feedback_comments($grade->id);
|
||||
if ($feedbackcomments) {
|
||||
return format_text($feedbackcomments->commenttext,
|
||||
$feedbackcomments->commentformat,
|
||||
array('context' => $this->assignment->get_context()));
|
||||
$text = $this->rewrite_feedback_comments_urls($feedbackcomments->commenttext, $grade->id);
|
||||
$text = format_text(
|
||||
$text,
|
||||
$feedbackcomments->commentformat,
|
||||
[
|
||||
'context' => $this->assignment->get_context()
|
||||
]
|
||||
);
|
||||
|
||||
return $text;
|
||||
}
|
||||
return '';
|
||||
}
|
||||
@ -482,6 +521,21 @@ class assign_feedback_comments extends assign_feedback_plugin {
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Return any files this plugin wishes to save to the gradebook.
|
||||
*
|
||||
* @param stdClass $grade The assign_grades object from the db
|
||||
* @return array
|
||||
*/
|
||||
public function files_for_gradebook(stdClass $grade) : array {
|
||||
return [
|
||||
'contextid' => $this->assignment->get_context()->id,
|
||||
'component' => ASSIGNFEEDBACK_COMMENTS_COMPONENT,
|
||||
'filearea' => ASSIGNFEEDBACK_COMMENTS_FILEAREA,
|
||||
'itemid' => $grade->id
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* The assignment has been deleted - cleanup
|
||||
*
|
||||
@ -526,4 +580,38 @@ class assign_feedback_comments extends assign_feedback_plugin {
|
||||
public function get_config_for_external() {
|
||||
return (array) $this->get_config();
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert encoded URLs in $text from the @@PLUGINFILE@@/... form to an actual URL.
|
||||
*
|
||||
* @param string $text the Text to check
|
||||
* @param int $gradeid The grade ID which refers to the id in the gradebook
|
||||
*/
|
||||
private function rewrite_feedback_comments_urls(string $text, int $gradeid) {
|
||||
return file_rewrite_pluginfile_urls(
|
||||
$text,
|
||||
'pluginfile.php',
|
||||
$this->assignment->get_context()->id,
|
||||
ASSIGNFEEDBACK_COMMENTS_COMPONENT,
|
||||
ASSIGNFEEDBACK_COMMENTS_FILEAREA,
|
||||
$gradeid
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* File format options.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
private function get_editor_options() {
|
||||
global $COURSE;
|
||||
|
||||
return [
|
||||
'subdirs' => 1,
|
||||
'maxbytes' => $COURSE->maxbytes,
|
||||
'accepted_types' => '*',
|
||||
'context' => $this->assignment->get_context(),
|
||||
'maxfiles' => EDITOR_UNLIMITED_FILES
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user