Merge branch 'MDL-25793' of git://github.com/samhemelryk/moodle
[moodle.git] / mod / wiki / db / upgrade.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This file keeps track of upgrades to the wiki module
20  *
21  * Sometimes, changes between versions involve
22  * alterations to database structures and other
23  * major things that may break installations.
24  *
25  * The upgrade function in this file will attempt
26  * to perform all the necessary actions to upgrade
27  * your older installation to the current version.
28  *
29  * @package mod-wiki-2.0
30  * @copyrigth 2009 Marc Alier, Jordi Piguillem marc.alier@upc.edu
31  * @copyrigth 2009 Universitat Politecnica de Catalunya http://www.upc.edu
32  *
33  * @author Jordi Piguillem
34  *
35  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
36  *
37  */
39 /**
40  *
41  * TODO LIST:
42  *
43  * 1. Add needed fields to wiki table. DONE
44  * 2. Rename other wiki tables. DONE
45  * 3. Create new wiki tables. DONE BUT NOT FINISHED, WATING FOR NEW TABLES
46  * 4. Move/Adapt/Transform configurations info to new structure
47  * 5. Migrate wiki entries to subwikis. DONE
48  * 6. Fill pages table with latest versions of every page. DONE
49  * 7. Migrate page history to new table (transforming formats). DONE, BUT STILL WORKING
50  * 8. Fill links table
51  * 9. Drop useless information
52  *
53  * ADITIONAL THINGS AFTER CHAT WITH ELOY:
54  *
55  * 1. addField is deprecated. DONE
56  * 2. Fix SQL error at block 3. DONE
57  * 3. Merge set_field_select with previous update sentence. DONE
58  * 4. Don't insert id fields on database (it won't work on mssql, oracle, pg). DONE.
59  * 5. Use upgrade_set_timeout function.
60  * 6. Use grafic of progess
61  *
62  * OTHER THINGS:
63  *
64  * 1. Use recordset instead of record when migrating historic
65  * 2. Select only usefull data on block 06
66  *
67  * @global moodle_database $DB
68  */
69 function xmldb_wiki_upgrade($oldversion) {
70     global $CFG, $DB, $OUTPUT;
72     $dbman = $DB->get_manager();
74     // Step 0: Add new fields to main wiki table
75     if ($oldversion < 2010040100) {
76         require_once(dirname(__FILE__) . '/upgradelib.php');
77         echo $OUTPUT->notification('Adding new fields to wiki table', 'notifysuccess');
78         wiki_add_wiki_fields();
80         upgrade_mod_savepoint(true, 2010040100, 'wiki');
81     }
83     // Step 1: Rename old tables
84     if ($oldversion < 2010040101) {
85         $tables = array('wiki_pages', 'wiki_locks', 'wiki_entries');
87         echo $OUTPUT->notification('Renaming old wiki module tables', 'notifysuccess');
88         foreach ($tables as $tablename) {
89             $table = new xmldb_table($tablename);
90             if ($dbman->table_exists($table)) {
91                 if ($dbman->table_exists($table)) {
92                     $dbman->rename_table($table, $tablename . '_old');
93                 }
94             }
95         }
96         upgrade_mod_savepoint(true, 2010040101, 'wiki');
97     }
99     // Step 2: Creating new tables
100     if ($oldversion < 2010040102) {
101         require_once(dirname(__FILE__) . '/upgradelib.php');
102         echo $OUTPUT->notification('Installing new wiki module tables', 'notifysuccess');
103         wiki_upgrade_install_20_tables();
104         upgrade_mod_savepoint(true, 2010040102, 'wiki');
105     }
107     // Step 3: migrating wiki instances
108     if ($oldversion < 2010040103) {
109         upgrade_set_timeout();
111         // Setting up wiki configuration
112         $sql = "UPDATE {wiki}
113                     SET intro = summary,
114                     firstpagetitle = pagename,
115                     defaultformat = ?";
116         $DB->execute($sql, array('html'));
118         $sql = "UPDATE {wiki}
119                     SET wikimode = ?
120                     WHERE wtype = ?";
121         $DB->execute($sql, array('collaborative', 'group'));
123         $sql = "UPDATE {wiki}
124                     SET wikimode = ?
125                     WHERE wtype != ?";
126         $DB->execute($sql, array('individual', 'group'));
128         // Removing edit & create capability to students in old teacher wikis
129         $studentroles = $DB->get_records('role', array('archetype' => 'student'));
130         $wikis = $DB->get_records('wiki');
131         foreach ($wikis as $wiki) {
132             echo $OUTPUT->notification('Migrating '.$wiki->wtype.' type wiki instance: '.$wiki->name, 'notifysuccess');
133             if ($wiki->wtype == 'teacher') {
134                 $cm = get_coursemodule_from_instance('wiki', $wiki->id);
135                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
136                 foreach ($studentroles as $studentrole) {
137                     role_change_permission($studentrole->id, $context, 'mod/wiki:editpage', CAP_PROHIBIT);
138                     role_change_permission($studentrole->id, $context, 'mod/wiki:createpage', CAP_PROHIBIT);
139                 }
140             }
141         }
143         echo $OUTPUT->notification('Migrating old wikis to new wikis', 'notifysuccess');
144         upgrade_mod_savepoint(true, 2010040103, 'wiki');
145     }
147     // Step 4: migrating wiki entries to new subwikis
148     if ($oldversion < 2010040104) {
149         /**
150          * Migrating wiki entries to new subwikis
151          */
152         $sql = "INSERT INTO {wiki_subwikis} (wikiid, groupid, userid)
153                 SELECT DISTINCT e.wikiid, e.groupid, e.userid
154                   FROM {wiki_entries_old} e";
155         echo $OUTPUT->notification('Migrating old entries to new subwikis', 'notifysuccess');
157         $DB->execute($sql, array());
159         upgrade_mod_savepoint(true, 2010040104, 'wiki');
160     }
162     // Step 5: Migrating pages
163     if ($oldversion < 2010040105) {
165         // select all wiki pages
166         $sql = "SELECT s.id, p.pagename, p.created, p.lastmodified, p.userid, p.hits
167                   FROM {wiki_pages_old} p
168                   LEFT OUTER JOIN {wiki_entries_old} e ON e.id = p.wiki
169                   LEFT OUTER JOIN {wiki_subwikis} s ON s.wikiid = e.wikiid AND s.groupid = e.groupid AND s.userid = e.userid
170                  WHERE p.version = (SELECT max(po.version)
171                                       FROM {wiki_pages_old} po
172                                      WHERE p.pagename = po.pagename AND p.wiki = po.wiki)";
173         echo $OUTPUT->notification('Migrating old pages to new pages', 'notifysuccess');
175         $records = $DB->get_recordset_sql($sql);
176         foreach ($records as $record) {
177             $page = new stdclass();
178             $page->subwikiid     = $record->id;
179             $page->title         = $record->pagename;
180             $page->cachedcontent = '**reparse needed**';
181             $page->timecreated   = $record->created;
182             $page->timemodified  = $record->lastmodified;
183             $page->userid        = $record->userid;
184             $page->pageviews     = $record->hits;
185             try {
186                 // make sure there is no duplicated records exist
187                 if (!$DB->record_exists('wiki_pages', array('subwikiid'=>$record->id, 'userid'=>$record->userid, 'title'=>$record->pagename))) {
188                     $DB->insert_record('wiki_pages', $page);
189                 }
190             } catch (dml_exception $e) {
191                 // catch possible insert exception
192                 debugging($e->getMessage());
193                 continue;
194             }
195         }
196         $records->close();
198         upgrade_mod_savepoint(true, 2010040105, 'wiki');
199     }
201     // Step 6: Migrating versions
202     if ($oldversion < 2010040106) {
203         require_once(dirname(__FILE__) . '/upgradelib.php');
204         echo $OUTPUT->notification('Migrating old history to new history', 'notifysuccess');
205         wiki_upgrade_migrate_versions();
206         upgrade_mod_savepoint(true, 2010040106, 'wiki');
207     }
209     // Step 7: refresh cachedcontent and fill wiki links table
210     if ($oldversion < 2010040107) {
211         require_once($CFG->dirroot. '/mod/wiki/locallib.php');
212         upgrade_set_timeout();
214         $pages = $DB->get_recordset('wiki_pages');
216         foreach ($pages as $page) {
217             wiki_refresh_cachedcontent($page);
218         }
220         $pages->close();
222         echo $OUTPUT->notification('Caching content', 'notifysuccess');
223         upgrade_mod_savepoint(true, 2010040107, 'wiki');
224     }
225     // Step 8, migrating files
226     if ($oldversion < 2010040108) {
227         $fs = get_file_storage();
228         $sql = "SELECT files.*, po.meta AS filemeta FROM {wiki_pages_old} po JOIN (
229                     SELECT DISTINCT po.id, po.pagename, w.id AS wikiid, po.userid,
230                         eo.id AS entryid, eo.groupid, s.id AS subwiki,
231                         w.course AS courseid, cm.id AS cmid
232                         FROM {wiki_pages_old} po
233                         LEFT OUTER JOIN {wiki_entries_old} eo
234                         ON eo.id=po.wiki
235                         LEFT OUTER JOIN {wiki} w
236                         ON w.id = eo.wikiid
237                         LEFT OUTER JOIN {wiki_subwikis} s
238                         ON s.groupid = eo.groupid AND s.wikiid = eo.wikiid AND eo.userid = s.userid
239                         JOIN {modules} m ON m.name = 'wiki'
240                         JOIN {course_modules} cm ON (cm.module = m.id AND cm.instance = w.id)
241                 ) files ON files.id = po.id";
243         $rs = $DB->get_recordset_sql($sql);
244         foreach ($rs as $r) {
245             if (strpos($r->pagename, 'internal://') !== false) {
246                 // Found a file resource!
247                 $pattern = 'internal://';
248                 $matches = array();
249                 $filename = str_replace($pattern, '', $r->pagename);
250                 $orgifilename = $filename = clean_param($filename, PARAM_FILE);
251                 $context = get_context_instance(CONTEXT_MODULE, $r->cmid);
252                 $filemeta = unserialize($r->filemeta);
253                 $filesection = $filemeta['section'];
254                 // When attach a file to wiki page, user can customize the file name instead of original file name
255                 // if user did, old wiki will create two pages, internal://original_pagename and internal://renamed_pagename
256                 // internal://original_pagename record has renamed pagename in meta field
257                 // but all file have this field
258                 // old wiki will rename file names to filter space and special character
259                 if (!empty($filemeta['Content-Location'])) {
260                     $orgifilename = urldecode($filemeta['Content-Location']);
261                     $orgifilename = str_replace(' ', '_', $orgifilename);
262                 }
263                 $thefile = $CFG->dataroot . '/' . $r->courseid . '/moddata/wiki/' . $r->wikiid .'/' . $r->entryid . '/'. $filesection .'/'. $filename;
265                 if (is_file($thefile) && is_readable($thefile)) {
266                     $filerecord = array('contextid' => $context->id,
267                                         'component' => 'mod_wiki',
268                                         'filearea'  => 'attachments',
269                                         'itemid'    => $r->subwiki,
270                                         'filepath'  => '/',
271                                         'filename'  => $orgifilename,
272                                         'userid'    => $r->userid);
273                     if (!$fs->file_exists($context->id, 'mod_wiki', 'attachments', $r->subwiki, '/', $orgifilename)) {
274                         //echo $OUTPUT->notification('Migrating file '.$orgifilename, 'notifysuccess');
275                         $storedfile = $fs->create_file_from_pathname($filerecord, $thefile);
276                     }
277                     // we have to create another file here to make sure interlinks work
278                     if (!$fs->file_exists($context->id, 'mod_wiki', 'attachments', $r->subwiki, '/', $filename)) {
279                         $filerecord['filename'] = $filename;
280                         //echo $OUTPUT->notification('Migrating file '.$filename, 'notifysuccess');
281                         $storedfile = $fs->create_file_from_pathname($filerecord, $thefile);
282                     }
283                 } else {
284                     echo $OUTPUT->notification("Bad data found: $r->pagename <br/> Expected file path: $thefile Please fix the bad file path manually.");
285                 }
286             }
287         }
288         $rs->close();
289         upgrade_mod_savepoint(true, 2010040108, 'wiki');
290     }
292     // Step 9: clean wiki table
293     if ($oldversion < 2010040109) {
294         $fields = array('summary', 'pagename', 'wtype', 'ewikiprinttitle', 'htmlmode', 'ewikiacceptbinary', 'disablecamelcase', 'setpageflags', 'strippages', 'removepages', 'revertchanges', 'initialcontent');
295         $table = new xmldb_table('wiki');
296         foreach ($fields as $fieldname) {
297             $field = new xmldb_field($fieldname);
298             if ($dbman->field_exists($table, $field)) {
299                 $dbman->drop_field($table, $field);
300             }
302         }
303         echo $OUTPUT->notification('Cleaning wiki table', 'notifysuccess');
304         upgrade_mod_savepoint(true, 2010040109, 'wiki');
305     }
307     if ($oldversion < 2010080201) {
309         $sql = "UPDATE {comments}
310                 SET commentarea = 'wiki_page'
311                 WHERE commentarea = 'wiki_comment_section'";
312         $DB->execute($sql);
314         $sql = "UPDATE {tag_instance}
315                 SET itemtype = 'wiki_page'
316                 WHERE itemtype = 'wiki'";
317         $DB->execute($sql);
319         echo $OUTPUT->notification('Updating comments and tags', 'notifysuccess');
321         upgrade_mod_savepoint(true, 2010080201, 'wiki');
322     }
324     if ($oldversion < 2010102500) {
326         // Define key subwikifk (foreign) to be added to wiki_pages
327         $table = new xmldb_table('wiki_pages');
328         $key = new xmldb_key('subwikifk', XMLDB_KEY_FOREIGN, array('subwikiid'), 'wiki_subwikis', array('id'));
330         // Launch add key subwikifk
331         $dbman->add_key($table, $key);
333          // Define key subwikifk (foreign) to be added to wiki_links
334         $table = new xmldb_table('wiki_links');
335         $key = new xmldb_key('subwikifk', XMLDB_KEY_FOREIGN, array('subwikiid'), 'wiki_subwikis', array('id'));
337         // Launch add key subwikifk
338         $dbman->add_key($table, $key);
340         // wiki savepoint reached
341         upgrade_mod_savepoint(true, 2010102500, 'wiki');
342     }
344     if ($oldversion < 2010102800) {
346         $sql = "UPDATE {tag_instance}
347                 SET itemtype = 'wiki_pages'
348                 WHERE itemtype = 'wiki_page'";
349         $DB->execute($sql);
351         echo $OUTPUT->notification('Updating tags itemtype', 'notifysuccess');
353         upgrade_mod_savepoint(true, 2010102800, 'wiki');
354     }
356     if ($oldversion < 2011011000) {
357         // Fix wiki in the post table after upgrade from 1.9
358         $table = new xmldb_table('wiki');
360         // name should default to Wiki
361         $field = new xmldb_field('name', XMLDB_TYPE_CHAR, 255, null, XMLDB_NOTNULL, null, 'Wiki', 'course');
362         if ($dbman->field_exists($table, $field)) {
363             $dbman->change_field_default($table, $field);
364         }
366         // timecreated field is missing after 1.9 upgrade
367         $field = new xmldb_field('timecreated', XMLDB_TYPE_INTEGER, 10, XMLDB_UNSIGNED, XMLDB_NOTNULL, null, 0, 'introformat');
368         if (!$dbman->field_exists($table, $field)) {
369             $dbman->add_field($table, $field);
370         }
372         // timemodified field is missing after 1.9 upgrade
373         $field = new xmldb_field('timemodified', XMLDB_TYPE_INTEGER, 10, XMLDB_UNSIGNED, XMLDB_NOTNULL, null, 0, 'timecreated');
374         if (!$dbman->field_exists($table, $field)) {
375             $dbman->add_field($table, $field);
376         }
378         // scaleid is not there any more
379         $field = new xmldb_field('scaleid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', null);
380         if ($dbman->field_exists($table, $field)) {
381             $dbman->drop_field($table, $field);
382         }
384         upgrade_mod_savepoint(true, 2011011000, 'wiki');
385     }
387     // TODO: Will hold the old tables so we will have chance to fix problems
388     // Will remove old tables once migrating 100% stable
389     // Step 10: delete old tables
390     //if ($oldversion < 2011000000) {
391         //$tables = array('wiki_pages', 'wiki_locks', 'wiki_entries');
393         //foreach ($tables as $tablename) {
394             //$table = new xmldb_table($tablename . '_old');
395             //if ($dbman->table_exists($table)) {
396                 //$dbman->drop_table($table);
397             //}
398         //}
399         //echo $OUTPUT->notification('Droping old tables', 'notifysuccess');
400         //upgrade_mod_savepoint(true, 2011000000, 'wiki');
401     //}
403     return true;