moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-05 08:56:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-68665 assignfeedback_editpdf: Add filearea to persist stamps

Browse source
This commit is contained in:
Jamie Stamp 2020-10-07 16:21:18 +01:00
parent 2c8db06e7a
commit 12fb5964f2
2 changed files with 130 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

42
mod/assign/feedback/editpdf/lib.php
View file

@ -24,6 +24,9 @@
defined('MOODLE_INTERNAL') || die(); defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->dirroot . '/mod/assign/locallib.php');
/** /**
* Serves assignment feedback and other files. * Serves assignment feedback and other files.
* *
@ -36,27 +39,28 @@ defined('MOODLE_INTERNAL') || die();
* @param array $options - List of options affecting file serving. * @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 * @return bool false if file not found, does not return if found - just send the file
*/ */
function assignfeedback_editpdf_pluginfile($course, function assignfeedback_editpdf_pluginfile(
$cm, $course,
context $context, $cm,
$filearea, context $context,
$args, $filearea,
$forcedownload, $args,
array $options=array()) { $forcedownload,
global $USER, $DB, $CFG; array $options = array()
) {
global $DB;
if ($filearea === 'systemstamps') {
require_once($CFG->dirroot . '/mod/assign/locallib.php'); if ($context->contextlevel !== CONTEXT_SYSTEM) {
return false;
}
if ($filearea === 'stamps' && $context->contextlevel === CONTEXT_SYSTEM) { $filename = array_pop($args);
$filepath = '/' . implode('/', $args) . '/';
$itemid = (int)array_shift($args);
$relativepath = implode('/', $args);
$fullpath = "/{$context->id}/assignfeedback_editpdf/$filearea/$itemid/$relativepath";
$fs = get_file_storage(); $fs = get_file_storage();
if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) { $file = $fs->get_file($context->id, 'assignfeedback_editpdf', $filearea, 0, $filepath, $filename);
if (!$file) {
return false; return false;
} }
@ -64,7 +68,9 @@ function assignfeedback_editpdf_pluginfile($course,
$options['immutable'] = true; $options['immutable'] = true;
send_stored_file($file, 0, 0, true, $options); send_stored_file($file, 0, 0, true, $options);
} else if ($context->contextlevel == CONTEXT_MODULE) { }
if ($context->contextlevel == CONTEXT_MODULE) {
require_login($course, false, $cm); require_login($course, false, $cm);
$itemid = (int)array_shift($args); $itemid = (int)array_shift($args);

162
mod/assign/feedback/editpdf/locallib.php
View file

@ -72,69 +72,82 @@ class assign_feedback_editpdf extends assign_feedback_plugin {
$systemfiles = array(); $systemfiles = array();
$fs = get_file_storage(); $fs = get_file_storage();
$syscontext = context_system::instance(); $syscontext = context_system::instance();
$asscontext = $this->assignment->get_context();
// Copy any new stamps to this instance. // Three file areas are used for stamps.
if ($files = $fs->get_area_files($syscontext->id, // Current stamps are those configured as a site administration setting to be available for new uses.
'assignfeedback_editpdf', // When a stamp is removed from this filearea it is no longer available for new grade items.
'stamps', $currentstamps = $fs->get_area_files($syscontext->id, 'assignfeedback_editpdf', 'stamps', 0, "filename", false);
0,
"filename",
false)) {
foreach ($files as $file) {
$filename = $file->get_filename();
if ($filename !== '.') {
$systemfiles[] = $filename;
$existingfile = $fs->file_exists( // Grade stamps are those which have been assigned for a specific grade item.
$this->assignment->get_context()->id, // The stamps associated with a grade item are always used for that grade item, even if the stamp is removed
'assignfeedback_editpdf', // from the list of current stamps.
'stamps', $gradestamps = $fs->get_area_files($asscontext->id, 'assignfeedback_editpdf', 'stamps', $grade->id, "filename", false);
$grade->id,
'/',
$file->get_filename()
);
if (!$existingfile) { // The system stamps are perpetual and always exist.
$newrecord = new stdClass(); // They allow Moodle to serve a common URL for all users for any possible combination of stamps.
$newrecord->contextid = $this->assignment->get_context()->id; // Files in the perpetual stamp filearea are within the system context, in itemid 0, and use the original stamps
$newrecord->itemid = $grade->id; // contenthash as a folder name. This ensures that the combination of stamp filename, and stamp file content is
$fs->create_file_from_storedfile($newrecord, $file); // unique.
} $systemstamps = $fs->get_area_files($syscontext->id, 'assignfeedback_editpdf', 'systemstamps', 0, "filename", false);
}
// First check that all current stamps are listed in the grade stamps.
foreach ($currentstamps as $stamp) {
// Ensure that the current stamp is in the list of perpetual stamps.
$systempathnamehash = $this->get_system_stamp_path($stamp);
if (!array_key_exists($systempathnamehash, $systemstamps)) {
$filerecord = (object) [
'filearea' => 'systemstamps',
'filepath' => '/' . $stamp->get_contenthash() . '/',
];
$newstamp = $fs->create_file_from_storedfile($filerecord, $stamp);
$systemstamps[$newstamp->get_pathnamehash()] = $newstamp;
}
// Ensure that the current stamp is in the list of stamps for the current grade item.
$gradeitempathhash = $this->get_assignment_stamp_path($stamp, $grade->id);
if (!array_key_exists($gradeitempathhash, $gradestamps)) {
$filerecord = (object) [
'contextid' => $asscontext->id,
'filearea' => 'stamps',
'itemid' => $grade->id,
];
$newstamp = $fs->create_file_from_storedfile($filerecord, $stamp);
$gradestamps[$newstamp->get_pathnamehash()] = $newstamp;
} }
} }
// Now get the full list of stamp files for this instance. foreach ($gradestamps as $stamp) {
if ($files = $fs->get_area_files($this->assignment->get_context()->id, // All gradestamps should be available in the systemstamps filearea, but some legacy stamps may not be.
'assignfeedback_editpdf', // These need to be copied over.
'stamps', // Note: This should ideally be performed as an upgrade step, but there may be other cases that these do not
$grade->id, // exist, for example restored backups.
"filename", // In any case this is a cheap operation as it is solely performing an array lookup.
false)) { $systempathnamehash = $this->get_system_stamp_path($stamp);
foreach ($files as $file) { if (!array_key_exists($systempathnamehash, $systemstamps)) {
$filename = $file->get_filename(); $filerecord = (object) [
if ($filename !== '.') { 'contextid' => $syscontext->id,
'itemid' => 0,
// Check to see if the file exists in system context. 'filearea' => 'systemstamps',
$insystemfiles = in_array($filename, $systemfiles); 'filepath' => '/' . $stamp->get_contenthash() . '/',
];
// If stamp is available in the system context, use that copy. $systemstamp = $fs->create_file_from_storedfile($filerecord, $stamp);
// If not then fall back to file saved in the files table. $systemstamps[$systemstamp->get_pathnamehash()] = $systemstamp;
$context = $insystemfiles ? $syscontext->id : $this->assignment->get_context()->id;
$itemid = $insystemfiles ? 0 : $grade->id;
$url = moodle_url::make_pluginfile_url(
$context,
'assignfeedback_editpdf',
'stamps',
$itemid,
'/',
$file->get_filename(),
false
);
array_push($stampfiles, $url->out());
}
} }
// Always serve the perpetual system stamp.
// This ensures that the stamp is highly cached and reduces the hit on the application server.
$gradestamp = $systemstamps[$systempathnamehash];
$url = moodle_url::make_pluginfile_url(
$gradestamp->get_contextid(),
$gradestamp->get_component(),
$gradestamp->get_filearea(),
false,
$gradestamp->get_filepath(),
$gradestamp->get_filename(),
false
);
array_push($stampfiles, $url->out());
} }
$url = false; $url = false;
@ -161,6 +174,43 @@ class assign_feedback_editpdf extends assign_feedback_plugin {
return $widget; return $widget;
} }
/**
* Get the pathnamehash for the specified stamp if in the system stamps.
*
* @param stored_file $file
* @return string
*/
protected function get_system_stamp_path(stored_file $stamp): string {
$systemcontext = context_system::instance();
return file_storage::get_pathname_hash(
$systemcontext->id,
'assignfeedback_editpdf',
'systemstamps',
0,
'/' . $stamp->get_contenthash() . '/',
$stamp->get_filename()
);
}
/**
* Get the pathnamehash for the specified stamp if in the current assignment stamps.
*
* @param stored_file $file
* @param int $gradeid
* @return string
*/
protected function get_assignment_stamp_path(stored_file $stamp, int $gradeid): string {
return file_storage::get_pathname_hash(
$this->assignment->get_context()->id,
'assignfeedback_editpdf',
'stamps',
$gradeid,
$stamp->get_filepath(),
$stamp->get_filename()
);
}
/** /**
* Get form elements for grading form * Get form elements for grading form
* *