Merge branch 'MDL-32880_23_3' of git://github.com/pauln/moodle into MOODLE_23_STABLE
[moodle.git] / backup / converter / moodle1 / lib.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  * Provides classes used by the moodle1 converter
20  *
21  * @package    backup-convert
22  * @subpackage moodle1
23  * @copyright  2011 Mark Nielsen <mark@moodlerooms.com>
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->dirroot . '/backup/converter/convertlib.php');
30 require_once($CFG->dirroot . '/backup/util/xml/parser/progressive_parser.class.php');
31 require_once($CFG->dirroot . '/backup/util/xml/parser/processors/grouped_parser_processor.class.php');
32 require_once($CFG->dirroot . '/backup/util/dbops/backup_dbops.class.php');
33 require_once($CFG->dirroot . '/backup/util/dbops/backup_controller_dbops.class.php');
34 require_once($CFG->dirroot . '/backup/util/dbops/restore_dbops.class.php');
35 require_once($CFG->dirroot . '/backup/util/xml/contenttransformer/xml_contenttransformer.class.php');
36 require_once(dirname(__FILE__) . '/handlerlib.php');
38 /**
39  * Converter of Moodle 1.9 backup into Moodle 2.x format
40  */
41 class moodle1_converter extends base_converter {
43     /** @var progressive_parser moodle.xml file parser */
44     protected $xmlparser;
46     /** @var moodle1_parser_processor */
47     protected $xmlprocessor;
49     /** @var array of {@link convert_path} to process */
50     protected $pathelements = array();
52     /** @var null|string the current module being processed - used to expand the MOD paths */
53     protected $currentmod = null;
55     /** @var null|string the current block being processed - used to expand the BLOCK paths */
56     protected $currentblock = null;
58     /** @var string path currently locking processing of children */
59     protected $pathlock;
61     /** @var int used by the serial number {@link get_nextid()} */
62     private $nextid = 1;
64     /**
65      * Instructs the dispatcher to ignore all children below path processor returning it
66      */
67     const SKIP_ALL_CHILDREN = -991399;
69     /**
70      * Log a message
71      *
72      * @see parent::log()
73      * @param string $message message text
74      * @param int $level message level {@example backup::LOG_WARNING}
75      * @param null|mixed $a additional information
76      * @param null|int $depth the message depth
77      * @param bool $display whether the message should be sent to the output, too
78      */
79     public function log($message, $level, $a = null, $depth = null, $display = false) {
80         parent::log('(moodle1) '.$message, $level, $a, $depth, $display);
81     }
83     /**
84      * Detects the Moodle 1.9 format of the backup directory
85      *
86      * @param string $tempdir the name of the backup directory
87      * @return null|string backup::FORMAT_MOODLE1 if the Moodle 1.9 is detected, null otherwise
88      */
89     public static function detect_format($tempdir) {
90         global $CFG;
92         $filepath = $CFG->tempdir . '/backup/' . $tempdir . '/moodle.xml';
93         if (file_exists($filepath)) {
94             // looks promising, lets load some information
95             $handle = fopen($filepath, 'r');
96             $first_chars = fread($handle, 200);
97             fclose($handle);
99             // check if it has the required strings
100             if (strpos($first_chars,'<?xml version="1.0" encoding="UTF-8"?>') !== false and
101                 strpos($first_chars,'<MOODLE_BACKUP>') !== false and
102                 strpos($first_chars,'<INFO>') !== false) {
104                 return backup::FORMAT_MOODLE1;
105             }
106         }
108         return null;
109     }
111     /**
112      * Initialize the instance if needed, called by the constructor
113      *
114      * Here we create objects we need before the execution.
115      */
116     protected function init() {
118         // ask your mother first before going out playing with toys
119         parent::init();
121         $this->log('initializing '.$this->get_name().' converter', backup::LOG_INFO);
123         // good boy, prepare XML parser and processor
124         $this->log('setting xml parser', backup::LOG_DEBUG, null, 1);
125         $this->xmlparser = new progressive_parser();
126         $this->xmlparser->set_file($this->get_tempdir_path() . '/moodle.xml');
127         $this->log('setting xml processor', backup::LOG_DEBUG, null, 1);
128         $this->xmlprocessor = new moodle1_parser_processor($this);
129         $this->xmlparser->set_processor($this->xmlprocessor);
131         // make sure that MOD and BLOCK paths are visited
132         $this->xmlprocessor->add_path('/MOODLE_BACKUP/COURSE/MODULES/MOD');
133         $this->xmlprocessor->add_path('/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK');
135         // register the conversion handlers
136         foreach (moodle1_handlers_factory::get_handlers($this) as $handler) {
137             $this->log('registering handler', backup::LOG_DEBUG, get_class($handler), 1);
138             $this->register_handler($handler, $handler->get_paths());
139         }
140     }
142     /**
143      * Converts the contents of the tempdir into the target format in the workdir
144      */
145     protected function execute() {
146         $this->log('creating the stash storage', backup::LOG_DEBUG);
147         $this->create_stash_storage();
149         $this->log('parsing moodle.xml starts', backup::LOG_DEBUG);
150         $this->xmlparser->process();
151         $this->log('parsing moodle.xml done', backup::LOG_DEBUG);
153         $this->log('dropping the stash storage', backup::LOG_DEBUG);
154         $this->drop_stash_storage();
155     }
157     /**
158      * Register a handler for the given path elements
159      */
160     protected function register_handler(moodle1_handler $handler, array $elements) {
162         // first iteration, push them to new array, indexed by name
163         // to detect duplicates in names or paths
164         $names = array();
165         $paths = array();
166         foreach($elements as $element) {
167             if (!$element instanceof convert_path) {
168                 throw new convert_exception('path_element_wrong_class', get_class($element));
169             }
170             if (array_key_exists($element->get_name(), $names)) {
171                 throw new convert_exception('path_element_name_alreadyexists', $element->get_name());
172             }
173             if (array_key_exists($element->get_path(), $paths)) {
174                 throw new convert_exception('path_element_path_alreadyexists', $element->get_path());
175             }
176             $names[$element->get_name()] = true;
177             $paths[$element->get_path()] = $element;
178         }
180         // now, for each element not having a processing object yet, assign the handler
181         // if the element is not a memeber of a group
182         foreach($paths as $key => $element) {
183             if (is_null($element->get_processing_object()) and !$this->grouped_parent_exists($element, $paths)) {
184                 $paths[$key]->set_processing_object($handler);
185             }
186             // add the element path to the processor
187             $this->xmlprocessor->add_path($element->get_path(), $element->is_grouped());
188         }
190         // done, store the paths (duplicates by path are discarded)
191         $this->pathelements = array_merge($this->pathelements, $paths);
193         // remove the injected plugin name element from the MOD and BLOCK paths
194         // and register such collapsed path, too
195         foreach ($elements as $element) {
196             $path = $element->get_path();
197             $path = preg_replace('/^\/MOODLE_BACKUP\/COURSE\/MODULES\/MOD\/(\w+)\//', '/MOODLE_BACKUP/COURSE/MODULES/MOD/', $path);
198             $path = preg_replace('/^\/MOODLE_BACKUP\/COURSE\/BLOCKS\/BLOCK\/(\w+)\//', '/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK/', $path);
199             if (!empty($path) and $path != $element->get_path()) {
200                 $this->xmlprocessor->add_path($path, false);
201             }
202         }
203     }
205     /**
206      * Helper method used by {@link self::register_handler()}
207      *
208      * @param convert_path $pelement path element
209      * @param array of convert_path instances
210      * @return bool true if grouped parent was found, false otherwise
211      */
212     protected function grouped_parent_exists($pelement, $elements) {
214         foreach ($elements as $element) {
215             if ($pelement->get_path() == $element->get_path()) {
216                 // don't compare against itself
217                 continue;
218             }
219             // if the element is grouped and it is a parent of pelement, return true
220             if ($element->is_grouped() and strpos($pelement->get_path() .  '/', $element->get_path()) === 0) {
221                 return true;
222             }
223         }
225         // no grouped parent found
226         return false;
227     }
229     /**
230      * Process the data obtained from the XML parser processor
231      *
232      * This methods receives one chunk of information from the XML parser
233      * processor and dispatches it, following the naming rules.
234      * We are expanding the modules and blocks paths here to include the plugin's name.
235      *
236      * @param array $data
237      */
238     public function process_chunk($data) {
240         $path = $data['path'];
242         // expand the MOD paths so that they contain the module name
243         if ($path === '/MOODLE_BACKUP/COURSE/MODULES/MOD') {
244             $this->currentmod = strtoupper($data['tags']['MODTYPE']);
245             $path = '/MOODLE_BACKUP/COURSE/MODULES/MOD/' . $this->currentmod;
247         } else if (strpos($path, '/MOODLE_BACKUP/COURSE/MODULES/MOD') === 0) {
248             $path = str_replace('/MOODLE_BACKUP/COURSE/MODULES/MOD', '/MOODLE_BACKUP/COURSE/MODULES/MOD/' . $this->currentmod, $path);
249         }
251         // expand the BLOCK paths so that they contain the module name
252         if ($path === '/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK') {
253             $this->currentblock = strtoupper($data['tags']['NAME']);
254             $path = '/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK/' . $this->currentblock;
256         } else if (strpos($path, '/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK') === 0) {
257             $path = str_replace('/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK', '/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK/' . $this->currentblock, $path);
258         }
260         if ($path !== $data['path']) {
261             if (!array_key_exists($path, $this->pathelements)) {
262                 // no handler registered for the transformed MOD or BLOCK path
263                 $this->log('no handler attached', backup::LOG_WARNING, $path);
264                 return;
266             } else {
267                 // pretend as if the original $data contained the tranformed path
268                 $data['path'] = $path;
269             }
270         }
272         if (!array_key_exists($data['path'], $this->pathelements)) {
273             // path added to the processor without the handler
274             throw new convert_exception('missing_path_handler', $data['path']);
275         }
277         $element  = $this->pathelements[$data['path']];
278         $object   = $element->get_processing_object();
279         $method   = $element->get_processing_method();
280         $returned = null; // data returned by the processing method, if any
282         if (empty($object)) {
283             throw new convert_exception('missing_processing_object', null, $data['path']);
284         }
286         // release the lock if we aren't anymore within children of it
287         if (!is_null($this->pathlock) and strpos($data['path'], $this->pathlock) === false) {
288             $this->pathlock = null;
289         }
291         // if the path is not locked, apply the element's recipes and dispatch
292         // the cooked tags to the processing method
293         if (is_null($this->pathlock)) {
294             $rawdatatags  = $data['tags'];
295             $data['tags'] = $element->apply_recipes($data['tags']);
297             // if the processing method exists, give it a chance to modify data
298             if (method_exists($object, $method)) {
299                 $returned = $object->$method($data['tags'], $rawdatatags);
300             }
301         }
303         // if the dispatched method returned SKIP_ALL_CHILDREN, remember the current path
304         // and lock it so that its children are not dispatched
305         if ($returned === self::SKIP_ALL_CHILDREN) {
306             // check we haven't any previous lock
307             if (!is_null($this->pathlock)) {
308                 throw new convert_exception('already_locked_path', $data['path']);
309             }
310             // set the lock - nothing below the current path will be dispatched
311             $this->pathlock = $data['path'] . '/';
313         // if the method has returned any info, set element data to it
314         } else if (!is_null($returned)) {
315             $element->set_tags($returned);
317         // use just the cooked parsed data otherwise
318         } else {
319             $element->set_tags($data['tags']);
320         }
321     }
323     /**
324      * Executes operations required at the start of a watched path
325      *
326      * For MOD and BLOCK paths, this is supported only for the sub-paths, not the root
327      * module/block element. For the illustration:
328      *
329      * You CAN'T attach on_xxx_start() listener to a path like
330      * /MOODLE_BACKUP/COURSE/MODULES/MOD/WORKSHOP because the <MOD> must
331      * be processed first in {@link self::process_chunk()} where $this->currentmod
332      * is set.
333      *
334      * You CAN attach some on_xxx_start() listener to a path like
335      * /MOODLE_BACKUP/COURSE/MODULES/MOD/WORKSHOP/SUBMISSIONS because it is
336      * a sub-path under <MOD> and we have $this->currentmod already set when the
337      * <SUBMISSIONS> is reached.
338      *
339      * @param string $path in the original file
340      */
341     public function path_start_reached($path) {
343         if ($path === '/MOODLE_BACKUP/COURSE/MODULES/MOD') {
344             $this->currentmod = null;
345             $forbidden = true;
347         } else if (strpos($path, '/MOODLE_BACKUP/COURSE/MODULES/MOD') === 0) {
348             // expand the MOD paths so that they contain the module name
349             $path = str_replace('/MOODLE_BACKUP/COURSE/MODULES/MOD', '/MOODLE_BACKUP/COURSE/MODULES/MOD/' . $this->currentmod, $path);
350         }
352         if ($path === '/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK') {
353             $this->currentblock = null;
354             $forbidden = true;
356         } else if (strpos($path, '/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK') === 0) {
357             // expand the BLOCK paths so that they contain the module name
358             $path = str_replace('/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK', '/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK/' . $this->currentblock, $path);
359         }
361         if (empty($this->pathelements[$path])) {
362             return;
363         }
365         $element = $this->pathelements[$path];
366         $pobject = $element->get_processing_object();
367         $method  = $element->get_start_method();
369         if (method_exists($pobject, $method)) {
370             if (empty($forbidden)) {
371                 $pobject->$method();
373             } else {
374                 // this path is not supported because we do not know the module/block yet
375                 throw new coding_exception('Attaching the on-start event listener to the root MOD or BLOCK element is forbidden.');
376             }
377         }
378     }
380     /**
381      * Executes operations required at the end of a watched path
382      *
383      * @param string $path in the original file
384      */
385     public function path_end_reached($path) {
387         // expand the MOD paths so that they contain the current module name
388         if ($path === '/MOODLE_BACKUP/COURSE/MODULES/MOD') {
389             $path = '/MOODLE_BACKUP/COURSE/MODULES/MOD/' . $this->currentmod;
391         } else if (strpos($path, '/MOODLE_BACKUP/COURSE/MODULES/MOD') === 0) {
392             $path = str_replace('/MOODLE_BACKUP/COURSE/MODULES/MOD', '/MOODLE_BACKUP/COURSE/MODULES/MOD/' . $this->currentmod, $path);
393         }
395         // expand the BLOCK paths so that they contain the module name
396         if ($path === '/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK') {
397             $path = '/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK/' . $this->currentblock;
399         } else if (strpos($path, '/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK') === 0) {
400             $path = str_replace('/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK', '/MOODLE_BACKUP/COURSE/BLOCKS/BLOCK/' . $this->currentblock, $path);
401         }
403         if (empty($this->pathelements[$path])) {
404             return;
405         }
407         $element = $this->pathelements[$path];
408         $pobject = $element->get_processing_object();
409         $method  = $element->get_end_method();
410         $tags    = $element->get_tags();
412         if (method_exists($pobject, $method)) {
413             $pobject->$method($tags);
414         }
415     }
417     /**
418      * Creates the temporary storage for stashed data
419      *
420      * This implementation uses backup_ids_temp table.
421      */
422     public function create_stash_storage() {
423         backup_controller_dbops::create_backup_ids_temp_table($this->get_id());
424     }
426     /**
427      * Drops the temporary storage of stashed data
428      *
429      * This implementation uses backup_ids_temp table.
430      */
431     public function drop_stash_storage() {
432         backup_controller_dbops::drop_backup_ids_temp_table($this->get_id());
433     }
435     /**
436      * Stores some information for later processing
437      *
438      * This implementation uses backup_ids_temp table to store data. Make
439      * sure that the $stashname + $itemid combo is unique.
440      *
441      * @param string $stashname name of the stash
442      * @param mixed $info information to stash
443      * @param int $itemid optional id for multiple infos within the same stashname
444      */
445     public function set_stash($stashname, $info, $itemid = 0) {
446         try {
447             restore_dbops::set_backup_ids_record($this->get_id(), $stashname, $itemid, 0, null, $info);
449         } catch (dml_exception $e) {
450             throw new moodle1_convert_storage_exception('unable_to_restore_stash', null, $e->getMessage());
451         }
452     }
454     /**
455      * Restores a given stash stored previously by {@link self::set_stash()}
456      *
457      * @param string $stashname name of the stash
458      * @param int $itemid optional id for multiple infos within the same stashname
459      * @throws moodle1_convert_empty_storage_exception if the info has not been stashed previously
460      * @return mixed stashed data
461      */
462     public function get_stash($stashname, $itemid = 0) {
464         $record = restore_dbops::get_backup_ids_record($this->get_id(), $stashname, $itemid);
466         if (empty($record)) {
467             throw new moodle1_convert_empty_storage_exception('required_not_stashed_data', array($stashname, $itemid));
468         } else {
469             return $record->info;
470         }
471     }
473     /**
474      * Restores a given stash or returns the given default if there is no such stash
475      *
476      * @param string $stashname name of the stash
477      * @param int $itemid optional id for multiple infos within the same stashname
478      * @param mixed $default information to return if the info has not been stashed previously
479      * @return mixed stashed data or the default value
480      */
481     public function get_stash_or_default($stashname, $itemid = 0, $default = null) {
482         try {
483             return $this->get_stash($stashname, $itemid);
484         } catch (moodle1_convert_empty_storage_exception $e) {
485             return $default;
486         }
487     }
489     /**
490      * Returns the list of existing stashes
491      *
492      * @return array
493      */
494     public function get_stash_names() {
495         global $DB;
497         $search = array(
498             'backupid' => $this->get_id(),
499         );
501         return array_keys($DB->get_records('backup_ids_temp', $search, '', 'itemname'));
502     }
504     /**
505      * Returns the list of stashed $itemids in the given stash
506      *
507      * @param string $stashname
508      * @return array
509      */
510     public function get_stash_itemids($stashname) {
511         global $DB;
513         $search = array(
514             'backupid' => $this->get_id(),
515             'itemname' => $stashname
516         );
518         return array_keys($DB->get_records('backup_ids_temp', $search, '', 'itemid'));
519     }
521     /**
522      * Generates an artificial context id
523      *
524      * Moodle 1.9 backups do not contain any context information. But we need them
525      * in Moodle 2.x format so here we generate fictive context id for every given
526      * context level + instance combo.
527      *
528      * CONTEXT_SYSTEM and CONTEXT_COURSE ignore the $instance as they represent a
529      * single system or the course being restored.
530      *
531      * @see get_context_instance()
532      * @param int $level the context level, like CONTEXT_COURSE or CONTEXT_MODULE
533      * @param int $instance the instance id, for example $course->id for courses or $cm->id for activity modules
534      * @return int the context id
535      */
536     public function get_contextid($level, $instance = 0) {
538         $stashname = 'context' . $level;
540         if ($level == CONTEXT_SYSTEM or $level == CONTEXT_COURSE) {
541             $instance = 0;
542         }
544         try {
545             // try the previously stashed id
546             return $this->get_stash($stashname, $instance);
548         } catch (moodle1_convert_empty_storage_exception $e) {
549             // this context level + instance is required for the first time
550             $newid = $this->get_nextid();
551             $this->set_stash($stashname, $newid, $instance);
552             return $newid;
553         }
554     }
556     /**
557      * Simple autoincrement generator
558      *
559      * @return int the next number in a row of numbers
560      */
561     public function get_nextid() {
562         return $this->nextid++;
563     }
565     /**
566      * Creates and returns new instance of the file manager
567      *
568      * @param int $contextid the default context id of the files being migrated
569      * @param string $component the default component name of the files being migrated
570      * @param string $filearea the default file area of the files being migrated
571      * @param int $itemid the default item id of the files being migrated
572      * @param int $userid initial user id of the files being migrated
573      * @return moodle1_file_manager
574      */
575     public function get_file_manager($contextid = null, $component = null, $filearea = null, $itemid = 0, $userid = null) {
576         return new moodle1_file_manager($this, $contextid, $component, $filearea, $itemid, $userid);
577     }
579     /**
580      * Creates and returns new instance of the inforef manager
581      *
582      * @param string $name the name of the annotator (like course, section, activity, block)
583      * @param int $id the id of the annotator if required
584      * @return moodle1_inforef_manager
585      */
586     public function get_inforef_manager($name, $id = 0) {
587         return new moodle1_inforef_manager($this, $name, $id);
588     }
591     /**
592      * Migrates all course files referenced from the hypertext using the given filemanager
593      *
594      * This is typically used to convert images embedded into the intro fields.
595      *
596      * @param string $text hypertext containing $@FILEPHP@$ referenced
597      * @param moodle1_file_manager $fileman file manager to use for the file migration
598      * @return string the original $text with $@FILEPHP@$ references replaced with the new @@PLUGINFILE@@
599      */
600     public static function migrate_referenced_files($text, moodle1_file_manager $fileman) {
602         $files = self::find_referenced_files($text);
603         if (!empty($files)) {
604             foreach ($files as $file) {
605                 try {
606                     $fileman->migrate_file('course_files'.$file, dirname($file));
607                 } catch (moodle1_convert_exception $e) {
608                     // file probably does not exist
609                     $fileman->log('error migrating file', backup::LOG_WARNING, 'course_files'.$file);
610                 }
611             }
612             $text = self::rewrite_filephp_usage($text, $files);
613         }
615         return $text;
616     }
618     /**
619      * Detects all links to file.php encoded via $@FILEPHP@$ and returns the files to migrate
620      *
621      * @see self::migrate_referenced_files()
622      * @param string $text
623      * @return array
624      */
625     public static function find_referenced_files($text) {
627         $files = array();
629         if (empty($text) or is_numeric($text)) {
630             return $files;
631         }
633         $matches = array();
634         $pattern = '|(["\'])(\$@FILEPHP@\$.+?)\1|';
635         $result = preg_match_all($pattern, $text, $matches);
636         if ($result === false) {
637             throw new moodle1_convert_exception('error_while_searching_for_referenced_files');
638         }
639         if ($result == 0) {
640             return $files;
641         }
642         foreach ($matches[2] as $match) {
643             $file = str_replace(array('$@FILEPHP@$', '$@SLASH@$', '$@FORCEDOWNLOAD@$'), array('', '/', ''), $match);
644             $files[] = rawurldecode($file);
645         }
647         return array_unique($files);
648     }
650     /**
651      * Given the list of migrated files, rewrites references to them from $@FILEPHP@$ form to the @@PLUGINFILE@@ one
652      *
653      * @see self::migrate_referenced_files()
654      * @param string $text
655      * @param array $files
656      * @return string
657      */
658     public static function rewrite_filephp_usage($text, array $files) {
660         foreach ($files as $file) {
661             // Expect URLs properly encoded by default.
662             $parts   = explode('/', $file);
663             $encoded = implode('/', array_map('rawurlencode', $parts));
664             $fileref = '$@FILEPHP@$'.str_replace('/', '$@SLASH@$', $encoded);
665             $text    = str_replace($fileref.'$@FORCEDOWNLOAD@$', '@@PLUGINFILE@@'.$encoded.'?forcedownload=1', $text);
666             $text    = str_replace($fileref, '@@PLUGINFILE@@'.$encoded, $text);
667             // Add support for URLs without any encoding.
668             $fileref = '$@FILEPHP@$'.str_replace('/', '$@SLASH@$', $file);
669             $text    = str_replace($fileref.'$@FORCEDOWNLOAD@$', '@@PLUGINFILE@@'.$encoded.'?forcedownload=1', $text);
670             $text    = str_replace($fileref, '@@PLUGINFILE@@'.$encoded, $text);
671         }
673         return $text;
674     }
676     /**
677      * @see parent::description()
678      */
679     public static function description() {
681         return array(
682             'from'  => backup::FORMAT_MOODLE1,
683             'to'    => backup::FORMAT_MOODLE,
684             'cost'  => 10,
685         );
686     }
690 /**
691  * Exception thrown by this converter
692  */
693 class moodle1_convert_exception extends convert_exception {
697 /**
698  * Exception thrown by the temporary storage subsystem of moodle1_converter
699  */
700 class moodle1_convert_storage_exception extends moodle1_convert_exception {
704 /**
705  * Exception thrown by the temporary storage subsystem of moodle1_converter
706  */
707 class moodle1_convert_empty_storage_exception extends moodle1_convert_exception {
711 /**
712  * XML parser processor used for processing parsed moodle.xml
713  */
714 class moodle1_parser_processor extends grouped_parser_processor {
716     /** @var moodle1_converter */
717     protected $converter;
719     public function __construct(moodle1_converter $converter) {
720         $this->converter = $converter;
721         parent::__construct();
722     }
724     /**
725      * Provides NULL decoding
726      *
727      * Note that we do not decode $@FILEPHP@$ and friends here as we are going to write them
728      * back immediately into another XML file.
729      */
730     public function process_cdata($cdata) {
732         if ($cdata === '$@NULL@$') {
733             return null;
734         }
736         return $cdata;
737     }
739     /**
740      * Dispatches the data chunk to the converter class
741      *
742      * @param array $data the chunk of parsed data
743      */
744     protected function dispatch_chunk($data) {
745         $this->converter->process_chunk($data);
746     }
748     /**
749      * Informs the converter at the start of a watched path
750      *
751      * @param string $path
752      */
753     protected function notify_path_start($path) {
754         $this->converter->path_start_reached($path);
755     }
757     /**
758      * Informs the converter at the end of a watched path
759      *
760      * @param string $path
761      */
762     protected function notify_path_end($path) {
763         $this->converter->path_end_reached($path);
764     }
768 /**
769  * XML transformer that modifies the content of the files being written during the conversion
770  *
771  * @see backup_xml_transformer
772  */
773 class moodle1_xml_transformer extends xml_contenttransformer {
775     /**
776      * Modify the content before it is writter to a file
777      *
778      * @param string|mixed $content
779      */
780     public function process($content) {
782         // the content should be a string. If array or object is given, try our best recursively
783         // but inform the developer
784         if (is_array($content)) {
785             debugging('Moodle1 XML transformer should not process arrays but plain content always', DEBUG_DEVELOPER);
786             foreach($content as $key => $plaincontent) {
787                 $content[$key] = $this->process($plaincontent);
788             }
789             return $content;
791         } else if (is_object($content)) {
792             debugging('Moodle1 XML transformer should not process objects but plain content always', DEBUG_DEVELOPER);
793             foreach((array)$content as $key => $plaincontent) {
794                 $content[$key] = $this->process($plaincontent);
795             }
796             return (object)$content;
797         }
799         // try to deal with some trivial cases first
800         if (is_null($content)) {
801             return '$@NULL@$';
803         } else if ($content === '') {
804             return '';
806         } else if (is_numeric($content)) {
807             return $content;
809         } else if (strlen($content) < 32) {
810             return $content;
811         }
813         return $content;
814     }
818 /**
819  * Class representing a path to be converted from XML file
820  *
821  * This was created as a copy of {@link restore_path_element} and should be refactored
822  * probably.
823  */
824 class convert_path {
826     /** @var string name of the element */
827     protected $name;
829     /** @var string path within the XML file this element will handle */
830     protected $path;
832     /** @var bool flag to define if this element will get child ones grouped or no */
833     protected $grouped;
835     /** @var object object instance in charge of processing this element. */
836     protected $pobject = null;
838     /** @var string the name of the processing method */
839     protected $pmethod = null;
841     /** @var string the name of the path start event handler */
842     protected $smethod = null;
844     /** @var string the name of the path end event handler */
845     protected $emethod = null;
847     /** @var mixed last data read for this element or returned data by processing method */
848     protected $tags = null;
850     /** @var array of deprecated fields that are dropped */
851     protected $dropfields = array();
853     /** @var array of fields renaming */
854     protected $renamefields = array();
856     /** @var array of new fields to add and their initial values */
857     protected $newfields = array();
859     /**
860      * Constructor
861      *
862      * @param string $name name of the element
863      * @param string $path path of the element
864      * @param array $recipe basic description of the structure conversion
865      * @param bool $grouped to gather information in grouped mode or no
866      */
867     public function __construct($name, $path, array $recipe = array(), $grouped = false) {
869         $this->validate_name($name);
871         $this->name     = $name;
872         $this->path     = $path;
873         $this->grouped  = $grouped;
875         // set the default method names
876         $this->set_processing_method('process_' . $name);
877         $this->set_start_method('on_'.$name.'_start');
878         $this->set_end_method('on_'.$name.'_end');
880         if ($grouped and !empty($recipe)) {
881             throw new convert_path_exception('recipes_not_supported_for_grouped_elements');
882         }
884         if (isset($recipe['dropfields']) and is_array($recipe['dropfields'])) {
885             $this->set_dropped_fields($recipe['dropfields']);
886         }
887         if (isset($recipe['renamefields']) and is_array($recipe['renamefields'])) {
888             $this->set_renamed_fields($recipe['renamefields']);
889         }
890         if (isset($recipe['newfields']) and is_array($recipe['newfields'])) {
891             $this->set_new_fields($recipe['newfields']);
892         }
893     }
895     /**
896      * Validates and sets the given processing object
897      *
898      * @param object $pobject processing object, must provide a method to be called
899      */
900     public function set_processing_object($pobject) {
901         $this->validate_pobject($pobject);
902         $this->pobject = $pobject;
903     }
905     /**
906      * Sets the name of the processing method
907      *
908      * @param string $pmethod
909      */
910     public function set_processing_method($pmethod) {
911         $this->pmethod = $pmethod;
912     }
914     /**
915      * Sets the name of the path start event listener
916      *
917      * @param string $smethod
918      */
919     public function set_start_method($smethod) {
920         $this->smethod = $smethod;
921     }
923     /**
924      * Sets the name of the path end event listener
925      *
926      * @param string $emethod
927      */
928     public function set_end_method($emethod) {
929         $this->emethod = $emethod;
930     }
932     /**
933      * Sets the element tags
934      *
935      * @param array $tags
936      */
937     public function set_tags($tags) {
938         $this->tags = $tags;
939     }
941     /**
942      * Sets the list of deprecated fields to drop
943      *
944      * @param array $fields
945      */
946     public function set_dropped_fields(array $fields) {
947         $this->dropfields = $fields;
948     }
950     /**
951      * Sets the required new names of the current fields
952      *
953      * @param array $fields (string)$currentname => (string)$newname
954      */
955     public function set_renamed_fields(array $fields) {
956         $this->renamefields = $fields;
957     }
959     /**
960      * Sets the new fields and their values
961      *
962      * @param array $fields (string)$field => (mixed)value
963      */
964     public function set_new_fields(array $fields) {
965         $this->newfields = $fields;
966     }
968     /**
969      * Cooks the parsed tags data by applying known recipes
970      *
971      * Recipes are used for common trivial operations like adding new fields
972      * or renaming fields. The handler's processing method receives cooked
973      * data.
974      *
975      * @param array $data the contents of the element
976      * @return array
977      */
978     public function apply_recipes(array $data) {
980         $cooked = array();
982         foreach ($data as $name => $value) {
983             // lower case rocks!
984             $name = strtolower($name);
986             if (is_array($value)) {
987                 if ($this->is_grouped()) {
988                     $value = $this->apply_recipes($value);
989                 } else {
990                     throw new convert_path_exception('non_grouped_path_with_array_values');
991                 }
992             }
994             // drop legacy fields
995             if (in_array($name, $this->dropfields)) {
996                 continue;
997             }
999             // fields renaming
1000             if (array_key_exists($name, $this->renamefields)) {
1001                 $name = $this->renamefields[$name];
1002             }
1004             $cooked[$name] = $value;
1005         }
1007         // adding new fields
1008         foreach ($this->newfields as $name => $value) {
1009             $cooked[$name] = $value;
1010         }
1012         return $cooked;
1013     }
1015     /**
1016      * @return string the element given name
1017      */
1018     public function get_name() {
1019         return $this->name;
1020     }
1022     /**
1023      * @return string the path to the element
1024      */
1025     public function get_path() {
1026         return $this->path;
1027     }
1029     /**
1030      * @return bool flag to define if this element will get child ones grouped or no
1031      */
1032     public function is_grouped() {
1033         return $this->grouped;
1034     }
1036     /**
1037      * @return object the processing object providing the processing method
1038      */
1039     public function get_processing_object() {
1040         return $this->pobject;
1041     }
1043     /**
1044      * @return string the name of the method to call to process the element
1045      */
1046     public function get_processing_method() {
1047         return $this->pmethod;
1048     }
1050     /**
1051      * @return string the name of the path start event listener
1052      */
1053     public function get_start_method() {
1054         return $this->smethod;
1055     }
1057     /**
1058      * @return string the name of the path end event listener
1059      */
1060     public function get_end_method() {
1061         return $this->emethod;
1062     }
1064     /**
1065      * @return mixed the element data
1066      */
1067     public function get_tags() {
1068         return $this->tags;
1069     }
1072     /// end of public API //////////////////////////////////////////////////////
1074     /**
1075      * Makes sure the given name is a valid element name
1076      *
1077      * Note it may look as if we used exceptions for code flow control here. That's not the case
1078      * as we actually validate the code, not the user data. And the code is supposed to be
1079      * correct.
1080      *
1081      * @param string @name the element given name
1082      * @throws convert_path_exception
1083      * @return void
1084      */
1085     protected function validate_name($name) {
1086         // Validate various name constraints, throwing exception if needed
1087         if (empty($name)) {
1088             throw new convert_path_exception('convert_path_emptyname', $name);
1089         }
1090         if (preg_replace('/\s/', '', $name) != $name) {
1091             throw new convert_path_exception('convert_path_whitespace', $name);
1092         }
1093         if (preg_replace('/[^\x30-\x39\x41-\x5a\x5f\x61-\x7a]/', '', $name) != $name) {
1094             throw new convert_path_exception('convert_path_notasciiname', $name);
1095         }
1096     }
1098     /**
1099      * Makes sure that the given object is a valid processing object
1100      *
1101      * The processing object must be an object providing at least element's processing method
1102      * or path-reached-end event listener or path-reached-start listener method.
1103      *
1104      * Note it may look as if we used exceptions for code flow control here. That's not the case
1105      * as we actually validate the code, not the user data. And the code is supposed to be
1106      * correct.
1107       *
1108      * @param object $pobject
1109      * @throws convert_path_exception
1110      * @return void
1111      */
1112     protected function validate_pobject($pobject) {
1113         if (!is_object($pobject)) {
1114             throw new convert_path_exception('convert_path_no_object', get_class($pobject));
1115         }
1116         if (!method_exists($pobject, $this->get_processing_method()) and
1117             !method_exists($pobject, $this->get_end_method()) and
1118             !method_exists($pobject, $this->get_start_method())) {
1119             throw new convert_path_exception('convert_path_missing_method', get_class($pobject));
1120         }
1121     }
1125 /**
1126  * Exception being thrown by {@link convert_path} methods
1127  */
1128 class convert_path_exception extends moodle_exception {
1130     /**
1131      * Constructor
1132      *
1133      * @param string $errorcode key for the corresponding error string
1134      * @param mixed $a extra words and phrases that might be required by the error string
1135      * @param string $debuginfo optional debugging information
1136      */
1137     public function __construct($errorcode, $a = null, $debuginfo = null) {
1138         parent::__construct($errorcode, '', '', $a, $debuginfo);
1139     }
1143 /**
1144  * The class responsible for files migration
1145  *
1146  * The files in Moodle 1.9 backup are stored in moddata, user_files, group_files,
1147  * course_files and site_files folders.
1148  */
1149 class moodle1_file_manager implements loggable {
1151     /** @var moodle1_converter instance we serve to */
1152     public $converter;
1154     /** @var int context id of the files being migrated */
1155     public $contextid;
1157     /** @var string component name of the files being migrated */
1158     public $component;
1160     /** @var string file area of the files being migrated */
1161     public $filearea;
1163     /** @var int item id of the files being migrated */
1164     public $itemid = 0;
1166     /** @var int user id */
1167     public $userid;
1169     /** @var string the root of the converter temp directory */
1170     protected $basepath;
1172     /** @var array of file ids that were migrated by this instance */
1173     protected $fileids = array();
1175     /**
1176      * Constructor optionally accepting some default values for the migrated files
1177      *
1178      * @param moodle1_converter $converter the converter instance we serve to
1179      * @param int $contextid initial context id of the files being migrated
1180      * @param string $component initial component name of the files being migrated
1181      * @param string $filearea initial file area of the files being migrated
1182      * @param int $itemid initial item id of the files being migrated
1183      * @param int $userid initial user id of the files being migrated
1184      */
1185     public function __construct(moodle1_converter $converter, $contextid = null, $component = null, $filearea = null, $itemid = 0, $userid = null) {
1186         // set the initial destination of the migrated files
1187         $this->converter = $converter;
1188         $this->contextid = $contextid;
1189         $this->component = $component;
1190         $this->filearea  = $filearea;
1191         $this->itemid    = $itemid;
1192         $this->userid    = $userid;
1193         // set other useful bits
1194         $this->basepath  = $converter->get_tempdir_path();
1195     }
1197     /**
1198      * Migrates one given file stored on disk
1199      *
1200      * @param string $sourcepath the path to the source local file within the backup archive {@example 'moddata/foobar/file.ext'}
1201      * @param string $filepath the file path of the migrated file, defaults to the root directory '/' {@example '/sub/dir/'}
1202      * @param string $filename the name of the migrated file, defaults to the same as the source file has
1203      * @param int $sortorder the sortorder of the file (main files have sortorder set to 1)
1204      * @param int $timecreated override the timestamp of when the migrated file should appear as created
1205      * @param int $timemodified override the timestamp of when the migrated file should appear as modified
1206      * @return int id of the migrated file
1207      */
1208     public function migrate_file($sourcepath, $filepath = '/', $filename = null, $sortorder = 0, $timecreated = null, $timemodified = null) {
1210         $sourcefullpath = $this->basepath.'/'.$sourcepath;
1212         if (!is_readable($sourcefullpath)) {
1213             throw new moodle1_convert_exception('file_not_readable', $sourcefullpath);
1214         }
1216         // sanitize filepath
1217         if (empty($filepath)) {
1218             $filepath = '/';
1219         }
1220         if (substr($filepath, -1) !== '/') {
1221             $filepath .= '/';
1222         }
1223         $filepath = clean_param($filepath, PARAM_PATH);
1225         if (textlib::strlen($filepath) > 255) {
1226             throw new moodle1_convert_exception('file_path_longer_than_255_chars');
1227         }
1229         if (is_null($filename)) {
1230             $filename = basename($sourcefullpath);
1231         }
1233         $filename = clean_param($filename, PARAM_FILE);
1235         if ($filename === '') {
1236             throw new moodle1_convert_exception('unsupported_chars_in_filename');
1237         }
1239         if (is_null($timecreated)) {
1240             $timecreated = filectime($sourcefullpath);
1241         }
1243         if (is_null($timemodified)) {
1244             $timemodified = filemtime($sourcefullpath);
1245         }
1247         $filerecord = $this->make_file_record(array(
1248             'filepath'      => $filepath,
1249             'filename'      => $filename,
1250             'sortorder'     => $sortorder,
1251             'mimetype'      => mimeinfo('type', $sourcefullpath),
1252             'timecreated'   => $timecreated,
1253             'timemodified'  => $timemodified,
1254         ));
1256         list($filerecord['contenthash'], $filerecord['filesize'], $newfile) = $this->add_file_to_pool($sourcefullpath);
1257         $this->stash_file($filerecord);
1259         return $filerecord['id'];
1260     }
1262     /**
1263      * Migrates all files in the given directory
1264      *
1265      * @param string $rootpath path within the backup archive to the root directory containing the files {@example 'course_files'}
1266      * @param string $relpath relative path used during the recursion - do not provide when calling this!
1267      * @return array ids of the migrated files, empty array if the $rootpath not found
1268      */
1269     public function migrate_directory($rootpath, $relpath='/') {
1271         if (!file_exists($this->basepath.'/'.$rootpath.$relpath)) {
1272             return array();
1273         }
1275         $fileids = array();
1277         // make the fake file record for the directory itself
1278         $filerecord = $this->make_file_record(array('filepath' => $relpath, 'filename' => '.'));
1279         $this->stash_file($filerecord);
1280         $fileids[] = $filerecord['id'];
1282         $items = new DirectoryIterator($this->basepath.'/'.$rootpath.$relpath);
1284         foreach ($items as $item) {
1286             if ($item->isDot()) {
1287                 continue;
1288             }
1290             if ($item->isLink()) {
1291                 throw new moodle1_convert_exception('unexpected_symlink');
1292             }
1294             if ($item->isFile()) {
1295                 $fileids[] = $this->migrate_file(substr($item->getPathname(), strlen($this->basepath.'/')),
1296                     $relpath, $item->getFilename(), 0, $item->getCTime(), $item->getMTime());
1298             } else {
1299                 $dirname = clean_param($item->getFilename(), PARAM_PATH);
1301                 if ($dirname === '') {
1302                     throw new moodle1_convert_exception('unsupported_chars_in_filename');
1303                 }
1305                 // migrate subdirectories recursively
1306                 $fileids = array_merge($fileids, $this->migrate_directory($rootpath, $relpath.$item->getFilename().'/'));
1307             }
1308         }
1310         return $fileids;
1311     }
1313     /**
1314      * Returns the list of all file ids migrated by this instance so far
1315      *
1316      * @return array of int
1317      */
1318     public function get_fileids() {
1319         return $this->fileids;
1320     }
1322     /**
1323      * Explicitly clear the list of file ids migrated by this instance so far
1324      */
1325     public function reset_fileids() {
1326         $this->fileids = array();
1327     }
1329     /**
1330      * Log a message using the converter's logging mechanism
1331      *
1332      * @param string $message message text
1333      * @param int $level message level {@example backup::LOG_WARNING}
1334      * @param null|mixed $a additional information
1335      * @param null|int $depth the message depth
1336      * @param bool $display whether the message should be sent to the output, too
1337      */
1338     public function log($message, $level, $a = null, $depth = null, $display = false) {
1339         $this->converter->log($message, $level, $a, $depth, $display);
1340     }
1342     /// internal implementation details ////////////////////////////////////////
1344     /**
1345      * Prepares a fake record from the files table
1346      *
1347      * @param array $fileinfo explicit file data
1348      * @return array
1349      */
1350     protected function make_file_record(array $fileinfo) {
1352         $defaultrecord = array(
1353             'contenthash'   => 'da39a3ee5e6b4b0d3255bfef95601890afd80709',  // sha1 of an empty file
1354             'contextid'     => $this->contextid,
1355             'component'     => $this->component,
1356             'filearea'      => $this->filearea,
1357             'itemid'        => $this->itemid,
1358             'filepath'      => null,
1359             'filename'      => null,
1360             'filesize'      => 0,
1361             'userid'        => $this->userid,
1362             'mimetype'      => null,
1363             'status'        => 0,
1364             'timecreated'   => $now = time(),
1365             'timemodified'  => $now,
1366             'source'        => null,
1367             'author'        => null,
1368             'license'       => null,
1369             'sortorder'     => 0,
1370         );
1372         if (!array_key_exists('id', $fileinfo)) {
1373             $defaultrecord['id'] = $this->converter->get_nextid();
1374         }
1376         // override the default values with the explicit data provided and return
1377         return array_merge($defaultrecord, $fileinfo);
1378     }
1380     /**
1381      * Copies the given file to the pool directory
1382      *
1383      * Returns an array containing SHA1 hash of the file contents, the file size
1384      * and a flag indicating whether the file was actually added to the pool or whether
1385      * it was already there.
1386      *
1387      * @param string $pathname the full path to the file
1388      * @return array with keys (string)contenthash, (int)filesize, (bool)newfile
1389      */
1390     protected function add_file_to_pool($pathname) {
1392         if (!is_readable($pathname)) {
1393             throw new moodle1_convert_exception('file_not_readable');
1394         }
1396         $contenthash = sha1_file($pathname);
1397         $filesize    = filesize($pathname);
1398         $hashpath    = $this->converter->get_workdir_path().'/files/'.substr($contenthash, 0, 2);
1399         $hashfile    = "$hashpath/$contenthash";
1401         if (file_exists($hashfile)) {
1402             if (filesize($hashfile) !== $filesize) {
1403                 // congratulations! you have found two files with different size and the same
1404                 // content hash. or, something were wrong (which is more likely)
1405                 throw new moodle1_convert_exception('same_hash_different_size');
1406             }
1407             $newfile = false;
1409         } else {
1410             check_dir_exists($hashpath);
1411             $newfile = true;
1413             if (!copy($pathname, $hashfile)) {
1414                 throw new moodle1_convert_exception('unable_to_copy_file');
1415             }
1417             if (filesize($hashfile) !== $filesize) {
1418                 throw new moodle1_convert_exception('filesize_different_after_copy');
1419             }
1420         }
1422         return array($contenthash, $filesize, $newfile);
1423     }
1425     /**
1426      * Stashes the file record into 'files' stash and adds the record id to list of migrated files
1427      *
1428      * @param array $filerecord
1429      */
1430     protected function stash_file(array $filerecord) {
1431         $this->converter->set_stash('files', $filerecord, $filerecord['id']);
1432         $this->fileids[] = $filerecord['id'];
1433     }
1437 /**
1438  * Helper class that handles ids annotations for inforef.xml files
1439  */
1440 class moodle1_inforef_manager {
1442     /** @var string the name of the annotator we serve to (like course, section, activity, block) */
1443     protected $annotator = null;
1445     /** @var int the id of the annotator if it can have multiple instances */
1446     protected $annotatorid = null;
1448     /** @var array the actual storage of references, currently implemented as a in-memory structure */
1449     private $refs = array();
1451     /**
1452      * Creates new instance of the manager for the given annotator
1453      *
1454      * The identification of the annotator we serve to may be important in the future
1455      * when we move the actual storage of the references from memory to a persistent storage.
1456      *
1457      * @param moodle1_converter $converter
1458      * @param string $name the name of the annotator (like course, section, activity, block)
1459      * @param int $id the id of the annotator if required
1460      */
1461     public function __construct(moodle1_converter $converter, $name, $id = 0) {
1462         $this->annotator   = $name;
1463         $this->annotatorid = $id;
1464     }
1466     /**
1467      * Adds a reference
1468      *
1469      * @param string $item the name of referenced item (like user, file, scale, outcome or grade_item)
1470      * @param int $id the value of the reference
1471      */
1472     public function add_ref($item, $id) {
1473         $this->validate_item($item);
1474         $this->refs[$item][$id] = true;
1475     }
1477     /**
1478      * Adds a bulk of references
1479      *
1480      * @param string $item the name of referenced item (like user, file, scale, outcome or grade_item)
1481      * @param array $ids the list of referenced ids
1482      */
1483     public function add_refs($item, array $ids) {
1484         $this->validate_item($item);
1485         foreach ($ids as $id) {
1486             $this->refs[$item][$id] = true;
1487         }
1488     }
1490     /**
1491      * Writes the current references using a given opened xml writer
1492      *
1493      * @param xml_writer $xmlwriter
1494      */
1495     public function write_refs(xml_writer $xmlwriter) {
1496         $xmlwriter->begin_tag('inforef');
1497         foreach ($this->refs as $item => $ids) {
1498             $xmlwriter->begin_tag($item.'ref');
1499             foreach (array_keys($ids) as $id) {
1500                 $xmlwriter->full_tag($item, $id);
1501             }
1502             $xmlwriter->end_tag($item.'ref');
1503         }
1504         $xmlwriter->end_tag('inforef');
1505     }
1507     /**
1508      * Makes sure that the given name is a valid citizen of inforef.xml file
1509      *
1510      * @see backup_helper::get_inforef_itemnames()
1511      * @param string $item the name of reference (like user, file, scale, outcome or grade_item)
1512      * @throws coding_exception
1513      */
1514     protected function validate_item($item) {
1516         $allowed = array(
1517             'user'              => true,
1518             'grouping'          => true,
1519             'group'             => true,
1520             'role'              => true,
1521             'file'              => true,
1522             'scale'             => true,
1523             'outcome'           => true,
1524             'grade_item'        => true,
1525             'question_category' => true
1526         );
1528         if (!isset($allowed[$item])) {
1529             throw new coding_exception('Invalid inforef item type');
1530         }
1531     }