Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?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/>.

/**
 * Upgrade code for the feedback_editpdf module.
 *
 * @package   assignfeedback_editpdf
 * @copyright 2013 Jerome Mouneyrac
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

/**
 * EditPDF upgrade code
 * @param int $oldversion
 * @return bool
 */
function xmldb_assignfeedback_editpdf_upgrade($oldversion) {
    global $CFG, $DB;

    $dbman = $DB->get_manager();

< // Automatically generated Moodle v3.5.0 release upgrade line.
> // Automatically generated Moodle v3.9.0 release upgrade line.
// Put any upgrade step following this.
< if ($oldversion < 2018051401) { < $table = new xmldb_table('assignfeedback_editpdf_queue'); < $field = new xmldb_field('attemptedconversions', XMLDB_TYPE_INTEGER, '10', null, < XMLDB_NOTNULL, null, 0, 'submissionattempt'); < < if (!$dbman->field_exists($table, $field)) { < $dbman->add_field($table, $field); < } < < // Attempts are removed from the queue after being processed, a duplicate row won't achieve anything productive. < // So look for any duplicates and remove them so we can add a unique key. < $sql = "SELECT MIN(id) as minid, submissionid, submissionattempt
> if ($oldversion < 2021060400) { > // Remove submissions from the processing queue that have been processed. > $sql = 'DELETE
FROM {assignfeedback_editpdf_queue}
< GROUP BY submissionid, submissionattempt < HAVING COUNT(id) > 1"; < < if ($duplicatedrows = $DB->get_recordset_sql($sql)) { < foreach ($duplicatedrows as $row) { < $DB->delete_records_select('assignfeedback_editpdf_queue', < 'submissionid = :submissionid AND submissionattempt = :submissionattempt AND id <> :minid', (array)$row); < } < } < $duplicatedrows->close(); < < // Define key submissionid-submissionattempt to be added to assignfeedback_editpdf_queue. < $table = new xmldb_table('assignfeedback_editpdf_queue'); < $key = new xmldb_key('submissionid-submissionattempt', XMLDB_KEY_UNIQUE, ['submissionid', 'submissionattempt']);
> WHERE EXISTS (SELECT 1 > FROM {assign_submission} s, > {assign_grades} g > WHERE s.id = submissionid > AND s.assignment = g.assignment > AND s.userid = g.userid > AND s.attemptnumber = g.attemptnumber)';
< $dbman->add_key($table, $key);
> $DB->execute($sql);
< upgrade_plugin_savepoint(true, 2018051401, 'assignfeedback', 'editpdf');
> // Editpdf savepoint reached. > upgrade_plugin_savepoint(true, 2021060400, 'assignfeedback', 'editpdf');
}
< // Automatically generated Moodle v3.6.0 release upgrade line.
> // Automatically generated Moodle v4.0.0 release upgrade line.
// Put any upgrade step following this.
< if ($oldversion < 2019010800) { < // Define table assignfeedback_editpdf_rot to be created. < $table = new xmldb_table('assignfeedback_editpdf_rot'); < < // Adding fields to table assignfeedback_editpdf_rot. < $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null); < $table->add_field('gradeid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0'); < $table->add_field('pageno', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0'); < $table->add_field('pathnamehash', XMLDB_TYPE_TEXT, null, null, XMLDB_NOTNULL, null, null); < $table->add_field('isrotated', XMLDB_TYPE_INTEGER, '1', null, XMLDB_NOTNULL, null, '0'); < $table->add_field('degree', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0'); < < // Adding keys to table assignfeedback_editpdf_rot. < $table->add_key('primary', XMLDB_KEY_PRIMARY, ['id']); < $table->add_key('gradeid', XMLDB_KEY_FOREIGN, ['gradeid'], 'assign_grades', ['id']); < < // Adding indexes to table assignfeedback_editpdf_rot. < $table->add_index('gradeid_pageno', XMLDB_INDEX_UNIQUE, ['gradeid', 'pageno']); < < // Conditionally launch create table for assignfeedback_editpdf_rot. < if (!$dbman->table_exists($table)) { < $dbman->create_table($table);
> if ($oldversion < 2022061000) { > $table = new xmldb_table('assignfeedback_editpdf_queue'); > if ($dbman->table_exists($table)) { > // Convert not yet converted submissions into adhoc tasks. > $rs = $DB->get_recordset('assignfeedback_editpdf_queue'); > foreach ($rs as $record) { > $data = [ > 'submissionid' => $record->submissionid, > 'submissionattempt' => $record->submissionattempt, > ]; > $task = new assignfeedback_editpdf\task\convert_submission; > $task->set_custom_data($data); > \core\task\manager::queue_adhoc_task($task, true); > } > $rs->close(); > > // Drop the table. > $dbman->drop_table($table);
} // Editpdf savepoint reached.
< upgrade_plugin_savepoint(true, 2019010800, 'assignfeedback', 'editpdf');
> upgrade_plugin_savepoint(true, 2022061000, 'assignfeedback', 'editpdf');
}
< // Automatically generated Moodle v3.7.0 release upgrade line. < // Put any upgrade step following this.
> if ($oldversion < 2022082200) { > // Conversion records need to be removed in order for conversions to restart. > $DB->delete_records('file_conversion');
< // Automatically generated Moodle v3.8.0 release upgrade line. < // Put any upgrade step following this.
> // Schedule an adhoc task to fix existing stale conversions. > $task = new \assignfeedback_editpdf\task\bump_submission_for_stale_conversions(); > \core\task\manager::queue_adhoc_task($task);
< // Automatically generated Moodle v3.9.0 release upgrade line. < // Put any upgrade step following this.
> upgrade_plugin_savepoint(true, 2022082200, 'assignfeedback', 'editpdf'); > }
< // Automatically generated Moodle v3.10.0 release upgrade line.
> // Automatically generated Moodle v4.1.0 release upgrade line.
// Put any upgrade step following this.
< if ($oldversion < 2020110901) { < // Remove submissions from the processing queue that have been processed. < $sql = 'DELETE < FROM {assignfeedback_editpdf_queue} < WHERE EXISTS (SELECT 1 < FROM {assign_submission} s, < {assign_grades} g < WHERE s.id = submissionid < AND s.assignment = g.assignment < AND s.userid = g.userid < AND s.attemptnumber = g.attemptnumber)';
> if ($oldversion < 2022112801) { > $task = new \assignfeedback_editpdf\task\remove_orphaned_editpdf_files(); > \core\task\manager::queue_adhoc_task($task);
< $DB->execute($sql); < < // Editpdf savepoint reached. < upgrade_plugin_savepoint(true, 2020110901, 'assignfeedback', 'editpdf');
> upgrade_plugin_savepoint(true, 2022112801, 'assignfeedback', 'editpdf');
} return true; }