Gitlab CSE Unil

pdf.php 29.1 KB
Newer Older
M. Chardon's avatar
init  
M. Chardon committed
1
<?php
M. Chardon's avatar
M. Chardon committed
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
21
22
23
24
25
26
27
28
29
30
// 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/>.

/**
 * Library code for manipulating PDFs
 *
 * @package assignfeedback_editpdfplus
 * @copyright 2012 Davo Smith
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace assignfeedback_editpdfplus;

defined('MOODLE_INTERNAL') || die();

global $CFG;
M. Chardon's avatar
M. Chardon committed
31
32
require_once($CFG->libdir . '/pdflib.php');
require_once($CFG->dirroot . '/mod/assign/feedback/editpdf/fpdi/fpdi.php');
M. Chardon's avatar
init  
M. Chardon committed
33
34
35
36
37
38
39
40
41
42
43
44

/**
 * Library code for manipulating PDFs
 *
 * @package assignfeedback_editpdfplus
 * @copyright 2012 Davo Smith
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class pdf extends \FPDI {

    /** @var int the number of the current page in the PDF being processed */
    protected $currentpage = 0;
M. Chardon's avatar
M. Chardon committed
45

M. Chardon's avatar
init  
M. Chardon committed
46
47
    /** @var int the total number of pages in the PDF being processed */
    protected $pagecount = 0;
M. Chardon's avatar
M. Chardon committed
48

M. Chardon's avatar
init  
M. Chardon committed
49
50
    /** @var float used to scale the pixel position of annotations (in the database) to the position in the final PDF */
    protected $scale = 0.0;
M. Chardon's avatar
M. Chardon committed
51

M. Chardon's avatar
init  
M. Chardon committed
52
53
    /** @var string the path in which to store generated page images */
    protected $imagefolder = null;
M. Chardon's avatar
M. Chardon committed
54

M. Chardon's avatar
init  
M. Chardon committed
55
56
57
58
59
    /** @var string the path to the PDF currently being processed */
    protected $filename = null;

    /** No errors */
    const GSPATH_OK = 'ok';
M. Chardon's avatar
M. Chardon committed
60

M. Chardon's avatar
init  
M. Chardon committed
61
62
    /** Not set */
    const GSPATH_EMPTY = 'empty';
M. Chardon's avatar
M. Chardon committed
63

M. Chardon's avatar
init  
M. Chardon committed
64
65
    /** Does not exist */
    const GSPATH_DOESNOTEXIST = 'doesnotexist';
M. Chardon's avatar
M. Chardon committed
66

M. Chardon's avatar
init  
M. Chardon committed
67
68
    /** Is a dir */
    const GSPATH_ISDIR = 'isdir';
M. Chardon's avatar
M. Chardon committed
69

M. Chardon's avatar
init  
M. Chardon committed
70
71
    /** Not executable */
    const GSPATH_NOTEXECUTABLE = 'notexecutable';
M. Chardon's avatar
M. Chardon committed
72

M. Chardon's avatar
init  
M. Chardon committed
73
74
    /** Test file missing */
    const GSPATH_NOTESTFILE = 'notestfile';
M. Chardon's avatar
M. Chardon committed
75

M. Chardon's avatar
init  
M. Chardon committed
76
77
    /** Any other error */
    const GSPATH_ERROR = 'error';
M. Chardon's avatar
M. Chardon committed
78

M. Chardon's avatar
init  
M. Chardon committed
79
80
    /** Min. width an annotation should have */
    const MIN_ANNOTATION_WIDTH = 5;
M. Chardon's avatar
M. Chardon committed
81

M. Chardon's avatar
init  
M. Chardon committed
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
    /** Min. height an annotation should have */
    const MIN_ANNOTATION_HEIGHT = 5;

    /**
     * Combine the given PDF files into a single PDF. Optionally add a coversheet and coversheet fields.
     * @param string[] $pdflist  the filenames of the files to combine
     * @param string $outfilename the filename to write to
     * @return int the number of pages in the combined PDF
     */
    public function combine_pdfs($pdflist, $outfilename) {

        raise_memory_limit(MEMORY_EXTRA);
        $olddebug = error_reporting(0);

        $this->setPageUnit('pt');
        $this->setPrintHeader(false);
        $this->setPrintFooter(false);
        $this->scale = 72.0 / 100.0;
        $this->SetFont('helvetica', '', 16.0 * $this->scale);
        $this->SetTextColor(0, 0, 0);

        $totalpagecount = 0;

        foreach ($pdflist as $file) {
            $pagecount = $this->setSourceFile($file);
            $totalpagecount += $pagecount;
M. Chardon's avatar
M. Chardon committed
108
            for ($i = 1; $i <= $pagecount; $i++) {
M. Chardon's avatar
init  
M. Chardon committed
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
                $this->create_page_from_source($i);
            }
        }

        $this->save_pdf($outfilename);
        error_reporting($olddebug);

        return $totalpagecount;
    }

    /**
     * The number of the current page in the PDF being processed
     * @return int
     */
    public function current_page() {
        return $this->currentpage;
    }

    /**
     * The total number of pages in the PDF being processed
     * @return int
     */
    public function page_count() {
        return $this->pagecount;
    }

    /**
     * Load the specified PDF and set the initial output configuration
     * Used when processing comments and outputting a new PDF
     * @param string $filename the path to the PDF to load
     * @return int the number of pages in the PDF
     */
    public function load_pdf($filename) {
        raise_memory_limit(MEMORY_EXTRA);
        $olddebug = error_reporting(0);

        $this->setPageUnit('pt');
        $this->scale = 72.0 / 100.0;
        $this->SetFont('helvetica', '', 16.0 * $this->scale);
        $this->SetFillColor(255, 255, 176);
        $this->SetDrawColor(0, 0, 0);
        $this->SetLineWidth(1.0 * $this->scale);
        $this->SetTextColor(0, 0, 0);
        $this->setPrintHeader(false);
        $this->setPrintFooter(false);
        $this->pagecount = $this->setSourceFile($filename);
        $this->filename = $filename;

        error_reporting($olddebug);
        return $this->pagecount;
    }

    /**
     * Sets the name of the PDF to process, but only loads the file if the
     * pagecount is zero (in order to count the number of pages)
     * Used when generating page images (but not a new PDF)
     * @param string $filename the path to the PDF to process
     * @param int $pagecount optional the number of pages in the PDF, if known
     * @return int the number of pages in the PDF
     */
    public function set_pdf($filename, $pagecount = 0) {
        if ($pagecount == 0) {
            return $this->load_pdf($filename);
        } else {
            $this->filename = $filename;
            $this->pagecount = $pagecount;
            return $pagecount;
        }
    }

    /**
     * Copy the next page from the source file and set it as the current page
     * @return bool true if successful
     */
    public function copy_page() {
        if (!$this->filename) {
            return false;
        }
M. Chardon's avatar
M. Chardon committed
187
        if ($this->currentpage >= $this->pagecount) {
M. Chardon's avatar
init  
M. Chardon committed
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
            return false;
        }
        $this->currentpage++;
        $this->create_page_from_source($this->currentpage);
        return true;
    }

    /**
     * Create a page from a source PDF.
     *
     * @param int $pageno
     */
    protected function create_page_from_source($pageno) {
        // Get the size (and deduce the orientation) of the next page.
        $template = $this->importPage($pageno);
        $size = $this->getTemplateSize($template);
        $orientation = 'P';
        if ($size['w'] > $size['h']) {
            $orientation = 'L';
        }
        // Create a page of the required size / orientation.
        $this->AddPage($orientation, array($size['w'], $size['h']));
        // Prevent new page creation when comments are at the bottom of a page.
        $this->setPageOrientation($orientation, false, 0);
        // Fill in the page with the original contents from the student.
        $this->useTemplate($template);
    }

    /**
     * Copy all the remaining pages in the file
     */
    public function copy_remaining_pages() {
        $morepages = true;
        while ($morepages) {
            $morepages = $this->copy_page();
        }
    }

    /**
     * Add a comment to the current page
     * @param string $text the text of the comment
     * @param int $x the x-coordinate of the comment (in pixels)
     * @param int $y the y-coordinate of the comment (in pixels)
     * @param int $width the width of the comment (in pixels)
     * @param string $colour optional the background colour of the comment (red, yellow, green, blue, white, clear)
     * @return bool true if successful (always)
     */
    public function add_comment($text, $x, $y, $width, $colour = 'yellow') {
        if (!$this->filename) {
            return false;
        }
        $this->SetDrawColor(51, 51, 51);
        switch ($colour) {
            case 'red':
                $this->SetFillColor(249, 181, 179);
                break;
            case 'green':
                $this->SetFillColor(214, 234, 178);
                break;
            case 'blue':
                $this->SetFillColor(203, 217, 237);
                break;
            case 'white':
                $this->SetFillColor(255, 255, 255);
                break;
            default: /* Yellow */
                $this->SetFillColor(255, 236, 174);
                break;
        }

        $x *= $this->scale;
        $y *= $this->scale;
        $width *= $this->scale;
        $text = str_replace('&lt;', '<', $text);
        $text = str_replace('&gt;', '>', $text);
        // Draw the text with a border, but no background colour (using a background colour would cause the fill to
        // appear behind any existing content on the page, hence the extra filled rectangle drawn below).
        $this->MultiCell($width, 1.0, $text, 0, 'L', 0, 4, $x, $y); /* width, height, text, border, justify, fill, ln, x, y */
        if ($colour != 'clear') {
            $newy = $this->GetY();
            // Now we know the final size of the comment, draw a rectangle with the background colour.
            $this->Rect($x, $y, $width, $newy - $y, 'DF');
            // Re-draw the text over the top of the background rectangle.
            $this->MultiCell($width, 1.0, $text, 0, 'L', 0, 4, $x, $y); /* width, height, text, border, justify, fill, ln, x, y */
        }
        return true;
    }

276
    private function get_colour_for_pdf($colour) {
M. Chardon's avatar
M. Chardon committed
277
        if (substr($colour, 0, 1) == '#') {
278
            $colourarray = $this->hex2RGB($colour, false);
M. Chardon's avatar
M. Chardon committed
279
280
        } else {
            switch ($colour) {
281
282
283
                case 'orange':
                    $colourarray = array(255, 207, 53);
                    break;
M. Chardon's avatar
M. Chardon committed
284
285
286
                case 'yellow':
                    $colourarray = array(255, 207, 53);
                    break;
287
288
289
                case 'yellowlemon':
                    $colourarray = array(255, 255, 0);
                    break;
M. Chardon's avatar
M. Chardon committed
290
291
292
293
294
295
296
297
298
299
300
301
                case 'green':
                    $colourarray = array(153, 202, 62);
                    break;
                case 'blue':
                    $colourarray = array(125, 159, 211);
                    break;
                case 'white':
                    $colourarray = array(255, 255, 255);
                    break;
                case 'black':
                    $colourarray = array(51, 51, 51);
                    break;
302
                default:
M. Chardon's avatar
M. Chardon committed
303
304
305
                    $colourarray = array(239, 69, 64);
                    break;
            }
M. Chardon's avatar
init  
M. Chardon committed
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
        return $colourarray;
    }

    /**
     * Convert a hexa decimal color code to its RGB equivalent
     *
     * @param string $hexStr (hexadecimal color value)
     * @param boolean $returnAsString (if set true, returns the value separated by the separator character. Otherwise returns associative array)
     * @param string $seperator (to separate RGB values. Applicable only if second parameter is true.)
     * @return array or string (depending on second parameter. Returns False if invalid hex color value)
     */
    private function hex2RGB($hexStr, $returnAsString = false, $seperator = ',') {
        $hexStr = preg_replace("/[^0-9A-Fa-f]/", '', $hexStr); // Gets a proper hex string
        $rgbArray = array();
        if (strlen($hexStr) == 6) { //If a proper hex code, convert using bitwise operation. No overhead... faster
            $colorVal = hexdec($hexStr);
            $rgbArray['red'] = 0xFF & ($colorVal >> 0x10);
            $rgbArray['green'] = 0xFF & ($colorVal >> 0x8);
            $rgbArray['blue'] = 0xFF & $colorVal;
        } elseif (strlen($hexStr) == 3) { //if shorthand notation, need some string manipulations
            $rgbArray['red'] = hexdec(str_repeat(substr($hexStr, 0, 1), 2));
            $rgbArray['green'] = hexdec(str_repeat(substr($hexStr, 1, 1), 2));
            $rgbArray['blue'] = hexdec(str_repeat(substr($hexStr, 2, 1), 2));
        } else {
            return false; //Invalid hex color code
        }
        return $returnAsString ? implode($seperator, $rgbArray) : $rgbArray; // returns the rgb string or the associative array
    }

    /**
     * Add an annotation to the current page
     * @param int $sx starting x-coordinate (in pixels)
     * @param int $sy starting y-coordinate (in pixels)
     * @param int $ex ending x-coordinate (in pixels)
     * @param int $ey ending y-coordinate (in pixels)
     * @param string $colour optional the colour of the annotation (red, yellow, green, blue, white, black)
     * @param string $type optional the type of annotation (line, oval, rectangle, highlight, pen, stamp)
     * @param int[]|string $path optional for 'pen' annotations this is an array of x and y coordinates for
     *              the line, for 'stamp' annotations it is the name of the stamp file (without the path)
     * @param string $imagefolder - Folder containing stamp images.
     * @return bool true if successful (always)
     */
    public function add_annotation(annotation $annotation, $path, $imagefolder,$annotation_index) {
        global $CFG;
        if (!$this->filename) {
            return false;
        }
        $colour = $annotation->colour;
        $colourarray = $this->get_colour_for_pdf($colour);
M. Chardon's avatar
init  
M. Chardon committed
356
357
        $this->SetDrawColorArray($colourarray);

M. Chardon's avatar
M. Chardon committed
358
359
360
361
        $sx = $this->scale * $annotation->x;
        $sy = $this->scale * $annotation->y;
        $ex = $this->scale * $annotation->endx;
        $ey = $this->scale * $annotation->endy;
M. Chardon's avatar
init  
M. Chardon committed
362

363
        $this->SetLineWidth(2.0 * $this->scale);
M. Chardon's avatar
M. Chardon committed
364
365
366
367
368
        //$type = 'line';
        $toolid = $annotation->toolid;
        $toolObject = page_editor::get_tool($toolid);
        $typetool = page_editor::get_type_tool($toolObject->type);
        $type = $typetool->label;
369
370
371
372
373
374
375
376
        $colourcartridge = $toolObject->cartridge_color;
        if (!$colourcartridge) {
            $colourcartridge = $typetool->cartridge_color;
        }
        $colourcartridgearray = $this->get_colour_for_pdf($colourcartridge);
        $this->SetTextColorArray($colourcartridgearray);
        $this->SetFontSize(10);

M. Chardon's avatar
init  
M. Chardon committed
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
        switch ($type) {
            case 'oval':
                $rx = abs($sx - $ex) / 2;
                $ry = abs($sy - $ey) / 2;
                $sx = min($sx, $ex) + $rx;
                $sy = min($sy, $ey) + $ry;

                // $rx and $ry should be >= min width and height
                if ($rx < self::MIN_ANNOTATION_WIDTH) {
                    $rx = self::MIN_ANNOTATION_WIDTH;
                }
                if ($ry < self::MIN_ANNOTATION_HEIGHT) {
                    $ry = self::MIN_ANNOTATION_HEIGHT;
                }

                $this->Ellipse($sx, $sy, $rx, $ry);
                break;
            case 'rectangle':
                $w = abs($sx - $ex);
                $h = abs($sy - $ey);
                $sx = min($sx, $ex);
                $sy = min($sy, $ey);

                // Width or height should be >= min width and height
                if ($w < self::MIN_ANNOTATION_WIDTH) {
                    $w = self::MIN_ANNOTATION_WIDTH;
                }
                if ($h < self::MIN_ANNOTATION_HEIGHT) {
                    $h = self::MIN_ANNOTATION_HEIGHT;
                }
                $this->Rect($sx, $sy, $w, $h);
                break;
            case 'highlight':
                $w = abs($sx - $ex);
                $h = 8.0 * $this->scale;
                $sx = min($sx, $ex);
                $sy = min($sy, $ey) + ($h * 0.5);
                $this->SetAlpha(0.5, 'Normal', 0.5, 'Normal');
                $this->SetLineWidth(8.0 * $this->scale);

                // width should be >= min width
                if ($w < self::MIN_ANNOTATION_WIDTH) {
                    $w = self::MIN_ANNOTATION_WIDTH;
                }

                $this->Rect($sx, $sy, $w, $h);
                $this->SetAlpha(1.0, 'Normal', 1.0, 'Normal');
                break;
            case 'pen':
                if ($path) {
                    $scalepath = array();
                    $points = preg_split('/[,:]/', $path);
                    foreach ($points as $point) {
                        $scalepath[] = intval($point) * $this->scale;
                    }

                    if (!empty($scalepath)) {
                        $this->PolyLine($scalepath, 'S');
                    }
                }
                break;
            case 'stamp':
                $imgfile = $imagefolder . '/' . clean_filename($path);
                $w = abs($sx - $ex);
                $h = abs($sy - $ey);
                $sx = min($sx, $ex);
                $sy = min($sy, $ey);

                // Stamp is always more than 40px, so no need to check width/height.
                $this->Image($imgfile, $sx, $sy, $w, $h);
                break;
M. Chardon's avatar
M. Chardon committed
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
            case 'highlightplus':
                $w = abs($sx - $ex);
                $h = 8.0 * $this->scale;
                $sx = min($sx, $ex);
                $sy = min($sy, $ey) + ($h * 0.5);
                $this->SetAlpha(0.5, 'Normal', 0.5, 'Normal');
                $this->SetLineWidth(8.0 * $this->scale);

                // width should be >= min width
                if ($w < self::MIN_ANNOTATION_WIDTH) {
                    $w = self::MIN_ANNOTATION_WIDTH;
                }

                $this->Rect($sx, $sy, $w, $h);
                $this->SetAlpha(1.0, 'Normal', 1.0, 'Normal');
463
464
465
466
467
468
469
470

                $scartx = ($annotation->cartridgex + $annotation->x) * $this->scale;
                $scarty = ($annotation->cartridgey + $annotation->y) * $this->scale;
                $this->SetXY($scartx, $scarty);
                $this->Write(5, $toolObject->cartridge . ' [' . $annotation_index . ']');
                //$this->writeHTML("<span style=border:solid;>".$toolObject->cartridge . ' [' . $annotation->id . ']'.'</span>',false);
                //$this->SetLineWidth(1);
                //$this->Cell(10, 5, $toolObject->cartridge . ' [' . $annotation->id . ']',1);
M. Chardon's avatar
M. Chardon committed
471
472
473
                break;
            case 'verticalline':
                $this->Line($sx, $sy, $sx, $ey);
474
475
476
477
478

                $scartx = ($annotation->cartridgex + $annotation->x) * $this->scale;
                $scarty = ($annotation->cartridgey + $annotation->y) * $this->scale;
                $this->SetXY($scartx, $scarty);
                $this->Write(5, $toolObject->cartridge . ' [' . $annotation_index . ']');
M. Chardon's avatar
M. Chardon committed
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
                break;
            case 'frame':
                $w = abs($sx - $ex);
                $h = abs($sy - $ey);
                $sx = min($sx, $ex);
                $sy = min($sy, $ey);

                // Width or height should be >= min width and height
                if ($w < self::MIN_ANNOTATION_WIDTH) {
                    $w = self::MIN_ANNOTATION_WIDTH;
                }
                if ($h < self::MIN_ANNOTATION_HEIGHT) {
                    $h = self::MIN_ANNOTATION_HEIGHT;
                }
                $this->Rect($sx, $sy, $w, $h);
494
495
496
497
498
499
500
501

                if (!$annotation->parent_annot) {
                    $scartx = ($annotation->cartridgex) * $this->scale;
                    $scarty = ($annotation->cartridgey + $annotation->y) * $this->scale;
                    $this->SetXY($scartx, $scarty);
                    $this->SetTextColorArray($colourarray);
                    $this->Write(5, $toolObject->cartridge . ' [' . $annotation_index . ']');
                }
M. Chardon's avatar
M. Chardon committed
502
503
                break;
            case 'stampcomment':
504
505
506
507
508
509
510
511
512
513
514
515
516
                if ($annotation->displayrotation == 1) {
                    $imgfile = $CFG->dirroot . '/mod/assign/feedback/editpdfplus/pix/twoway_v_pdf.png';
                    $h = abs($sy - $ey);
                    $w = $h * 37 / 96;
                    $sx = min($sx, $ex) + 8;
                    $sy = min($sy, $ey) + 2;
                } else {
                    $imgfile = $CFG->dirroot . '/mod/assign/feedback/editpdfplus/pix/twoway_h_pdf.png';
                    $w = abs($sx - $ex);
                    $h = $w * 37 / 96;
                    $sx = min($sx, $ex) + 2;
                    $sy = min($sy, $ey) + 8;
                }
M. Chardon's avatar
M. Chardon committed
517

518
519
520
                //$w = /*abs($annotation->x - $annotation->endx)*/ 10 * $this->scale;
                //$h = /*abs($annotation->y - $annotation->endy)*/ 4 * $this->scale;
                //debugging('stampcomment ' . $annotation->id . ' - ' . $sx . ':' . $sy . ' -  ' . $imgfile);
M. Chardon's avatar
M. Chardon committed
521
522
                // Stamp is always more than 40px, so no need to check width/height.
                $this->Image($imgfile, $sx, $sy, $w, $h);
523
524
525
526
527

                $scartx = ($annotation->cartridgex + $annotation->x) * $this->scale;
                $scarty = ($annotation->cartridgey + $annotation->y) * $this->scale;
                $this->SetXY($scartx, $scarty);
                $this->Write(5, $toolObject->cartridge . ' [' . $annotation_index . ']');
M. Chardon's avatar
M. Chardon committed
528
529
                break;
            case 'commentplus':
530
531
532
                $imgfile = $CFG->dirroot . '/mod/assign/feedback/editpdfplus/pix/comment.png';
                $w = 16 * $this->scale;
                $h = 16 * $this->scale;
M. Chardon's avatar
M. Chardon committed
533
534
                $sx = min($sx, $ex);
                $sy = min($sy, $ey);
535
536
537
                //debugging('commentplus ' . $annotation->id . ' - ' . $sx . ':' . $sy . ' -  ' . $imgfile);
                $this->SetXY($sx + $w + 2, $sy);
                $this->Write(5, $toolObject->cartridge . ' [' . $annotation_index . ']');
M. Chardon's avatar
M. Chardon committed
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554

                // Stamp is always more than 40px, so no need to check width/height.
                $this->Image($imgfile, $sx, $sy, $w, $h);
                break;
            case 'stampplus':
                $w = abs($sx - $ex);
                $h = abs($sy - $ey);
                $sx = min($sx, $ex);
                $sy = min($sy, $ey);

                // Width or height should be >= min width and height
                if ($w < self::MIN_ANNOTATION_WIDTH) {
                    $w = self::MIN_ANNOTATION_WIDTH;
                }
                if ($h < self::MIN_ANNOTATION_HEIGHT) {
                    $h = self::MIN_ANNOTATION_HEIGHT;
                }
555
556
557
                $this->SetXY($sx, $sy);
                $this->Write(5, $toolObject->cartridge);
                //$this->Rect($sx, $sy, $w, $h);
M. Chardon's avatar
M. Chardon committed
558
                break;
M. Chardon's avatar
init  
M. Chardon committed
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
            default: // Line.
                $this->Line($sx, $sy, $ex, $ey);
                break;
        }
        $this->SetDrawColor(0, 0, 0);
        $this->SetLineWidth(1.0 * $this->scale);

        return true;
    }

    /**
     * Save the completed PDF to the given file
     * @param string $filename the filename for the PDF (including the full path)
     */
    public function save_pdf($filename) {
        $olddebug = error_reporting(0);
        $this->Output($filename, 'F');
        error_reporting($olddebug);
    }

    /**
     * Set the path to the folder in which to generate page image files
     * @param string $folder
     */
    public function set_image_folder($folder) {
        $this->imagefolder = $folder;
    }

    /**
     * Generate an image of the specified page in the PDF
     * @param int $pageno the page to generate the image of
     * @throws moodle_exception
     * @throws coding_exception
     * @return string the filename of the generated image
     */
    public function get_image($pageno) {
        global $CFG;

        if (!$this->filename) {
            throw new \coding_exception('Attempting to generate a page image without first setting the PDF filename');
        }

        if (!$this->imagefolder) {
            throw new \coding_exception('Attempting to generate a page image without first specifying the image output folder');
        }

        if (!is_dir($this->imagefolder)) {
            throw new \coding_exception('The specified image output folder is not a valid folder');
        }

M. Chardon's avatar
M. Chardon committed
609
        $imagefile = $this->imagefolder . '/image_page' . $pageno . '.png';
M. Chardon's avatar
init  
M. Chardon committed
610
611
        $generate = true;
        if (file_exists($imagefile)) {
M. Chardon's avatar
M. Chardon committed
612
            if (filemtime($imagefile) > filemtime($this->filename)) {
M. Chardon's avatar
init  
M. Chardon committed
613
614
615
616
617
618
619
620
621
622
623
624
                // Make sure the image is newer than the PDF file.
                $generate = false;
            }
        }

        if ($generate) {
            // Use ghostscript to generate an image of the specified page.
            $gsexec = \escapeshellarg($CFG->pathtogs);
            $imageres = \escapeshellarg(100);
            $imagefilearg = \escapeshellarg($imagefile);
            $filename = \escapeshellarg($this->filename);
            $pagenoinc = \escapeshellarg($pageno + 1);
M. Chardon's avatar
M. Chardon committed
625
626
            $command = "$gsexec -q -sDEVICE=png16m -dSAFER -dBATCH -dNOPAUSE -r$imageres -dFirstPage=$pagenoinc -dLastPage=$pagenoinc " .
                    "-dDOINTERPOLATE -dGraphicsAlphaBits=4 -dTextAlphaBits=4 -sOutputFile=$imagefilearg $filename";
M. Chardon's avatar
init  
M. Chardon committed
627
628
629
630

            $output = null;
            $result = exec($command, $output);
            if (!file_exists($imagefile)) {
M. Chardon's avatar
M. Chardon committed
631
                $fullerror = '<pre>' . get_string('command', 'assignfeedback_editpdfplus') . "\n";
M. Chardon's avatar
init  
M. Chardon committed
632
                $fullerror .= $command . "\n\n";
M. Chardon's avatar
M. Chardon committed
633
                $fullerror .= get_string('result', 'assignfeedback_editpdfplus') . "\n";
M. Chardon's avatar
init  
M. Chardon committed
634
                $fullerror .= htmlspecialchars($result) . "\n\n";
M. Chardon's avatar
M. Chardon committed
635
636
                $fullerror .= get_string('output', 'assignfeedback_editpdfplus') . "\n";
                $fullerror .= htmlspecialchars(implode("\n", $output)) . '</pre>';
M. Chardon's avatar
init  
M. Chardon committed
637
638
639
640
                throw new \moodle_exception('errorgenerateimage', 'assignfeedback_editpdfplus', '', $fullerror);
            }
        }

M. Chardon's avatar
M. Chardon committed
641
        return 'image_page' . $pageno . '.png';
M. Chardon's avatar
init  
M. Chardon committed
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
    }

    /**
     * Check to see if PDF is version 1.4 (or below); if not: use ghostscript to convert it
     * @param stored_file $file
     * @return string path to copy or converted pdf (false == fail)
     */
    public static function ensure_pdf_compatible(\stored_file $file) {
        global $CFG;

        $temparea = \make_temp_directory('assignfeedback_editpdfplus');
        $hash = $file->get_contenthash(); // Use the contenthash to make sure the temp files have unique names.
        $tempsrc = $temparea . "/src-$hash.pdf";
        $tempdst = $temparea . "/dst-$hash.pdf";
        $file->copy_content_to($tempsrc); // Copy the file.

        $pdf = new pdf();
        $pagecount = 0;
        try {
            $pagecount = $pdf->load_pdf($tempsrc);
        } catch (\Exception $e) {
            // PDF was not valid - try running it through ghostscript to clean it up.
            $pagecount = 0;
        }
        $pdf->Close(); // PDF loaded and never saved/outputted needs to be closed.

        if ($pagecount > 0) {
            // Page is valid and can be read by tcpdf.
            return $tempsrc;
        }

        $gsexec = \escapeshellarg($CFG->pathtogs);
        $tempdstarg = \escapeshellarg($tempdst);
        $tempsrcarg = \escapeshellarg($tempsrc);
        $command = "$gsexec -q -sDEVICE=pdfwrite -dBATCH -dNOPAUSE -sOutputFile=$tempdstarg $tempsrcarg";
        exec($command);
        @unlink($tempsrc);
        if (!file_exists($tempdst)) {
            // Something has gone wrong in the conversion.
            return false;
        }

        $pdf = new pdf();
        $pagecount = 0;
        try {
            $pagecount = $pdf->load_pdf($tempdst);
        } catch (\Exception $e) {
            // PDF was not valid - try running it through ghostscript to clean it up.
            $pagecount = 0;
        }
        $pdf->Close(); // PDF loaded and never saved/outputted needs to be closed.

        if ($pagecount <= 0) {
            @unlink($tempdst);
            // Could not parse the converted pdf.
            return false;
        }

        return $tempdst;
    }

    /**
     * Test that the configured path to ghostscript is correct and working.
     * @param bool $generateimage - If true - a test image will be generated to verify the install.
     * @return bool
     */
    public static function test_gs_path($generateimage = true) {
        global $CFG;

M. Chardon's avatar
M. Chardon committed
711
712
713
        $ret = (object) array(
                    'status' => self::GSPATH_OK,
                    'message' => null,
M. Chardon's avatar
init  
M. Chardon committed
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
        );
        $gspath = $CFG->pathtogs;
        if (empty($gspath)) {
            $ret->status = self::GSPATH_EMPTY;
            return $ret;
        }
        if (!file_exists($gspath)) {
            $ret->status = self::GSPATH_DOESNOTEXIST;
            return $ret;
        }
        if (is_dir($gspath)) {
            $ret->status = self::GSPATH_ISDIR;
            return $ret;
        }
        if (!is_executable($gspath)) {
            $ret->status = self::GSPATH_NOTEXECUTABLE;
            return $ret;
        }

        if (!$generateimage) {
            return $ret;
        }

M. Chardon's avatar
M. Chardon committed
737
        $testfile = $CFG->dirroot . '/mod/assign/feedback/editpdfplus/tests/fixtures/testgs.pdf';
M. Chardon's avatar
init  
M. Chardon committed
738
739
740
741
742
743
        if (!file_exists($testfile)) {
            $ret->status = self::GSPATH_NOTESTFILE;
            return $ret;
        }

        $testimagefolder = \make_temp_directory('assignfeedback_editpdfplus_test');
M. Chardon's avatar
M. Chardon committed
744
        @unlink($testimagefolder . '/image_page0.png'); // Delete any previous test images.
M. Chardon's avatar
init  
M. Chardon committed
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765

        $pdf = new pdf();
        $pdf->set_pdf($testfile);
        $pdf->set_image_folder($testimagefolder);
        try {
            $pdf->get_image(0);
        } catch (\moodle_exception $e) {
            $ret->status = self::GSPATH_ERROR;
            $ret->message = $e->getMessage();
        }
        $pdf->Close(); // PDF loaded and never saved/outputted needs to be closed.

        return $ret;
    }

    /**
     * If the test image has been generated correctly - send it direct to the browser.
     */
    public static function send_test_image() {
        global $CFG;
        header('Content-type: image/png');
M. Chardon's avatar
M. Chardon committed
766
        require_once($CFG->libdir . '/filelib.php');
M. Chardon's avatar
init  
M. Chardon committed
767
768

        $testimagefolder = \make_temp_directory('assignfeedback_editpdfplus_test');
M. Chardon's avatar
M. Chardon committed
769
        $testimage = $testimagefolder . '/image_page0.png';
M. Chardon's avatar
init  
M. Chardon committed
770
771
772
773
774
        send_file($testimage, basename($testimage), 0);
        die();
    }

}