Source for file pdfimporter.php

Documentation is available at pdfimporter.php

  1. <?php
  2. // This file is part of the Sloodle project (www.sloodle.org) and is released under the GNU GPL v3.
  3.  
  4. /**
  5. * Defines the SLOODLE Presenter importer plugin for converting a PDF file to a list of images (1 image per page).
  6. * Many thanks to Jordan Guinaud for his original code which made this plugin possible.
  7. * Note: this plugin requires PHP >= 4.1.0 and the presence of the IMagick extension.
  8. *
  9. * @package sloodle
  10. * @copyright Copyright (c) 2009 Sloodle (various contributors)
  11. * @license http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3
  12. * @since Sloodle 0.4.1
  13. *
  14. * @contributor Jordan Guinaud
  15. * @contributor Peter R. Bloomfield
  16. *
  17. */
  18.  
  19.  
  20. // Path to the ImageMagick "convert" file. Leave it blank to DISABLE this feature for security.
  21. // Likely to be something like this:  '/usr/bin/convert' or '/usr/local/bin/convert'
  22. global $IMAGICK_CONVERT_PATH;
  23. $IMAGICK_CONVERT_PATH = '/usr/local/bin/convert';
  24.  
  25.  
  26. /**
  27. * Presenter plugin for importing a PDF file as a series of image slides.
  28. *
  29. * @package sloodle
  30. */
  31. class SloodlePluginPresenterPDFImporter extends SloodlePluginBasePresenterImporter
  32. {
  33.     /**
  34.     * Render this importer on a web page.
  35.     * All importing functionality should be handled by this function as well.
  36.     * @param string $url A URL to this Presenter, without a "mode" parameter.
  37.     * @param SloodleModulePresenter $presenter An object representing this Presenter.
  38.     */
  39.     function render($url, $presenter)
  40.     {
  41.         // Get translation strings
  42.         $struploadfile = get_string('upload:file', 'sloodle');
  43.         $strselectuploadfile = get_string('upload:selectfile', 'sloodle');
  44.         $strimportposition = get_string('presenter:importposition', 'sloodle');
  45.         $strimportfromcomputer = get_string('presenter:importfrommycomputer', 'sloodle');
  46.         $strimportname = get_string('presenter:importname', 'sloodle');
  47.         $strimportnamecaption = get_string('presenter:importnamecaption', 'sloodle');
  48.  
  49.         // Get expected form data
  50.         $selectfile = optional_param('selectfile', '', PARAM_CLEAN);
  51.         $uploadfile = optional_param('uploadfile', '', PARAM_CLEAN);
  52.         $importname = optional_param('importname', '', PARAM_CLEAN);
  53.         $position = (int)optional_param('sloodleentryposition', -1, PARAM_INT);
  54.         
  55.         // Has a file been selected?
  56.         if (!empty($selectfile)) {
  57.             // Has a local file name been specified to import from?
  58.             $localfile = optional_param('sloodleimportfile', '', PARAM_CLEAN);
  59.             if (!empty($localfile)) return $this->import_file($presenter, $localfile, $importname, $position);
  60.         }
  61.  
  62.         // Has a file been uploaded?
  63.         if (!empty($uploadfile)) {
  64.             // Has an upload been made which we can import from?
  65.             $localfile = ''; $name = '';
  66.             $res = $this->process_upload($localfile, $name);
  67.             if ($res === true) {
  68.                 sloodle_debug("Upload successful<br/>\n");
  69.                 return $this->import_file($presenter, $localfile, $importname, $position);
  70.             }
  71.             if (is_string($res)) error($res, $url.'&amp;mode=edit');
  72.         }
  73.  
  74.         // No file specified - display forms to let the user select or upload the file.
  75.  
  76.         // Determine our maximum upload size
  77.         $maxsize = sloodle_get_max_post_upload();
  78.         $maxsizedesc = sloodle_get_size_description($maxsize);
  79.  
  80.         // Open the form
  81.         echo '<form action="" method="post" enctype="multipart/form-data"><fieldset style="border-style:none;">';
  82.         echo '<input type="hidden" name="id" id="id" value="'.$presenter->cm->id.'" />';
  83.         echo '<input type="hidden" name="mode" id="mode" value="importslides" />';
  84.         echo '<input type="hidden" name="sloodleplugintype" id="sloodleplugintype" value="'.$this->get_id().'" />';
  85.         echo '</fieldset><br/>';
  86.  
  87.         // Let the user specify a name for the imported files
  88.         echo '<label for="importname" title="'.$strimportnamecaption.'">'.$strimportname.': </label>';
  89.         echo '<input type="text" name="importname" id="importname" value="" size="30" maxlength="100" title="'.$strimportnamecaption.'" />';
  90.         echo "<br/><br/>\n";
  91.         // Let the user select the position to upload to in the Presentation
  92.         $this->print_slide_position_menu($presenter, $position);
  93.         echo "<br/><br/>\n";
  94.  
  95.         // Display our upload form
  96.         echo '<fieldset style="width:50%; margin-left:auto; margin-right:auto;">';
  97.         echo '<h3>'.$strimportfromcomputer."</h3>\n";
  98.         echo '<input type="hidden" name="MAX_FILE_SIZE" value="'.$maxsize.'" />';
  99.         echo '<label for="userfile">'.$strselectuploadfile.': </label>';
  100.         echo '<input type="file" name="userfile" id="userfile" size="50" />';
  101.         echo '<p style="font-style:italic; font-size:90%;">['.get_string('upload:maxsize', 'sloodle', $maxsizedesc)."]</p><br/>\n";
  102.         echo '<input type="submit" name="uploadfile" id="uploadfile" value="'.$struploadfile.'" /><br/>'."\n";
  103.         echo '</fieldset><br/>';
  104.  
  105.         // TODO: add a separate section allowing the import of a file elsewhere on the web
  106.  
  107.         // TODO: add a separate section allowing the import of a file already in the course/site files
  108.  
  109.         // Close the form
  110.         echo "</fieldset></form><br/>\n";
  111.  
  112.     }
  113.  
  114.     /**
  115.     * Display a drop-down menu of slides in the current presentation.
  116.     * @param SloodleModulePresenter $presenter An object representing the Preseter to work from.
  117.     * @param integer $position Specifies the intially selected position, if known. Defaults to end.
  118.     */
  119.     function print_slide_position_menu($presenter, $position = -1)
  120.     {
  121.         // Get translation strings
  122.         $strimportposition = get_string('presenter:importposition', 'sloodle');
  123.         $strimportpositioncaption = get_string('presenter:importpositioncaption', 'sloodle');
  124.  
  125.         // Get a list of slides
  126.         $slides = $presenter->get_slides();
  127.         // Display the form element
  128.         echo '<label for="sloodleentryposition" title="'.$strimportpositioncaption.'">'.$strimportposition.': </label>';
  129.         echo '<select name="sloodleentryposition" id="sloodleentryposition" size="1" title="'.$strimportpositioncaption.'">'."\n";
  130.         $selected = false;
  131.         foreach ($slides as $curslide) {
  132.             // Add this slide to the menu
  133.             echo "<option value=\"{$curslide->slideposition}\"";
  134.             if ($curslide->slideposition == $position) {
  135.                 echo ' selected="selected"';
  136.                 $selected = true;
  137.             }
  138.             echo ">{$curslide->slideposition}: {$curslide->name}</option>\n";
  139.         }
  140.         // Add an 'end' option
  141.         $endentrynum = $curslide->slideposition + 1;
  142.         echo "<option value=\"{$endentrynum}\"";
  143.         if (!$selected) echo " selected=\"selected\"";
  144.         echo ">--".get_string('end', 'sloodle')."--</option>\n";
  145.         echo "</select>\n";
  146.     }
  147.  
  148.  
  149.     /**
  150.     * Attempt to process a file upload.
  151.     * @param string $path [out] This reference parameter will contain the path of the uploaded file if an upload has been performed. It will be empty if no upload has occurred.
  152.     * @param string $name [out] This reference parameter will contain the original name of the uploaded file if an upload has been performed.
  153.     * @return bool|stringReturns true if an upload occurred succesfully. Returns false if no upload has happened. Returns a string containing an error message if an error occurred.
  154.     */
  155.     function process_upload(&$path, &$name)
  156.     {
  157.         // If no file has been uploaded, then there is nothing to do
  158.         if (empty($_FILES['userfile']['name'])) return false;
  159.  
  160.         // Is the file empty?
  161.         if ((int)$_FILES['userfile']['size'] == 0) return get_string('upload:emptyfile', 'sloodle');
  162.  
  163.         // Was an error code specified?
  164.         if (isset($_FILES['userfile']['error'])) {
  165.             switch ($_FILES['userfile']['error']) {
  166.                 case UPLOAD_ERR_INI_SIZE: case UPLOAD_ERR_FORM_SIZE: return get_string('upload:toobig', 'sloodle');
  167.                 case UPLOAD_ERR_PARTIAL: return get_string('upload:partial', 'sloodle');
  168.             }
  169.             if ($_FILES['userfile']['error'] != UPLOAD_ERR_OK) return get_string('upload:error', 'sloodle');
  170.         }
  171.         
  172.         // Store the file path and name
  173.         $name = $_FILES['userfile']['name'];
  174.         $path = $_FILES['userfile']['tmp_name'];
  175.         return true;
  176.     }
  177.  
  178.  
  179.     /**
  180.     * Import a file to this Presenter.
  181.     * @param SloodleModulePresenter $presenter An object representing the Presenter we are importing into.
  182.     * @param string $path The path of the file to import (must be local... i.e. on disk!)
  183.     * @param string $name Optional -- a name for the import. If omitted, it will be taken from the path.
  184.     * @param integer $position The position at which the slides should be imported. Optional. Defaults to import at the end.
  185.     * @return bool True if successful or false if not.
  186.     */
  187.     function import_file($presenter, $path, $name = '', $position = -1)
  188.     {
  189.         global $CFG;
  190.  
  191.         // PHP 4 doesn't support recursive creation of folders, so we need to do this the manual way
  192.         $dir_sitefiles = $CFG->dataroot.'/'.SITEID;
  193.         $dir_presenter = $dir_sitefiles.'/presenter';
  194.         $dir_import = $dir_presenter.'/'.$presenter->cm->id;
  195.         if (!file_exists($dir_sitefiles)) mkdir($dir_sitefiles);
  196.         if (!file_exists($dir_presenter)) mkdir($dir_presenter);
  197.         if (!file_exists($dir_import)) mkdir($dir_import);
  198.         // Now check on last time that the import folder exists
  199.         if (!file_exists($dir_import)) {
  200.             error("Failed to create directory for imported images. Please check the file permissions for your MoodleData folder.<br/><br/>Attempted to create: {$dir_import}");
  201.         }
  202.  
  203.         // Construct the URL of the folder for viewing the files
  204.         $dir_view = $CFG->wwwroot.'/file.php/'.SITEID.'/presenter/'.$presenter->cm->id;
  205.  
  206.         // Use the file name from the path if necessary
  207.         if (empty($name)) $name = basename($path);
  208.         // Construct a basic identifier for the files which will be imported.
  209.         // It will consist of a timestamp and the import name
  210.         $filebase = gmdate('U').'_'.str_replace(" ", "_", $name);
  211.  
  212.         // We'll use JPG files as standard just now. We could make this customizable in future?
  213.         $ext = 'jpg';
  214.  
  215.         // Attempt each importing method in turn
  216.         $result = $this->_import_MagickWand($presenter, $path, $dir_import, $dir_view, $filebase, $ext, $name, $position);
  217.         if ($result === false) $result = $this->_import_ImageMagick($presenter, $path, $dir_import, $dir_view, $filebase, $ext, $name, $position);
  218.  
  219.         // Prepare a "Continue" link which takes us to edit mode
  220.         $continueURL = $CFG->wwwroot."/mod/sloodle/view.php?id={$presenter->cm->id}&amp;mode=edit";
  221.  
  222.         // Display the results (in future, it might be good to show a list of slides, and let the user rename or delete them before addition to the presentation)
  223.         if ($result === false) {
  224.             echo "<h3>",get_string('presenter:importfailed', 'sloodle'),"</h3>\n";
  225.             echo "<h4>",get_string('presenter:importneedimagick', 'sloodle'),"</h4>\n";
  226.             redirect($continueURL, '', 5);
  227.             return false;
  228.         }
  229.         echo "<h3>",get_string('presenter:importsuccessful', 'sloodle', $result),"</h3>\n";
  230.         redirect($continueURL, '', 5);
  231.         return true;
  232.     }
  233.     
  234.  
  235.     /**
  236.     * Imports the given file using the MagickWand extension if possible. (Internal only)
  237.     * @param SloodleModulePresenter $presenter An object representing the Presenter we are importing into.
  238.     * @param string $srcfile Full path of the PDF file we are importing
  239.     * @param string $destpath Folder path to which the imported files will be added.
  240.     * @param string $viewurl URL of the folder in which the imported files will be viewed
  241.     * @param string $destfile Name for the output files (excluding extension, such as .jpg). The page numbers will be appended automatically, before the extension
  242.     * @param string $destfileext Extension for destination files, not including the dot. (e.g. "jpg" or "png").
  243.     * @param string $destname Basic name to use for each imported slide. The page numbers will be appended automatically.
  244.     * @param integer $position The position within the Presentation to add the new slides. Optional. Default is to put them at the end.
  245.     * @return integer|boolIf successful, an integer indicating the number of slides loaded is displayed. If the import does not (or cannot) work, then boolean false is returned.
  246.     * @access private
  247.     */
  248.     function _import_MagickWand($presenter, $srcfile, $destpath, $viewurl, $destfile, $destfileext, $destname, $position = -1)
  249.     {
  250.         global $CFG;
  251.         // Check to see if the MagickWand extension is already loaded.
  252.         // Attempt to load it if not -- the name will vary depending on OS
  253.         sloodle_debug('<br/><strong>Checking for presence of extension "magickwand"...</strong> ');
  254.         if (!extension_loaded('magickwand')) {
  255.             sloodle_debug('not loaded.<br/>Checking OS... ');
  256.             if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
  257.                 sloodle_debug('Windows.<br/>Attempting to load "php_magickwand.dll"... ');
  258.                 @dl('php_magickwand.dll');
  259.             } else {
  260.                 sloodle_debug('Non-Windows.<br>Attempting to load "magickwand.so"... ');
  261.                 @dl('magickwand.so');
  262.             }
  263.             // If it's still not loaded, then we cannot use this function
  264.             if (!@extension_loaded('magickwand')) {
  265.                 sloodle_debug('extension unavailable.<br/>');
  266.                 return false;
  267.             }
  268.         }
  269.         sloodle_debug('extension loaded.<br/>');
  270.         
  271.         // Load the PDF file
  272.         sloodle_debug('Loading PDF file... ');
  273.         $mwand = NewMagickWand();
  274.         if (!MagickReadImage($mwand, $srcfile)) {
  275.             sloodle_debug('failed.<br/>');
  276.             return false;
  277.         }
  278.         sloodle_debug('OK.<br/>');
  279.         
  280.         // Quick validation - position should start at 1. (-ve numbers mean "at the end")
  281.         if ($position == 0) $position = 1;
  282.  
  283.         // Go through each page
  284.         sloodle_debug('Preparing to iterate through pages of document...<br/>');
  285.         MagickSetFirstIterator($mwand);
  286.         $pagenum = 0; $page_position = -1;
  287.         do {
  288.             // Determine this page's position in the Presentation
  289.             if ($position > 0) $page_position = $position + $pagenum;
  290.             $pagenum++;
  291.  
  292.             // Construct the file and slide names for this page
  293.             $page_filename = "{$destpath}/{$destfile}-{$pagenum}.{$destfileext}"; // Where it gets uploaded to
  294.             $page_slidesource = "{$viewurl}/{$destfile}-{$pagenum}.{$destfileext}"; // The URL to access it publicly
  295.             $page_slidename = "{$destname} ({$pagenum})";
  296.  
  297.             // Output the file
  298.             sloodle_debug(" Writing page {$pagenum} to file...");
  299.             if (!MagickWriteImage($mwand, $page_filename)) {
  300.                 sloodle_debug('failed.<br/>');
  301.             } else {
  302.                 sloodle_debug('OK.<br/>');
  303.             }
  304.  
  305.             // Add the entry to the Presenter
  306.             sloodle_debug("  Adding slide \"{$page_slidename}\" to presentation at position {$page_position}... ");
  307.             if (!$presenter->add_entry($page_slidesource, 'PresenterSlideImage', $page_slidename, $page_position)) {
  308.                 sloodle_debug('failed.<br/>');
  309.             } else {
  310.                 sloodle_debug('OK.<br/>');
  311.             }
  312.             
  313.         } while (MagickNextImage($mwand));
  314.         sloodle_debug('Finished.<br/>');
  315.         DestroyMagickWand($mwand);
  316.         return $pagenum;
  317.     }
  318.  
  319.  
  320.     /**
  321.     * Imports the given file using the ImageMagick command line programs if possible. (Internal only)
  322.     * @param SloodleModulePresenter $presenter An object representing the Presenter we are importing into.
  323.     * @param string $srcfile Full path of the PDF file we are importing
  324.     * @param string $destpath Folder path to which the imported files will be added.
  325.     * @param string $viewurl URl of the folder in which the files can be viewed
  326.     * @param string $destfile Name for the output files (excluding extension, such as .jpg). The page numbers will be appended automatically, before the extension
  327.     * @param string $destfileext Extension for destination files, not including the dot. (e.g. "jpg" or "png").
  328.     * @param string $destname Basic name to use for each imported slide. The page numbers will be appended automatically.
  329.     * @param integer $position The position within the Presentation to add the new slides. Optional. Default is to put them at the end.
  330.     * @return integer|boolIf successful, an integer indicating the number of slides loaded is displayed. If the import does not (or cannot) work, then boolean false is returned.
  331.     * @access private
  332.     */
  333.     function _import_ImageMagick($presenter, $srcfile, $destpath, $viewurl, $destfile, $destfileext, $destname, $position = -1)
  334.     {
  335.         global $IMAGICK_CONVERT_PATH;
  336.  
  337.         // Do a security check -- has command-line execution of IMagick been disabled by the admin?
  338.         sloodle_debug("<br/><strong>Attempting to use ImageMagick by command-line.</strong><br/>");
  339.         if (empty($IMAGICK_CONVERT_PATH)) {
  340.             sloodle_debug(" ERROR: path to ImageMagick \"convert\" program is blank.");
  341.             return false;
  342.         }
  343.         // Now make sure there are no quotation marks in the source/destination file and path names
  344.         //  (these could be used to execute malicious commands on the server)
  345.         if (strpos($srcfile, "\"") !== false || strpos($destpath, "\"") !== false || strpos($destfile, "\"") !== false || strpos($destfileext, "\"") != false) error("Invalid file name -- please remove quotation marks from file names.");
  346.  
  347.         // Execute the conversion command
  348.         $cmd = escapeshellcmd("{$IMAGICK_CONVERT_PATH} -verbose \"{$srcfile}\" \"{$destpath}/{$destfile}.{$destfileext}\"");
  349.         $output = '';
  350.         sloodle_debug(" Executing shell command<br/>");
  351.         $result = exec($cmd);
  352.         // If all the output is empty, then execution failed
  353.         if (empty($result) && empty($output)) {
  354.             sloodle_debug(" ERROR: execution of the shell command failed.<br/>");
  355.             return false;
  356.         }
  357.         
  358.         // Quick validation - position should start at 1. (-ve numbers mean "at the end")
  359.         if ($position == 0) $position = 1;
  360.  
  361.         // Go through each page which was created.
  362.         // Stop when we encounter a file which wasn't created -- that will be the end of the document.
  363.         $pagenum = 0; $page_position = -1;
  364.         $stop = false;
  365.         while ($stop == false && $pagenum < 10000) {
  366.             // Determine this page's position in the Presentation
  367.             if ($position > 0) $page_position = $position + $pagenum;
  368.  
  369.             // Construct the file and slide names for this page
  370.             $page_filename = "{$destpath}/{$destfile}-{$pagenum}.{$destfileext}"; // Where it gets uploaded to
  371.             $page_slidesource = "{$viewurl}/{$destfile}-{$pagenum}.{$destfileext}"; // The URL to access it publicly
  372.             $page_slidename = "{$destname} (".($pagenum + 1).")";
  373.             // Was this file created?
  374.             if (file_exists($page_filename)) {
  375.                 // Add it to the Presenter
  376.                 $presenter->add_entry($page_slidesource, 'PresenterSlideImage', $page_slidename, $page_position);
  377.                 $pagenum++;
  378.             } else {
  379.                 $stop = true;
  380.             }
  381.         }
  382.  
  383.         return $pagenum;
  384.     }
  385.     
  386.  
  387.  
  388.     /**
  389.     * Gets the human-readable name of this plugin.
  390.     * @param string $lang Optional -- can specify the language we want the plugin name in, as an identifier like "en_utf8". If unspecified, then the current Moodle language should be used.
  391.     * @access public
  392.     * @return string The human-readable name of this plugin
  393.     */
  394.     function get_plugin_name($lang = null)
  395.     {
  396.         return 'PDF Importer';
  397.     }
  398.  
  399.     /**
  400.     * Gets the human-readable description of this plugin.
  401.     */
  402.     function get_plugin_description($lang = null)
  403.     {
  404.         return 'Imports an Adbobe Acrobat (PDF) file into your Presentation. Each page becomes a single image slide.';
  405.     }
  406.  
  407.     /**
  408.     * Gets the internal version number of this plugin.
  409.     * This should be a number like the internal version number for Moodle modules, containing the date and release number.
  410.     * Format is: YYYYMMDD##.
  411.     * For example, "2009012302" would be the 3rd release on the 23rd January 2009.
  412.     * @return int The version number of this module.
  413.     */
  414.     function get_version()
  415.     {
  416.         return 2009063000;
  417.     }
  418. }
  419.  
  420.  
  421. ?>

Documentation generated on Fri, 17 Jul 2009 11:02:21 +0100 by phpDocumentor 1.4.0