-
Notifications
You must be signed in to change notification settings - Fork 0
/
locallib.php
559 lines (496 loc) · 21.9 KB
/
locallib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
<?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 definition for the library class for PDF feedback plugin
*
*
* @package assignfeedback_exapdf
* @copyright 2012 Davo Smith
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
use \assignfeedback_exapdf\document_services;
use \assignfeedback_exapdf\page_editor;
use assignfeedback_exapdf\utils;
/**
* library class for exapdf feedback plugin extending feedback plugin base class
*
* @package assignfeedback_exapdf
* @copyright 2012 Davo Smith
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class assign_feedback_exapdf extends assign_feedback_plugin {
/** @var boolean|null $enabledcache Cached lookup of the is_enabled function */
private $enabledcache = null;
/**
* Get the name of the file feedback plugin
* @return string
*/
public function get_name() {
return get_string('pluginname', 'assignfeedback_exapdf');
}
/**
* Create a widget for rendering the editor.
*
* @param int $userid
* @param stdClass $grade
* @param bool $readonly
* @return assignfeedback_exapdf_widget
*/
public function get_widget($userid, $grade, $readonly) {
$attempt = -1;
if ($grade && isset($grade->attemptnumber)) {
$attempt = $grade->attemptnumber;
} else {
$grade = $this->assignment->get_user_grade($userid, true);
}
$feedbackfile = document_services::get_feedback_document(
$this->assignment->get_instance()->id,
$userid,
$attempt
);
$stampfiles = array();
$fs = get_file_storage();
$syscontext = context_system::instance();
$asscontext = $this->assignment->get_context();
// Three file areas are used for stamps.
// Current stamps are those configured as a site administration setting to be available for new uses.
// When a stamp is removed from this filearea it is no longer available for new grade items.
$currentstamps = $fs->get_area_files($syscontext->id, 'assignfeedback_exapdf', 'stamps', 0, 'filename', false);
// Grade stamps are those which have been assigned for a specific grade item.
// The stamps associated with a grade item are always used for that grade item, even if the stamp is removed
// from the list of current stamps.
$gradestamps = $fs->get_area_files($asscontext->id, 'assignfeedback_exapdf', 'stamps', $grade->id, 'filename', false);
// The system stamps are perpetual and always exist.
// They allow Moodle to serve a common URL for all users for any possible combination of stamps.
// Files in the perpetual stamp filearea are within the system context, in itemid 0, and use the original stamps
// contenthash as a folder name. This ensures that the combination of stamp filename, and stamp file content is
// unique.
$systemstamps = $fs->get_area_files($syscontext->id, 'assignfeedback_exapdf', '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;
}
}
foreach ($gradestamps as $stamp) {
// All gradestamps should be available in the systemstamps filearea, but some legacy stamps may not be.
// These need to be copied over.
// Note: This should ideally be performed as an upgrade step, but there may be other cases that these do not
// exist, for example restored backups.
// In any case this is a cheap operation as it is solely performing an array lookup.
$systempathnamehash = $this->get_system_stamp_path($stamp);
if (!array_key_exists($systempathnamehash, $systemstamps)) {
$filerecord = (object)[
'contextid' => $syscontext->id,
'itemid' => 0,
'filearea' => 'systemstamps',
'filepath' => '/' . $stamp->get_contenthash() . '/',
];
$systemstamp = $fs->create_file_from_storedfile($filerecord, $stamp);
$systemstamps[$systemstamp->get_pathnamehash()] = $systemstamp;
}
// 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(),
null,
$gradestamp->get_filepath(),
$gradestamp->get_filename(),
false
);
array_push($stampfiles, $url->out());
}
$url = false;
$filename = '';
if ($feedbackfile) {
$url = moodle_url::make_pluginfile_url(
$this->assignment->get_context()->id,
'assignfeedback_exapdf',
document_services::FINAL_PDF_FILEAREA,
$grade->id,
'/',
$feedbackfile->get_filename(),
false
);
$filename = $feedbackfile->get_filename();
}
$widget = new assignfeedback_exapdf_widget(
$this->assignment->get_instance()->id,
$userid,
$attempt,
$url,
$filename,
$stampfiles,
$readonly
);
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_exapdf',
'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_exapdf',
'stamps',
$gradeid,
$stamp->get_filepath(),
$stamp->get_filename()
);
}
/**
* Get form elements for grading form
*
* @param stdClass $grade
* @param MoodleQuickForm $mform
* @param stdClass $data
* @param int $userid
* @return bool true if elements were added to the form
*/
public function get_form_elements_for_user($grade, MoodleQuickForm $mform, stdClass $data, $userid) {
global $CFG;
$attempt = -1;
if ($grade) {
$attempt = $grade->attemptnumber;
}
// Links to download the generated pdf...
// if ($attempt > -1 && page_editor::has_annotations_or_comments($grade->id, false)) {
if ($attempt > -1) {
$html = $this->assignment->render_area_files('assignfeedback_exapdf',
document_services::FINAL_PDF_FILEAREA,
$grade->id);
$mform->addElement('static', 'exapdf_files', get_string('downloadfeedback', 'assignfeedback_editpdf'), $html);
}
$context = $this->assignment->get_context();
$combined_file = utils::get_combined_file($context, $grade);
$fileid = join('/', [$context->id, $grade->id, $combined_file->get_contenthash()]);
if ($_SERVER['HTTP_HOST'] == 'localhost') {
// local dev
$dakoraurl = 'http://dev.dakoraplus.eu:3000';
} else {
$dakoraurl = 'https://dakoraplus.eu/feature/exapdf';
}
$dakoraurl .= '/assignment-grading?fileid=' . $fileid . '&moodle_url=' . $CFG->wwwroot . '&do_login=1';
$data = [
'dakoraurl' => $dakoraurl,
'fileid' => $fileid,
];
$jscode = file_get_contents(__DIR__ . '/editor.js')
. 'load_dakora(' . json_encode($data) . ');';
global $PAGE;
$PAGE->requires->js('/mod/assign/feedback/exapdf/editor.js', true);
$PAGE->requires->js_init_code($jscode);
// $mform->addElement('static', 'exapdf', get_string('exapdf', 'assignfeedback_exapdf'), $html);
// $mform->addHelpButton('exapdf', 'exapdf', 'assignfeedback_exapdf');
// $mform->addElement('hidden', 'exapdf_source_userid', $userid);
// $mform->setType('exapdf_source_userid', PARAM_INT);
// $mform->setConstant('exapdf_source_userid', $userid);
}
/**
* Check to see if the grade feedback for the pdf has been modified.
*
* @param stdClass $grade Grade object.
* @param stdClass $data Data from the form submission (not used).
* @return boolean True if the pdf has been modified, else false.
*/
public function is_feedback_modified(stdClass $grade, stdClass $data) {
$contextid = $this->assignment->get_context()->id;
$fs = get_file_storage();
$annotated_file = current($fs->get_area_files($contextid, 'assignfeedback_exapdf', 'annotated', $grade->id, 'itemid', false));
$download_file = current($fs->get_area_files($contextid, 'assignfeedback_exapdf', document_services::FINAL_PDF_FILEAREA, $grade->id, 'itemid', false));
// annoated_file exists and no download file yet, or is newer than download_file
$modified = $annotated_file && (($download_file ? $annotated_file->get_timemodified() > $download_file->get_timemodified() : true));
return $modified;
// We only need to know if the source user's PDF has changed. If so then all
// following users will have the same status. If it's only an individual annotation
// then only one user will come through this method.
// Source user id is only added to the form if there was a pdf.
if (!empty($data->exapdf_source_userid)) {
$sourceuserid = $data->exapdf_source_userid;
// Retrieve the grade information for the source user.
$sourcegrade = $this->assignment->get_user_grade($sourceuserid, true, $grade->attemptnumber);
$pagenumbercount = document_services::page_number_for_attempt($this->assignment, $sourceuserid, $sourcegrade->attemptnumber);
for ($i = 0; $i < $pagenumbercount; $i++) {
// Select all annotations.
$draftannotations = page_editor::get_annotations($sourcegrade->id, $i, true);
$nondraftannotations = page_editor::get_annotations($grade->id, $i, false);
// Check to see if the count is the same.
if (count($draftannotations) != count($nondraftannotations)) {
// The count is different so we have a modification.
return true;
} else {
$matches = 0;
// Have a closer look and see if the draft files match all the non draft files.
foreach ($nondraftannotations as $ndannotation) {
foreach ($draftannotations as $dannotation) {
foreach ($ndannotation as $key => $value) {
// As the $draft was included in the class annotation,
// it is necessary to omit it in the condition below as well,
// otherwise, an error would be raised.
if ($key != 'id' && $key != 'draft' && $value != $dannotation->{$key}) {
continue 2;
}
}
$matches++;
}
}
if ($matches !== count($nondraftannotations)) {
return true;
}
}
// Select all comments.
$draftcomments = page_editor::get_comments($sourcegrade->id, $i, true);
$nondraftcomments = page_editor::get_comments($grade->id, $i, false);
if (count($draftcomments) != count($nondraftcomments)) {
return true;
} else {
// Go for a closer inspection.
$matches = 0;
foreach ($nondraftcomments as $ndcomment) {
foreach ($draftcomments as $dcomment) {
foreach ($ndcomment as $key => $value) {
// As the $draft was included in the class comment,
// it is necessary to omit it in the condition below as well,
// otherwise, an error would be raised.
if ($key != 'id' && $key != 'draft' && $value != $dcomment->{$key}) {
continue 2;
}
}
$matches++;
}
}
if ($matches !== count($nondraftcomments)) {
return true;
}
}
}
}
return false;
}
/**
* Generate the pdf.
*
* @param stdClass $grade
* @param stdClass $data
* @return bool
*/
public function save(stdClass $grade, stdClass $data) {
global $DB;
$contextid = $this->assignment->get_context()->id;
// first delete old files
$fs = get_file_storage();
$fs->delete_area_files($contextid, 'assignfeedback_exapdf', document_services::FINAL_PDF_FILEAREA, $grade->id);
$annotated_file = current($fs->get_area_files($contextid, 'assignfeedback_exapdf', 'annotated', $grade->id, 'itemid', false));
$user = $DB->get_record('user', ['id' => $grade->userid]);
if ($user) {
$filename = fullname($user) . '-Feedback.pdf';
} else {
$filename = 'Feedback.pdf';
}
$filerecord = (object)[
'filearea' => document_services::FINAL_PDF_FILEAREA,
'timecreated' => time(),
'timemodified' => time(),
'filepath' => '/',
'filename' => $filename,
];
$fs->create_file_from_storedfile($filerecord, $annotated_file);
return true;
// Source user id is only added to the form if there was a pdf.
if (!empty($data->editpdf_source_userid)) {
$sourceuserid = $data->editpdf_source_userid;
// Copy drafts annotations and comments if current user is different to sourceuserid.
if ($sourceuserid != $grade->userid) {
page_editor::copy_drafts_from_to($this->assignment, $grade, $sourceuserid);
}
}
if (page_editor::has_annotations_or_comments($grade->id, true)) {
document_services::generate_feedback_document($this->assignment, $grade->userid, $grade->attemptnumber);
}
return true;
}
/**
* Display the list of files in the feedback status table.
*
* @param stdClass $grade
* @param bool $showviewlink (Always set to false).
* @return string
*/
public function view_summary(stdClass $grade, &$showviewlink) {
$showviewlink = false;
return $this->view($grade);
}
/**
* Display the list of files in the feedback status table.
*
* @param stdClass $grade
* @return string
*/
public function view(stdClass $grade) {
$html = $this->assignment->render_area_files('assignfeedback_exapdf',
document_services::FINAL_PDF_FILEAREA,
$grade->id);
return $html;
global $PAGE;
$html = '';
// Show a link to download the pdf.
if (page_editor::has_annotations_or_comments($grade->id, false)) {
$html = $this->assignment->render_area_files('assignfeedback_exapdf',
document_services::FINAL_PDF_FILEAREA,
$grade->id);
// Also show the link to the read-only interface.
$renderer = $PAGE->get_renderer('assignfeedback_exapdf');
$widget = $this->get_widget($grade->userid, $grade, true);
$html .= $renderer->render($widget);
}
return $html;
}
/**
* Return true if there are no released comments/annotations.
*
* @param stdClass $grade
*/
public function is_empty(stdClass $grade) {
global $DB;
$comments = $DB->count_records('assignfeedback_editpdf_cmnt', array('gradeid' => $grade->id, 'draft' => 0));
$annotations = $DB->count_records('assignfeedback_editpdf_annot', array('gradeid' => $grade->id, 'draft' => 0));
return $comments == 0 && $annotations == 0;
}
/**
* The assignment has been deleted - remove the plugin specific data
*
* @return bool
*/
public function delete_instance() {
global $DB;
$grades = $DB->get_records('assign_grades', array('assignment' => $this->assignment->get_instance()->id), '', 'id');
if ($grades) {
list($gradeids, $params) = $DB->get_in_or_equal(array_keys($grades), SQL_PARAMS_NAMED);
$DB->delete_records_select('assignfeedback_exapdf_annot', 'gradeid ' . $gradeids, $params);
// $DB->delete_records_select('assignfeedback_editpdf_cmnt', 'gradeid ' . $gradeids, $params);
// $DB->delete_records_select('assignfeedback_exapdf_rot', 'gradeid ' . $gradeids, $params);
}
return true;
}
/**
* Determine if ghostscript is available and working.
*
* @return bool
*/
public function is_available() {
return true;
if ($this->enabledcache === null) {
$testpath = assignfeedback_exapdf\pdf::test_gs_path(false);
$this->enabledcache = ($testpath->status == assignfeedback_exapdf\pdf::GSPATH_OK);
}
return $this->enabledcache;
}
/**
* Prevent enabling this plugin if ghostscript is not available.
*
* @return bool false
*/
public function is_configurable() {
return $this->is_available();
}
/**
* Get file areas returns a list of areas this plugin stores files.
*
* @return array - An array of fileareas (keys) and descriptions (values)
*/
public function get_file_areas() {
return [
document_services::FINAL_PDF_FILEAREA => $this->get_name(),
document_services::COMBINED_PDF_FILEAREA => $this->get_name(),
document_services::PARTIAL_PDF_FILEAREA => $this->get_name(),
document_services::IMPORT_HTML_FILEAREA => $this->get_name(),
document_services::PAGE_IMAGE_FILEAREA => $this->get_name(),
document_services::PAGE_IMAGE_READONLY_FILEAREA => $this->get_name(),
document_services::STAMPS_FILEAREA => $this->get_name(),
document_services::TMP_JPG_TO_PDF_FILEAREA => $this->get_name(),
document_services::TMP_ROTATED_JPG_FILEAREA => $this->get_name(),
];
}
/**
* Get all file areas for user data related to this plugin.
*
* @return array - An array of user data fileareas (keys) and descriptions (values)
*/
public function get_user_data_file_areas(): array {
return [
document_services::FINAL_PDF_FILEAREA => $this->get_name(),
];
}
/**
* This plugin will inject content into the review panel with javascript.
* @return bool true
*/
public function supports_review_panel() {
return true;
}
/**
* Return the plugin configs for external functions.
*
* @return array the list of settings
* @since Moodle 3.2
*/
public function get_config_for_external() {
return (array)$this->get_config();
}
}