NOBUG: comment is a reserved word for oracle. I reserve my comments about it ;-)
[moodle.git] / mod / glossary / db / upgrade.php
1 <?php
3 // This file keeps track of upgrades to
4 // the glossary module
5 //
6 // Sometimes, changes between versions involve
7 // alterations to database structures and other
8 // major things that may break installations.
9 //
10 // The upgrade function in this file will attempt
11 // to perform all the necessary actions to upgrade
12 // your older installtion to the current version.
13 //
14 // If there's something it cannot do itself, it
15 // will tell you what you need to do.
16 //
17 // The commands in here will all be database-neutral,
18 // using the methods of database_manager class
19 //
20 // Please do not forget to use upgrade_set_timeout()
21 // before any action that may take longer time to finish.
23 function xmldb_glossary_upgrade($oldversion) {
24     global $CFG, $DB, $OUTPUT;
26     $dbman = $DB->get_manager();
27     $result = true;
29 //===== 1.9.0 upgrade line ======//
31     if ($result && $oldversion < 2008081900) {
33         /////////////////////////////////////
34         /// new file storage upgrade code ///
35         /////////////////////////////////////
37         $fs = get_file_storage();
39         $empty = $DB->sql_empty(); // silly oracle empty string handling workaround
41         $sqlfrom = "FROM {glossary_entries} ge
42                     JOIN {glossary} g ON g.id = ge.glossaryid
43                     JOIN {modules} m ON m.name = 'glossary'
44                     JOIN {course_modules} cm ON (cm.module = m.id AND cm.instance = g.id)
45                    WHERE ge.attachment <> '$empty' AND ge.attachment <> '1'";
47         $count = $DB->count_records_sql("SELECT COUNT('x') $sqlfrom");
49         if ($rs = $DB->get_recordset_sql("SELECT ge.id, ge.userid, ge.attachment, ge.glossaryid, ge.sourceglossaryid, g.course, cm.id AS cmid $sqlfrom ORDER BY g.course, g.id")) {
51             $pbar = new progress_bar('migrateglossaryfiles', 500, true);
53             $i = 0;
54             foreach ($rs as $entry) {
55                 $i++;
56                 upgrade_set_timeout(60); // set up timeout, may also abort execution
57                 $pbar->update($i, $count, "Migrating glossary entries - $i/$count.");
59                 $filepath = "$CFG->dataroot/$entry->course/$CFG->moddata/glossary/$entry->glossaryid/$entry->id/$entry->attachment";
60                 if ($entry->sourceglossaryid and !is_readable($filepath)) {
61                     //eh - try the second possible location
62                     $filepath = "$CFG->dataroot/$entry->course/$CFG->moddata/glossary/$entry->sourceglossaryid/$entry->id/$entry->attachment";
64                 }
65                 if (!is_readable($filepath)) {
66                     //file missing??
67                     echo $OUTPUT->notification("File not readable, skipping: $filepath");
68                     $entry->attachment = '';
69                     $DB->update_record('glossary_entries', $entry);
70                     continue;
71                 }
72                 $context = get_context_instance(CONTEXT_MODULE, $entry->cmid);
74                 $filearea = 'glossary_attachment';
75                 $filename = clean_param($entry->attachment, PARAM_FILE);
76                 if ($filename === '') {
77                     echo $OUTPUT->notification("Unsupported entry filename, skipping: ".$filepath);
78                     $entry->attachment = '';
79                     $DB->update_record('glossary_entries', $entry);
80                     continue;
81                 }
82                 if (!$fs->file_exists($context->id, $filearea, $entry->id, '/', $filename)) {
83                     $file_record = array('contextid'=>$context->id, 'filearea'=>$filearea, 'itemid'=>$entry->id, 'filepath'=>'/', 'filename'=>$filename, 'userid'=>$entry->userid);
84                     if ($fs->create_file_from_pathname($file_record, $filepath)) {
85                         $entry->attachment = '1';
86                         if ($DB->update_record('glossary_entries', $entry)) {
87                             unlink($filepath);
88                         }
89                     }
90                 }
92                 // remove dirs if empty
93                 @rmdir("$CFG->dataroot/$entry->course/$CFG->moddata/glossary/$entry->glossaryid/$entry->id");
94                 @rmdir("$CFG->dataroot/$entry->course/$CFG->moddata/glossary/$entry->glossaryid");
95                 @rmdir("$CFG->dataroot/$entry->course/$CFG->moddata/glossary");
96             }
97             $rs->close();
98         }
100         upgrade_mod_savepoint($result, 2008081900, 'glossary');
101     }
103     if ($result && $oldversion < 2009042000) {
105     /// Rename field definitionformat on table glossary_entries to definitionformat
106         $table = new xmldb_table('glossary_entries');
107         $field = new xmldb_field('format', XMLDB_TYPE_INTEGER, '2', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'definition');
109     /// Launch rename field definitionformat
110         $dbman->rename_field($table, $field, 'definitionformat');
112     /// glossary savepoint reached
113         upgrade_mod_savepoint($result, 2009042000, 'glossary');
114     }
116     if ($result && $oldversion < 2009042001) {
118     /// Define field definitiontrust to be added to glossary_entries
119         $table = new xmldb_table('glossary_entries');
120         $field = new xmldb_field('definitiontrust', XMLDB_TYPE_INTEGER, '2', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'definitionformat');
122     /// Launch add field definitiontrust
123         $dbman->add_field($table, $field);
125     /// glossary savepoint reached
126         upgrade_mod_savepoint($result, 2009042001, 'glossary');
127     }
129     if ($result && $oldversion < 2009042002) {
131     /// Rename field format on table glossary_comments to NEWNAMEGOESHERE
132         $table = new xmldb_table('glossary_comments');
133         $field = new xmldb_field('format', XMLDB_TYPE_INTEGER, '2', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'entrycomment');
135     /// Launch rename field format
136         $dbman->rename_field($table, $field, 'entrycommentformat');
138     /// glossary savepoint reached
139         upgrade_mod_savepoint($result, 2009042002, 'glossary');
140     }
142     if ($result && $oldversion < 2009042003) {
144     /// Define field entrycommenttrust to be added to glossary_comments
145         $table = new xmldb_table('glossary_comments');
146         $field = new xmldb_field('entrycommenttrust', XMLDB_TYPE_INTEGER, '2', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'entrycommentformat');
148     /// Conditionally launch add field entrycommenttrust
149         if (!$dbman->field_exists($table, $field)) {
150             $dbman->add_field($table, $field);
151         }
153     /// glossary savepoint reached
154         upgrade_mod_savepoint($result, 2009042003, 'glossary');
155     }
157     if ($result && $oldversion < 2009042004) {
158         $trustmark = '#####TRUSTTEXT#####';
159         $rs = $DB->get_recordset_sql("SELECT * FROM {glossary_entries} WHERE definition LIKE '$trustmark%'");
160         foreach ($rs as $entry) {
161             if (strpos($entry->definition, $trustmark) !== 0) {
162                 // probably lowercase in some DBs
163                 continue;
164             }
165             $entry->definition      = trusttext_strip($entry->definition);
166             $entry->definitiontrust = 1;
167             $DB->update_record('glossary_entries', $entry);
168         }
169         $rs->close();
171     /// glossary savepoint reached
172         upgrade_mod_savepoint($result, 2009042004, 'glossary');
173     }
175     if ($result && $oldversion < 2009042005) {
176         $trustmark = '#####TRUSTTEXT#####';
177         $rs = $DB->get_recordset_sql("SELECT * FROM {glossary_comments} WHERE entrycomment LIKE '$trustmark%'");
178         foreach ($rs as $comment) {
179             if (strpos($comment->entrycomment, $trustmark) !== 0) {
180                 // probably lowercase in some DBs
181                 continue;
182             }
183             $comment->entrycomment      = trusttext_strip($comment->entrycomment);
184             $comment->entrycommenttrust = 1;
185             $DB->update_record('glossary_comments', $comment);
186         }
187         $rs->close();
189     /// glossary savepoint reached
190         upgrade_mod_savepoint($result, 2009042005, 'glossary');
191     }
193     if ($result && $oldversion < 2009042006) {
195     /// Define field introformat to be added to glossary
196         $table = new xmldb_table('glossary');
197         $field = new xmldb_field('introformat', XMLDB_TYPE_INTEGER, '4', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'intro');
199     /// Conditionally launch add field introformat
200         if (!$dbman->field_exists($table, $field)) {
201             $dbman->add_field($table, $field);
202         }
204     /// glossary savepoint reached
205         upgrade_mod_savepoint($result, 2009042006, 'glossary');
206     }
207     if ($result && $oldversion < 2009110800) {
208         require_once($CFG->dirroot . '/comment/lib.php');
209         upgrade_set_timeout(60*20);
211     /// Define table glossary_comments to be dropped
212         $table = new xmldb_table('glossary_comments');
214     /// Conditionally launch drop table for glossary_comments
215         if ($dbman->table_exists($table)) {
216             $sql = 'SELECT e.glossaryid AS glossaryid,
217                 g.course AS courseid,
218                 e.id AS itemid,
219                 c.id AS old_id,
220                 c.entrycomment AS commentcontent,
221                 c.entrycommentformat AS format,
222                 c.entrycommenttrust AS trust,
223                 c.timemodified AS timemodified
224                 FROM {glossary_comments} c, {glossary_entries} e, {glossary} g
225                 WHERE c.entryid=e.id AND e.glossaryid=g.id ORDER BY glossaryid, courseid';
226             $lastglossaryid = null;
227             $lastcourseid   = null;
228             $modcontext     = null;
230         /// move glossary comments to new comments table
231             if ($rs = $DB->get_recordset_sql($sql)) {
232                 foreach($rs as $res) {
233                     if ($res->glossaryid != $lastglossaryid || $res->courseid != $lastcourseid) {
234                         $cm = get_coursemodule_from_instance('glossary', $res->glossaryid, $res->courseid);
235                         if ($cm) {
236                             $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
237                         }
238                         $lastglossaryid = $res->glossaryid;
239                         $lastcourseid   = $res->courseid;
240                     }
241                     $cmt = new stdclass;
242                     $cmt->contextid = $modcontext->id;
243                     $cmt->courseid  = $res->courseid;
244                     $cmt->area      = 'glossary_entry';
245                     $cmt->itemid    = $res->itemid;
246                     $comment = new comment($cmt);
247                     $cmt = $comment->add($res->commentcontent, $res->format);
248                     if (!empty($cmt)) {
249                         $DB->delete_records('glossary_comments', array('id'=>$res->old_id));
250                     }
251                 }
252             }
253             $dbman->drop_table($table);
254         }
256     /// glossary savepoint reached
257         upgrade_mod_savepoint($result, 2009110800, 'glossary');
258     }
260     if($result && $oldversion < 2010031800) {
261         //migrate glossary_ratings to the central rating table
262         require_once('../lib/db/upgradelib.php');
264         //glossary ratings only have a single time column so use it for both time created and modified
265         $ratingssql = 'SELECT r.id AS rid, r.entryid AS itemid, r.rating, r.userid, r.time AS timecreated, r.time AS timemodified, g.scale, g.id AS mid
266 FROM {glossary_ratings} r
267 JOIN {glossary_entries} ge ON ge.id=r.entryid
268 JOIN {glossary} g ON g.id=ge.glossaryid';
269         $result = $result && upgrade_module_ratings($ratingssql,'glossary');
271         //todo andrew drop glossary_ratings
273         //todo andrew set rating permissions based on current value of glossary.assessed
275         upgrade_mod_savepoint($result, 2010031800, 'glossary');
276     }
278     return $result;