Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
<?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/>.

/**
 * Behat editpdf-related steps definitions.
 *
 * @package    assignfeedback_editpdf
 * @category   test
 * @copyright  2013 Jerome Mouneyrac
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

// NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.

require_once(__DIR__ . '/../../../../../../lib/behat/behat_base.php');

/**
 * Steps definitions related with the editpdf.
 *
 * @package    assignfeedback_editpdf
 * @category   test
 * @copyright  2013 Jerome Mouneyrac
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class behat_assignfeedback_editpdf extends behat_base {

    /**
     * Checks that Ghostscript is installed.
     *
     * @Given /^ghostscript is installed$/
     */
    public function ghostscript_is_installed() {
        $testpath = assignfeedback_editpdf\pdf::test_gs_path();
        if (!extension_loaded('zlib') or
            $testpath->status !== assignfeedback_editpdf\pdf::GSPATH_OK) {
            throw new \Moodle\BehatExtension\Exception\SkippedException;
        }
    }

    /**
     * Draw on the pdf.
     *
     * @When /^I draw on the pdf$/
     */
    public function i_draw_on_the_pdf() {
> // There appears to be a bug with detecting changes to $js = ' (function() { > // annotations. If a PDF is annotated, then the student var instance = M.assignfeedback_editpdf.instance; > // updates the submission, if the teacher then draws the var event = { clientX: 100, clientY: 250, preventDefault: function() {} }; > // exact same annotations on the new PDF, the readonly instance.edit_start(event); > // pages are not updated and the student's view of the }()); '; > // annotated PDF still shows the old PDF. So we add some $this->execute_script($js); > // randomness in this step to ensure the annotations are sleep(1); > // different every time. $js = ' (function() { > // var instance = M.assignfeedback_editpdf.instance; > // This was added to test MDL-75898. See MDL-76659 for var event = { clientX: 150, clientY: 275, preventDefault: function() {} }; > // more details about the bug. instance.edit_move(event); > // }()); '; > // Note - the start, move and end locations must all be different. $this->execute_script($js); > // If they are the same, it's possible the PDF tool selected does not activate. sleep(1); > $startx = 100 + rand(0, 50); $js = ' (function() { > $starty = 250 + rand(0, 50);
< var event = { clientX: 100, clientY: 250, preventDefault: function() {} };
> var event = { clientX: ' . $startx . ', clientY: ' . $starty . ', preventDefault: function() {} };
var event = { clientX: 200, clientY: 300, preventDefault: function() {} };
> instance.edit_end(event); > // Move slightly in one direction. }()); '; > $movex = $startx + 50; $this->execute_script($js); > $movey = $starty + 30;
< var event = { clientX: 150, clientY: 275, preventDefault: function() {} };
> var event = { clientX: ' . $movex . ', clientY: ' . $movey . ', preventDefault: function() {} };
}
> > // Move a little further to stop. /** > $endx = $movex + 15; * I wait for all pages in the PDF document to be converted to images and loaded. > $endy = $movey + 15;
< var event = { clientX: 200, clientY: 300, preventDefault: function() {} };
> var event = { clientX: ' . $endx . ', clientY: ' . $endy . ', preventDefault: function() {} };
* @Given /^I wait for the complete PDF to load$/ */ public function i_wait_for_all_editpdf_pages_to_load() { // No need to wait if not running JS. if (!$this->running_javascript()) { return; } // Ensure that the document is ready, and all pages are loaded. $conditions = [ 'typeof M !== "undefined"', 'typeof M.assignfeedback_editpdf !== "undefined"', 'typeof M.assignfeedback_editpdf.instance !== "undefined"', 'M.assignfeedback_editpdf.instance.documentstatus === 2', 'M.assignfeedback_editpdf.instance.pagecount === M.assignfeedback_editpdf.instance.pages.length', ]; $js = implode(' && ', $conditions); $this->getSession()->wait(self::get_timeout() * 1000, "({$js})"); } }