332dec3a0c53fe4f66b52a1f58de2717b49108ec
[moodle.git] / mod / imscp / 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  * IMS CP module upgrade related helper functions
20  *
21  * @package   mod-imscp
22  * @copyright 2009 Petr Skoda (http://skodak.org)
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 /**
27  * Migrate imscp module data from 1.9 resource_old table to new imscp table
28  * @return void
29  */
30 function imscp_20_migrate() {
31     global $CFG, $DB, $OUTPUT;
32     require_once("$CFG->libdir/filelib.php");
33     require_once("$CFG->dirroot/course/lib.php");
34     require_once("$CFG->dirroot/mod/imscp/locallib.php");
36     if (!file_exists("$CFG->dirroot/mod/resource/db/upgradelib.php")) {
37         // bad luck, somebody deleted resource module
38         return;
39     }
41     require_once("$CFG->dirroot/mod/resource/db/upgradelib.php");
43     // create resource_old table and copy resource table there if needed
44     if (!resource_20_prepare_migration()) {
45         // no modules or fresh install
46         return;
47     }
49     if (!$candidates = $DB->get_recordset('resource_old', array('type'=>'ims', 'migrated'=>0))) {
50         return;
51     }
53     $fs = get_file_storage();
55     foreach ($candidates as $candidate) {
56         upgrade_set_timeout(60);
58         $imscp = new object();
59         $imscp->course       = $candidate->course;
60         $imscp->name         = $candidate->name;
61         $imscp->intro        = $candidate->intro;
62         $imscp->introformat  = $candidate->introformat;
63         $imscp->revision     = 1;
64         $imscp->keepold      = 1;
65         $imscp->timemodified = time();
67         if (!$imscp = resource_migrate_to_module('imscp', $candidate, $imscp)) {
68             continue;
69         }
71         $context = get_context_instance(CONTEXT_MODULE, $candidate->cmid);
72         $root = "$CFG->dataroot/$candidate->course/$CFG->moddata/resource/$candidate->oldid";
74         // migrate package backup file
75         if ($candidate->reference) {
76             $package = basename($candidate->reference);
77             $fullpath = $root.'/'.$package;
78             if (file_exists($fullpath)) {
79                 $file_record = array('contextid' => $context->id,
80                                      'component' => 'mod_imscp',
81                                      'filearea'  => 'backup',
82                                      'itemid'    => 1,
83                                      'filepath'  => '/',
84                                      'filename'  => $package);
85                 $fs->create_file_from_pathname($file_record, $fullpath);
86             }
87         }
89         // migrate extracted package data
90         $files = imsc_migrate_get_old_files($root, '');
91         if (empty($files)) {
92             // if ims package doesn't exist, continue loop
93             echo $OUTPUT->notification("IMS package data cannot be found, failed migrating activity: \"$candidate->name\", please fix it manually");
94             continue;
95         }
97         $file_record = array('contextid'=>$context->id, 'component'=>'mod_imscp', 'filearea'=>'content', 'itemid'=>1);
98         $error = false;
99         foreach ($files as $relname=>$fullpath) {
100             $parts = explode('/', $relname);
101             $file_record['filename'] = array_pop($parts);
102             $parts[] = ''; // keep trailing slash
103             $file_record['filepath'] = implode('/', $parts);
105             try {
106                 $fs->create_file_from_pathname($file_record, $fullpath);
107             } catch (Exception $e) {
108                 //continue on error, we can not recover anyway
109                 $error = true;
110                 echo $OUTPUT->notification("IMSCP: failed migrating file: $relname");
111             }
112         }
113         unset($files);
115         // parse manifest
116         $structure = imscp_parse_structure($imscp, $context);
117         $imscp->structure = is_array($structure) ? serialize($structure) : null;
118         $DB->update_record('imscp', $imscp);
120         // remove old moddata dir only if no error and manifest ok
121         if (!$error and is_array($structure)) {
122             fulldelete($root);
123         }
124     }
126     $candidates->close();
128     // clear all course modinfo caches
129     rebuild_course_cache(0, true);
132 /**
133  * Private function returning all extracted IMS content package file
134  */
135 function imsc_migrate_get_old_files($path, $relative) {
136     global $OUTPUT;
137     $result = array();
138     if (!file_exists($path)) {
139         echo $OUTPUT->notification("File path doesn't exist: $path <br/> Please fix it manually.");
140         return array();
141     }
142     $items = new DirectoryIterator($path);
143     foreach ($items as $item) {
144         if ($item->isDot() or $item->isLink()) {
145             // symbolik links could create infinite loops or cause unintended file migration, sorry
146             continue;
147         }
148         $pathname = $item->getPathname();
149         $relname  = $relative.'/'.$item->getFilename();
150         if ($item->isFile()) {
151             $result[$relname] = $pathname;
152         } else if ($item->isDir()) {
153             $result = array_merge($result, imsc_migrate_get_old_files($pathname, $relname));
154         }
155         unset($item);
156     }
157     unset($items);
158     return $result;