spelling fix
[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
22  * @subpackage imscp
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 imscp module data from 1.9 resource_old table to new imscp table
31  * @return void
32  */
33 function imscp_20_migrate() {
34     global $CFG, $DB, $OUTPUT;
35     require_once("$CFG->libdir/filelib.php");
36     require_once("$CFG->dirroot/course/lib.php");
37     require_once("$CFG->dirroot/mod/imscp/locallib.php");
39     if (!file_exists("$CFG->dirroot/mod/resource/db/upgradelib.php")) {
40         // bad luck, somebody deleted resource module
41         return;
42     }
44     require_once("$CFG->dirroot/mod/resource/db/upgradelib.php");
46     // create resource_old table and copy resource table there if needed
47     if (!resource_20_prepare_migration()) {
48         // no modules or fresh install
49         return;
50     }
52     if (!$candidates = $DB->get_recordset('resource_old', array('type'=>'ims', 'migrated'=>0))) {
53         return;
54     }
56     $fs = get_file_storage();
58     foreach ($candidates as $candidate) {
59         upgrade_set_timeout(60);
61         if ($CFG->texteditors !== 'textarea') {
62             $intro       = text_to_html($candidate->intro, false, false, true);
63             $introformat = FORMAT_HTML;
64         } else {
65             $intro       = $candidate->intro;
66             $introformat = FORMAT_MOODLE;
67         }
69         $imscp = new object();
70         $imscp->course       = $candidate->course;
71         $imscp->name         = $candidate->name;
72         $imscp->intro        = $intro;
73         $imscp->introformat  = $introformat;
74         $imscp->revision     = 1;
75         $imscp->keepold      = 1;
76         $imscp->timemodified = time();
78         if (!$imscp = resource_migrate_to_module('imscp', $candidate, $imscp)) {
79             continue;
80         }
82         $context = get_context_instance(CONTEXT_MODULE, $candidate->cmid);
83         $root = "$CFG->dataroot/$candidate->course/$CFG->moddata/resource/$candidate->oldid";
85         // migrate package backup file
86         if ($candidate->reference) {
87             $package = basename($candidate->reference);
88             $fullpath = $root.'/'.$package;
89             if (file_exists($fullpath)) {
90                 $file_record = array('contextid' => $context->id,
91                                      'component' => 'mod_imscp',
92                                      'filearea'  => 'backup',
93                                      'itemid'    => 1,
94                                      'filepath'  => '/',
95                                      'filename'  => $package);
96                 $fs->create_file_from_pathname($file_record, $fullpath);
97             }
98         }
100         // migrate extracted package data
101         $files = imsc_migrate_get_old_files($root, '');
102         if (empty($files)) {
103             // if ims package doesn't exist, continue loop
104             echo $OUTPUT->notification("IMS package data cannot be found, failed migrating activity: \"$candidate->name\", please fix it manually");
105             continue;
106         }
108         $file_record = array('contextid'=>$context->id, 'component'=>'mod_imscp', 'filearea'=>'content', 'itemid'=>1);
109         $error = false;
110         foreach ($files as $relname=>$fullpath) {
111             $parts = explode('/', $relname);
112             $file_record['filename'] = array_pop($parts);
113             $parts[] = ''; // keep trailing slash
114             $file_record['filepath'] = implode('/', $parts);
116             try {
117                 $fs->create_file_from_pathname($file_record, $fullpath);
118             } catch (Exception $e) {
119                 //continue on error, we can not recover anyway
120                 $error = true;
121                 echo $OUTPUT->notification("IMSCP: failed migrating file: $relname");
122             }
123         }
124         unset($files);
126         // parse manifest
127         $structure = imscp_parse_structure($imscp, $context);
128         $imscp->structure = is_array($structure) ? serialize($structure) : null;
129         $DB->update_record('imscp', $imscp);
131         // remove old moddata dir only if no error and manifest ok
132         if (!$error and is_array($structure)) {
133             fulldelete($root);
134         }
135     }
137     $candidates->close();
139     // clear all course modinfo caches
140     rebuild_course_cache(0, true);
143 /**
144  * Private function returning all extracted IMS content package file
145  */
146 function imsc_migrate_get_old_files($path, $relative) {
147     global $OUTPUT;
148     $result = array();
149     if (!file_exists($path)) {
150         echo $OUTPUT->notification("File path doesn't exist: $path <br/> Please fix it manually.");
151         return array();
152     }
153     $items = new DirectoryIterator($path);
154     foreach ($items as $item) {
155         if ($item->isDot() or $item->isLink()) {
156             // symbolic links could create infinite loops or cause unintended file migration, sorry
157             continue;
158         }
159         $pathname = $item->getPathname();
160         $relname  = $relative.'/'.$item->getFilename();
161         if ($item->isFile()) {
162             $result[$relname] = $pathname;
163         } else if ($item->isDir()) {
164             $result = array_merge($result, imsc_migrate_get_old_files($pathname, $relname));
165         }
166         unset($item);
167     }
168     unset($items);
169     return $result;