MDL-53923 mod_assign: test unoconv path

This commit is contained in:
Simey Lameze 2016-05-03 16:04:16 +08:00 committed by Adrian Greeve
parent 65cbefc403
commit c4d692285f
7 changed files with 221 additions and 0 deletions

View File

@ -1696,6 +1696,11 @@
<ON_CHECK message="unsupporteddbtablerowformat" />
</FEEDBACK>
</CUSTOM_CHECK>
<CUSTOM_CHECK file="lib/upgradelib.php" function="check_unoconv_version" level="optional">
<FEEDBACK>
<ON_CHECK message="unoconvwarning" />
</FEEDBACK>
</CUSTOM_CHECK>
</CUSTOM_CHECKS>
</MOODLE>
</COMPATIBILITY_MATRIX>

View File

@ -1073,6 +1073,7 @@ $string['unbookmarkthispage'] = 'Unbookmark this page';
$string['unicoderequired'] = 'It is required that you store all your data in Unicode format (UTF-8). New installations must be performed into databases that have their default character set as Unicode. If you are upgrading, you should perform the UTF-8 migration process (see the Admin page).';
$string['uninstallplugin'] = 'Uninstall';
$string['unlockaccount'] = 'Unlock account';
$string['unoconvwarning'] = 'The installed version of your unoconv is not supported, the required version for the assignment grading is 0.7';
$string['unsettheme'] = 'Unset theme';
$string['unsupported'] = 'Unsupported';
$string['unsupporteddbstorageengine'] = 'The database storage engine being used is no longer supported.';

View File

@ -2282,3 +2282,22 @@ function upgrade_install_plugins(array $installable, $confirmed, $heading='', $c
die();
}
}
/**
* Method used to check the installed unoconv version.
*
* @param environment_results $result object to update, if relevant.
* @return environment_results|null updated results or null if unoconv path is not executable.
*/
function check_unoconv_version(environment_results $result){
global $CFG;
if (!during_initial_install() && !empty($CFG->pathtounoconv) && is_executable(trim($CFG->pathtounoconv))) {
if (assignfeedback_editpdf\pdf::check_unoconv_version_support() === false) {
$result->setInfo('unoconv version not supported');
$result->setStatus(false);
return $result;
}
}
return null;
}

View File

@ -64,6 +64,23 @@ class pdf extends \FPDI {
const GSPATH_NOTESTFILE = 'notestfile';
/** Any other error */
const GSPATH_ERROR = 'error';
/** No errors */
const UNOCONVPATH_OK = 'ok';
/** Not set */
const UNOCONVPATH_EMPTY = 'empty';
/** Does not exist */
const UNOCONVPATH_DOESNOTEXIST = 'doesnotexist';
/** Is a dir */
const UNOCONVPATH_ISDIR = 'isdir';
/** Not executable */
const UNOCONVPATH_NOTEXECUTABLE = 'notexecutable';
/** Test file missing */
const UNOCONVPATH_NOTESTFILE = 'notestfile';
/** Version not supported */
const UNOCONVPATH_VERSIONNOTSUPPORTED = 'versionnotsupported';
/** Any other error */
const UNOCONVPATH_ERROR = 'error';
/** Min. width an annotation should have */
const MIN_ANNOTATION_WIDTH = 5;
/** Min. height an annotation should have */
@ -593,5 +610,93 @@ class pdf extends \FPDI {
die();
}
/**
* If the test pdf has been generated correctly and send it direct to the browser.
*/
public static function send_test_pdf() {
global $CFG;
require_once($CFG->libdir . '/filelib.php');
$filerecord = array(
'contextid' => \context_system::instance()->id,
'component' => 'test',
'filearea' => 'assignfeedback_editpdf',
'itemid' => 0,
'filepath' => '/',
'filename' => 'unoconv_test.docx'
);
// Get the fixture doc file content and generate and stored_file object.
$fs = get_file_storage();
$fixturefile = $CFG->libdir . '/tests/fixtures/unoconv-source.docx';
$fixturedata = file_get_contents($fixturefile);
$testdocx = $fs->get_file($filerecord['contextid'], $filerecord['component'], $filerecord['filearea'],
$filerecord['itemid'], $filerecord['filepath'], $filerecord['filename']);
if (!$testdocx) {
$testdocx = $fs->create_file_from_string($filerecord, $fixturedata);
}
// Convert the doc file to pdf and send it direct to the browser.
$result = $fs->get_converted_document($testdocx, 'pdf');
readfile_accel($result, 'application/pdf', true);
}
/**
* Check if unoconv configured path is correct and working.
*
* @return \stdClass an object with the test status and the UNOCONVPATH_ constant message.
*/
public static function test_unoconv_path() {
global $CFG;
$unoconvpath = $CFG->pathtounoconv;
$ret = new \stdClass();
$ret->status = self::UNOCONVPATH_OK;
$ret->message = null;
if (empty($unoconvpath)) {
$ret->status = self::UNOCONVPATH_EMPTY;
return $ret;
}
if (!file_exists($unoconvpath)) {
$ret->status = self::UNOCONVPATH_DOESNOTEXIST;
return $ret;
}
if (is_dir($unoconvpath)) {
$ret->status = self::UNOCONVPATH_ISDIR;
return $ret;
}
if (!is_executable($unoconvpath)) {
$ret->status = self::UNOCONVPATH_NOTEXECUTABLE;
return $ret;
}
if (self::check_unoconv_version_support() === false) {
$ret->status = self::UNOCONVPATH_VERSIONNOTSUPPORTED;
return $ret;
}
return $ret;
}
/**
* Check if the installed version of unoconv is supported.
*
* @return bool true if the present version is supported, false otherwise.
*/
public static function check_unoconv_version_support() {
global $CFG;
$unoconvbin = \escapeshellarg($CFG->pathtounoconv);
$command = "$unoconvbin --version";
exec($command, $output);
preg_match('/([0-9]+\.[0-9]+)/', $output[0], $matches);
$currentversion = (float)$matches[0];
$supportedversion = 0.7;
if ($currentversion < $supportedversion) {
return false;
}
return true;
}
}

View File

@ -53,6 +53,7 @@ $string['gotopage'] = 'Go to page';
$string['green'] = 'Green';
$string['gsimage'] = 'Ghostscript test image';
$string['pathtogspathdesc'] = 'Please note that annotate PDF requires the path to ghostscript to be set in {$a}.';
$string['pathtounoconvpathdesc'] = 'Please note that annotate PDF requires the path to unoconv to be set in {$a}.';
$string['highlight'] = 'Highlight';
$string['jsrequired'] = 'JavaScript is required to annotate a PDF. Please enable JavaScript in your browser to use this feature.';
$string['launcheditor'] = 'Launch PDF editor...';
@ -83,6 +84,14 @@ $string['test_isdir'] = 'The ghostscript path points to a folder, please include
$string['test_notestfile'] = 'The test PDF is missing';
$string['test_notexecutable'] = 'The ghostscript points to a file that is not executable';
$string['test_ok'] = 'The ghostscript path appears to be OK - please check you can see the message in the image below';
$string['test_doesnotexist'] = 'The ghostscript path points to a non-existent file';
$string['test_empty'] = 'The ghostscript path is empty - please enter the correct path';
$string['test_unoconv'] = 'Test unoconv path';
$string['test_unoconv_isdir'] = 'The unoconv path points to a folder, please include the unoconv program in the path you specify';
$string['test_unoconv_notestfile'] = 'The test DOC is missing';
$string['test_unoconv_notexecutable'] = 'The unoconv points to a file that is not executable';
$string['test_unoconv_ok'] = 'The unoconv path appears to properly configured, please click on the button below to download the test pdf file';
$string['test_unoconv_versionnotsupported'] = 'The minimum supported version for unoconv is 0.7';
$string['toolbarbutton'] = '{$a->tool} {$a->shortcut}';
$string['tool'] = 'Tool';
$string['viewfeedbackonline'] = 'View annotated PDF...';

View File

@ -42,3 +42,13 @@ $settings->add(new admin_setting_heading('pathtogs', get_string('pathtogs', 'adm
$url = new moodle_url('/mod/assign/feedback/editpdf/testgs.php');
$link = html_writer::link($url, get_string('testgs', 'assignfeedback_editpdf'));
$settings->add(new admin_setting_heading('testgs', '', $link));
// Unoconv setting.
$systempathslink = new moodle_url('/admin/settings.php', array('section' => 'systempaths'));
$systempathlink = html_writer::link($systempathslink, get_string('systempaths', 'admin'));
$settings->add(new admin_setting_heading('pathtounoconv', get_string('pathtounoconv', 'admin'),
get_string('pathtounoconvpathdesc', 'assignfeedback_editpdf', $systempathlink)));
$url = new moodle_url('/mod/assign/feedback/editpdf/testunoconv.php');
$link = html_writer::link($url, get_string('test_unoconv', 'assignfeedback_editpdf'));
$settings->add(new admin_setting_heading('test_unoconv', '', $link));

View File

@ -0,0 +1,72 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Test that unoconv is configured correctly
*
* @package assignfeedback_editpdf
* @copyright 2016 Simey Lameze
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require('../../../../config.php');
global $PAGE, $OUTPUT;
$PAGE->set_url(new moodle_url('/mod/assign/feedback/editpdf/testunoconv.php'));
$PAGE->set_context(context_system::instance());
require_login();
require_capability('moodle/site:config', context_system::instance());
$strheading = get_string('test_unoconv', 'assignfeedback_editpdf');
$PAGE->navbar->add(get_string('administrationsite'));
$PAGE->navbar->add(get_string('plugins', 'admin'));
$PAGE->navbar->add(get_string('assignmentplugins', 'mod_assign'));
$PAGE->navbar->add(get_string('feedbackplugins', 'mod_assign'));
$PAGE->navbar->add(get_string('pluginname', 'assignfeedback_editpdf'),
new moodle_url('/admin/settings.php?section=assignfeedback_editpdf'));
$PAGE->navbar->add($strheading);
$PAGE->set_heading($strheading);
$PAGE->set_title($strheading);
$sendpdf = optional_param('sendpdf', 0, PARAM_BOOL);
if ($sendpdf) {
// Serve the generated test pdf.
assignfeedback_editpdf\pdf::send_test_pdf();
die();
}
$result = assignfeedback_editpdf\pdf::test_unoconv_path();
switch ($result->status) {
case assignfeedback_editpdf\pdf::UNOCONVPATH_OK:
$msg = get_string('test_unoconv_ok', 'assignfeedback_editpdf');
$msg .= html_writer::empty_tag('br');
$pdflink = new moodle_url($PAGE->url, array('sendpdf' => 1));
$msg .= $OUTPUT->single_button($pdflink, get_string('download'));
$msg .= html_writer::empty_tag('br');
break;
case assignfeedback_editpdf\pdf::UNOCONVPATH_ERROR:
$msg = $result->message;
break;
default:
$msg = get_string("test_unoconv_{$result->status}", 'assignfeedback_editpdf');
break;
}
$returl = new moodle_url('/admin/settings.php', array('section' => 'assignfeedback_editpdf'));
$msg .= $OUTPUT->continue_button($returl);
echo $OUTPUT->header();
echo $OUTPUT->box($msg, 'generalbox ');
echo $OUTPUT->footer();