771fd41af07da2e44cc3550db19dbbfe300df842
[moodle.git] / mod / forum / backup / moodle2 / restore_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 restore steps that will be used by the restore_forum_activity_task
27  */
29 /**
30  * Structure step to restore one forum activity
31  */
32 class restore_forum_activity_structure_step extends restore_activity_structure_step {
34     protected function define_structure() {
36         $paths = array();
37         $userinfo = $this->get_setting_value('userinfo');
39         $paths[] = new restore_path_element('forum', '/activity/forum');
40         if ($userinfo) {
41             $paths[] = new restore_path_element('forum_discussion', '/activity/forum/discussions/discussion');
42             $paths[] = new restore_path_element('forum_post', '/activity/forum/discussions/discussion/posts/post');
43             $paths[] = new restore_path_element('forum_tag', '/activity/forum/poststags/tag');
44             $paths[] = new restore_path_element('forum_discussion_sub', '/activity/forum/discussions/discussion/discussion_subs/discussion_sub');
45             $paths[] = new restore_path_element('forum_rating', '/activity/forum/discussions/discussion/posts/post/ratings/rating');
46             $paths[] = new restore_path_element('forum_subscription', '/activity/forum/subscriptions/subscription');
47             $paths[] = new restore_path_element('forum_digest', '/activity/forum/digests/digest');
48             $paths[] = new restore_path_element('forum_read', '/activity/forum/readposts/read');
49             $paths[] = new restore_path_element('forum_track', '/activity/forum/trackedprefs/track');
50         }
52         // Return the paths wrapped into standard activity structure
53         return $this->prepare_activity_structure($paths);
54     }
56     protected function process_forum($data) {
57         global $DB;
59         $data = (object)$data;
60         $oldid = $data->id;
61         $data->course = $this->get_courseid();
63         // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
64         // See MDL-9367.
65         $data->assesstimestart = $this->apply_date_offset($data->assesstimestart);
66         $data->assesstimefinish = $this->apply_date_offset($data->assesstimefinish);
67         if ($data->scale < 0) { // scale found, get mapping
68             $data->scale = -($this->get_mappingid('scale', abs($data->scale)));
69         }
71         $newitemid = $DB->insert_record('forum', $data);
72         $this->apply_activity_instance($newitemid);
74         // Add current enrolled user subscriptions if necessary.
75         $data->id = $newitemid;
76         $ctx = context_module::instance($this->task->get_moduleid());
77         forum_instance_created($ctx, $data);
78     }
80     protected function process_forum_discussion($data) {
81         global $DB;
83         $data = (object)$data;
84         $oldid = $data->id;
85         $data->course = $this->get_courseid();
87         $data->forum = $this->get_new_parentid('forum');
88         $data->timestart = $this->apply_date_offset($data->timestart);
89         $data->timeend = $this->apply_date_offset($data->timeend);
90         $data->userid = $this->get_mappingid('user', $data->userid);
91         $data->groupid = $this->get_mappingid('group', $data->groupid);
92         $data->usermodified = $this->get_mappingid('user', $data->usermodified);
94         $newitemid = $DB->insert_record('forum_discussions', $data);
95         $this->set_mapping('forum_discussion', $oldid, $newitemid);
96     }
98     protected function process_forum_post($data) {
99         global $DB;
101         $data = (object)$data;
102         $oldid = $data->id;
104         $data->discussion = $this->get_new_parentid('forum_discussion');
105         $data->userid = $this->get_mappingid('user', $data->userid);
106         // If post has parent, map it (it has been already restored)
107         if (!empty($data->parent)) {
108             $data->parent = $this->get_mappingid('forum_post', $data->parent);
109         }
111         $newitemid = $DB->insert_record('forum_posts', $data);
112         $this->set_mapping('forum_post', $oldid, $newitemid, true);
114         // If !post->parent, it's the 1st post. Set it in discussion
115         if (empty($data->parent)) {
116             $DB->set_field('forum_discussions', 'firstpost', $newitemid, array('id' => $data->discussion));
117         }
118     }
120     protected function process_forum_tag($data) {
121         $data = (object)$data;
123         if (!core_tag_tag::is_enabled('mod_forum', 'forum_posts')) { // Tags disabled in server, nothing to process.
124             return;
125         }
127         $tag = $data->rawname;
128         if (!$itemid = $this->get_mappingid('forum_post', $data->itemid)) {
129             // Some orphaned tag, we could not find the restored post for it - ignore.
130             return;
131         }
133         $context = context_module::instance($this->task->get_moduleid());
134         core_tag_tag::add_item_tag('mod_forum', 'forum_posts', $itemid, $context, $tag);
135     }
137     protected function process_forum_rating($data) {
138         global $DB;
140         $data = (object)$data;
142         // Cannot use ratings API, cause, it's missing the ability to specify times (modified/created)
143         $data->contextid = $this->task->get_contextid();
144         $data->itemid    = $this->get_new_parentid('forum_post');
145         if ($data->scaleid < 0) { // scale found, get mapping
146             $data->scaleid = -($this->get_mappingid('scale', abs($data->scaleid)));
147         }
148         $data->rating = $data->value;
149         $data->userid = $this->get_mappingid('user', $data->userid);
151         // We need to check that component and ratingarea are both set here.
152         if (empty($data->component)) {
153             $data->component = 'mod_forum';
154         }
155         if (empty($data->ratingarea)) {
156             $data->ratingarea = 'post';
157         }
159         $newitemid = $DB->insert_record('rating', $data);
160     }
162     protected function process_forum_subscription($data) {
163         global $DB;
165         $data = (object)$data;
166         $oldid = $data->id;
168         $data->forum = $this->get_new_parentid('forum');
169         $data->userid = $this->get_mappingid('user', $data->userid);
171         // Create only a new subscription if it does not already exist (see MDL-59854).
172         if ($subscription = $DB->get_record('forum_subscriptions',
173                 array('forum' => $data->forum, 'userid' => $data->userid))) {
174             $this->set_mapping('forum_subscription', $oldid, $subscription->id, true);
175         } else {
176             $newitemid = $DB->insert_record('forum_subscriptions', $data);
177             $this->set_mapping('forum_subscription', $oldid, $newitemid, true);
178         }
180     }
182     protected function process_forum_discussion_sub($data) {
183         global $DB;
185         $data = (object)$data;
186         $oldid = $data->id;
188         $data->discussion = $this->get_new_parentid('forum_discussion');
189         $data->forum = $this->get_new_parentid('forum');
190         $data->userid = $this->get_mappingid('user', $data->userid);
192         $newitemid = $DB->insert_record('forum_discussion_subs', $data);
193         $this->set_mapping('forum_discussion_sub', $oldid, $newitemid, true);
194     }
196     protected function process_forum_digest($data) {
197         global $DB;
199         $data = (object)$data;
200         $oldid = $data->id;
202         $data->forum = $this->get_new_parentid('forum');
203         $data->userid = $this->get_mappingid('user', $data->userid);
205         $newitemid = $DB->insert_record('forum_digests', $data);
206     }
208     protected function process_forum_read($data) {
209         global $DB;
211         $data = (object)$data;
212         $oldid = $data->id;
214         $data->forumid = $this->get_new_parentid('forum');
215         $data->discussionid = $this->get_mappingid('forum_discussion', $data->discussionid);
216         $data->postid = $this->get_mappingid('forum_post', $data->postid);
217         $data->userid = $this->get_mappingid('user', $data->userid);
219         $newitemid = $DB->insert_record('forum_read', $data);
220     }
222     protected function process_forum_track($data) {
223         global $DB;
225         $data = (object)$data;
226         $oldid = $data->id;
228         $data->forumid = $this->get_new_parentid('forum');
229         $data->userid = $this->get_mappingid('user', $data->userid);
231         $newitemid = $DB->insert_record('forum_track_prefs', $data);
232     }
234     protected function after_execute() {
235         // Add forum related files, no need to match by itemname (just internally handled context)
236         $this->add_related_files('mod_forum', 'intro', null);
238         // Add post related files, matching by itemname = 'forum_post'
239         $this->add_related_files('mod_forum', 'post', 'forum_post');
240         $this->add_related_files('mod_forum', 'attachment', 'forum_post');
241     }
243     protected function after_restore() {
244         global $DB;
246         // If the forum is of type 'single' and no discussion has been ignited
247         // (non-userinfo backup/restore) create the discussion here, using forum
248         // information as base for the initial post.
249         $forumid = $this->task->get_activityid();
250         $forumrec = $DB->get_record('forum', array('id' => $forumid));
251         if ($forumrec->type == 'single' && !$DB->record_exists('forum_discussions', array('forum' => $forumid))) {
252             // Create single discussion/lead post from forum data
253             $sd = new stdClass();
254             $sd->course   = $forumrec->course;
255             $sd->forum    = $forumrec->id;
256             $sd->name     = $forumrec->name;
257             $sd->assessed = $forumrec->assessed;
258             $sd->message  = $forumrec->intro;
259             $sd->messageformat = $forumrec->introformat;
260             $sd->messagetrust  = true;
261             $sd->mailnow  = false;
262             $sdid = forum_add_discussion($sd, null, null, $this->task->get_userid());
263             // Mark the post as mailed
264             $DB->set_field ('forum_posts','mailed', '1', array('discussion' => $sdid));
265             // Copy all the files from mod_foum/intro to mod_forum/post
266             $fs = get_file_storage();
267             $files = $fs->get_area_files($this->task->get_contextid(), 'mod_forum', 'intro');
268             foreach ($files as $file) {
269                 $newfilerecord = new stdClass();
270                 $newfilerecord->filearea = 'post';
271                 $newfilerecord->itemid   = $DB->get_field('forum_discussions', 'firstpost', array('id' => $sdid));
272                 $fs->create_file_from_storedfile($newfilerecord, $file);
273             }
274         }
275     }