MDL-21432 backup 2.0 - initial commit. forum moodle2 backup
authorEloy Lafuente <stronk7@moodle.org>
Wed, 21 Apr 2010 09:35:30 +0000 (09:35 +0000)
committerEloy Lafuente <stronk7@moodle.org>
Wed, 21 Apr 2010 09:35:30 +0000 (09:35 +0000)
mod/forum/backup/moodle2/backup_forum_activity_task.class.php [new file with mode: 0644]
mod/forum/backup/moodle2/backup_forum_settingslib.php [new file with mode: 0644]
mod/forum/backup/moodle2/backup_forum_stepslib.php [new file with mode: 0644]

diff --git a/mod/forum/backup/moodle2/backup_forum_activity_task.class.php b/mod/forum/backup/moodle2/backup_forum_activity_task.class.php
new file mode 100644 (file)
index 0000000..ab6c15b
--- /dev/null
@@ -0,0 +1,84 @@
+<?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/>.
+
+/**
+ * @package moodlecore
+ * @subpackage backup-moodle2
+ * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require_once($CFG->dirroot . '/mod/forum/backup/moodle2/backup_forum_stepslib.php'); // Because it exists (must)
+require_once($CFG->dirroot . '/mod/forum/backup/moodle2/backup_forum_settingslib.php'); // Because it exists (optional)
+
+/**
+ * forum backup task that provides all the settings and steps to perform one
+ * complete backup of the activity
+ */
+class backup_forum_activity_task extends backup_activity_task {
+
+    /**
+     * Define (add) particular settings this activity can have
+     */
+    protected function define_my_settings() {
+        // No particular settings for this activity
+    }
+
+    /**
+     * Define (add) particular steps this activity can have
+     */
+    protected function define_my_steps() {
+        // Forum only has one structure step
+        $this->add_step(new backup_forum_activity_structure_step('forum structure', 'forum.xml'));
+    }
+
+    /**
+     * Code the transformations to perform in the activity in
+     * order to get transportable (encoded) links
+     */
+    static public function encode_content_links($content) {
+        global $CFG;
+
+        $base = preg_quote($CFG->wwwroot,"/");
+
+        // Link to the list of forums
+        $search="/(".$base."\/mod\/forum\/index.php\?id\=)([0-9]+)/";
+        $content= preg_replace($search, '$@FORUMINDEX*$2@$', $content);
+
+        // Link to forum view by moduleid
+        $search="/(".$base."\/mod\/forum\/view.php\?id\=)([0-9]+)/";
+        $content= preg_replace($search, '$@FORUMVIEWBYID*$2@$', $content);
+
+        // Link to forum view by forumid
+        $search="/(".$base."\/mod\/forum\/view.php\?f\=)([0-9]+)/";
+        $content= preg_replace($search, '$@FORUMVIEWBYF*$2@$', $content);
+
+        // Link to forum discussion with parent syntax
+        $search="/(".$base."\/mod\/forum\/discuss.php\?d\=)([0-9]+)\&parent\=([0-9]+)/";
+        $content= preg_replace($search, '$@FORUMDISCUSSIONVIEWPARENT*$2*$3@$', $content);
+
+        // Link to forum discussion with relative syntax
+        $search="/(".$base."\/mod\/forum\/discuss.php\?d\=)([0-9]+)\#([0-9]+)/";
+        $content= preg_replace($search, '$@FORUMDISCUSSIONVIEWINSIDE*$2*$3@$', $content);
+
+        // Link to forum discussion by discussionid
+        $search="/(".$base."\/mod\/forum\/discuss.php\?d\=)([0-9]+)/";
+        $content= preg_replace($search, '$@FORUMDISCUSSIONVIEW*$2@$', $content);
+
+        return $content;
+    }
+}
diff --git a/mod/forum/backup/moodle2/backup_forum_settingslib.php b/mod/forum/backup/moodle2/backup_forum_settingslib.php
new file mode 100644 (file)
index 0000000..b66e78a
--- /dev/null
@@ -0,0 +1,27 @@
+<?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/>.
+
+/**
+ * @package moodlecore
+ * @subpackage backup-moodle2
+ * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+ // This activity has not particular settings but the inherited from the generic
+ // backup_activity_task so here there isn't any class definition, like the ones
+ // existing in /backup/moodle2/backup_settingslib.php (activities section)
diff --git a/mod/forum/backup/moodle2/backup_forum_stepslib.php b/mod/forum/backup/moodle2/backup_forum_stepslib.php
new file mode 100644 (file)
index 0000000..4b1e2f1
--- /dev/null
@@ -0,0 +1,145 @@
+<?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/>.
+
+/**
+ * @package moodlecore
+ * @subpackage backup-moodle2
+ * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Define all the backup steps that will be used by the backup_forum_activity_task
+ */
+
+/**
+ * Define the complete forum structure for backup, with file and id annotations
+ */
+class backup_forum_activity_structure_step extends backup_activity_structure_step {
+
+    protected function define_structure() {
+
+        // To know if we are including userinfo
+        $userinfo = $this->get_setting_value('userinfo');
+
+        // Define each element separated
+
+        $forum = new backup_nested_element('forum', array('id'), array(
+            'type', 'name', 'intro', 'introformat',
+            'assessed', 'assesstimestart', 'assesstimefinish', 'scale',
+            'maxbytes', 'maxattachments', 'forcesubscribe', 'trackingtype',
+            'rsstype', 'rssarticles', 'timemodified', 'warnafter',
+            'blockafter', 'blockperiod', 'completiondiscussions', 'completionreplies',
+            'completionposts'));
+
+        $discussions = new backup_nested_element('discussions');
+
+        $discussion = new backup_nested_element('discussion', array('id'), array(
+            'name', 'firstpost', 'userid', 'groupid',
+            'assessed', 'timemodified', 'usermodified', 'timestart',
+            'timeend'));
+
+        $posts = new backup_nested_element('posts');
+
+        $post = new backup_nested_element('post', array('id'), array(
+            'parent', 'userid', 'created', 'modified',
+            'mailed', 'subject', 'message', 'messageformat',
+            'messagetrust', 'attachment', 'totalscore', 'mailnow'));
+
+        $ratings = new backup_nested_element('ratings');
+
+        $rating = new backup_nested_element('rating', array('id'), array(
+            'scaleid', 'value', 'userid', 'timecreated', 'timemodified'));
+
+        $subscriptions = new backup_nested_element('subscriptions');
+
+        $subscription = new backup_nested_element('subscription', array('id'), array(
+            'userid'));
+
+        $readposts = new backup_nested_element('readposts');
+
+        $read = new backup_nested_element('read', array('id'), array(
+            'userid', 'discussionid', 'postid', 'firstread',
+            'lastread'));
+
+        // Build the tree
+
+        $forum->add_child($discussions);
+        $discussions->add_child($discussion);
+
+        $forum->add_child($subscriptions);
+        $subscriptions->add_child($subscription);
+
+        $forum->add_child($readposts);
+        $readposts->add_child($read);
+
+        $discussion->add_child($posts);
+        $posts->add_child($post);
+
+        $post->add_child($ratings);
+        $ratings->add_child($rating);
+
+        // Define sources
+
+        $forum->set_source_table('forum', array('id' => backup::VAR_ACTIVITYID));
+
+        // All these source definitions only happen if we are including user info
+        if ($userinfo) {
+            $discussion->set_source_sql('
+                SELECT *
+                  FROM {forum_discussions}
+                 WHERE forum = ?',
+                array(backup::VAR_PARENTID));
+
+            $post->set_source_table('forum_posts', array('discussion' => backup::VAR_PARENTID));
+
+            $subscription->set_source_table('forum_subscriptions', array('forum' => backup::VAR_PARENTID));
+
+            $read->set_source_table('forum_read', array('forumid' => backup::VAR_PARENTID));
+
+            $rating->set_source_table('rating', array('contextid' => backup::VAR_CONTEXTID,
+                                                      'itemid'    => backup::VAR_PARENTID));
+            $rating->set_source_alias('rating', 'value');
+        }
+
+        // Define id annotations
+
+        $forum->annotate_ids('scale', 'scale');
+
+        $discussion->annotate_ids('group', 'groupid');
+
+        $post->annotate_ids('user', 'userid');
+
+        $rating->annotate_ids('scale', 'scaleid');
+
+        $rating->annotate_ids('user', 'userid');
+
+        $subscription->annotate_ids('user', 'userid');
+
+        $read->annotate_ids('user', 'userid');
+
+        // Define file annotations
+
+        $forum->annotate_files(array('forum_intro'), null); // This file area hasn't itemid
+
+        $post->annotate_files(array('forum_post', 'forum_attachment'), 'id');
+
+        // Return the root element (forum), wrapped into standard activity structure
+        return $this->prepare_activity_structure($forum);
+    }
+
+}