Merge branch 'MDL-25708' of git://github.com/stronk7/moodle
[moodle.git] / mod / resource / db / upgradelib.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  * Resource module upgrade related helper functions
20  *
21  * @package    mod
22  * @subpackage resource
23  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die;
29 /**
30  * Migrate resource module data from 1.9 resource_old table to new resource table
31  * @return void
32  */
33 function resource_20_migrate() {
34     global $CFG, $DB;
36     require_once("$CFG->libdir/filelib.php");
37     require_once("$CFG->libdir/resourcelib.php");
38     require_once("$CFG->dirroot/course/lib.php");
40     $fs = get_file_storage();
42     $withrelativelinks = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/x-shockwave-flash');
43     // note: pdf doc and other types may contain links too, but we do not support relative links there
45     $candidates = $DB->get_recordset('resource_old', array('type'=>'file', 'migrated'=>0));
46     if (!$candidates->valid()) {
47         $candidates->close(); // Not going to iterate (but exit), close rs
48         return;
49     }
51     foreach ($candidates as $candidate) {
52         upgrade_set_timeout();
54         $path = $candidate->reference;
55         $siteid = get_site()->id;
56         $fs = get_file_storage();
58         if (empty($candidate->cmid)) {
59             // skip borked records
60             continue;
62         } else if (strpos($path, 'LOCALPATH') === 0) {
63             // ignore not maintained local files - sorry
64             continue;
66         } else if (preg_match("|$CFG->wwwroot/file.php(\?file=)?/$siteid(/[^\s'\"&\?#]+)|", $path, $matches)) {
67             // public site files
68             $path = $matches[2];
70             $resource = new stdClass();
71             $resource->id           = $candidate->oldid;
72             $resource->tobemigrated = 0;
73             $resource->mainfile     = $path;
74             $resource->filterfiles  = $CFG->filteruploadedfiles;
75             $resource->legacyfiles  = RESOURCELIB_LEGACYFILES_NO; // on-demand-migration not possible for site files, sorry
77             $context     = get_context_instance(CONTEXT_MODULE, $candidate->cmid);
78             $sitecontext = get_context_instance(CONTEXT_COURSE, $siteid);
79             $file_record = array('contextid'=>$context->id, 'component'=>'mod_resourse', 'filearea'=>'content', 'itemid'=>0);
80             if ($file = $fs->get_file_by_hash(sha1("/$sitecontext->id/course/legacy/content/0".$path))) {
81                 try {
82                     $fs->create_file_from_storedfile($file_record, $file);
83                 } catch (Exception $x) {
84                 }
85                 $resource->mainfile = $file->get_filepath().$file->get_filename();
86             }
88         } else if (preg_match("|$CFG->wwwroot/file.php(\?file=)?/$candidate->course(/[^\s'\"&\?#]+)|", $path, $matches)) {
89             // current course files
90             $path = $matches[2];
92             $resource = new stdClass();
93             $resource->id           = $candidate->oldid;
94             $resource->tobemigrated = 0;
95             $resource->mainfile     = $path;
96             $resource->filterfiles  = $CFG->filteruploadedfiles;
97             $mimetype = mimeinfo('type', $resource->mainfile);
98             if (in_array($mimetype, $withrelativelinks)) {
99                 $resource->legacyfiles = RESOURCELIB_LEGACYFILES_ACTIVE;
100             } else {
101                 $resource->legacyfiles = RESOURCELIB_LEGACYFILES_NO;
102             }
104             // try migration of main file - ignore if does not exist
105             if ($file = resourcelib_try_file_migration($resource->mainfile, $candidate->cmid, $candidate->course, 'mod_resource', 'content', 0)) {
106                 $resource->mainfile = $file->get_filepath().$file->get_filename();
107             }
109         } else if (strpos($path, '://') or strpos($path, '/') === 0) {
110             // http:// https:// ftp:// OR starts with slash - to be converted to link resource
111             continue;
113         } else {
114             // current course files
115             // cleanup old path first
116             $path = '/'.trim(trim($path), '/');
117             if (strpos($path, '?forcedownload=1') !== false) {
118                 // eliminate old force download tricks
119                 $candidate->options = 'forcedownload';
120                 $path = str_replace('?forcedownload=1', '', $path);
121             }
122             // get rid of any extra url parameters, sorry we can not support these
123             preg_match("/^[^?#]+/", $path, $matches);
124             $parts = $matches[0];
126             $resource = new stdClass();
127             $resource->id           = $candidate->oldid;
128             $resource->tobemigrated = 0;
129             $resource->mainfile     = $path;
130             $resource->filterfiles  = $CFG->filteruploadedfiles;
131             $mimetype = mimeinfo('type', $resource->mainfile);
132             if (in_array($mimetype, $withrelativelinks)) {
133                 $resource->legacyfiles = RESOURCELIB_LEGACYFILES_ACTIVE;
134             } else {
135                 $resource->legacyfiles = RESOURCELIB_LEGACYFILES_NO;
136             }
138             // try migration of main file - ignore if does not exist
139             if ($file = resourcelib_try_file_migration($resource->mainfile, $candidate->cmid, $candidate->course, 'mod_resource', 'content', 0)) {
140                 $resource->mainfile = $file->get_filepath().$file->get_filename();
141             }
142         }
144         $options = array('printheading'=>0, 'printintro'=>1);
145         if ($candidate->options == 'frame') {
146             $resource->display = RESOURCELIB_DISPLAY_FRAME;
148         } else if ($candidate->options == 'objectframe') {
149             $resource->display = RESOURCELIB_DISPLAY_EMBED;
151         } else if ($candidate->options == 'forcedownload') {
152             $resource->display = RESOURCELIB_DISPLAY_DOWNLOAD;
154         } else if ($candidate->popup) {
155             $resource->display = RESOURCELIB_DISPLAY_POPUP;
156             if ($candidate->popup) {
157                 $rawoptions = explode(',', $candidate->popup);
158                 foreach ($rawoptions as $rawoption) {
159                     list($name, $value) = explode('=', trim($rawoption), 2);
160                     if ($value > 0 and ($name == 'width' or $name == 'height')) {
161                         $options['popup'.$name] = $value;
162                         continue;
163                     }
164                 }
165             }
167         } else {
168             $resource->display = RESOURCELIB_DISPLAY_AUTO;
169         }
170         $resource->displayoptions = serialize($options);
172         // update resource instance and mark as migrated
173         $DB->update_record('resource', $resource);
174         $candidate->newmodule = 'resource';
175         $candidate->newid     = $candidate->oldid;
176         $candidate->migrated  = time();
177         $DB->update_record('resource_old', $candidate);
178     }
180     $candidates->close();
182     // clear all course modinfo caches
183     rebuild_course_cache(0, true);
186 /**
187  * This function creates resource_old table and copies all data
188  * from resource table, this functions has to be called from
189  * all modules that are successors of old resource module types.
190  * @return bool true if migration required, false if not
191  */
192 function resource_20_prepare_migration() {
193     global $DB;
195     $dbman = $DB->get_manager();
197     // If the resource not created yet, this is probably a new install
198     $table = new xmldb_table('resource');
199     if (!$dbman->table_exists($table)) {
200         return false;
201     }
203     // Define table resource_old to be created
204     $table = new xmldb_table('resource_old');
206     if ($dbman->table_exists($table)) {
207         //already executed
208         return true;
209     }
211     // fix invalid NULL popup and options data in old mysql databases
212     $sql = "UPDATE {resource} SET popup = ? WHERE popup IS NULL";
213     $DB->execute($sql, array($DB->sql_empty()));
214     $sql = "UPDATE {resource} SET options = ? WHERE options IS NULL";
215     $DB->execute($sql, array($DB->sql_empty()));
217     // Adding fields to table resource_old
218     $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
219     $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
220     $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
221     $table->add_field('type', XMLDB_TYPE_CHAR, '30', null, XMLDB_NOTNULL, null, null);
222     $table->add_field('reference', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
223     $table->add_field('intro', XMLDB_TYPE_TEXT, 'small', null, null, null, null);
224     $table->add_field('introformat', XMLDB_TYPE_INTEGER, '4', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
225     $table->add_field('alltext', XMLDB_TYPE_TEXT, 'medium', null, XMLDB_NOTNULL, null, null);
226     $table->add_field('popup', XMLDB_TYPE_TEXT, 'small', null, XMLDB_NOTNULL, null, null);
227     $table->add_field('options', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
228     $table->add_field('timemodified', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
229     $table->add_field('oldid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null);
230     $table->add_field('cmid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, null, null, null);
231     $table->add_field('newmodule', XMLDB_TYPE_CHAR, '50', null, null, null, null);
232     $table->add_field('newid', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, null, null, null);
233     $table->add_field('migrated', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
235     // Adding keys to table resource_old
236     $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
238     // Adding indexes to table resource_old
239     $table->add_index('oldid', XMLDB_INDEX_UNIQUE, array('oldid'));
240     $table->add_index('cmid', XMLDB_INDEX_NOTUNIQUE, array('cmid'));
242     // Launch create table for resource_old
243     $dbman->create_table($table);
245     $module = $DB->get_field('modules', 'id', array('name'=>'resource'));
247     if (!$DB->count_records('resource')) {
248         // upgrade of fresh new server from 1.9 - no upgrade needed
249         return false;
250     }
252     // copy old data, the intro text format was FORMAT_MOODLE==0
253     $sql = "INSERT INTO {resource_old} (oldid, course, name, type, reference, intro, introformat, alltext, popup, options, timemodified, cmid)
254             SELECT r.id, r.course, r.name, r.type, r.reference, r.summary, 0, r.alltext, r.popup, r.options, r.timemodified, cm.id
255               FROM {resource} r
256          LEFT JOIN {course_modules} cm ON (r.id = cm.instance AND cm.module = :module)";
258     $DB->execute($sql, array('module'=>$module));
260     return true;
263 /**
264  * Migrate old resource type to new module, updates all related info, keeps the context id.
265  * @param string $modname name of new module
266  * @param object $candidate old instance from resource_old
267  * @param object $newinstance new module instance to be inserted into db
268  * @return mixed false if error, object new instance with id if success
269  */
270 function resource_migrate_to_module($modname, $candidate, $newinstance) {
271     global $DB;
273     if (!$cm = get_coursemodule_from_id('resource', $candidate->cmid)) {
274         return false;
275     }
277     if (!$module = $DB->get_record('modules', array('name'=>$modname))) {
278         return false;
279     }
281     if (!$resource = $DB->get_record('resource', array('id'=>$candidate->oldid))) {
282         return false;
283     }
285     // insert new instance
286     $newinstance->id = $DB->insert_record($modname, $newinstance);
288     // update course modules
289     $cm->module   = $module->id;
290     $cm->instance = $newinstance->id;
291     $DB->update_record('course_modules', $cm);
293     //delete old record
294     $DB->delete_records('resource', array('id'=>$resource->id));
296     //mark as migrated
297     $candidate->newmodule = $modname;
298     $candidate->newid     = $newinstance->id;
299     $candidate->migrated  = time();
300     $DB->update_record('resource_old', $candidate);
302     //no need to upgrade data in logs because resource module is able to redirect to migrated instances
303     return $newinstance;