question/type/essay/db/upgrade.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Essay question type upgrade code.
  19  *
  20  * @package    qtype
  21  * @subpackage essay
  22  * @copyright  2011 The Open University
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26
  27 defined('MOODLE_INTERNAL') || die();
  28
  29
  30 /**
  31  * Upgrade code for the essay question type.
  32  * @param int $oldversion the version we are upgrading from.
  33  */
  34 function xmldb_qtype_essay_upgrade($oldversion) {
  35     global $CFG, $DB;
  36
  37     $dbman = $DB->get_manager();
  38
  39
  40     // Moodle v2.2.0 release upgrade line
  41     // Put any upgrade step following this
  42
  43     if ($oldversion < 2011102701) {
  44         $sql = "
  45                   FROM {question} q
  46                   JOIN {question_answers} qa ON qa.question = q.id
  47
  48                  WHERE q.qtype = 'essay'
  49                    AND " . $DB->sql_isnotempty('question_answers', 'feedback', false, true);
  50         // In Moodle <= 2.0 essay had both question.generalfeedback and question_answers.feedback.
  51         // This was silly, and in Moodel >= 2.1 only question.generalfeedback. To avoid
  52         // dataloss, we concatenate question_answers.feedback onto the end of question.generalfeedback.
  53         $count = $DB->count_records_sql("
  54                 SELECT COUNT(1) $sql");
  55         if ($count) {
  56             $progressbar = new progress_bar('essay23', 500, true);
  57             $done = 0;
  58
  59             $toupdate = $DB->get_recordset_sql("
  60                     SELECT q.id,
  61                            q.generalfeedback,
  62                            q.generalfeedbackformat,
  63                            qa.feedback,
  64                            qa.feedbackformat
  65                     $sql");
  66
  67             foreach ($toupdate as $data) {
  68                 $progressbar->update($done, $count, "Updating essay feedback ($done/$count).");
  69                 upgrade_set_timeout(60);
  70                 if ($data->generalfeedbackformat == $data->feedbackformat) {
  71                     $DB->set_field('question', 'generalfeedback',
  72                             $data->generalfeedback . $data->feedback,
  73                             array('id' => $data->id));
  74
  75                 } else {
  76                     $newdata = new stdClass();
  77                     $newdata->id = $data->id;
  78                     $newdata->generalfeedback =
  79                             qtype_essay_convert_to_html($data->generalfeedback, $data->generalfeedbackformat) .
  80                             qtype_essay_convert_to_html($data->feedback,        $data->feedbackformat);
  81                     $newdata->generalfeedbackformat = FORMAT_HTML;
  82                     $DB->update_record('question', $newdata);
  83                 }
  84             }
  85
  86             $progressbar->update($count, $count, "Updating essay feedback complete!");
  87             $toupdate->close();
  88         }
  89
  90         // Essay savepoint reached.
  91         upgrade_plugin_savepoint(true, 2011102701, 'qtype', 'essay');
  92     }
  93
  94     if ($oldversion < 2011102702) {
  95         // Then we delete the old question_answers rows for essay questions.
  96         $DB->delete_records_select('question_answers',
  97                 "question IN (SELECT id FROM {question} WHERE qtype = 'essay')");
  98
  99         // Essay savepoint reached.
 100         upgrade_plugin_savepoint(true, 2011102702, 'qtype', 'essay');
 101     }
 102
 103     // Moodle v2.3.0 release upgrade line
 104     // Put any upgrade step following this
 105
 106
 107     // Moodle v2.4.0 release upgrade line
 108     // Put any upgrade step following this
 109
 110     if ($oldversion < 2013011800) {
 111         // Then we delete the old question_answers rows for essay questions.
 112         $DB->delete_records_select('qtype_essay_options', "NOT EXISTS (
 113                 SELECT 1 FROM {question} WHERE qtype = 'essay' AND
 114                     {question}.id = {qtype_essay_options}.questionid)");
 115
 116         // Essay savepoint reached.
 117         upgrade_plugin_savepoint(true, 2013011800, 'qtype', 'essay');
 118     }
 119
 120     return true;
 121 }
 122
 123 /**
 124  * Convert some content to HTML.
 125  * @param string $text the content to convert to HTML
 126  * @param int $oldformat One of the FORMAT_... constants.
 127  */
 128 function qtype_essay_convert_to_html($text, $oldformat) {
 129     switch ($oldformat) {
 130         // Similar to format_text.
 131
 132         case FORMAT_PLAIN:
 133             $text = s($text);
 134             $text = str_replace(' ', '&nbsp; ', $text);
 135             $text = nl2br($text);
 136             return $text;
 137
 138         case FORMAT_MARKDOWN:
 139             return markdown_to_html($text);
 140
 141         case FORMAT_MOODLE:
 142             return text_to_html($text);
 143
 144         case FORMAT_HTML:
 145             return $text;
 146
 147         default:
 148             throw new coding_exception(
 149                     'Unexpected text format when upgrading essay questions.');
 150     }
 151 }