. /** * upgrade processes for this module. * * @package mod_attendance * @copyright 2011 Artem Andreev * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); require_once(dirname(__FILE__) . '/upgradelib.php'); /** * upgrade this attendance instance - this function could be skipped but it will be needed later * @param int $oldversion The old version of the attendance module * @return bool */ function xmldb_attendance_upgrade($oldversion=0) { global $DB; $dbman = $DB->get_manager(); // Loads ddl manager and xmldb classes. $result = true; if ($oldversion < 2014112000) { $table = new xmldb_table('attendance_sessions'); $field = new xmldb_field('studentscanmark'); $field->set_attributes(XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0'); if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } upgrade_mod_savepoint(true, 2014112000, 'attendance'); } if ($oldversion < 2014112001) { // Replace values that reference old module "attforblock" to "attendance". $sql = "UPDATE {grade_items} SET itemmodule = 'attendance' WHERE itemmodule = 'attforblock'"; $DB->execute($sql); $sql = "UPDATE {grade_items_history} SET itemmodule = 'attendance' WHERE itemmodule = 'attforblock'"; $DB->execute($sql); /* * The user's custom capabilities need to be preserved due to the module renaming. * Capabilities with a modifierid = 0 value are installed by default. * Only update the user's custom capabilities where modifierid is not zero. */ $sql = $DB->sql_like('capability', '?').' AND modifierid <> 0'; $rs = $DB->get_recordset_select('role_capabilities', $sql, array('%mod/attforblock%')); foreach ($rs as $cap) { $renamedcapability = str_replace('mod/attforblock', 'mod/attendance', $cap->capability); $exists = $DB->record_exists('role_capabilities', array('roleid' => $cap->roleid, 'capability' => $renamedcapability)); if (!$exists) { $DB->update_record('role_capabilities', array('id' => $cap->id, 'capability' => $renamedcapability)); } } // Delete old role capabilities. $sql = $DB->sql_like('capability', '?'); $DB->delete_records_select('role_capabilities', $sql, array('%mod/attforblock%')); // Delete old capabilities. $DB->delete_records_select('capabilities', 'component = ?', array('mod_attforblock')); upgrade_mod_savepoint(true, 2014112001, 'attendance'); } if ($oldversion < 2015040501) { // Define table attendance_tempusers to be created. $table = new xmldb_table('attendance_tempusers'); // Adding fields to table attendance_tempusers. $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null); $table->add_field('studentid', XMLDB_TYPE_INTEGER, '10', null, null, null, null); $table->add_field('courseid', XMLDB_TYPE_INTEGER, '10', null, null, null, null); $table->add_field('fullname', XMLDB_TYPE_CHAR, '100', null, null, null, null); $table->add_field('email', XMLDB_TYPE_CHAR, '100', null, null, null, null); $table->add_field('created', XMLDB_TYPE_INTEGER, '10', null, null, null, null); // Adding keys to table attendance_tempusers. $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id')); // Conditionally launch create table for attendance_tempusers. if (!$dbman->table_exists($table)) { $dbman->create_table($table); } // Conditionally launch add index courseid. $index = new xmldb_index('courseid', XMLDB_INDEX_NOTUNIQUE, array('courseid')); if (!$dbman->index_exists($table, $index)) { $dbman->add_index($table, $index); } // Conditionally launch add index studentid. $index = new xmldb_index('studentid', XMLDB_INDEX_UNIQUE, array('studentid')); if (!$dbman->index_exists($table, $index)) { $dbman->add_index($table, $index); } // Attendance savepoint reached. upgrade_mod_savepoint(true, 2015040501, 'attendance'); } if ($oldversion < 2015040502) { // Define field setnumber to be added to attendance_statuses. $table = new xmldb_table('attendance_statuses'); $field = new xmldb_field('setnumber', XMLDB_TYPE_INTEGER, '5', null, XMLDB_NOTNULL, null, '0', 'deleted'); // Conditionally launch add field setnumber. if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } // Define field statusset to be added to attendance_sessions. $table = new xmldb_table('attendance_sessions'); $field = new xmldb_field('statusset', XMLDB_TYPE_INTEGER, '5', null, XMLDB_NOTNULL, null, '0', 'descriptionformat'); // Conditionally launch add field statusset. if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } // Attendance savepoint reached. upgrade_mod_savepoint(true, 2015040502, 'attendance'); } if ($oldversion < 2015040503) { // Changing type of field grade on table attendance_statuses to number. $table = new xmldb_table('attendance_statuses'); $field = new xmldb_field('grade', XMLDB_TYPE_NUMBER, '5, 2', null, XMLDB_NOTNULL, null, '0', 'description'); // Launch change of type for field grade. $dbman->change_field_type($table, $field); // Attendance savepoint reached. upgrade_mod_savepoint(true, 2015040503, 'attendance'); } if ($oldversion < 2016052202) { // Adding field to store calendar event ids. $table = new xmldb_table('attendance_sessions'); $field = new xmldb_field('caleventid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', null); // Conditionally launch add field statusset. if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } // Creating events for all existing sessions. attendance_upgrade_create_calendar_events(); // Attendance savepoint reached. upgrade_mod_savepoint(true, 2016052202, 'attendance'); } if ($oldversion < 2016082900) { // Define field timemodified to be added to attendance. $table = new xmldb_table('attendance'); $field = new xmldb_field('timemodified', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'grade'); // Conditionally launch add field timemodified. if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } // Attendance savepoint reached. upgrade_mod_savepoint(true, 2016082900, 'attendance'); } if ($oldversion < 2016112100) { $table = new xmldb_table('attendance'); $newfield = $table->add_field('subnet', XMLDB_TYPE_CHAR, '255', null, null, null, null, 'timemodified'); if (!$dbman->field_exists($table, $newfield)) { $dbman->add_field($table, $newfield); } upgrade_mod_savepoint(true, 2016112100, 'attendance'); } if ($oldversion < 2016121300) { $table = new xmldb_table('attendance'); $field = new xmldb_field('sessiondetailspos', XMLDB_TYPE_CHAR, '5', null, null, null, 'left', 'subnet'); if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } $field = new xmldb_field('showsessiondetails', XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '1', 'subnet'); if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } upgrade_mod_savepoint(true, 2016121300, 'attendance'); } if ($oldversion < 2017020700) { // Define field timemodified to be added to attendance. $table = new xmldb_table('attendance'); $fields = []; $fields[] = new xmldb_field('intro', XMLDB_TYPE_TEXT, null, null, null, null, null, 'timemodified'); $fields[] = new xmldb_field('introformat', XMLDB_TYPE_INTEGER, '4', null, XMLDB_NOTNULL, null, 0, 'intro'); // Conditionally launch add field. foreach ($fields as $field) { if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } } // Attendance savepoint reached. upgrade_mod_savepoint(true, 2017020700, 'attendance'); } if ($oldversion < 2017042800) { $table = new xmldb_table('attendance_sessions'); $field = new xmldb_field('studentpassword'); $field->set_attributes(XMLDB_TYPE_CHAR, '50', null, false, null, '', 'studentscanmark'); if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } upgrade_mod_savepoint(true, 2017042800, 'attendance'); } if ($oldversion < 2017050202) { // Define field studentavailability to be added to attendance_statuses. $table = new xmldb_table('attendance_statuses'); $field = new xmldb_field('studentavailability', XMLDB_TYPE_INTEGER, '10', null, null, null, null, 'grade'); // Conditionally launch add field studentavailability. if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } // Attendance savepoint reached. upgrade_mod_savepoint(true, 2017050202, 'attendance'); } if ($oldversion < 2017050204) { $table = new xmldb_table('attendance_sessions'); $newfield = $table->add_field('subnet', XMLDB_TYPE_CHAR, '255', null, null, null, null, 'studentpassword'); if (!$dbman->field_exists($table, $newfield)) { $dbman->add_field($table, $newfield); // The meaning of the subnet in the attendance table has changed - it is now the "default" value - find all existing // Attendance with subnet set and set the session subnet for these. $attendances = $DB->get_recordset_select('attendance', 'subnet IS NOT NULL'); foreach ($attendances as $attendance) { if (!empty($attendance->subnet)) { // Get all sessions for this attendance. $sessions = $DB->get_recordset('attendance_sessions', array('attendanceid' => $attendance->id)); foreach ($sessions as $session) { $session->subnet = $attendance->subnet; $DB->update_record('attendance_sessions', $session); } $sessions->close(); } } $attendances->close(); } upgrade_mod_savepoint(true, 2017050204, 'attendance'); } if ($oldversion < 2017050206) { // Define field setunmarked to be added to attendance_statuses. $table = new xmldb_table('attendance_statuses'); $field = new xmldb_field('setunmarked', XMLDB_TYPE_INTEGER, '2', null, null, null, null, 'studentavailability'); // Conditionally launch add field setunmarked. if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } // Define field setunmarked to be added to attendance_statuses. $table = new xmldb_table('attendance_sessions'); $field = new xmldb_field('automark', XMLDB_TYPE_INTEGER, '1', null, true, null, '0', 'subnet'); // Conditionally launch add field automark. if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } $field = new xmldb_field('automarkcompleted', XMLDB_TYPE_INTEGER, '1', null, true, null, '0', 'automark'); // Conditionally launch add field automarkcompleted. if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } // Attendance savepoint reached. upgrade_mod_savepoint(true, 2017050206, 'attendance'); } if ($oldversion < 2017050209) { // Automark values changed. $default = get_config('attendance', 'automark_default'); if (!empty($default)) { // Change default if set. set_config('automark_default', 2, 'attendance'); } // Update any sessions set to use automark = 1. $sql = "UPDATE {attendance_sessions} SET automark = 2 WHERE automark = 1"; $DB->execute($sql); // Update automarkcompleted to 2 if already complete. $sql = "UPDATE {attendance_sessions} SET automarkcompleted = 2 WHERE automarkcompleted = 1"; $DB->execute($sql); upgrade_mod_savepoint(true, 2017050209, 'attendance'); } // Add new warning table. if ($oldversion < 2017050210) { // Define table attendance_warning_done to be created. $table = new xmldb_table('attendance_warning_done'); // Adding fields to table attendance_warning_done. $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null); $table->add_field('notifyid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null); $table->add_field('userid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null); $table->add_field('timesent', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null); // Adding keys to table attendance_warning_done. $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id')); // Adding indexes to table attendance_warning_done. $table->add_index('notifyid_userid', XMLDB_INDEX_UNIQUE, array('notifyid', 'userid')); // Conditionally launch create table for attendance_warning_done. if (!$dbman->table_exists($table)) { $dbman->create_table($table); } // Attendance savepoint reached. upgrade_mod_savepoint(true, 2017050210, 'attendance'); } if ($oldversion < 2017050213) { // Fix key. $table = new xmldb_table('attendance_warning'); if (!$dbman->table_exists($table)) { // Adding fields to table attendance_warning. $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null); $table->add_field('idnumber', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null); $table->add_field('warningpercent', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null); $table->add_field('warnafter', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null); $table->add_field('emailuser', XMLDB_TYPE_INTEGER, '4', null, XMLDB_NOTNULL, null, null); $table->add_field('emailsubject', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null); $table->add_field('emailcontent', XMLDB_TYPE_TEXT, null, null, XMLDB_NOTNULL, null, null); $table->add_field('emailcontentformat', XMLDB_TYPE_INTEGER, '4', null, XMLDB_NOTNULL, null, null); $table->add_field('thirdpartyemails', XMLDB_TYPE_TEXT, null, null, null, null, null); // Adding keys to table attendance_warning. $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id')); $table->add_key('level_id', XMLDB_KEY_UNIQUE, array('idnumber, warningpercent, warnafter')); // Conditionally launch create table for attendance_warning. $dbman->create_table($table); } else { // Key definition is probably incorrect so fix it - drop_key dml function doesn't seem to work. $indexes = $DB->get_indexes('attendance_warning'); foreach ($indexes as $name => $index) { if ($DB->get_dbfamily() === 'mysql') { $DB->execute("ALTER TABLE {attendance_warning} DROP INDEX ". $name); } else { $DB->execute("DROP INDEX ". $name); } } $index = new xmldb_key('level_id', XMLDB_KEY_UNIQUE, array('idnumber, warningpercent', 'warnafter')); $dbman->add_key($table, $index); } // Attendance savepoint reached. upgrade_mod_savepoint(true, 2017050213, 'attendance'); } if ($oldversion < 2017050214) { // Define field setunmarked to be added to attendance_statuses. $table = new xmldb_table('attendance_warning'); $field = new xmldb_field('maxwarn', XMLDB_TYPE_INTEGER, '10', null, true, null, '1', 'warnafter'); // Conditionally launch add field automark. if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } // Define field setunmarked to be added to attendance_statuses. $table = new xmldb_table('attendance_warning_done'); $index = new xmldb_index('notifyid_userid', XMLDB_INDEX_UNIQUE, array('notifyid', 'userid')); $dbman->drop_index($table, $index); $index = new xmldb_index('notifyid', XMLDB_INDEX_NOTUNIQUE, array('notifyid', 'userid')); $dbman->add_index($table, $index); // Attendance savepoint reached. upgrade_mod_savepoint(true, 2017050214, 'attendance'); } if ($oldversion < 2017050216) { // Warnings idnumber field should use attendanceid instead of cmid. $sql = "SELECT cm.id, cm.instance FROM {course_modules} cm JOIN {modules} md ON md.id = cm.module AND md.name = 'attendance'"; $idnumbers = $DB->get_records_sql_menu($sql); $warnings = $DB->get_recordset('attendance_warning'); foreach ($warnings as $warning) { if (!empty($warning->idnumber) && !empty($idnumbers[$warning->idnumber])) { $warning->idnumber = $idnumbers[$warning->idnumber]; $DB->update_record("attendance_warning", $warning); } } $warnings->close(); // Attendance savepoint reached. upgrade_mod_savepoint(true, 2017050216, 'attendance'); } if ($oldversion < 2017050222) { $table = new xmldb_table('attendance_sessions'); $field = new xmldb_field('absenteereport'); $field->set_attributes(XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '1', 'statusset'); if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } upgrade_mod_savepoint(true, 2017050222, 'attendance'); } if ($oldversion < 2017050223) { $table = new xmldb_table('attendance_sessions'); $field = new xmldb_field('autoassignstatus'); $field->set_attributes(XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'studentscanmark'); if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } upgrade_mod_savepoint(true, 2017050223, 'attendance'); } if ($oldversion < 2017050225) { $table = new xmldb_table('attendance'); $field = new xmldb_field('showextrauserdetails', XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '1', 'showsessiondetails'); if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } upgrade_mod_savepoint(true, 2017050225, 'attendance'); } if ($oldversion < 2017050227) { $table = new xmldb_table('attendance_sessions'); $field = new xmldb_field('preventsharedip', XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'absenteereport'); if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } $field = new xmldb_field('preventsharediptime', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, null, null, null, 'preventsharedip'); if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } $table = new xmldb_table('attendance_log'); $field = new xmldb_field('ipaddress', XMLDB_TYPE_CHAR, '45', null, null, null, '', 'remarks'); if (!$dbman->field_exists($table, $field)) { $dbman->add_field($table, $field); } upgrade_mod_savepoint(true, 2017050227, 'attendance'); } return $result; }