Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Merge pull request #10 from nebgor/MDL-27451

MDL-27451 Backup - added 1.9 backup conversion handler for wiki
  • Loading branch information...
commit db6491bf9ef33a80981e5dbce52f25a83223fc08 2 parents c15649f + 61ff1fe
@mudrd8mz mudrd8mz authored
Showing with 270 additions and 0 deletions.
  1. +270 −0 mod/wiki/backup/moodle1/lib.php
View
270 mod/wiki/backup/moodle1/lib.php
@@ -0,0 +1,270 @@
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Provides support for the conversion of moodle1 backup to the moodle2 format
+ * Based off of a template @ http://docs.moodle.org/en/Development:Backup_1.9_conversion_for_developers
+ *
+ * @package mod
+ * @subpackage wiki
+ * @copyright 2011 Aparup Banerjee <aparup@moodle.com>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Wiki conversion handler
+ */
+class moodle1_mod_wiki_handler extends moodle1_mod_handler {
+ /** @var string initial content for creating first page from optional 1.9 wiki file*/
+ protected $initialcontent;
+ protected $initialcontentfilename;
+
+ /** @var bool initial content page already exists */
+ protected $needinitpage = false;
+
+ /** @var array a data element transfer buffer, can be used for transfer of data between xml path levels. */
+ protected $databuf = array();
+
+ /**
+ * Declare the paths in moodle.xml we are able to convert
+ *
+ * The method returns list of {@link convert_path} instances.
+ * For each path returned, the corresponding conversion method must be
+ * defined.
+ *
+ * Note that the path /MOODLE_BACKUP/COURSE/MODULES/MOD/WIKI does not
+ * actually exist in the file. The last element with the module name was
+ * appended by the moodle1_converter class.
+ *
+ * @return array of {@link convert_path} instances
+ */
+ public function get_paths() {
+ return array(
+ new convert_path(
+ 'wiki', '/MOODLE_BACKUP/COURSE/MODULES/MOD/WIKI',
+ array(
+ 'newfields' => array(
+ 'introformat' => '0',
+ 'defaultformat' => 'html', //1.9 migrations default to html
+ 'forceformat' => '1',
+ 'editbegin' => '0',
+ 'editend' => '0',
+ 'timecreated' => time(), //2.x time of creation since theres no 1.9 time of creation
+ ),
+ 'renamefields' => array(
+ 'summary' => 'intro',
+ 'format' => 'introformat',
+ 'firstpagetitle' => 'pagename',
+ 'wtype' => 'wikimode'
+ ),
+ 'dropfields' => array(
+ 'pagename', 'scaleid', 'ewikiprinttitle', 'htmlmode', 'ewikiacceptbinary', 'disablecamelcase',
+ 'setpageflags', 'strippages', 'removepages', 'revertchanges'
+ )
+ )
+ ),
+ new convert_path(
+ 'wiki_entries', '/MOODLE_BACKUP/COURSE/MODULES/MOD/WIKI/ENTRIES',
+ array(
+ 'newfields' => array(
+ 'synonyms' => '0',
+ 'links' => 'collaborative',
+ ),
+ 'dropfields' => array(
+ 'pagename' ,'timemodified'
+ )
+ )
+ ),
+ new convert_path(
+ 'wiki_entry', '/MOODLE_BACKUP/COURSE/MODULES/MOD/WIKI/ENTRIES/ENTRY'
+ ),
+ new convert_path(
+ 'wiki_pages', '/MOODLE_BACKUP/COURSE/MODULES/MOD/WIKI/ENTRIES/ENTRY/PAGES'
+ ),
+ new convert_path(
+ 'wiki_entry_page', '/MOODLE_BACKUP/COURSE/MODULES/MOD/WIKI/ENTRIES/ENTRY/PAGES/PAGE',
+ array(
+ 'newfields' => array(
+ 'cachedcontent' => '**reparse needed**',
+ 'timerendered' => '0',
+ 'readonly' => '0',
+ 'tags' => ''
+ ),
+ 'renamefields' => array(
+ 'pagename' => 'title',
+ 'created' => 'timecreated',
+ 'lastmodified' => 'timemodified',
+ 'hits' => 'pageviews'
+ ),
+ 'dropfields' => array(
+ 'version', 'flags', 'author', 'refs', //refs will be reparsed during rendering
+ 'meta'
+ )
+ )
+ )
+ );
+ }
+
+ /**
+ * This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/WIKI
+ * data available
+ */
+ public function process_wiki($data) {
+ if (!empty($data['initialcontent'])) {
+ //convert file in <INITIALCONTENT>filename</INITIALCONTENT> into a subwiki page if no entry created.
+ $temppath = $this->converter->get_tempdir_path();
+ $this->initialcontent = file_get_contents($temppath.'/course_files/'.$data['initialcontent']);
+ $this->initialcontentfilename = $data['initialcontent'];
+ $this->needinitpage = true;
+ }
+ unset($data['initialcontent']);
+ if ($data['wikimode'] !== 'group') {
+ $data['wikimode'] = 'individual';
+ //@todo need to create extra subwikis due to individual wikimode?
+ //this would then need to reference the users in the course that is being restored.(some parent class API needed)
+ } else {
+ $data['wikimode'] = 'collaborative';
+ }
+
+ if (empty($data['name'])) {
+ $data['name'] = 'Wiki';
+ }
+ // get the course module id and context id
+ $instanceid = $data['id'];
+ $cminfo = $this->get_cminfo($instanceid);
+ $moduleid = $cminfo['id'];
+ $contextid = $this->converter->get_contextid(CONTEXT_MODULE, $moduleid);
+
+ // we now have all information needed to start writing into the file
+ $this->open_xml_writer("activities/wiki_{$moduleid}/wiki.xml");
+ $this->xmlwriter->begin_tag('activity', array('id' => $instanceid, 'moduleid' => $moduleid,
+ 'modulename' => 'wiki', 'contextid' => $contextid));
+ $this->xmlwriter->begin_tag('wiki', array('id' => $instanceid));
+
+ unset($data['id']); // we already write it as attribute, do not repeat it as child element
+ foreach ($data as $field => $value) {
+ $this->xmlwriter->full_tag($field, $value);
+ }
+ }
+
+ //process ENTRIES
+ public function on_wiki_entries_start() {
+ $this->xmlwriter->begin_tag('subwikis');
+ $this->needinitpage = false; //backup has entries, so the initial_content file has been stored as a page in 1.9.
+ }
+ public function on_wiki_entries_end() {
+ $this->xmlwriter->end_tag('subwikis');
+ }
+
+ //process ENTRY
+ public function process_wiki_entry($data) {
+ $this->xmlwriter->begin_tag('subwiki', array('id' => $data['id']));
+ unset($data['id']);
+
+ unset($data['pagename']);
+ unset($data['timemodified']);
+
+ foreach ($data as $field => $value) {
+ $this->xmlwriter->full_tag($field, $value);
+ }
+ }
+ public function on_wiki_entry_end() {
+ $this->xmlwriter->end_tag('subwiki');
+ }
+
+ // process PAGES
+ public function on_wiki_pages_start() {
+ $this->xmlwriter->begin_tag('pages');
+ }
+ public function on_wiki_pages_end() {
+ $this->xmlwriter->end_tag('pages');
+ }
+
+ // process PAGE
+ public function process_wiki_entry_page($data) {
+ // assimilate data to create later in extra virtual path page/versions/version/
+ $this->databuf['id'] = $this->converter->get_nextid();
+ $this->databuf['content'] = $data['content'];
+ unset($data['content']);
+ $this->databuf['contentformat'] = 'html';
+ $this->databuf['version'] = 0;
+ $this->databuf['timecreated'] = $data['timecreated']; //do not unset, is reused
+ $this->databuf['userid'] = $data['userid']; //do not unset, is reused
+
+ //process page data (user data and also the one that is from <initialcontent>
+ $this->xmlwriter->begin_tag('page', array('id' => $data['id']));
+ unset($data['id']); // we already write it as attribute, do not repeat it as child element
+ foreach ($data as $field => $value) {
+ $this->xmlwriter->full_tag($field, $value);
+ }
+
+ //process page content as a version.
+ $this->xmlwriter->begin_tag('versions');
+ $this->write_xml('version', $this->databuf, array('/version/id')); //version id from get_nextid()
+ $this->xmlwriter->end_tag('versions');
+ }
+ public function on_wiki_entry_page_end() {
+ $this->xmlwriter->end_tag('page');
+ }
+
+ /**
+ * This is executed when we reach the closing </MOD> tag of our 'wiki' path
+ */
+ public function on_wiki_end() {
+ global $USER;
+ //check if initial content needs to be created ( and if a page already there for it?)
+ if ($this->initialcontentfilename && $this->needinitpage) {
+ //contruct (synthetic - not for cooking) a full path for creating entries/entry/pages/page
+ $data_entry = array(
+ 'id' => $this->converter->get_nextid(), //creating the first entry
+ 'groupid' => 0,
+ 'userid' => 0,
+ 'synonyms' => '',
+ 'links' => ''
+ );
+ $data_page = array(
+ 'id' => $this->converter->get_nextid(), //just creating the first page in the wiki
+ 'title' => $this->initialcontentfilename,
+ 'content' => $this->initialcontent,
+ 'userid' => $USER->id,
+ 'timecreated' => time(),
+ 'timemodified' => 0,
+ 'pageviews' => 0,
+ 'cachedcontent' => '**reparse needed**',
+ 'timerendered' => 0,
+ 'readonly' => 0,
+ 'tags' => ''
+ );
+ //create xml with constructed page data (from initial_content file).
+ $this->on_wiki_entries_start();
+ $this->process_wiki_entry($data_entry);
+ $this->on_wiki_pages_start();
+ $this->process_wiki_entry_page($data_page);
+ $this->on_wiki_entry_page_end();
+ $this->on_wiki_pages_end();
+ $this->on_wiki_entry_end();
+ $this->on_wiki_entries_end();
+ }
+
+ //close wiki.xml
+ $this->xmlwriter->end_tag('wiki');
+ $this->xmlwriter->end_tag('activity');
+ $this->close_xml_writer();
+ }
+}
Please sign in to comment.
Something went wrong with that request. Please try again.