fc157496b7d833b69f7181c5fe50d047dd867877
[moodle.git] / mod / assign / feedback / editpdf / classes / pdf.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Library code for manipulating PDFs
19  *
20  * @package assignfeedback_editpdf
21  * @copyright 2012 Davo Smith
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace assignfeedback_editpdf;
27 defined('MOODLE_INTERNAL') || die();
29 global $CFG;
30 require_once($CFG->libdir.'/pdflib.php');
31 require_once($CFG->dirroot.'/mod/assign/feedback/editpdf/fpdi/fpdi.php');
33 /**
34  * Library code for manipulating PDFs
35  *
36  * @package assignfeedback_editpdf
37  * @copyright 2012 Davo Smith
38  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class pdf extends \FPDI {
42     /** @var int the number of the current page in the PDF being processed */
43     protected $currentpage = 0;
44     /** @var int the total number of pages in the PDF being processed */
45     protected $pagecount = 0;
46     /** @var float used to scale the pixel position of annotations (in the database) to the position in the final PDF */
47     protected $scale = 0.0;
48     /** @var string the path in which to store generated page images */
49     protected $imagefolder = null;
50     /** @var string the path to the PDF currently being processed */
51     protected $filename = null;
53     /** No errors */
54     const GSPATH_OK = 'ok';
55     /** Not set */
56     const GSPATH_EMPTY = 'empty';
57     /** Does not exist */
58     const GSPATH_DOESNOTEXIST = 'doesnotexist';
59     /** Is a dir */
60     const GSPATH_ISDIR = 'isdir';
61     /** Not executable */
62     const GSPATH_NOTEXECUTABLE = 'notexecutable';
63     /** Test file missing */
64     const GSPATH_NOTESTFILE = 'notestfile';
65     /** Any other error */
66     const GSPATH_ERROR = 'error';
67     /** Min. width an annotation should have */
68     const MIN_ANNOTATION_WIDTH = 5;
69     /** Min. height an annotation should have */
70     const MIN_ANNOTATION_HEIGHT = 5;
71     /** Blank PDF file used during error. */
72     const BLANK_PDF = '/mod/assign/feedback/editpdf/fixtures/blank.pdf';
74     /**
75      * Get the name of the font to use in generated PDF files.
76      * If $CFG->pdfexportfont is set - use it, otherwise use "freesans" as this
77      * open licensed font has wide support for different language charsets.
78      *
79      * @return string
80      */
81     private function get_export_font_name() {
82         global $CFG;
84         $fontname = 'freesans';
85         if (!empty($CFG->pdfexportfont)) {
86             $fontname = $CFG->pdfexportfont;
87         }
88         return $fontname;
89     }
91     /**
92      * Combine the given PDF files into a single PDF. Optionally add a coversheet and coversheet fields.
93      * @param string[] $pdflist  the filenames of the files to combine
94      * @param string $outfilename the filename to write to
95      * @return int the number of pages in the combined PDF
96      */
97     public function combine_pdfs($pdflist, $outfilename) {
99         raise_memory_limit(MEMORY_EXTRA);
100         $olddebug = error_reporting(0);
102         $this->setPageUnit('pt');
103         $this->setPrintHeader(false);
104         $this->setPrintFooter(false);
105         $this->scale = 72.0 / 100.0;
106         // Use font supporting the widest range of characters.
107         $this->SetFont($this->get_export_font_name(), '', 16.0 * $this->scale, '', true);
108         $this->SetTextColor(0, 0, 0);
110         $totalpagecount = 0;
112         foreach ($pdflist as $file) {
113             $pagecount = $this->setSourceFile($file);
114             $totalpagecount += $pagecount;
115             for ($i = 1; $i<=$pagecount; $i++) {
116                 $this->create_page_from_source($i);
117             }
118         }
120         $this->save_pdf($outfilename);
121         error_reporting($olddebug);
123         return $totalpagecount;
124     }
126     /**
127      * The number of the current page in the PDF being processed
128      * @return int
129      */
130     public function current_page() {
131         return $this->currentpage;
132     }
134     /**
135      * The total number of pages in the PDF being processed
136      * @return int
137      */
138     public function page_count() {
139         return $this->pagecount;
140     }
142     /**
143      * Load the specified PDF and set the initial output configuration
144      * Used when processing comments and outputting a new PDF
145      * @param string $filename the path to the PDF to load
146      * @return int the number of pages in the PDF
147      */
148     public function load_pdf($filename) {
149         raise_memory_limit(MEMORY_EXTRA);
150         $olddebug = error_reporting(0);
152         $this->setPageUnit('pt');
153         $this->scale = 72.0 / 100.0;
154         $this->SetFont($this->get_export_font_name(), '', 16.0 * $this->scale, '', true);
155         $this->SetFillColor(255, 255, 176);
156         $this->SetDrawColor(0, 0, 0);
157         $this->SetLineWidth(1.0 * $this->scale);
158         $this->SetTextColor(0, 0, 0);
159         $this->setPrintHeader(false);
160         $this->setPrintFooter(false);
161         $this->pagecount = $this->setSourceFile($filename);
162         $this->filename = $filename;
164         error_reporting($olddebug);
165         return $this->pagecount;
166     }
168     /**
169      * Sets the name of the PDF to process, but only loads the file if the
170      * pagecount is zero (in order to count the number of pages)
171      * Used when generating page images (but not a new PDF)
172      * @param string $filename the path to the PDF to process
173      * @param int $pagecount optional the number of pages in the PDF, if known
174      * @return int the number of pages in the PDF
175      */
176     public function set_pdf($filename, $pagecount = 0) {
177         if ($pagecount == 0) {
178             return $this->load_pdf($filename);
179         } else {
180             $this->filename = $filename;
181             $this->pagecount = $pagecount;
182             return $pagecount;
183         }
184     }
186     /**
187      * Copy the next page from the source file and set it as the current page
188      * @return bool true if successful
189      */
190     public function copy_page() {
191         if (!$this->filename) {
192             return false;
193         }
194         if ($this->currentpage>=$this->pagecount) {
195             return false;
196         }
197         $this->currentpage++;
198         $this->create_page_from_source($this->currentpage);
199         return true;
200     }
202     /**
203      * Create a page from a source PDF.
204      *
205      * @param int $pageno
206      */
207     protected function create_page_from_source($pageno) {
208         // Get the size (and deduce the orientation) of the next page.
209         $template = $this->importPage($pageno);
210         $size = $this->getTemplateSize($template);
211         $orientation = 'P';
212         if ($size['w'] > $size['h']) {
213             $orientation = 'L';
214         }
215         // Create a page of the required size / orientation.
216         $this->AddPage($orientation, array($size['w'], $size['h']));
217         // Prevent new page creation when comments are at the bottom of a page.
218         $this->setPageOrientation($orientation, false, 0);
219         // Fill in the page with the original contents from the student.
220         $this->useTemplate($template);
221     }
223     /**
224      * Copy all the remaining pages in the file
225      */
226     public function copy_remaining_pages() {
227         $morepages = true;
228         while ($morepages) {
229             $morepages = $this->copy_page();
230         }
231     }
233     /**
234      * Append all comments to the end of the document.
235      *
236      * @param array $allcomments All comments, indexed by page number (starting at 0).
237      * @return array|bool An array of links to comments, or false.
238      */
239     public function append_comments($allcomments) {
240         if (!$this->filename) {
241             return false;
242         }
244         $this->SetFontSize(12 * $this->scale);
245         $this->SetMargins(100 * $this->scale, 120 * $this->scale, -1, true);
246         $this->SetAutoPageBreak(true, 100 * $this->scale);
247         $this->setHeaderFont(array($this->get_export_font_name(), '', 24 * $this->scale, '', true));
248         $this->setHeaderMargin(24 * $this->scale);
249         $this->setHeaderData('', 0, '', get_string('commentindex', 'assignfeedback_editpdf'));
251         // Add a new page to the document with an appropriate header.
252         $this->setPrintHeader(true);
253         $this->AddPage();
255         // Add the comments.
256         $commentlinks = array();
257         foreach ($allcomments as $pageno => $comments) {
258             foreach ($comments as $index => $comment) {
259                 // Create a link to the current location, which will be added to the marker.
260                 $commentlink = $this->AddLink();
261                 $this->SetLink($commentlink, -1);
262                 $commentlinks[$pageno][$index] = $commentlink;
263                 // Also create a link back to the marker, which will be added here.
264                 $markerlink = $this->AddLink();
265                 $this->SetLink($markerlink, $comment->y * $this->scale, $pageno + 1);
266                 $label = get_string('commentlabel', 'assignfeedback_editpdf', array('pnum' => $pageno + 1, 'cnum' => $index + 1));
267                 $this->Cell(50 * $this->scale, 0, $label, 0, 0, '', false, $markerlink);
268                 $this->MultiCell(0, 0, $comment->rawtext, 0, 'L');
269                 $this->Ln(12 * $this->scale);
270             }
271             // Add an extra line break between pages.
272             $this->Ln(12 * $this->scale);
273         }
275         return $commentlinks;
276     }
278     /**
279      * Add a comment marker to the specified page.
280      *
281      * @param int $pageno The page number to add markers to (starting at 0).
282      * @param int $index The comment index.
283      * @param int $x The x-coordinate of the marker (in pixels).
284      * @param int $y The y-coordinate of the marker (in pixels).
285      * @param int $link The link identifier pointing to the full comment text.
286      * @param string $colour The fill colour of the marker (red, yellow, green, blue, white, clear).
287      * @return bool Success status.
288      */
289     public function add_comment_marker($pageno, $index, $x, $y, $link, $colour = 'yellow') {
290         if (!$this->filename) {
291             return false;
292         }
294         $fill = '';
295         $fillopacity = 0.9;
296         switch ($colour) {
297             case 'red':
298                 $fill = 'rgb(249, 181, 179)';
299                 break;
300             case 'green':
301                 $fill = 'rgb(214, 234, 178)';
302                 break;
303             case 'blue':
304                 $fill = 'rgb(203, 217, 237)';
305                 break;
306             case 'white':
307                 $fill = 'rgb(255, 255, 255)';
308                 break;
309             case 'clear':
310                 $fillopacity = 0;
311                 break;
312             default: /* Yellow */
313                 $fill = 'rgb(255, 236, 174)';
314         }
315         $marker = '@<svg xmlns="http://www.w3.org/2000/svg" viewBox="-0.5 -0.5 12 12" preserveAspectRatio="xMinYMin meet">' .
316                 '<path d="M11 0H1C.4 0 0 .4 0 1v6c0 .6.4 1 1 1h1v4l4-4h5c.6 0 1-.4 1-1V1c0-.6-.4-1-1-1z" fill="' . $fill . '" ' .
317                 'fill-opacity="' . $fillopacity . '" stroke="rgb(153, 153, 153)" stroke-width="0.5"/></svg>';
318         $label = get_string('commentlabel', 'assignfeedback_editpdf', array('pnum' => $pageno + 1, 'cnum' => $index + 1));
320         $x *= $this->scale;
321         $y *= $this->scale;
322         $size = 24 * $this->scale;
323         $this->SetDrawColor(51, 51, 51);
324         $this->SetFontSize(10 * $this->scale);
325         $this->setPage($pageno + 1);
327         // Add the marker image.
328         $this->ImageSVG($marker, $x - 0.5, $y - 0.5, $size, $size, $link);
330         // Add the label.
331         $this->MultiCell($size * 0.95, 0, $label, 0, 'C', false, 1, $x, $y, true, 0, false, true, $size * 0.60, 'M', true);
333         return true;
334     }
336     /**
337      * Add a comment to the current page
338      * @param string $text the text of the comment
339      * @param int $x the x-coordinate of the comment (in pixels)
340      * @param int $y the y-coordinate of the comment (in pixels)
341      * @param int $width the width of the comment (in pixels)
342      * @param string $colour optional the background colour of the comment (red, yellow, green, blue, white, clear)
343      * @return bool true if successful (always)
344      */
345     public function add_comment($text, $x, $y, $width, $colour = 'yellow') {
346         if (!$this->filename) {
347             return false;
348         }
349         $this->SetDrawColor(51, 51, 51);
350         switch ($colour) {
351             case 'red':
352                 $this->SetFillColor(249, 181, 179);
353                 break;
354             case 'green':
355                 $this->SetFillColor(214, 234, 178);
356                 break;
357             case 'blue':
358                 $this->SetFillColor(203, 217, 237);
359                 break;
360             case 'white':
361                 $this->SetFillColor(255, 255, 255);
362                 break;
363             default: /* Yellow */
364                 $this->SetFillColor(255, 236, 174);
365                 break;
366         }
368         $x *= $this->scale;
369         $y *= $this->scale;
370         $width *= $this->scale;
371         $text = str_replace('&lt;', '<', $text);
372         $text = str_replace('&gt;', '>', $text);
373         // Draw the text with a border, but no background colour (using a background colour would cause the fill to
374         // appear behind any existing content on the page, hence the extra filled rectangle drawn below).
375         $this->MultiCell($width, 1.0, $text, 0, 'L', 0, 4, $x, $y); /* width, height, text, border, justify, fill, ln, x, y */
376         if ($colour != 'clear') {
377             $newy = $this->GetY();
378             // Now we know the final size of the comment, draw a rectangle with the background colour.
379             $this->Rect($x, $y, $width, $newy - $y, 'DF');
380             // Re-draw the text over the top of the background rectangle.
381             $this->MultiCell($width, 1.0, $text, 0, 'L', 0, 4, $x, $y); /* width, height, text, border, justify, fill, ln, x, y */
382         }
383         return true;
384     }
386     /**
387      * Add an annotation to the current page
388      * @param int $sx starting x-coordinate (in pixels)
389      * @param int $sy starting y-coordinate (in pixels)
390      * @param int $ex ending x-coordinate (in pixels)
391      * @param int $ey ending y-coordinate (in pixels)
392      * @param string $colour optional the colour of the annotation (red, yellow, green, blue, white, black)
393      * @param string $type optional the type of annotation (line, oval, rectangle, highlight, pen, stamp)
394      * @param int[]|string $path optional for 'pen' annotations this is an array of x and y coordinates for
395      *              the line, for 'stamp' annotations it is the name of the stamp file (without the path)
396      * @param string $imagefolder - Folder containing stamp images.
397      * @return bool true if successful (always)
398      */
399     public function add_annotation($sx, $sy, $ex, $ey, $colour = 'yellow', $type = 'line', $path, $imagefolder) {
400         global $CFG;
401         if (!$this->filename) {
402             return false;
403         }
404         switch ($colour) {
405             case 'yellow':
406                 $colourarray = array(255, 207, 53);
407                 break;
408             case 'green':
409                 $colourarray = array(153, 202, 62);
410                 break;
411             case 'blue':
412                 $colourarray = array(125, 159, 211);
413                 break;
414             case 'white':
415                 $colourarray = array(255, 255, 255);
416                 break;
417             case 'black':
418                 $colourarray = array(51, 51, 51);
419                 break;
420             default: /* Red */
421                 $colour = 'red';
422                 $colourarray = array(239, 69, 64);
423                 break;
424         }
425         $this->SetDrawColorArray($colourarray);
427         $sx *= $this->scale;
428         $sy *= $this->scale;
429         $ex *= $this->scale;
430         $ey *= $this->scale;
432         $this->SetLineWidth(3.0 * $this->scale);
433         switch ($type) {
434             case 'oval':
435                 $rx = abs($sx - $ex) / 2;
436                 $ry = abs($sy - $ey) / 2;
437                 $sx = min($sx, $ex) + $rx;
438                 $sy = min($sy, $ey) + $ry;
440                 // $rx and $ry should be >= min width and height
441                 if ($rx < self::MIN_ANNOTATION_WIDTH) {
442                     $rx = self::MIN_ANNOTATION_WIDTH;
443                 }
444                 if ($ry < self::MIN_ANNOTATION_HEIGHT) {
445                     $ry = self::MIN_ANNOTATION_HEIGHT;
446                 }
448                 $this->Ellipse($sx, $sy, $rx, $ry);
449                 break;
450             case 'rectangle':
451                 $w = abs($sx - $ex);
452                 $h = abs($sy - $ey);
453                 $sx = min($sx, $ex);
454                 $sy = min($sy, $ey);
456                 // Width or height should be >= min width and height
457                 if ($w < self::MIN_ANNOTATION_WIDTH) {
458                     $w = self::MIN_ANNOTATION_WIDTH;
459                 }
460                 if ($h < self::MIN_ANNOTATION_HEIGHT) {
461                     $h = self::MIN_ANNOTATION_HEIGHT;
462                 }
463                 $this->Rect($sx, $sy, $w, $h);
464                 break;
465             case 'highlight':
466                 $w = abs($sx - $ex);
467                 $h = 8.0 * $this->scale;
468                 $sx = min($sx, $ex);
469                 $sy = min($sy, $ey) + ($h * 0.5);
470                 $this->SetAlpha(0.5, 'Normal', 0.5, 'Normal');
471                 $this->SetLineWidth(8.0 * $this->scale);
473                 // width should be >= min width
474                 if ($w < self::MIN_ANNOTATION_WIDTH) {
475                     $w = self::MIN_ANNOTATION_WIDTH;
476                 }
478                 $this->Rect($sx, $sy, $w, $h);
479                 $this->SetAlpha(1.0, 'Normal', 1.0, 'Normal');
480                 break;
481             case 'pen':
482                 if ($path) {
483                     $scalepath = array();
484                     $points = preg_split('/[,:]/', $path);
485                     foreach ($points as $point) {
486                         $scalepath[] = intval($point) * $this->scale;
487                     }
489                     if (!empty($scalepath)) {
490                         $this->PolyLine($scalepath, 'S');
491                     }
492                 }
493                 break;
494             case 'stamp':
495                 $imgfile = $imagefolder . '/' . clean_filename($path);
496                 $w = abs($sx - $ex);
497                 $h = abs($sy - $ey);
498                 $sx = min($sx, $ex);
499                 $sy = min($sy, $ey);
501                 // Stamp is always more than 40px, so no need to check width/height.
502                 $this->Image($imgfile, $sx, $sy, $w, $h);
503                 break;
504             default: // Line.
505                 $this->Line($sx, $sy, $ex, $ey);
506                 break;
507         }
508         $this->SetDrawColor(0, 0, 0);
509         $this->SetLineWidth(1.0 * $this->scale);
511         return true;
512     }
514     /**
515      * Save the completed PDF to the given file
516      * @param string $filename the filename for the PDF (including the full path)
517      */
518     public function save_pdf($filename) {
519         $olddebug = error_reporting(0);
520         $this->Output($filename, 'F');
521         error_reporting($olddebug);
522     }
524     /**
525      * Set the path to the folder in which to generate page image files
526      * @param string $folder
527      */
528     public function set_image_folder($folder) {
529         $this->imagefolder = $folder;
530     }
532     /**
533      * Generate an image of the specified page in the PDF
534      * @param int $pageno the page to generate the image of
535      * @throws \moodle_exception
536      * @throws \coding_exception
537      * @return string the filename of the generated image
538      */
539     public function get_image($pageno) {
540         global $CFG;
542         if (!$this->filename) {
543             throw new \coding_exception('Attempting to generate a page image without first setting the PDF filename');
544         }
546         if (!$this->imagefolder) {
547             throw new \coding_exception('Attempting to generate a page image without first specifying the image output folder');
548         }
550         if (!is_dir($this->imagefolder)) {
551             throw new \coding_exception('The specified image output folder is not a valid folder');
552         }
554         $imagefile = $this->imagefolder.'/image_page' . $pageno . '.png';
555         $generate = true;
556         if (file_exists($imagefile)) {
557             if (filemtime($imagefile) > filemtime($this->filename)) {
558                 // Make sure the image is newer than the PDF file.
559                 $generate = false;
560             }
561         }
563         if ($generate) {
564             // Use ghostscript to generate an image of the specified page.
565             $gsexec = \escapeshellarg($CFG->pathtogs);
566             $imageres = \escapeshellarg(100);
567             $imagefilearg = \escapeshellarg($imagefile);
568             $filename = \escapeshellarg($this->filename);
569             $pagenoinc = \escapeshellarg($pageno + 1);
570             $command = "$gsexec -q -sDEVICE=png16m -dSAFER -dBATCH -dNOPAUSE -r$imageres -dFirstPage=$pagenoinc -dLastPage=$pagenoinc ".
571                 "-dDOINTERPOLATE -dGraphicsAlphaBits=4 -dTextAlphaBits=4 -sOutputFile=$imagefilearg $filename";
573             $output = null;
574             $result = exec($command, $output);
575             if (!file_exists($imagefile)) {
576                 $fullerror = '<pre>'.get_string('command', 'assignfeedback_editpdf')."\n";
577                 $fullerror .= $command . "\n\n";
578                 $fullerror .= get_string('result', 'assignfeedback_editpdf')."\n";
579                 $fullerror .= htmlspecialchars($result) . "\n\n";
580                 $fullerror .= get_string('output', 'assignfeedback_editpdf')."\n";
581                 $fullerror .= htmlspecialchars(implode("\n", $output)) . '</pre>';
582                 throw new \moodle_exception('errorgenerateimage', 'assignfeedback_editpdf', '', $fullerror);
583             }
584         }
586         return 'image_page'.$pageno.'.png';
587     }
589     /**
590      * Check to see if PDF is version 1.4 (or below); if not: use ghostscript to convert it
591      *
592      * @param stored_file $file
593      * @return string path to copy or converted pdf (false == fail)
594      */
595     public static function ensure_pdf_compatible(\stored_file $file) {
596         global $CFG;
598         // Copy the stored_file to local disk for checking.
599         $temparea = make_request_directory();
600         $tempsrc = $temparea . "/source.pdf";
601         $file->copy_content_to($tempsrc);
603         return self::ensure_pdf_file_compatible($tempsrc);
604     }
606     /**
607      * Check to see if PDF is version 1.4 (or below); if not: use ghostscript to convert it
608      *
609      * @param   string $tempsrc The path to the file on disk.
610      * @return  string path to copy or converted pdf (false == fail)
611      */
612     public static function ensure_pdf_file_compatible($tempsrc) {
613         global $CFG;
615         $pdf = new pdf();
616         $pagecount = 0;
617         try {
618             $pagecount = $pdf->load_pdf($tempsrc);
619         } catch (\Exception $e) {
620             // PDF was not valid - try running it through ghostscript to clean it up.
621             $pagecount = 0;
622         }
623         $pdf->Close(); // PDF loaded and never saved/outputted needs to be closed.
625         if ($pagecount > 0) {
626             // PDF is already valid and can be read by tcpdf.
627             return $tempsrc;
628         }
630         $temparea = make_request_directory();
631         $tempdst = $temparea . "/target.pdf";
633         $gsexec = \escapeshellarg($CFG->pathtogs);
634         $tempdstarg = \escapeshellarg($tempdst);
635         $tempsrcarg = \escapeshellarg($tempsrc);
636         $command = "$gsexec -q -sDEVICE=pdfwrite -dBATCH -dNOPAUSE -sOutputFile=$tempdstarg $tempsrcarg";
637         exec($command);
638         if (!file_exists($tempdst)) {
639             // Something has gone wrong in the conversion.
640             return false;
641         }
643         $pdf = new pdf();
644         $pagecount = 0;
645         try {
646             $pagecount = $pdf->load_pdf($tempdst);
647         } catch (\Exception $e) {
648             // PDF was not valid - try running it through ghostscript to clean it up.
649             $pagecount = 0;
650         }
651         $pdf->Close(); // PDF loaded and never saved/outputted needs to be closed.
653         if ($pagecount <= 0) {
654             // Could not parse the converted pdf.
655             return false;
656         }
658         return $tempdst;
659     }
661     /**
662      * Generate an localised error image for the given pagenumber.
663      *
664      * @param string $errorimagefolder path of the folder where error image needs to be created.
665      * @param int $pageno page number for which error image needs to be created.
666      *
667      * @return string File name
668      * @throws \coding_exception
669      */
670     public static function get_error_image($errorimagefolder, $pageno) {
671         global $CFG;
673         $errorfile = $CFG->dirroot . self::BLANK_PDF;
674         if (!file_exists($errorfile)) {
675             throw new \coding_exception("Blank PDF not found", "File path" . $errorfile);
676         }
678         $tmperrorimagefolder = make_request_directory();
680         $pdf = new pdf();
681         $pdf->set_pdf($errorfile);
682         $pdf->copy_page();
683         $pdf->add_comment(get_string('errorpdfpage', 'assignfeedback_editpdf'), 250, 300, 200, "red");
684         $generatedpdf = $tmperrorimagefolder . '/' . 'error.pdf';
685         $pdf->save_pdf($generatedpdf);
687         $pdf = new pdf();
688         $pdf->set_pdf($generatedpdf);
689         $pdf->set_image_folder($tmperrorimagefolder);
690         $image = $pdf->get_image(0);
691         $pdf->Close(); // PDF loaded and never saved/outputted needs to be closed.
692         $newimg = 'image_page' . $pageno . '.png';
694         copy($tmperrorimagefolder . '/' . $image, $errorimagefolder . '/' . $newimg);
695         return $newimg;
696     }
698     /**
699      * Test that the configured path to ghostscript is correct and working.
700      * @param bool $generateimage - If true - a test image will be generated to verify the install.
701      * @return \stdClass
702      */
703     public static function test_gs_path($generateimage = true) {
704         global $CFG;
706         $ret = (object)array(
707             'status' => self::GSPATH_OK,
708             'message' => null,
709         );
710         $gspath = $CFG->pathtogs;
711         if (empty($gspath)) {
712             $ret->status = self::GSPATH_EMPTY;
713             return $ret;
714         }
715         if (!file_exists($gspath)) {
716             $ret->status = self::GSPATH_DOESNOTEXIST;
717             return $ret;
718         }
719         if (is_dir($gspath)) {
720             $ret->status = self::GSPATH_ISDIR;
721             return $ret;
722         }
723         if (!is_executable($gspath)) {
724             $ret->status = self::GSPATH_NOTEXECUTABLE;
725             return $ret;
726         }
728         if (!$generateimage) {
729             return $ret;
730         }
732         $testfile = $CFG->dirroot.'/mod/assign/feedback/editpdf/tests/fixtures/testgs.pdf';
733         if (!file_exists($testfile)) {
734             $ret->status = self::GSPATH_NOTESTFILE;
735             return $ret;
736         }
738         $testimagefolder = \make_temp_directory('assignfeedback_editpdf_test');
739         @unlink($testimagefolder.'/image_page0.png'); // Delete any previous test images.
741         $pdf = new pdf();
742         $pdf->set_pdf($testfile);
743         $pdf->set_image_folder($testimagefolder);
744         try {
745             $pdf->get_image(0);
746         } catch (\moodle_exception $e) {
747             $ret->status = self::GSPATH_ERROR;
748             $ret->message = $e->getMessage();
749         }
750         $pdf->Close(); // PDF loaded and never saved/outputted needs to be closed.
752         return $ret;
753     }
755     /**
756      * If the test image has been generated correctly - send it direct to the browser.
757      */
758     public static function send_test_image() {
759         global $CFG;
760         header('Content-type: image/png');
761         require_once($CFG->libdir.'/filelib.php');
763         $testimagefolder = \make_temp_directory('assignfeedback_editpdf_test');
764         $testimage = $testimagefolder.'/image_page0.png';
765         send_file($testimage, basename($testimage), 0);
766         die();
767     }