Gitlab CSE Unil

page_editor.php 17.6 KB
Newer Older
M. Chardon's avatar
init  
M. Chardon committed
1
<?php
2

M. Chardon's avatar
init  
M. Chardon committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// 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 editor class for the assignfeedback_editpdfplus plugin
 *
21
22
23
24
 * This class performs crud operations on comments and annotations from a page of a response.
 *
 * No capability checks are done - they should be done by the calling class.
 *
M. Chardon's avatar
init  
M. Chardon committed
25
 * @package   assignfeedback_editpdfplus
M. Chardon's avatar
GPL3    
M. Chardon committed
26
 * @copyright  2016 Université de Lausanne
27
 * The code is based on mod/assign/feedback/editpdf/classes/page_editor.php by Davo Smith
M. Chardon's avatar
init  
M. Chardon committed
28
29
30
31
32
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace assignfeedback_editpdfplus;

M. Chardon's avatar
M. Chardon committed
33
34
35
36
37
use assignfeedback_editpdfplus\bdd\type_tool;
use assignfeedback_editpdfplus\bdd\tool;
use assignfeedback_editpdfplus\bdd\tool_generic;
use assignfeedback_editpdfplus\bdd\axis;
use assignfeedback_editpdfplus\bdd\annotation;
38

M. Chardon's avatar
init  
M. Chardon committed
39
40
class page_editor {

41
42
43
44
45
46
    const BDDTABLEOOL = "assignfeedback_editpp_tool";
    const BDDTABLETOOLTYPE = "assignfeedback_editpp_typet";
    const BDDTABLEANNOTATION = "assignfeedback_editpp_annot";
    const CONTEXTID = "contextid";
    const GRADEID = "gradeid";
    const DRAFLIB = "draft";
M. Chardon's avatar
M. Chardon committed
47
    const AXISGENERIC = 0;
48

49
50
51
52
53
54
55
56
    /**
     * Get all tools for a page.
     * @param int $contextid
     * @param int $axis
     * @return tool[]
     */
    public static function get_tools($contextidlist) {
        global $DB;
57

M. Chardon's avatar
M. Chardon committed
58
59
60
61
62
63
        $typeToolsRaw = self::get_typetools(null);
        $typeTools = array();
        foreach ($typeToolsRaw as $typeTool) {
            $typeTools[$typeTool->id] = $typeTool;
        }

64
        $tools = array();
65
        if ($contextidlist) {
66
            $records = $DB->get_records_list(self::BDDTABLEOOL, self::CONTEXTID, $contextidlist);
67
        } else {
68
            $records = $DB->get_records(self::BDDTABLEOOL);
69
        }
70
        foreach ($records as $record) {
M. Chardon's avatar
M. Chardon committed
71
            $tooltmp = null;
M. Chardon's avatar
M. Chardon committed
72
            if ($record->axis == self::AXISGENERIC) {
M. Chardon's avatar
M. Chardon committed
73
74
75
76
77
78
                $tooltmp = new tool_generic($record);
            } else {
                $tooltmp = new tool($record);
            }
            $tooltmp->typeObject = $typeTools[$tooltmp->type];
            array_push($tools, $tooltmp);
79
        }
M. Chardon's avatar
M. Chardon committed
80
        usort($tools, function($a, $b) {
M. Chardon's avatar
M. Chardon committed
81
82
            $al = $a->order_tool;
            $bl = $b->order_tool;
M. Chardon's avatar
M. Chardon committed
83
84
85
86
87
            if ($al == $bl) {
                return 0;
            }
            return ($al > $bl) ? +1 : -1;
        });
88
        return $tools;
M. Chardon's avatar
init  
M. Chardon committed
89
90
    }

M. Chardon's avatar
M. Chardon committed
91
92
93
94
95
96
97
    /**
     * Get a single tool by id.
     * @param int $toolid
     * @return tool or false
     */
    public static function get_tool($toolid) {
        global $DB;
98
        $record = $DB->get_record(self::BDDTABLEOOL, array('id' => $toolid), '*', IGNORE_MISSING);
M. Chardon's avatar
M. Chardon committed
99
        if ($record) {
M. Chardon's avatar
M. Chardon committed
100
101
102
103
            $tool = new tool($record);
            $typetool = self::get_type_tool($tool->type);
            $tool->typeObject = $typetool;
            return $tool;
M. Chardon's avatar
M. Chardon committed
104
105
106
107
108
        }
        return false;
    }

    /**
109
     * Get the tool type with id tooltypeid.
M. Chardon's avatar
M. Chardon committed
110
111
112
113
114
     * @param int $tooltypeid
     * @return type_tool
     */
    public static function get_type_tool($tooltypeid) {
        global $DB;
115
        $record = $DB->get_record(self::BDDTABLETOOLTYPE, array('id' => $tooltypeid));
M. Chardon's avatar
M. Chardon committed
116
        if ($record) {
117
118
            $newTypeTool = new type_tool($record);
            return page_editor::custom_type_tool($newTypeTool);
M. Chardon's avatar
M. Chardon committed
119
120
121
122
        }
        return false;
    }

123
124
125
126
127
    /**
     * Get all the type tools.
     * @param array $contextidlist
     * @return type_tool
     */
M. Chardon's avatar
M. Chardon committed
128
129
130
131
    public static function get_typetools($contextidlist) {
        global $DB;
        $typetools = array();
        if ($contextidlist) {
132
            $records = $DB->get_records_list(self::BDDTABLETOOLTYPE, self::CONTEXTID, $contextidlist);
M. Chardon's avatar
M. Chardon committed
133
        } else {
134
            $records = $DB->get_records(self::BDDTABLETOOLTYPE);
M. Chardon's avatar
M. Chardon committed
135
136
        }
        foreach ($records as $record) {
137
138
            $newToolType = new type_tool($record);
            array_push($typetools, page_editor::custom_type_tool($newToolType));
M. Chardon's avatar
M. Chardon committed
139
140
141
142
        }
        return $typetools;
    }

M. Chardon's avatar
M. Chardon committed
143
    /**
144
145
     * Get all axis for contextid.
     * @param array $contextidlist optional
M. Chardon's avatar
M. Chardon committed
146
     * @return axis[]
M. Chardon's avatar
M. Chardon committed
147
148
149
150
151
     */
    public static function get_axis($contextidlist) {
        global $DB;
        $axis = array();
        if ($contextidlist) {
152
            $records = $DB->get_records_list('assignfeedback_editpp_axis', self::CONTEXTID, $contextidlist);
M. Chardon's avatar
M. Chardon committed
153
154
155
156
        } else {
            $records = $DB->get_records('assignfeedback_editpp_axis');
        }
        foreach ($records as $record) {
M. Chardon's avatar
M. Chardon committed
157
            array_push($axis, new axis($record));
M. Chardon's avatar
M. Chardon committed
158
159
        }
        usort($axis, function($a, $b) {
M. Chardon's avatar
M. Chardon committed
160
161
            $al = $a->order_axis;
            $bl = $b->order_axis;
M. Chardon's avatar
M. Chardon committed
162
163
164
165
166
167
168
169
            if ($al == $bl) {
                return 0;
            }
            return ($al > $bl) ? +1 : -1;
        });
        return $axis;
    }

M. Chardon's avatar
init  
M. Chardon committed
170
171
172
173
174
    /**
     * Get all annotations for a page.
     * @param int $gradeid
     * @param int $pageno
     * @param bool $draft
M. Chardon's avatar
M. Chardon committed
175
     * @return bdd\annotation[]
M. Chardon's avatar
init  
M. Chardon committed
176
177
178
179
     */
    public static function get_annotations($gradeid, $pageno, $draft) {
        global $DB;

180
        $params = array(self::GRADEID => $gradeid, 'pageno' => $pageno, self::DRAFLIB => 1);
M. Chardon's avatar
init  
M. Chardon committed
181
        if (!$draft) {
182
            $params[self::DRAFLIB] = 0;
M. Chardon's avatar
init  
M. Chardon committed
183
184
        }
        $annotations = array();
185
        $records = $DB->get_records(self::BDDTABLEANNOTATION, $params);
M. Chardon's avatar
init  
M. Chardon committed
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
        foreach ($records as $record) {
            array_push($annotations, new annotation($record));
        }

        return $annotations;
    }

    /**
     * Set all annotations for a page.
     * @param int $gradeid
     * @param int $pageno
     * @param annotation[] $annotations
     * @return int - the number of annotations.
     */
    public static function set_annotations($gradeid, $pageno, $annotations) {
        global $DB;

203
        $DB->delete_records(self::BDDTABLEANNOTATION, array(self::GRADEID => $gradeid, 'pageno' => $pageno, self::DRAFLIB => 1));
M. Chardon's avatar
init  
M. Chardon committed
204
        $added = 0;
205
        $annotationdiv = array();
M. Chardon's avatar
init  
M. Chardon committed
206
        foreach ($annotations as $record) {
207
208
209
210
211
212
            $currentdiv = $record->divcartridge;
            if ($record->parent_annot_div != '') {
                //on est dans le cas d'une annotation liee
                $idparent = $annotationdiv[$record->parent_annot_div];
                $record->parent_annot = intval($idparent);
            }
M. Chardon's avatar
init  
M. Chardon committed
213
214
215
216
217
218
219
220
221
            // Force these.
            if (!($record instanceof annotation)) {
                $annotation = new annotation($record);
            } else {
                $annotation = $record;
            }
            $annotation->gradeid = $gradeid;
            $annotation->pageno = $pageno;
            $annotation->draft = 1;
222
223
224
225
226
            $newid = self::add_annotation($annotation);
            if ($newid) {
                if ($currentdiv != '') {
                    $annotationdiv[$currentdiv] = $newid;
                }
M. Chardon's avatar
init  
M. Chardon committed
227
228
229
230
231
232
233
                $added++;
            }
        }

        return $added;
    }

234
235
236
237
238
239
240
    /**
     * Update a set of annotations to database
     * @global $DB
     * @param annotation[] $annotations
     * @return int number of rows updated
     */
    public static function update_annotations_status($annotations) {
241
242
243
244
        global $DB;
        $added = 0;
        foreach ($annotations as $recordtmp) {
            $record = page_editor::get_annotation($recordtmp->id);
245
            //$old = $record->studentstatus;
246
            $record->studentstatus = $recordtmp->studentstatus;
247
            $record->studentanswer = $recordtmp->studentanswer;
248
            //debugging($recordtmp->id . ' - ' . $record->id . ' - ' . $old . ' | ' . $recordtmp->studentstatus . ' - ' . $record->studentstatus . ' | ' . $recordtmp->studentanswer . ' - ' . $record->studentanswer);
249
            $DB->update_record(self::BDDTABLEANNOTATION, $record);
250
251
252
253
254
255
            $added++;
        }

        return $added;
    }

M. Chardon's avatar
init  
M. Chardon committed
256
257
258
259
260
261
262
263
    /**
     * Get a single annotation by id.
     * @param int $annotationid
     * @return annotation or false
     */
    public static function get_annotation($annotationid) {
        global $DB;

264
        $record = $DB->get_record(self::BDDTABLEANNOTATION, array('id' => $annotationid), '*', IGNORE_MISSING);
M. Chardon's avatar
init  
M. Chardon committed
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
        if ($record) {
            return new annotation($record);
        }
        return false;
    }

    /**
     * Unrelease drafts
     * @param int $gradeid
     * @return bool
     */
    public static function unrelease_drafts($gradeid) {
        global $DB;

        // Delete the non-draft annotations and comments.
M. Chardon's avatar
M. Chardon committed
280
        return $DB->delete_records(self::BDDTABLEANNOTATION, array(self::GRADEID => $gradeid, self::DRAFLIB => 0));
M. Chardon's avatar
init  
M. Chardon committed
281
282
283
284
285
286
287
288
289
290
291
    }

    /**
     * Release the draft comments and annotations to students.
     * @param int $gradeid
     * @return bool
     */
    public static function release_drafts($gradeid) {
        global $DB;

        // Delete the previous non-draft annotations and comments.
292
        $DB->delete_records(self::BDDTABLEANNOTATION, array(self::GRADEID => $gradeid, self::DRAFLIB => 0));
M. Chardon's avatar
init  
M. Chardon committed
293
294

        // Copy all the draft annotations and comments to non-drafts.
295
        $parentlink = [];
296
        $records = $DB->get_records(self::BDDTABLEANNOTATION, array(self::GRADEID => $gradeid, self::DRAFLIB => 1));
M. Chardon's avatar
init  
M. Chardon committed
297
        foreach ($records as $record) {
298
            $oldid = $record->id;
M. Chardon's avatar
init  
M. Chardon committed
299
300
            unset($record->id);
            $record->draft = 0;
301
302
303
304
            $oldparentrecord = $record->parent_annot;
            if ($record->parent_annot > 0) {
                $record->parent_annot = $parentlink[$record->parent_annot];
            }
305
            $newid = $DB->insert_record(self::BDDTABLEANNOTATION, $record);
306
            $parentlink[$oldid] = $newid;
M. Chardon's avatar
init  
M. Chardon committed
307
308
309
310
311
312
313
314
315
316
317
318
        }

        return true;
    }

    /**
     * Has annotations or comments.
     * @param int $gradeid
     * @return bool
     */
    public static function has_annotations_or_comments($gradeid, $includedraft) {
        global $DB;
319
        $params = array(self::GRADEID => $gradeid);
M. Chardon's avatar
init  
M. Chardon committed
320
        if (!$includedraft) {
321
            $params[self::DRAFLIB] = 0;
M. Chardon's avatar
init  
M. Chardon committed
322
        }
323
        if ($DB->count_records(self::BDDTABLEANNOTATION, $params)) {
M. Chardon's avatar
init  
M. Chardon committed
324
325
326
327
328
329
330
331
332
333
334
335
336
337
            return true;
        }
        return false;
    }

    /**
     * Aborts all draft annotations and reverts to the last version released to students.
     * @param int $gradeid
     * @return bool
     */
    public static function revert_drafts($gradeid) {
        global $DB;

        // Delete the previous non-draft annotations and comments.
338
        $DB->delete_records(self::BDDTABLEANNOTATION, array(self::GRADEID => $gradeid, self::DRAFLIB => 1));
M. Chardon's avatar
init  
M. Chardon committed
339
340

        // Copy all the draft annotations and comments to non-drafts.
341
        $records = $DB->get_records(self::BDDTABLEANNOTATION, array(self::GRADEID => $gradeid, self::DRAFLIB => 0));
M. Chardon's avatar
init  
M. Chardon committed
342
343
344
        foreach ($records as $record) {
            unset($record->id);
            $record->draft = 0;
345
            $DB->insert_record(self::BDDTABLEANNOTATION, $record);
M. Chardon's avatar
init  
M. Chardon committed
346
347
348
349
350
351
352
353
354
355
356
357
358
359
        }

        return true;
    }

    /**
     * Add a annotation to a page.
     * @param annotation $annotation
     * @return bool
     */
    public static function add_annotation(annotation $annotation) {
        global $DB;

        $annotation->id = null;
360
361
362
        if ($annotation->parent_annot == 0) {
            $annotation->parent_annot = null;
        }
363
        return $DB->insert_record(self::BDDTABLEANNOTATION, $annotation);
M. Chardon's avatar
init  
M. Chardon committed
364
365
366
367
368
369
370
371
372
373
    }

    /**
     * Remove a annotation from a page.
     * @param int $annotationid
     * @return bool
     */
    public static function remove_annotation($annotationid) {
        global $DB;

374
        return $DB->delete_records(self::BDDTABLEANNOTATION, array('id' => $annotationid));
M. Chardon's avatar
init  
M. Chardon committed
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
    }

    /**
     * Copy annotations, comments, pages, and other required content from the source user to the current group member
     * being procssed when using applytoall.
     *
     * @param int|\assign $assignment
     * @param stdClass $grade
     * @param int $sourceuserid
     * @return bool
     */
    public static function copy_drafts_from_to($assignment, $grade, $sourceuserid) {
        global $DB;

        // Delete any existing annotations and comments from current user.
390
        $DB->delete_records(self::BDDTABLEANNOTATION, array(self::GRADEID => $grade->id));
M. Chardon's avatar
init  
M. Chardon committed
391
392
        // Get gradeid, annotations and comments from sourceuserid.
        $sourceusergrade = $assignment->get_user_grade($sourceuserid, true, $grade->attemptnumber);
393
        $annotations = $DB->get_records(self::BDDTABLEANNOTATION, array(self::GRADEID => $sourceusergrade->id, self::DRAFLIB => 1));
M. Chardon's avatar
init  
M. Chardon committed
394
395
396
397
398
399
        $contextid = $assignment->get_context()->id;
        $sourceitemid = $sourceusergrade->id;

        // Add annotations and comments to current user to generate feedback file.
        foreach ($annotations as $annotation) {
            $annotation->gradeid = $grade->id;
400
            $DB->insert_record(self::BDDTABLEANNOTATION, $annotation);
M. Chardon's avatar
init  
M. Chardon committed
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
        }

        $fs = get_file_storage();

        // Copy the stamp files.
        self::replace_files_from_to($fs, $contextid, $sourceitemid, $grade->id, document_services::STAMPS_FILEAREA, true);

        // Copy the PAGE_IMAGE_FILEAREA files.
        self::replace_files_from_to($fs, $contextid, $sourceitemid, $grade->id, document_services::PAGE_IMAGE_FILEAREA);

        return true;
    }

    /**
     * Replace the area files in the specified area with those in the source item id.
     *
     * @param \file_storage $fs The file storage class
     * @param int $contextid The ID of the context for the assignment.
     * @param int $sourceitemid The itemid to copy from - typically the source grade id.
     * @param int $itemid The itemid to copy to - typically the target grade id.
     * @param string $area The file storage area.
     * @param bool $includesubdirs Whether to copy the content of sub-directories too.
     */
    public static function replace_files_from_to($fs, $contextid, $sourceitemid, $itemid, $area, $includesubdirs = false) {
        $component = 'assignfeedback_editpdfplus';
        // Remove the existing files within this area.
        $fs->delete_area_files($contextid, $component, $area, $itemid);

        // Copy the files from the source area.
430
        if ($files = $fs->get_area_files($contextid, $component, $area, $sourceitemid, "filename", $includesubdirs)) {
M. Chardon's avatar
init  
M. Chardon committed
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
            foreach ($files as $file) {
                $newrecord = new \stdClass();
                $newrecord->contextid = $contextid;
                $newrecord->itemid = $itemid;
                $fs->create_file_from_storedfile($newrecord, $file);
            }
        }
    }

    /**
     * Delete the draft annotations and comments.
     *
     * This is intended to be used when the version of the PDF has changed and the annotations
     * might not be relevant any more, therefore we should delete them.
     *
     * @param int $gradeid The grade ID.
     * @return bool
     */
    public static function delete_draft_content($gradeid) {
        global $DB;
451
452
        $conditions = array(self::GRADEID => $gradeid, self::DRAFLIB => 1);
        $result = $DB->delete_records(self::BDDTABLEANNOTATION, $conditions);
M. Chardon's avatar
init  
M. Chardon committed
453
454
        return $result;
    }
455

456
457
458
459
460
461
462
463
464
    /**
     * Get the feedback comment from the database.
     *
     * @param int $gradeid
     * @return stdClass|false The feedback comments for the given grade if it exists.
     *                        False if it doesn't.
     */
    public function get_feedback_comments($gradeid) {
        global $DB;
465
        return $DB->get_record('assignfeedback_comments', array('grade' => $gradeid));
466
467
    }

468
469
470
471
    public static function custom_type_tool(type_tool $newToolType) {
        global $CFG;
        switch ($newToolType->label) {
            case 'highlightplus':
472
473
474
475
                $newToolType->setColor($CFG->highlightplus_color);
                $newToolType->setCartridgeColor($CFG->highlightplus_cartridge_color);
                $newToolType->setCartridgeX($CFG->highlightplus_cartridge_x);
                $newToolType->setCartridgeY($CFG->highlightplus_cartridge_y);
476
477
478
                break;

            case 'stampplus':
479
                $newToolType->setColor($CFG->stampplus_color);
480
481
482
                break;

            case 'frame':
483
484
                $newToolType->setCartridgeX($CFG->frame_cartridge_x);
                $newToolType->setCartridgeY($CFG->frame_cartridge_y);
485
486
487
                break;

            case 'verticalline':
488
489
490
491
                $newToolType->setColor($CFG->verticalline_color);
                $newToolType->setCartridgeColor($CFG->verticalline_cartridge_color);
                $newToolType->setCartridgeX($CFG->verticalline_cartridge_x);
                $newToolType->setCartridgeY($CFG->verticalline_cartridge_y);
492
493
494
                break;

            case 'stampcomment':
495
496
497
                $newToolType->setCartridgeColor($CFG->stampcomment_cartridge_color);
                $newToolType->setCartridgeX($CFG->stampcomment_cartridge_x);
                $newToolType->setCartridgeY($CFG->stampcomment_cartridge_y);
498
499
500
                break;

            case 'commentplus':
501
502
503
                $newToolType->setCartridgeColor($CFG->commentplus_cartridge_color);
                $newToolType->setCartridgeX($CFG->commentplus_cartridge_x);
                $newToolType->setCartridgeY($CFG->commentplus_cartridge_y);
504
505
506
507
508
509
510
511
                break;

            default:
                break;
        }
        return $newToolType;
    }

M. Chardon's avatar
init  
M. Chardon committed
512
}