Cameron Ball
94cf5b1fd3
MDL-45580 introduced the readonlypages filearea, and when loading page images for an attempt, the code would check if the pages existed , creating them if not. The code inside this block also contained a guard clause for the case where no readonly pages existed - which is a situation that should not happen. Whenever readonly pages are requested, they should exist. MDL-66626 introduced a situation where page counts not matching would also retrigger page generation. However this led to a situation where the guard clause could be entered when requesting readonly pages. This patch refactors the guard clause, and improves the logic to regenerate pages.
1109 lines
47 KiB
PHP
1109 lines
47 KiB
PHP
<?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 ingest manager for the assignfeedback_editpdf plugin
|
|
*
|
|
* @package assignfeedback_editpdf
|
|
* @copyright 2012 Davo Smith
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace assignfeedback_editpdf;
|
|
|
|
use DOMDocument;
|
|
|
|
/**
|
|
* Functions for generating the annotated pdf.
|
|
*
|
|
* This class controls the ingest of student submission files to a normalised
|
|
* PDF 1.4 document with all submission files concatinated together. It also
|
|
* provides the functions to generate a downloadable pdf with all comments and
|
|
* annotations embedded.
|
|
* @copyright 2012 Davo Smith
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class document_services {
|
|
|
|
/** Compoment name */
|
|
const COMPONENT = "assignfeedback_editpdf";
|
|
/** File area for generated pdf */
|
|
const FINAL_PDF_FILEAREA = 'download';
|
|
/** File area for combined pdf */
|
|
const COMBINED_PDF_FILEAREA = 'combined';
|
|
/** File area for partial combined pdf */
|
|
const PARTIAL_PDF_FILEAREA = 'partial';
|
|
/** File area for importing html */
|
|
const IMPORT_HTML_FILEAREA = 'importhtml';
|
|
/** File area for page images */
|
|
const PAGE_IMAGE_FILEAREA = 'pages';
|
|
/** File area for readonly page images */
|
|
const PAGE_IMAGE_READONLY_FILEAREA = 'readonlypages';
|
|
/** File area for the stamps */
|
|
const STAMPS_FILEAREA = 'stamps';
|
|
/** Filename for combined pdf */
|
|
const COMBINED_PDF_FILENAME = 'combined.pdf';
|
|
/** Temporary place to save JPG Image to PDF file */
|
|
const TMP_JPG_TO_PDF_FILEAREA = 'tmp_jpg_to_pdf';
|
|
/** Temporary place to save (Automatically) Rotated JPG FILE */
|
|
const TMP_ROTATED_JPG_FILEAREA = 'tmp_rotated_jpg';
|
|
/** Hash of blank pdf */
|
|
const BLANK_PDF_HASH = '4c803c92c71f21b423d13de570c8a09e0a31c718';
|
|
|
|
/** Base64 encoded blank pdf. This is the most reliable/fastest way to generate a blank pdf. */
|
|
const BLANK_PDF_BASE64 = <<<EOD
|
|
JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURl
|
|
Y29kZT4+CnN0cmVhbQp4nDPQM1Qo5ypUMFAwALJMLU31jBQsTAz1LBSKUrnCtRTyuAIVAIcdB3IK
|
|
ZW5kc3RyZWFtCmVuZG9iagoKMyAwIG9iago0MgplbmRvYmoKCjUgMCBvYmoKPDwKPj4KZW5kb2Jq
|
|
Cgo2IDAgb2JqCjw8L0ZvbnQgNSAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XQo+PgplbmRvYmoKCjEg
|
|
MCBvYmoKPDwvVHlwZS9QYWdlL1BhcmVudCA0IDAgUi9SZXNvdXJjZXMgNiAwIFIvTWVkaWFCb3hb
|
|
MCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+
|
|
L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgo0IDAgb2JqCjw8L1R5cGUvUGFnZXMKL1Jlc291cmNl
|
|
cyA2IDAgUgovTWVkaWFCb3hbIDAgMCA1OTUgODQyIF0KL0tpZHNbIDEgMCBSIF0KL0NvdW50IDE+
|
|
PgplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PcGVuQWN0aW9u
|
|
WzEgMCBSIC9YWVogbnVsbCBudWxsIDBdCi9MYW5nKGVuLUFVKQo+PgplbmRvYmoKCjggMCBvYmoK
|
|
PDwvQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAw
|
|
NEMwMDY5MDA2MjAwNzIwMDY1MDA0RjAwNjYwMDY2MDA2OTAwNjMwMDY1MDAyMDAwMzQwMDJFMDAz
|
|
ND4KL0NyZWF0aW9uRGF0ZShEOjIwMTYwMjI2MTMyMzE0KzA4JzAwJyk+PgplbmRvYmoKCnhyZWYK
|
|
MCA5CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDIyNiAwMDAwMCBuIAowMDAwMDAwMDE5IDAw
|
|
MDAwIG4gCjAwMDAwMDAxMzIgMDAwMDAgbiAKMDAwMDAwMDM2OCAwMDAwMCBuIAowMDAwMDAwMTUx
|
|
IDAwMDAwIG4gCjAwMDAwMDAxNzMgMDAwMDAgbiAKMDAwMDAwMDQ2NiAwMDAwMCBuIAowMDAwMDAw
|
|
NTYyIDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSA5L1Jvb3QgNyAwIFIKL0luZm8gOCAwIFIKL0lE
|
|
IFsgPEJDN0REQUQwRDQyOTQ1OTQ2OUU4NzJCMjI1ODUyNkU4Pgo8QkM3RERBRDBENDI5NDU5NDY5
|
|
RTg3MkIyMjU4NTI2RTg+IF0KL0RvY0NoZWNrc3VtIC9BNTYwMEZCMDAzRURCRTg0MTNBNTk3RTZF
|
|
MURDQzJBRgo+PgpzdGFydHhyZWYKNzM2CiUlRU9GCg==
|
|
EOD;
|
|
|
|
/**
|
|
* This function will take an int or an assignment instance and
|
|
* return an assignment instance. It is just for convenience.
|
|
* @param int|\assign $assignment
|
|
* @return \assign
|
|
*/
|
|
private static function get_assignment_from_param($assignment) {
|
|
global $CFG;
|
|
|
|
require_once($CFG->dirroot . '/mod/assign/locallib.php');
|
|
|
|
if (!is_object($assignment)) {
|
|
$cm = get_coursemodule_from_instance('assign', $assignment, 0, false, MUST_EXIST);
|
|
$context = \context_module::instance($cm->id);
|
|
|
|
$assignment = new \assign($context, null, null);
|
|
}
|
|
return $assignment;
|
|
}
|
|
|
|
/**
|
|
* Get a hash that will be unique and can be used in a path name.
|
|
* @param int|\assign $assignment
|
|
* @param int $userid
|
|
* @param int $attemptnumber (-1 means latest attempt)
|
|
*/
|
|
private static function hash($assignment, $userid, $attemptnumber) {
|
|
if (is_object($assignment)) {
|
|
$assignmentid = $assignment->get_instance()->id;
|
|
} else {
|
|
$assignmentid = $assignment;
|
|
}
|
|
return sha1($assignmentid . '_' . $userid . '_' . $attemptnumber);
|
|
}
|
|
|
|
/**
|
|
* Use a DOM parser to accurately replace images with their alt text.
|
|
* @param string $html
|
|
* @return string New html with no image tags.
|
|
*/
|
|
protected static function strip_images($html) {
|
|
// Load HTML and suppress any parsing errors (DOMDocument->loadHTML() does not current support HTML5 tags).
|
|
$dom = new DOMDocument();
|
|
libxml_use_internal_errors(true);
|
|
$dom->loadHTML('<?xml version="1.0" encoding="UTF-8" ?>' . $html);
|
|
libxml_clear_errors();
|
|
|
|
// Find all img tags.
|
|
if ($imgnodes = $dom->getElementsByTagName('img')) {
|
|
// Replace img nodes with the img alt text without overriding DOM elements.
|
|
for ($i = ($imgnodes->length - 1); $i >= 0; $i--) {
|
|
$imgnode = $imgnodes->item($i);
|
|
$alt = ($imgnode->hasAttribute('alt')) ? ' [ ' . $imgnode->getAttribute('alt') . ' ] ' : ' ';
|
|
$textnode = $dom->createTextNode($alt);
|
|
|
|
$imgnode->parentNode->replaceChild($textnode, $imgnode);
|
|
}
|
|
}
|
|
$count = 1;
|
|
return str_replace("<?xml version=\"1.0\" encoding=\"UTF-8\" ?>", "", $dom->saveHTML(), $count);
|
|
}
|
|
|
|
/**
|
|
* This function will search for all files that can be converted
|
|
* and concatinated into a PDF (1.4) - for any submission plugin
|
|
* for this students attempt.
|
|
*
|
|
* @param int|\assign $assignment
|
|
* @param int $userid
|
|
* @param int $attemptnumber (-1 means latest attempt)
|
|
* @return combined_document
|
|
*/
|
|
protected static function list_compatible_submission_files_for_attempt($assignment, $userid, $attemptnumber) {
|
|
global $USER, $DB;
|
|
|
|
$assignment = self::get_assignment_from_param($assignment);
|
|
|
|
// Capability checks.
|
|
if (!$assignment->can_view_submission($userid)) {
|
|
throw new \moodle_exception('nopermission');
|
|
}
|
|
|
|
$files = array();
|
|
|
|
if ($assignment->get_instance()->teamsubmission) {
|
|
$submission = $assignment->get_group_submission($userid, 0, false, $attemptnumber);
|
|
} else {
|
|
$submission = $assignment->get_user_submission($userid, false, $attemptnumber);
|
|
}
|
|
$user = $DB->get_record('user', array('id' => $userid));
|
|
|
|
// User has not submitted anything yet.
|
|
if (!$submission) {
|
|
return new combined_document();
|
|
}
|
|
|
|
$fs = get_file_storage();
|
|
$converter = new \core_files\converter();
|
|
// Ask each plugin for it's list of files.
|
|
foreach ($assignment->get_submission_plugins() as $plugin) {
|
|
if ($plugin->is_enabled() && $plugin->is_visible()) {
|
|
$pluginfiles = $plugin->get_files($submission, $user);
|
|
foreach ($pluginfiles as $filename => $file) {
|
|
if ($file instanceof \stored_file) {
|
|
$mimetype = $file->get_mimetype();
|
|
// PDF File, no conversion required.
|
|
if ($mimetype === 'application/pdf') {
|
|
$files[$filename] = $file;
|
|
} else if ($plugin->allow_image_conversion() && $mimetype === "image/jpeg") {
|
|
// Rotates image based on the EXIF value.
|
|
list ($rotateddata, $size) = $file->rotate_image();
|
|
if ($rotateddata) {
|
|
$file = self::save_rotated_image_file($assignment, $userid, $attemptnumber,
|
|
$rotateddata, $filename);
|
|
}
|
|
// Save as PDF file if there is no available converter.
|
|
if (!$converter->can_convert_format_to('jpg', 'pdf')) {
|
|
$pdffile = self::save_jpg_to_pdf($assignment, $userid, $attemptnumber, $file, $size);
|
|
if ($pdffile) {
|
|
$files[$filename] = $pdffile;
|
|
}
|
|
}
|
|
}
|
|
// The file has not been converted to PDF, try to convert it to PDF.
|
|
if (!isset($files[$filename])
|
|
&& $convertedfile = $converter->start_conversion($file, 'pdf')) {
|
|
$files[$filename] = $convertedfile;
|
|
}
|
|
} else if ($converter->can_convert_format_to('html', 'pdf')) {
|
|
// Create a tmp stored_file from this html string.
|
|
$file = reset($file);
|
|
// Strip image tags, because they will not be resolvable.
|
|
$file = self::strip_images($file);
|
|
$record = new \stdClass();
|
|
$record->contextid = $assignment->get_context()->id;
|
|
$record->component = 'assignfeedback_editpdf';
|
|
$record->filearea = self::IMPORT_HTML_FILEAREA;
|
|
$record->itemid = $submission->id;
|
|
$record->filepath = '/';
|
|
$record->filename = $plugin->get_type() . '-' . $filename;
|
|
|
|
$htmlfile = $fs->get_file($record->contextid,
|
|
$record->component,
|
|
$record->filearea,
|
|
$record->itemid,
|
|
$record->filepath,
|
|
$record->filename);
|
|
|
|
$newhash = sha1($file);
|
|
|
|
// If the file exists, and the content hash doesn't match, remove it.
|
|
if ($htmlfile && $newhash !== $htmlfile->get_contenthash()) {
|
|
$htmlfile->delete();
|
|
$htmlfile = false;
|
|
}
|
|
|
|
// If the file doesn't exist, or if it was removed above, create a new one.
|
|
if (!$htmlfile) {
|
|
$htmlfile = $fs->create_file_from_string($record, $file);
|
|
}
|
|
|
|
$convertedfile = $converter->start_conversion($htmlfile, 'pdf');
|
|
|
|
if ($convertedfile) {
|
|
$files[$filename] = $convertedfile;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
$combineddocument = new combined_document();
|
|
$combineddocument->set_source_files($files);
|
|
|
|
return $combineddocument;
|
|
}
|
|
|
|
/**
|
|
* Fetch the current combined document ready for state checking.
|
|
*
|
|
* @param int|\assign $assignment
|
|
* @param int $userid
|
|
* @param int $attemptnumber (-1 means latest attempt)
|
|
* @return combined_document
|
|
*/
|
|
public static function get_combined_document_for_attempt($assignment, $userid, $attemptnumber) {
|
|
global $USER, $DB;
|
|
|
|
$assignment = self::get_assignment_from_param($assignment);
|
|
|
|
// Capability checks.
|
|
if (!$assignment->can_view_submission($userid)) {
|
|
throw new \moodle_exception('nopermissiontoaccesspage', 'error');
|
|
}
|
|
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
if ($assignment->get_instance()->teamsubmission) {
|
|
$submission = $assignment->get_group_submission($userid, 0, false, $attemptnumber);
|
|
} else {
|
|
$submission = $assignment->get_user_submission($userid, false, $attemptnumber);
|
|
}
|
|
|
|
$contextid = $assignment->get_context()->id;
|
|
$component = 'assignfeedback_editpdf';
|
|
$filearea = self::COMBINED_PDF_FILEAREA;
|
|
$partialfilearea = self::PARTIAL_PDF_FILEAREA;
|
|
$itemid = $grade->id;
|
|
$filepath = '/';
|
|
$filename = self::COMBINED_PDF_FILENAME;
|
|
$fs = get_file_storage();
|
|
|
|
$partialpdf = $fs->get_file($contextid, $component, $partialfilearea, $itemid, $filepath, $filename);
|
|
if (!empty($partialpdf)) {
|
|
$combinedpdf = $partialpdf;
|
|
} else {
|
|
$combinedpdf = $fs->get_file($contextid, $component, $filearea, $itemid, $filepath, $filename);
|
|
}
|
|
|
|
if ($combinedpdf && $submission) {
|
|
if ($combinedpdf->get_timemodified() < $submission->timemodified) {
|
|
// The submission has been updated since the PDF was generated.
|
|
$combinedpdf = false;
|
|
} else if ($combinedpdf->get_contenthash() == self::BLANK_PDF_HASH) {
|
|
// The PDF is for a blank page.
|
|
$combinedpdf = false;
|
|
}
|
|
}
|
|
|
|
if (empty($combinedpdf)) {
|
|
// The combined PDF does not exist yet. Return the list of files to be combined.
|
|
return self::list_compatible_submission_files_for_attempt($assignment, $userid, $attemptnumber);
|
|
} else {
|
|
// The combined PDF aleady exists. Return it in a new combined_document object.
|
|
$combineddocument = new combined_document();
|
|
return $combineddocument->set_combined_file($combinedpdf);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This function return the combined pdf for all valid submission files.
|
|
*
|
|
* @param int|\assign $assignment
|
|
* @param int $userid
|
|
* @param int $attemptnumber (-1 means latest attempt)
|
|
* @return combined_document
|
|
*/
|
|
public static function get_combined_pdf_for_attempt($assignment, $userid, $attemptnumber) {
|
|
$document = self::get_combined_document_for_attempt($assignment, $userid, $attemptnumber);
|
|
|
|
if ($document->get_status() === combined_document::STATUS_COMPLETE) {
|
|
// The combined document is already ready.
|
|
return $document;
|
|
} else {
|
|
// Attempt to combined the files in the document.
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
$document->combine_files($assignment->get_context()->id, $grade->id);
|
|
return $document;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This function will return the number of pages of a pdf.
|
|
*
|
|
* @param int|\assign $assignment
|
|
* @param int $userid
|
|
* @param int $attemptnumber (-1 means latest attempt)
|
|
* @param bool $readonly When true we get the number of pages for the readonly version.
|
|
* @return int number of pages
|
|
*/
|
|
public static function page_number_for_attempt($assignment, $userid, $attemptnumber, $readonly = false) {
|
|
global $CFG;
|
|
|
|
require_once($CFG->libdir . '/pdflib.php');
|
|
|
|
$assignment = self::get_assignment_from_param($assignment);
|
|
|
|
if (!$assignment->can_view_submission($userid)) {
|
|
throw new \moodle_exception('nopermission');
|
|
}
|
|
|
|
// When in readonly we can return the number of images in the DB because they should already exist,
|
|
// if for some reason they do not, then we proceed as for the normal version.
|
|
if ($readonly) {
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
$fs = get_file_storage();
|
|
$files = $fs->get_directory_files($assignment->get_context()->id, 'assignfeedback_editpdf',
|
|
self::PAGE_IMAGE_READONLY_FILEAREA, $grade->id, '/');
|
|
$pagecount = count($files);
|
|
if ($pagecount > 0) {
|
|
return $pagecount;
|
|
}
|
|
}
|
|
|
|
// Get a combined pdf file from all submitted pdf files.
|
|
$document = self::get_combined_pdf_for_attempt($assignment, $userid, $attemptnumber);
|
|
return $document->get_page_count();
|
|
}
|
|
|
|
/**
|
|
* This function will generate and return a list of the page images from a pdf.
|
|
* @param int|\assign $assignment
|
|
* @param int $userid
|
|
* @param int $attemptnumber (-1 means latest attempt)
|
|
* @param bool $resetrotation check if need to reset page rotation information
|
|
* @return array(stored_file)
|
|
*/
|
|
protected static function generate_page_images_for_attempt($assignment, $userid, $attemptnumber, $resetrotation = true) {
|
|
global $CFG;
|
|
|
|
require_once($CFG->libdir . '/pdflib.php');
|
|
|
|
$assignment = self::get_assignment_from_param($assignment);
|
|
|
|
if (!$assignment->can_view_submission($userid)) {
|
|
throw new \moodle_exception('nopermission');
|
|
}
|
|
|
|
// Need to generate the page images - first get a combined pdf.
|
|
$document = self::get_combined_pdf_for_attempt($assignment, $userid, $attemptnumber);
|
|
|
|
$status = $document->get_status();
|
|
if ($status === combined_document::STATUS_FAILED) {
|
|
throw new \moodle_exception('Could not generate combined pdf.');
|
|
} else if ($status === combined_document::STATUS_PENDING_INPUT) {
|
|
// The conversion is still in progress.
|
|
return [];
|
|
}
|
|
|
|
$tmpdir = \make_temp_directory('assignfeedback_editpdf/pageimages/' . self::hash($assignment, $userid, $attemptnumber));
|
|
$combined = $tmpdir . '/' . self::COMBINED_PDF_FILENAME;
|
|
|
|
$document->get_combined_file()->copy_content_to($combined); // Copy the file.
|
|
|
|
$pdf = new pdf();
|
|
|
|
$pdf->set_image_folder($tmpdir);
|
|
$pagecount = $pdf->set_pdf($combined);
|
|
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
|
|
$record = new \stdClass();
|
|
$record->contextid = $assignment->get_context()->id;
|
|
$record->component = 'assignfeedback_editpdf';
|
|
$record->filearea = self::PAGE_IMAGE_FILEAREA;
|
|
$record->itemid = $grade->id;
|
|
$record->filepath = '/';
|
|
$fs = get_file_storage();
|
|
|
|
// Remove the existing content of the filearea.
|
|
$fs->delete_area_files($record->contextid, $record->component, $record->filearea, $record->itemid);
|
|
|
|
$files = array();
|
|
$images = $pdf->get_images();
|
|
for ($i = 0; $i < $pagecount; $i++) {
|
|
try {
|
|
if (empty($images[$i])) {
|
|
throw new \moodle_exception('error image');
|
|
}
|
|
$image = $images[$i];
|
|
if (!$resetrotation) {
|
|
$pagerotation = page_editor::get_page_rotation($grade->id, $i);
|
|
$degree = !empty($pagerotation) ? $pagerotation->degree : 0;
|
|
if ($degree != 0) {
|
|
$filepath = $tmpdir . '/' . $image;
|
|
$imageresource = imagecreatefrompng($filepath);
|
|
$content = imagerotate($imageresource, $degree, 0);
|
|
imagepng($content, $filepath);
|
|
}
|
|
}
|
|
} catch (\moodle_exception $e) {
|
|
// We catch only moodle_exception here as other exceptions indicate issue with setup not the pdf.
|
|
$image = pdf::get_error_image($tmpdir, $i);
|
|
}
|
|
$record->filename = basename($image);
|
|
$files[$i] = $fs->create_file_from_pathname($record, $tmpdir . '/' . $image);
|
|
@unlink($tmpdir . '/' . $image);
|
|
// Set page rotation default value.
|
|
if (!empty($files[$i])) {
|
|
if ($resetrotation) {
|
|
page_editor::set_page_rotation($grade->id, $i, false, $files[$i]->get_pathnamehash());
|
|
}
|
|
}
|
|
}
|
|
$pdf->Close(); // PDF loaded and never saved/outputted needs to be closed.
|
|
|
|
@unlink($combined);
|
|
@rmdir($tmpdir);
|
|
|
|
return $files;
|
|
}
|
|
|
|
/**
|
|
* This function returns a list of the page images from a pdf.
|
|
*
|
|
* The readonly version is different than the normal one. The readonly version contains a copy
|
|
* of the pages in the state they were when the PDF was annotated, by doing so we prevent the
|
|
* the pages that are displayed to change as soon as the submission changes.
|
|
*
|
|
* Though there is an edge case, if the PDF was annotated before MDL-45580, then it is possible
|
|
* that we do not find any readonly version of the pages. In that case, we will get the normal
|
|
* pages and copy them to the readonly area. This ensures that the pages will remain in that
|
|
* state until the submission is updated. When the normal files do not exist, we throw an exception
|
|
* because the readonly pages should only ever be displayed after a teacher has annotated the PDF,
|
|
* they would not exist until they do.
|
|
*
|
|
* @param int|\assign $assignment
|
|
* @param int $userid
|
|
* @param int $attemptnumber (-1 means latest attempt)
|
|
* @param bool $readonly If true, then we are requesting the readonly version.
|
|
* @return array(stored_file)
|
|
*/
|
|
public static function get_page_images_for_attempt($assignment, $userid, $attemptnumber, $readonly = false) {
|
|
global $DB;
|
|
|
|
$assignment = self::get_assignment_from_param($assignment);
|
|
|
|
if (!$assignment->can_view_submission($userid)) {
|
|
throw new \moodle_exception('nopermission');
|
|
}
|
|
|
|
if ($assignment->get_instance()->teamsubmission) {
|
|
$submission = $assignment->get_group_submission($userid, 0, false, $attemptnumber);
|
|
} else {
|
|
$submission = $assignment->get_user_submission($userid, false, $attemptnumber);
|
|
}
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
|
|
$contextid = $assignment->get_context()->id;
|
|
$component = 'assignfeedback_editpdf';
|
|
$itemid = $grade->id;
|
|
$filepath = '/';
|
|
$filearea = self::PAGE_IMAGE_FILEAREA;
|
|
|
|
$fs = get_file_storage();
|
|
|
|
// If we are after the readonly pages...
|
|
if ($readonly) {
|
|
$filearea = self::PAGE_IMAGE_READONLY_FILEAREA;
|
|
if ($fs->is_area_empty($contextid, $component, $filearea, $itemid)) {
|
|
// We have a problem here, we were supposed to find the files.
|
|
// Attempt to re-generate the pages from the combined images.
|
|
self::generate_page_images_for_attempt($assignment, $userid, $attemptnumber);
|
|
self::copy_pages_to_readonly_area($assignment, $grade);
|
|
}
|
|
}
|
|
|
|
$files = $fs->get_directory_files($contextid, $component, $filearea, $itemid, $filepath);
|
|
|
|
$pages = array();
|
|
$resetrotation = false;
|
|
if (!empty($files)) {
|
|
$first = reset($files);
|
|
$pagemodified = $first->get_timemodified();
|
|
// Check that we don't just have a single blank page. The hash of a blank page image can vary with
|
|
// the version of ghostscript used, so we need to examine the combined pdf it was generated from.
|
|
$blankpage = false;
|
|
if (!$readonly && count($files) == 1) {
|
|
$pdfarea = self::COMBINED_PDF_FILEAREA;
|
|
$pdfname = self::COMBINED_PDF_FILENAME;
|
|
if ($pdf = $fs->get_file($contextid, $component, $pdfarea, $itemid, $filepath, $pdfname)) {
|
|
// The combined pdf may have a different hash if it has been regenerated since the page
|
|
// image was created. However if this is the case the page image will be stale anyway.
|
|
if ($pdf->get_contenthash() == self::BLANK_PDF_HASH || $pagemodified < $pdf->get_timemodified()) {
|
|
$blankpage = true;
|
|
}
|
|
}
|
|
}
|
|
if (!$readonly && ($pagemodified < $submission->timemodified || $blankpage)) {
|
|
// Image files are stale, we need to regenerate them, except in readonly mode.
|
|
// We also need to remove the draft annotations and comments associated with this attempt.
|
|
$fs->delete_area_files($contextid, $component, $filearea, $itemid);
|
|
page_editor::delete_draft_content($itemid);
|
|
$files = array();
|
|
$resetrotation = true;
|
|
} else {
|
|
|
|
// Need to reorder the files following their name.
|
|
// because get_directory_files() return a different order than generate_page_images_for_attempt().
|
|
foreach ($files as $file) {
|
|
// Extract the page number from the file name image_pageXXXX.png.
|
|
preg_match('/page([\d]+)\./', $file->get_filename(), $matches);
|
|
if (empty($matches) or !is_numeric($matches[1])) {
|
|
throw new \coding_exception("'" . $file->get_filename()
|
|
. "' file hasn't the expected format filename: image_pageXXXX.png.");
|
|
}
|
|
$pagenumber = (int)$matches[1];
|
|
|
|
// Save the page in the ordered array.
|
|
$pages[$pagenumber] = $file;
|
|
}
|
|
ksort($pages);
|
|
}
|
|
}
|
|
|
|
// This should never happen, there should be a version of the pages available
|
|
// whenever we are requesting the readonly version.
|
|
if (empty($pages) && $readonly) {
|
|
throw new \moodle_exception('Could not find readonly pages for grade ' . $grade->id);
|
|
}
|
|
|
|
// There are two situations where the number of page images generated does not
|
|
// match the number of pages in the PDF:
|
|
//
|
|
// 1. The document conversion adhoc task was interrupted somehow (node died, solar flare, etc)
|
|
// 2. The submission has been updated by the student
|
|
//
|
|
// In the case of 1. we need to regenerate the pages, see MDL-66626.
|
|
// In the case of 2. we should do nothing, see MDL-45580.
|
|
//
|
|
// To differentiate between 1. and 2. we can check if the submission has been modified since the
|
|
// pages were generated. If it has, then we're in situation 2.
|
|
$totalpagesforattempt = self::page_number_for_attempt($assignment, $userid, $attemptnumber, false);
|
|
$submissionmodified = isset($pagemodified) && $submission->timemodified > $pagemodified;
|
|
if (empty($pages) || (count($pages) != $totalpagesforattempt && !$submissionmodified)) {
|
|
$pages = self::generate_page_images_for_attempt($assignment, $userid, $attemptnumber, $resetrotation);
|
|
}
|
|
|
|
return $pages;
|
|
}
|
|
|
|
/**
|
|
* This function returns sensible filename for a feedback file.
|
|
* @param int|\assign $assignment
|
|
* @param int $userid
|
|
* @param int $attemptnumber (-1 means latest attempt)
|
|
* @return string
|
|
*/
|
|
protected static function get_downloadable_feedback_filename($assignment, $userid, $attemptnumber) {
|
|
global $DB;
|
|
|
|
$assignment = self::get_assignment_from_param($assignment);
|
|
|
|
$groupmode = groups_get_activity_groupmode($assignment->get_course_module());
|
|
$groupname = '';
|
|
if ($groupmode) {
|
|
$groupid = groups_get_activity_group($assignment->get_course_module(), true);
|
|
$groupname = groups_get_group_name($groupid).'-';
|
|
}
|
|
if ($groupname == '-') {
|
|
$groupname = '';
|
|
}
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
$user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
|
|
|
|
if ($assignment->is_blind_marking()) {
|
|
$prefix = $groupname . get_string('participant', 'assign');
|
|
$prefix = str_replace('_', ' ', $prefix);
|
|
$prefix = clean_filename($prefix . '_' . $assignment->get_uniqueid_for_user($userid) . '_');
|
|
} else {
|
|
$prefix = $groupname . fullname($user);
|
|
$prefix = str_replace('_', ' ', $prefix);
|
|
$prefix = clean_filename($prefix . '_' . $assignment->get_uniqueid_for_user($userid) . '_');
|
|
}
|
|
$prefix .= $grade->attemptnumber;
|
|
|
|
return $prefix . '.pdf';
|
|
}
|
|
|
|
/**
|
|
* This function takes the combined pdf and embeds all the comments and annotations.
|
|
*
|
|
* This also moves the annotations and comments from drafts to not drafts. And it will
|
|
* copy all the images stored to the readonly area, so that they can be viewed online, and
|
|
* not be overwritten when a new submission is sent.
|
|
*
|
|
* @param int|\assign $assignment
|
|
* @param int $userid
|
|
* @param int $attemptnumber (-1 means latest attempt)
|
|
* @return \stored_file
|
|
*/
|
|
public static function generate_feedback_document($assignment, $userid, $attemptnumber) {
|
|
global $CFG;
|
|
|
|
$assignment = self::get_assignment_from_param($assignment);
|
|
|
|
if (!$assignment->can_view_submission($userid)) {
|
|
throw new \moodle_exception('nopermission');
|
|
}
|
|
if (!$assignment->can_grade()) {
|
|
throw new \moodle_exception('nopermission');
|
|
}
|
|
|
|
// Need to generate the page images - first get a combined pdf.
|
|
$document = self::get_combined_pdf_for_attempt($assignment, $userid, $attemptnumber);
|
|
|
|
$status = $document->get_status();
|
|
if ($status === combined_document::STATUS_FAILED) {
|
|
throw new \moodle_exception('Could not generate combined pdf.');
|
|
} else if ($status === combined_document::STATUS_PENDING_INPUT) {
|
|
// The conversion is still in progress.
|
|
return false;
|
|
}
|
|
|
|
$file = $document->get_combined_file();
|
|
|
|
$tmpdir = make_temp_directory('assignfeedback_editpdf/final/' . self::hash($assignment, $userid, $attemptnumber));
|
|
$combined = $tmpdir . '/' . self::COMBINED_PDF_FILENAME;
|
|
$file->copy_content_to($combined); // Copy the file.
|
|
|
|
$pdf = new pdf();
|
|
|
|
// Set fontname from course setting if it's enabled.
|
|
if (!empty($CFG->enablepdfexportfont)) {
|
|
$fontlist = $pdf->get_export_fontlist();
|
|
// Load font from course if it's more than 1.
|
|
if (count($fontlist) > 1) {
|
|
$course = $assignment->get_course();
|
|
if (!empty($course->pdfexportfont)) {
|
|
$pdf->set_export_font_name($course->pdfexportfont);
|
|
}
|
|
} else {
|
|
$pdf->set_export_font_name(current($fontlist));
|
|
}
|
|
}
|
|
|
|
$fs = get_file_storage();
|
|
$stamptmpdir = make_temp_directory('assignfeedback_editpdf/stamps/' . self::hash($assignment, $userid, $attemptnumber));
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
// Copy any new stamps to this instance.
|
|
if ($files = $fs->get_area_files($assignment->get_context()->id,
|
|
'assignfeedback_editpdf',
|
|
'stamps',
|
|
$grade->id,
|
|
"filename",
|
|
false)) {
|
|
foreach ($files as $file) {
|
|
$filename = $stamptmpdir . '/' . $file->get_filename();
|
|
$file->copy_content_to($filename); // Copy the file.
|
|
}
|
|
}
|
|
|
|
$pagecount = $pdf->set_pdf($combined);
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
page_editor::release_drafts($grade->id);
|
|
|
|
$allcomments = array();
|
|
|
|
for ($i = 0; $i < $pagecount; $i++) {
|
|
$pagerotation = page_editor::get_page_rotation($grade->id, $i);
|
|
$pagemargin = $pdf->getBreakMargin();
|
|
$autopagebreak = $pdf->getAutoPageBreak();
|
|
if (empty($pagerotation) || !$pagerotation->isrotated) {
|
|
$pdf->copy_page();
|
|
} else {
|
|
$rotatedimagefile = $fs->get_file_by_hash($pagerotation->pathnamehash);
|
|
if (empty($rotatedimagefile)) {
|
|
$pdf->copy_page();
|
|
} else {
|
|
$pdf->add_image_page($rotatedimagefile);
|
|
}
|
|
}
|
|
|
|
$comments = page_editor::get_comments($grade->id, $i, false);
|
|
$annotations = page_editor::get_annotations($grade->id, $i, false);
|
|
|
|
if (!empty($comments)) {
|
|
$allcomments[$i] = $comments;
|
|
}
|
|
|
|
foreach ($annotations as $annotation) {
|
|
$pdf->add_annotation($annotation->x,
|
|
$annotation->y,
|
|
$annotation->endx,
|
|
$annotation->endy,
|
|
$annotation->colour,
|
|
$annotation->type,
|
|
$annotation->path,
|
|
$stamptmpdir);
|
|
}
|
|
$pdf->SetAutoPageBreak($autopagebreak, $pagemargin);
|
|
$pdf->setPageMark();
|
|
}
|
|
|
|
if (!empty($allcomments)) {
|
|
// Append all comments to the end of the document.
|
|
$links = $pdf->append_comments($allcomments);
|
|
// Add the comment markers with links.
|
|
foreach ($allcomments as $pageno => $comments) {
|
|
foreach ($comments as $index => $comment) {
|
|
$pdf->add_comment_marker($comment->pageno, $index, $comment->x, $comment->y, $links[$pageno][$index],
|
|
$comment->colour);
|
|
}
|
|
}
|
|
}
|
|
|
|
fulldelete($stamptmpdir);
|
|
|
|
$filename = self::get_downloadable_feedback_filename($assignment, $userid, $attemptnumber);
|
|
$filename = clean_param($filename, PARAM_FILE);
|
|
|
|
$generatedpdf = $tmpdir . '/' . $filename;
|
|
$pdf->save_pdf($generatedpdf);
|
|
|
|
$record = new \stdClass();
|
|
|
|
$record->contextid = $assignment->get_context()->id;
|
|
$record->component = 'assignfeedback_editpdf';
|
|
$record->filearea = self::FINAL_PDF_FILEAREA;
|
|
$record->itemid = $grade->id;
|
|
$record->filepath = '/';
|
|
$record->filename = $filename;
|
|
|
|
// Only keep one current version of the generated pdf.
|
|
$fs->delete_area_files($record->contextid, $record->component, $record->filearea, $record->itemid);
|
|
|
|
$file = $fs->create_file_from_pathname($record, $generatedpdf);
|
|
|
|
// Cleanup.
|
|
@unlink($generatedpdf);
|
|
@unlink($combined);
|
|
@rmdir($tmpdir);
|
|
|
|
self::copy_pages_to_readonly_area($assignment, $grade);
|
|
|
|
return $file;
|
|
}
|
|
|
|
/**
|
|
* Copy the pages image to the readonly area.
|
|
*
|
|
* @param int|\assign $assignment The assignment.
|
|
* @param \stdClass $grade The grade record.
|
|
* @return void
|
|
*/
|
|
public static function copy_pages_to_readonly_area($assignment, $grade) {
|
|
$fs = get_file_storage();
|
|
$assignment = self::get_assignment_from_param($assignment);
|
|
$contextid = $assignment->get_context()->id;
|
|
$component = 'assignfeedback_editpdf';
|
|
$itemid = $grade->id;
|
|
|
|
// Get all the pages.
|
|
$originalfiles = $fs->get_area_files($contextid, $component, self::PAGE_IMAGE_FILEAREA, $itemid);
|
|
if (empty($originalfiles)) {
|
|
// Nothing to do here...
|
|
return;
|
|
}
|
|
|
|
// Delete the old readonly files.
|
|
$fs->delete_area_files($contextid, $component, self::PAGE_IMAGE_READONLY_FILEAREA, $itemid);
|
|
|
|
// Do the copying.
|
|
foreach ($originalfiles as $originalfile) {
|
|
$fs->create_file_from_storedfile(array('filearea' => self::PAGE_IMAGE_READONLY_FILEAREA), $originalfile);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This function returns the generated pdf (if it exists).
|
|
* @param int|\assign $assignment
|
|
* @param int $userid
|
|
* @param int $attemptnumber (-1 means latest attempt)
|
|
* @return \stored_file
|
|
*/
|
|
public static function get_feedback_document($assignment, $userid, $attemptnumber) {
|
|
|
|
$assignment = self::get_assignment_from_param($assignment);
|
|
|
|
if (!$assignment->can_view_submission($userid)) {
|
|
throw new \moodle_exception('nopermission');
|
|
}
|
|
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
|
|
$contextid = $assignment->get_context()->id;
|
|
$component = 'assignfeedback_editpdf';
|
|
$filearea = self::FINAL_PDF_FILEAREA;
|
|
$itemid = $grade->id;
|
|
$filepath = '/';
|
|
|
|
$fs = get_file_storage();
|
|
$files = $fs->get_area_files($contextid,
|
|
$component,
|
|
$filearea,
|
|
$itemid,
|
|
"itemid, filepath, filename",
|
|
false);
|
|
if ($files) {
|
|
return reset($files);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* This function deletes the generated pdf for a student.
|
|
* @param int|\assign $assignment
|
|
* @param int $userid
|
|
* @param int $attemptnumber (-1 means latest attempt)
|
|
* @return bool
|
|
*/
|
|
public static function delete_feedback_document($assignment, $userid, $attemptnumber) {
|
|
|
|
$assignment = self::get_assignment_from_param($assignment);
|
|
|
|
if (!$assignment->can_view_submission($userid)) {
|
|
throw new \moodle_exception('nopermission');
|
|
}
|
|
if (!$assignment->can_grade()) {
|
|
throw new \moodle_exception('nopermission');
|
|
}
|
|
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
|
|
$contextid = $assignment->get_context()->id;
|
|
$component = 'assignfeedback_editpdf';
|
|
$filearea = self::FINAL_PDF_FILEAREA;
|
|
$itemid = $grade->id;
|
|
|
|
$fs = get_file_storage();
|
|
return $fs->delete_area_files($contextid, $component, $filearea, $itemid);
|
|
}
|
|
|
|
/**
|
|
* Get All files in a File area
|
|
* @param int|\assign $assignment Assignment
|
|
* @param int $userid User ID
|
|
* @param int $attemptnumber Attempt Number
|
|
* @param string $filearea File Area
|
|
* @param string $filepath File Path
|
|
* @return array
|
|
*/
|
|
private static function get_files($assignment, $userid, $attemptnumber, $filearea, $filepath = '/') {
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
$itemid = $grade->id;
|
|
$contextid = $assignment->get_context()->id;
|
|
$component = self::COMPONENT;
|
|
$fs = get_file_storage();
|
|
$files = $fs->get_directory_files($contextid, $component, $filearea, $itemid, $filepath);
|
|
return $files;
|
|
}
|
|
|
|
/**
|
|
* Save file.
|
|
* @param int|\assign $assignment Assignment
|
|
* @param int $userid User ID
|
|
* @param int $attemptnumber Attempt Number
|
|
* @param string $filearea File Area
|
|
* @param string $newfilepath File Path
|
|
* @param string $storedfilepath stored file path
|
|
* @return \stored_file
|
|
* @throws \file_exception
|
|
* @throws \stored_file_creation_exception
|
|
*/
|
|
private static function save_file($assignment, $userid, $attemptnumber, $filearea, $newfilepath, $storedfilepath = '/') {
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
$itemid = $grade->id;
|
|
$contextid = $assignment->get_context()->id;
|
|
|
|
$record = new \stdClass();
|
|
$record->contextid = $contextid;
|
|
$record->component = self::COMPONENT;
|
|
$record->filearea = $filearea;
|
|
$record->itemid = $itemid;
|
|
$record->filepath = $storedfilepath;
|
|
$record->filename = basename($newfilepath);
|
|
|
|
$fs = get_file_storage();
|
|
|
|
$oldfile = $fs->get_file($record->contextid, $record->component, $record->filearea,
|
|
$record->itemid, $record->filepath, $record->filename);
|
|
|
|
if ($oldfile) {
|
|
$newhash = \file_storage::hash_from_path($newfilepath);
|
|
if ($newhash === $oldfile->get_contenthash()) {
|
|
// Use existing file if contenthash match.
|
|
return $oldfile;
|
|
}
|
|
// Delete existing file.
|
|
$oldfile->delete();
|
|
}
|
|
|
|
return $fs->create_file_from_pathname($record, $newfilepath);
|
|
}
|
|
|
|
/**
|
|
* This function rotate a page, and mark the page as rotated.
|
|
* @param int|\assign $assignment Assignment
|
|
* @param int $userid User ID
|
|
* @param int $attemptnumber Attempt Number
|
|
* @param int $index Index of Current Page
|
|
* @param bool $rotateleft To determine whether the page is rotated left or right.
|
|
* @return null|\stored_file return rotated File
|
|
* @throws \coding_exception
|
|
* @throws \file_exception
|
|
* @throws \moodle_exception
|
|
* @throws \stored_file_creation_exception
|
|
*/
|
|
public static function rotate_page($assignment, $userid, $attemptnumber, $index, $rotateleft) {
|
|
$assignment = self::get_assignment_from_param($assignment);
|
|
$grade = $assignment->get_user_grade($userid, true, $attemptnumber);
|
|
// Check permission.
|
|
if (!$assignment->can_view_submission($userid)) {
|
|
throw new \moodle_exception('nopermission');
|
|
}
|
|
|
|
$filearea = self::PAGE_IMAGE_FILEAREA;
|
|
$files = self::get_files($assignment, $userid, $attemptnumber, $filearea);
|
|
if (!empty($files)) {
|
|
foreach ($files as $file) {
|
|
preg_match('/' . pdf::IMAGE_PAGE . '([\d]+)\./', $file->get_filename(), $matches);
|
|
if (empty($matches) or !is_numeric($matches[1])) {
|
|
throw new \coding_exception("'" . $file->get_filename()
|
|
. "' file hasn't the expected format filename: image_pageXXXX.png.");
|
|
}
|
|
$pagenumber = (int)$matches[1];
|
|
|
|
if ($pagenumber == $index) {
|
|
$source = imagecreatefromstring($file->get_content());
|
|
$pagerotation = page_editor::get_page_rotation($grade->id, $index);
|
|
$degree = empty($pagerotation) ? 0 : $pagerotation->degree;
|
|
if ($rotateleft) {
|
|
$content = imagerotate($source, 90, 0);
|
|
$degree = ($degree + 90) % 360;
|
|
} else {
|
|
$content = imagerotate($source, -90, 0);
|
|
$degree = ($degree - 90) % 360;
|
|
}
|
|
$filename = $matches[0].'png';
|
|
$tmpdir = make_temp_directory(self::COMPONENT . '/' . self::PAGE_IMAGE_FILEAREA . '/'
|
|
. self::hash($assignment, $userid, $attemptnumber));
|
|
$tempfile = $tmpdir . '/' . time() . '_' . $filename;
|
|
imagepng($content, $tempfile);
|
|
|
|
$filearea = self::PAGE_IMAGE_FILEAREA;
|
|
$newfile = self::save_file($assignment, $userid, $attemptnumber, $filearea, $tempfile);
|
|
|
|
unlink($tempfile);
|
|
rmdir($tmpdir);
|
|
imagedestroy($source);
|
|
imagedestroy($content);
|
|
$file->delete();
|
|
if (!empty($newfile)) {
|
|
page_editor::set_page_rotation($grade->id, $pagenumber, true, $newfile->get_pathnamehash(), $degree);
|
|
}
|
|
return $newfile;
|
|
}
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Convert jpg file to pdf file
|
|
* @param int|\assign $assignment Assignment
|
|
* @param int $userid User ID
|
|
* @param int $attemptnumber Attempt Number
|
|
* @param \stored_file $file file to save
|
|
* @param null|array $size size of image
|
|
* @return \stored_file
|
|
* @throws \file_exception
|
|
* @throws \stored_file_creation_exception
|
|
*/
|
|
private static function save_jpg_to_pdf($assignment, $userid, $attemptnumber, $file, $size=null) {
|
|
// Temporary file.
|
|
$filename = $file->get_filename();
|
|
$tmpdir = make_temp_directory('assignfeedback_editpdf' . DIRECTORY_SEPARATOR
|
|
. self::TMP_JPG_TO_PDF_FILEAREA . DIRECTORY_SEPARATOR
|
|
. self::hash($assignment, $userid, $attemptnumber));
|
|
$tempfile = $tmpdir . DIRECTORY_SEPARATOR . $filename . ".pdf";
|
|
// Determine orientation.
|
|
$orientation = 'P';
|
|
if (!empty($size['width']) && !empty($size['height'])) {
|
|
if ($size['width'] > $size['height']) {
|
|
$orientation = 'L';
|
|
}
|
|
}
|
|
// Save JPG image to PDF file.
|
|
$pdf = new pdf();
|
|
$pdf->SetHeaderMargin(0);
|
|
$pdf->SetFooterMargin(0);
|
|
$pdf->SetMargins(0, 0, 0, true);
|
|
$pdf->setPrintFooter(false);
|
|
$pdf->setPrintHeader(false);
|
|
$pdf->setImageScale(PDF_IMAGE_SCALE_RATIO);
|
|
$pdf->AddPage($orientation);
|
|
$pdf->SetAutoPageBreak(false);
|
|
// Width has to be define here to fit into A4 page. Otherwise the image will be inserted with original size.
|
|
if ($orientation == 'P') {
|
|
$pdf->Image('@' . $file->get_content(), 0, 0, 210);
|
|
} else {
|
|
$pdf->Image('@' . $file->get_content(), 0, 0, 297);
|
|
}
|
|
$pdf->setPageMark();
|
|
$pdf->save_pdf($tempfile);
|
|
$filearea = self::TMP_JPG_TO_PDF_FILEAREA;
|
|
$pdffile = self::save_file($assignment, $userid, $attemptnumber, $filearea, $tempfile);
|
|
if (file_exists($tempfile)) {
|
|
unlink($tempfile);
|
|
rmdir($tmpdir);
|
|
}
|
|
return $pdffile;
|
|
}
|
|
|
|
/**
|
|
* Save rotated image data to file.
|
|
* @param int|\assign $assignment Assignment
|
|
* @param int $userid User ID
|
|
* @param int $attemptnumber Attempt Number
|
|
* @param resource $rotateddata image data to save
|
|
* @param string $filename name of the image file
|
|
* @return \stored_file
|
|
* @throws \file_exception
|
|
* @throws \stored_file_creation_exception
|
|
*/
|
|
private static function save_rotated_image_file($assignment, $userid, $attemptnumber, $rotateddata, $filename) {
|
|
$filearea = self::TMP_ROTATED_JPG_FILEAREA;
|
|
$tmpdir = make_temp_directory('assignfeedback_editpdf' . DIRECTORY_SEPARATOR
|
|
. $filearea . DIRECTORY_SEPARATOR
|
|
. self::hash($assignment, $userid, $attemptnumber));
|
|
$tempfile = $tmpdir . DIRECTORY_SEPARATOR . basename($filename);
|
|
imagejpeg($rotateddata, $tempfile);
|
|
$newfile = self::save_file($assignment, $userid, $attemptnumber, $filearea, $tempfile);
|
|
if (file_exists($tempfile)) {
|
|
unlink($tempfile);
|
|
rmdir($tmpdir);
|
|
}
|
|
return $newfile;
|
|
}
|
|
|
|
}
|