moodle-mod_attendance/db/upgrade.php

<?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/>.

// This file keeps track of upgrades to
// the attforblock module.

function xmldb_attforblock_upgrade($oldversion=0) {

    global $CFG, $THEME, $DB;
    $dbman = $DB->get_manager(); // Loads ddl manager and xmldb classes.

    $result = true;

    if ($oldversion < 2008021904) { // New version in version.php.
        global $USER;
        if ($sessions = $DB->get_records('attendance_sessions', array('takenby'=> 0))) {
            foreach ($sessions as $sess) {
                if ($DB->count_records('attendance_log', array('attsid'=> $sess->id)) > 0) {
                    $sess->takenby = $USER->id;
                    $sess->timetaken = $sess->timemodified ? $sess->timemodified : time();
                    $sess->description = addslashes($sess->description);
                    $result = $DB->update_record('attendance_sessions', $sess) and $result;
                }
            }
        }
                upgrade_mod_savepoint(true, 2008021904, 'attforblock');
    }

    if ($oldversion < 2008102401) {

        $table = new xmldb_table('attforblock');

        $field = new xmldb_field('grade');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '100', 'name');
        $dbman->add_field($table, $field);

        $table = new xmldb_table('attendance_sessions');

        $field = new xmldb_field('courseid');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'id');
        $dbman->change_field_unsigned($table, $field);

        $field = new xmldb_field('sessdate');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'creator');
        $dbman->change_field_unsigned($table, $field);

        $field = new xmldb_field('duration');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'sessdate');
        $dbman->add_field($table, $field);

        $field = new xmldb_field('timetaken');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'takenby');
        $dbman->change_field_unsigned($table, $field);
        $dbman->rename_field($table, $field, 'lasttaken');

        $field = new xmldb_field('takenby');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'lasttaken');
        $dbman->change_field_unsigned($table, $field);
        $dbman->rename_field($table, $field, 'lasttakenby');

        $field = new xmldb_field('timemodified');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, null, null, null, 'lasttaken');
        $dbman->change_field_unsigned($table, $field);

        $table = new xmldb_table('attendance_log');

        $field = new xmldb_field('attsid');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'id');
        $dbman->change_field_unsigned($table, $field);

        $field = new xmldb_field('studentid');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'attsid');
        $dbman->change_field_unsigned($table, $field);

        $field = new xmldb_field('statusid');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'status');
        $dbman->add_field($table, $field);

        $field = new xmldb_field('statusset');
        $field->set_attributes(XMLDB_TYPE_CHAR, '100', null, null, null, null, 'statusid');
        $dbman->add_field($table, $field);

        $field = new xmldb_field('timetaken');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'statusid');
        $dbman->add_field($table, $field);

        $field = new xmldb_field('takenby');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'timetaken');
        $dbman->add_field($table, $field);

        // Indexes.
        $index = new xmldb_index('statusid');
        $index->set_attributes(XMLDB_INDEX_NOTUNIQUE, array('statusid'));
        $dbman->add_index($table, $index);

        $index = new xmldb_index('attsid');
        $index->set_attributes(XMLDB_INDEX_NOTUNIQUE, array('attsid'));
        $dbman->drop_index($table, $index);

        $field = new xmldb_field('attsid'); // Rename field.
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'id');
        $dbman->rename_field($table, $field, 'sessionid');

        $index = new xmldb_index('sessionid');
        $index->set_attributes(XMLDB_INDEX_NOTUNIQUE, array('sessionid'));
        $dbman->add_index($table, $index);

        $table = new xmldb_table('attendance_settings');

        $field = new xmldb_field('courseid');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'id');
        $dbman->change_field_unsigned($table, $field);

        $field = new xmldb_field('visible');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '1', 'grade');
        $dbman->add_field($table, $field);

        $field = new xmldb_field('deleted');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '1', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'visible');
        $dbman->add_field($table, $field);

        // Indexes.
        $index = new xmldb_index('visible');
        $index->set_attributes(XMLDB_INDEX_NOTUNIQUE, array('visible'));
        $dbman->add_index($table, $index);

        $index = new xmldb_index('deleted');
        $index->set_attributes(XMLDB_INDEX_NOTUNIQUE, array('deleted'));
        $dbman->add_index($table, $index);

        $dbman->rename_table($table, 'attendance_statuses');

        upgrade_mod_savepoint(true, 2008102401, 'attforblock');
    }

    if ($oldversion < 2008102406) {

        if ($courses = $DB->get_records_sql("SELECT courseid FROM {attendance_sessions} GROUP BY courseid")) {
            foreach ($courses as $c) {
                // Adding own status for course (now it must have own).
                if (!$DB->count_records('attendance_statuses', array( 'courseid'=> $c->courseid))) {
                    $statuses = $DB->get_records('attendance_statuses', array('courseid'=> 0));
                    foreach ($statuses as $stat) {
                        $rec = $stat;
                        $rec->courseid = $c->courseid;
                        $DB->insert_record('attendance_statuses', $rec);
                    }
                }
                $statuses = $DB->get_records('attendance_statuses', array('courseid'=> $c->courseid));
                $statlist = implode(',', array_keys($statuses));
                $sess = $DB->get_records_select_menu('attendance_sessions',
                                                     "courseid = ? AND lasttakenby > 0", array($c->courseid));
                $sesslist = implode(',', array_keys($sess));
                foreach ($statuses as $stat) {
                    execute("UPDATE {attendance_log}
                                    SET statusid = {$stat->id}, statusset = '$statlist'
                                  WHERE sessionid IN ($sesslist) AND status = '$stat->status'");
                }
                $sessions = $DB->get_records_list('attendance_sessions',  array('id'=> $sesslist));
                foreach ($sessions as $sess) {
                    execute("UPDATE {attendance_log}
                                    SET timetaken = {$sess->lasttaken},
                                        takenby = {$sess->lasttakenby}
                                  WHERE sessionid = {$sess->id}");
                }

            }
        }
        upgrade_mod_savepoint(true, 2008102406, 'attforblock');
    }

    if ($oldversion < 2008102409) {
        $table = new xmldb_table('attendance_statuses');

        $field = new xmldb_field('status');
        $dbman->drop_field($table, $field);

        $index = new xmldb_index('status');
        $index->set_attributes(XMLDB_INDEX_NOTUNIQUE, array('status'));
        $dbman->drop_index($table, $index);

        $table = new xmldb_table('attendance_log');

        $field = new xmldb_field('status');
        $dbman->drop_field($table, $field);

        $index = new xmldb_index('status');
        $index->set_attributes(XMLDB_INDEX_NOTUNIQUE, array('status'));
        $dbman->drop_index($table, $index);

        $table = new xmldb_table('attendance_sessions');

        $field = new xmldb_field('creator');
        $dbman->drop_field($table, $field);
        upgrade_mod_savepoint(true, 2008102409, 'attforblock');
    }

    if ($oldversion < 2010070900) {
        $table = new xmldb_table('attendance_sessions');

        $field = new xmldb_field('groupid');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'courseid');
        if (!$dbman->field_exists($table, $field)) {
            $dbman->add_field($table, $field);
        }

        $index = new xmldb_index('groupid');
        $index->set_attributes(XMLDB_INDEX_NOTUNIQUE, array('groupid'));
        if (!$dbman->index_exists($table, $index)) {
            $dbman->add_index($table, $index);
        }

        upgrade_mod_savepoint(true, 2010070900, 'attforblock');
    }

    if ($oldversion < 2010123003) {

        $table = new xmldb_table('attendance_sessions');

        $field = new xmldb_field('attendanceid');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'groupid');
        if (!$dbman->field_exists($table, $field)) {
            $dbman->add_field($table, $field);
        }

        $index = new xmldb_index('attendanceid');
        $index->set_attributes(XMLDB_INDEX_NOTUNIQUE, array('attendanceid'));
        if (!$dbman->index_exists($table, $index)) {
            $dbman->add_index($table, $index);
        }

        $sql = "UPDATE {attendance_sessions} AS ses
                  JOIN {attforblock} AS att
                    ON (ses.courseid = att.course)
                   SET ses.attendanceid=att.id";
        $DB->execute($sql);

        $table = new xmldb_table('attendance_statuses');

        $field = new xmldb_field('attendanceid');
        $field->set_attributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'courseid');
        if (!$dbman->field_exists($table, $field)) {
            $dbman->add_field($table, $field);
        }
        $index = new xmldb_index('attendanceid');
        $index->set_attributes(XMLDB_INDEX_NOTUNIQUE, array('attendanceid'));
        if (!$dbman->index_exists($table, $index)) {
            $dbman->add_index($table, $index);
        }

        $sql = "UPDATE {attendance_statuses} AS sta
                  JOIN {attforblock} as att
                    ON (sta.courseid = att.course)
                   SET sta.attendanceid = att.id";
        $DB->execute($sql);

        upgrade_mod_savepoint(true, 2010123003, 'attforblock');
    }

    if ($oldversion < 2011061800) {
        $table = new xmldb_table('attendance_sessions');

        $field = new xmldb_field('description');
        $field->set_attributes(XMLDB_TYPE_TEXT, 'small', null, XMLDB_NOTNULL, null, null, 'timemodified');
        $dbman->change_field_type($table, $field);

        $field = new xmldb_field('descriptionformat', XMLDB_TYPE_INTEGER, '4',
                                 XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'description');

        if (!$dbman->field_exists($table, $field)) {
            $dbman->add_field($table, $field);
        }

        // Conditionally migrate to html format in intro.
        if ($CFG->texteditors !== 'textarea') {
            $rs = $DB->get_recordset('attendance_sessions', array('descriptionformat' => FORMAT_MOODLE),
                                     '', 'id,description,descriptionformat');
            foreach ($rs as $s) {
                $s->description       = text_to_html($s->description, false, false, true);
                $s->descriptionformat = FORMAT_HTML;
                $DB->update_record('attendance_sessions', $s);
                upgrade_set_timeout();
            }
            $rs->close();
        }

        // Now we can create more than one attendances per course
        // thus sessions and statuses belongs to attendance
        // so we don't need courseid fields in attendance_sessions and attendance_statuses.
        $index = new xmldb_index('courseid', XMLDB_INDEX_NOTUNIQUE, array('courseid'));
        if ($dbman->index_exists($table, $index)) {
            $dbman->drop_index($table, $index);
        }
        $field = new xmldb_field('courseid');
        if ($dbman->field_exists($table, $field)) {
            $dbman->drop_field($table, $field);
        }

        $table = new xmldb_table('attendance_statuses');
        if ($dbman->index_exists($table, $index)) {
            $dbman->drop_index($table, $index);
        }
        if ($dbman->field_exists($table, $field)) {
            $dbman->drop_field($table, $field);
        }

        upgrade_mod_savepoint(true, 2011061800, 'attforblock');
    }
    return $result;
}