63f45d9c6eb4570545fe49d497fba91940c2dfbf
[moodle.git] / mod / forum / backup / moodle2 / backup_forum_stepslib.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  * @package    mod_forum
20  * @subpackage backup-moodle2
21  * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * Define all the backup steps that will be used by the backup_forum_activity_task
27  */
29 /**
30  * Define the complete forum structure for backup, with file and id annotations
31  */
32 class backup_forum_activity_structure_step extends backup_activity_structure_step {
34     protected function define_structure() {
36         // To know if we are including userinfo
37         $userinfo = $this->get_setting_value('userinfo');
39         // Define each element separated
41         $forum = new backup_nested_element('forum', array('id'), array(
42             'type', 'name', 'intro', 'introformat',
43             'assessed', 'assesstimestart', 'assesstimefinish', 'scale',
44             'maxbytes', 'maxattachments', 'forcesubscribe', 'trackingtype',
45             'rsstype', 'rssarticles', 'timemodified', 'warnafter',
46             'blockafter', 'blockperiod', 'completiondiscussions', 'completionreplies',
47             'completionposts', 'displaywordcount', 'lockdiscussionafter'));
49         $discussions = new backup_nested_element('discussions');
51         $discussion = new backup_nested_element('discussion', array('id'), array(
52             'name', 'firstpost', 'userid', 'groupid',
53             'assessed', 'timemodified', 'usermodified', 'timestart',
54             'timeend', 'pinned'));
56         $posts = new backup_nested_element('posts');
58         $post = new backup_nested_element('post', array('id'), array(
59             'parent', 'userid', 'created', 'modified',
60             'mailed', 'subject', 'message', 'messageformat',
61             'messagetrust', 'attachment', 'totalscore', 'mailnow'));
63         $tags = new backup_nested_element('poststags');
64         $tag = new backup_nested_element('tag', array('id'), array('itemid', 'rawname'));
66         $ratings = new backup_nested_element('ratings');
68         $rating = new backup_nested_element('rating', array('id'), array(
69             'component', 'ratingarea', 'scaleid', 'value', 'userid', 'timecreated', 'timemodified'));
71         $discussionsubs = new backup_nested_element('discussion_subs');
73         $discussionsub = new backup_nested_element('discussion_sub', array('id'), array(
74             'userid',
75             'preference',
76         ));
78         $subscriptions = new backup_nested_element('subscriptions');
80         $subscription = new backup_nested_element('subscription', array('id'), array(
81             'userid'));
83         $digests = new backup_nested_element('digests');
85         $digest = new backup_nested_element('digest', array('id'), array(
86             'userid', 'maildigest'));
88         $readposts = new backup_nested_element('readposts');
90         $read = new backup_nested_element('read', array('id'), array(
91             'userid', 'discussionid', 'postid', 'firstread',
92             'lastread'));
94         $trackedprefs = new backup_nested_element('trackedprefs');
96         $track = new backup_nested_element('track', array('id'), array(
97             'userid'));
99         // Build the tree
101         $forum->add_child($discussions);
102         $discussions->add_child($discussion);
104         $forum->add_child($subscriptions);
105         $subscriptions->add_child($subscription);
107         $forum->add_child($digests);
108         $digests->add_child($digest);
110         $forum->add_child($readposts);
111         $readposts->add_child($read);
113         $forum->add_child($trackedprefs);
114         $trackedprefs->add_child($track);
116         $forum->add_child($tags);
117         $tags->add_child($tag);
119         $discussion->add_child($posts);
120         $posts->add_child($post);
122         $post->add_child($ratings);
123         $ratings->add_child($rating);
125         $discussion->add_child($discussionsubs);
126         $discussionsubs->add_child($discussionsub);
128         // Define sources
130         $forum->set_source_table('forum', array('id' => backup::VAR_ACTIVITYID));
132         // All these source definitions only happen if we are including user info
133         if ($userinfo) {
134             $discussion->set_source_sql('
135                 SELECT *
136                   FROM {forum_discussions}
137                  WHERE forum = ?',
138                 array(backup::VAR_PARENTID));
140             // Need posts ordered by id so parents are always before childs on restore
141             $post->set_source_table('forum_posts', array('discussion' => backup::VAR_PARENTID), 'id ASC');
142             $discussionsub->set_source_table('forum_discussion_subs', array('discussion' => backup::VAR_PARENTID));
144             $subscription->set_source_table('forum_subscriptions', array('forum' => backup::VAR_PARENTID));
145             $digest->set_source_table('forum_digests', array('forum' => backup::VAR_PARENTID));
147             $read->set_source_table('forum_read', array('forumid' => backup::VAR_PARENTID));
149             $track->set_source_table('forum_track_prefs', array('forumid' => backup::VAR_PARENTID));
151             $rating->set_source_table('rating', array('contextid'  => backup::VAR_CONTEXTID,
152                                                       'component'  => backup_helper::is_sqlparam('mod_forum'),
153                                                       'ratingarea' => backup_helper::is_sqlparam('post'),
154                                                       'itemid'     => backup::VAR_PARENTID));
155             $rating->set_source_alias('rating', 'value');
157             if (core_tag_tag::is_enabled('mod_forum', 'forum_posts')) {
158                 // Backup all tags for all forum posts in this forum.
159                 $tag->set_source_sql('SELECT t.id, ti.itemid, t.rawname
160                                         FROM {tag} t
161                                         JOIN {tag_instance} ti ON ti.tagid = t.id
162                                        WHERE ti.itemtype = ?
163                                          AND ti.component = ?
164                                          AND ti.contextid = ?', array(
165                     backup_helper::is_sqlparam('forum_posts'),
166                     backup_helper::is_sqlparam('mod_forum'),
167                     backup::VAR_CONTEXTID));
168             }
169         }
171         // Define id annotations
173         $forum->annotate_ids('scale', 'scale');
175         $discussion->annotate_ids('group', 'groupid');
177         $post->annotate_ids('user', 'userid');
179         $discussionsub->annotate_ids('user', 'userid');
181         $rating->annotate_ids('scale', 'scaleid');
183         $rating->annotate_ids('user', 'userid');
185         $subscription->annotate_ids('user', 'userid');
187         $digest->annotate_ids('user', 'userid');
189         $read->annotate_ids('user', 'userid');
191         $track->annotate_ids('user', 'userid');
193         // Define file annotations
195         $forum->annotate_files('mod_forum', 'intro', null); // This file area hasn't itemid
197         $post->annotate_files('mod_forum', 'post', 'id');
198         $post->annotate_files('mod_forum', 'attachment', 'id');
200         // Return the root element (forum), wrapped into standard activity structure
201         return $this->prepare_activity_structure($forum);
202     }