cf6c1b81f24fd46c8757204e11e70d4248234f50
[moodle.git] / mod / lesson / backup / moodle2 / backup_lesson_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  * This file contains the backup structure for the lesson module
20  *
21  * This is the "graphical" structure of the lesson module:
22  *
23  *         lesson ---------->-------------|------------>---------|----------->----------|----------->----------|
24  *      (CL,pk->id)                       |                      |                      |                      |
25  *            |                           |                      |                      |                      |
26  *            |                     lesson_grades          lesson_high_scores     lesson_timer           lesson_overrides
27  *            |            (UL, pk->id,fk->lessonid) (UL, pk->id,fk->lessonid) (UL, pk->id,fk->lessonid) (UL, pk->id,fk->lessonid)
28  *            |                           |
29  *            |                           |
30  *            |                           |
31  *            |                           |
32  *      lesson_pages-------->-------lesson_branch
33  *   (CL,pk->id,fk->lessonid)     (UL, pk->id,fk->pageid)
34  *            |
35  *            |
36  *            |
37  *      lesson_answers
38  *   (CL,pk->id,fk->pageid)
39  *            |
40  *            |
41  *            |
42  *      lesson_attempts
43  *  (UL,pk->id,fk->answerid)
44  *
45  * Meaning: pk->primary key field of the table
46  *          fk->foreign key to link with parent
47  *          nt->nested field (recursive data)
48  *          CL->course level info
49  *          UL->user level info
50  *          files->table may have files)
51  *
52  * @package mod_lesson
53  * @copyright  2010 Sam Hemelryk
54  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
55  */
57 /**
58  * Structure step class that informs a backup task how to backup the lesson module.
59  *
60  * @copyright  2010 Sam Hemelryk
61  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
62  */
63 class backup_lesson_activity_structure_step extends backup_activity_structure_step {
65     protected function define_structure() {
67         // The lesson table
68         // This table contains all of the goodness for the lesson module, quite
69         // alot goes into it but nothing relational other than course when will
70         // need to be corrected upon restore
71         $lesson = new backup_nested_element('lesson', array('id'), array(
72             'course', 'name', 'intro', 'introformat', 'practice', 'modattempts',
73             'usepassword', 'password',
74             'dependency', 'conditions', 'grade', 'custom', 'ongoing', 'usemaxgrade',
75             'maxanswers', 'maxattempts', 'review', 'nextpagedefault', 'feedback',
76             'minquestions', 'maxpages', 'timelimit', 'retake', 'activitylink',
77             'mediafile', 'mediaheight', 'mediawidth', 'mediaclose', 'slideshow',
78             'width', 'height', 'bgcolor', 'displayleft', 'displayleftif', 'progressbar',
79             'showhighscores', 'maxhighscores', 'available', 'deadline', 'timemodified',
80             'completionendreached', 'completiontimespent'
81         ));
82         // Tell the lesson element about the showhighscores elements mapping to the highscores
83         // database field.
84         $lesson->set_source_alias('highscores', 'showhighscores');
86         // The lesson_pages table
87         // Grouped within a `pages` element, important to note that page is relational
88         // to the lesson, and also to the previous/next page in the series.
89         // Upon restore prevpageid and nextpageid will need to be corrected.
90         $pages = new backup_nested_element('pages');
91         $page = new backup_nested_element('page', array('id'), array(
92             'prevpageid','nextpageid','qtype','qoption','layout',
93             'display','timecreated','timemodified','title','contents',
94             'contentsformat'
95         ));
97         // The lesson_answers table
98         // Grouped within an answers `element`, the lesson_answers table relates
99         // to the page and lesson with `pageid` and `lessonid` that will both need
100         // to be corrected during restore.
101         $answers = new backup_nested_element('answers');
102         $answer = new backup_nested_element('answer', array('id'), array(
103             'jumpto','grade','score','flags','timecreated','timemodified','answer_text',
104             'response', 'answerformat', 'responseformat'
105         ));
106         // Tell the answer element about the answer_text elements mapping to the answer
107         // database field.
108         $answer->set_source_alias('answer', 'answer_text');
110         // The lesson_attempts table
111         // Grouped by an `attempts` element this is relational to the page, lesson,
112         // and user.
113         $attempts = new backup_nested_element('attempts');
114         $attempt = new backup_nested_element('attempt', array('id'), array(
115             'userid','retry','correct','useranswer','timeseen'
116         ));
118         // The lesson_branch table
119         // Grouped by a `branch` element this is relational to the page, lesson,
120         // and user.
121         $branches = new backup_nested_element('branches');
122         $branch = new backup_nested_element('branch', array('id'), array(
123              'userid', 'retry', 'flag', 'timeseen', 'nextpageid'
124         ));
126         // The lesson_grades table
127         // Grouped by a grades element this is relational to the lesson and user.
128         $grades = new backup_nested_element('grades');
129         $grade = new backup_nested_element('grade', array('id'), array(
130             'userid','grade','late','completed'
131         ));
133         // The lesson_high_scores table
134         // Grouped by a highscores element this is relational to the lesson, user,
135         // and possibly a grade.
136         $highscores = new backup_nested_element('highscores');
137         $highscore = new backup_nested_element('highscore', array('id'), array(
138             'gradeid','userid','nickname'
139         ));
141         // The lesson_timer table
142         // Grouped by a `timers` element this is relational to the lesson and user.
143         $timers = new backup_nested_element('timers');
144         $timer = new backup_nested_element('timer', array('id'), array(
145             'userid', 'starttime', 'lessontime', 'completed'
146         ));
148         $overrides = new backup_nested_element('overrides');
149         $override = new backup_nested_element('override', array('id'), array(
150             'groupid', 'userid', 'available', 'deadline', 'timelimit',
151             'review', 'maxattempts', 'retake', 'password'));
153         // Now that we have all of the elements created we've got to put them
154         // together correctly.
155         $lesson->add_child($pages);
156         $pages->add_child($page);
157         $page->add_child($answers);
158         $answers->add_child($answer);
159         $answer->add_child($attempts);
160         $attempts->add_child($attempt);
161         $page->add_child($branches);
162         $branches->add_child($branch);
163         $lesson->add_child($grades);
164         $grades->add_child($grade);
165         $lesson->add_child($highscores);
166         $highscores->add_child($highscore);
167         $lesson->add_child($timers);
168         $timers->add_child($timer);
169         $lesson->add_child($overrides);
170         $overrides->add_child($override);
172         // Set the source table for the elements that aren't reliant on the user
173         // at this point (lesson, lesson_pages, lesson_answers)
174         $lesson->set_source_table('lesson', array('id' => backup::VAR_ACTIVITYID));
175         //we use SQL here as it must be ordered by prevpageid so that restore gets the pages in the right order.
176         $page->set_source_table('lesson_pages', array('lessonid' => backup::VAR_PARENTID), 'prevpageid ASC');
178         // We use SQL here as answers must be ordered by id so that the restore gets them in the right order
179         $answer->set_source_table('lesson_answers', array('pageid' => backup::VAR_PARENTID), 'id ASC');
181         // Lesson overrides to backup are different depending of user info.
182         $overrideparams = array('lessonid' => backup::VAR_PARENTID);
184         // Check if we are also backing up user information
185         if ($this->get_setting_value('userinfo')) {
186             // Set the source table for elements that are reliant on the user
187             // lesson_attempts, lesson_branch, lesson_grades, lesson_high_scores, lesson_timer
188             $attempt->set_source_table('lesson_attempts', array('answerid' => backup::VAR_PARENTID));
189             $branch->set_source_table('lesson_branch', array('pageid' => backup::VAR_PARENTID));
190             $grade->set_source_table('lesson_grades', array('lessonid'=>backup::VAR_PARENTID));
191             $highscore->set_source_table('lesson_high_scores', array('lessonid' => backup::VAR_PARENTID));
192             $timer->set_source_table('lesson_timer', array('lessonid' => backup::VAR_PARENTID));
193         } else {
194             $overrideparams['userid'] = backup_helper::is_sqlparam(null); //  Without userinfo, skip user overrides.
195         }
197         $override->set_source_table('lesson_overrides', $overrideparams);
199         // Annotate the user id's where required.
200         $attempt->annotate_ids('user', 'userid');
201         $branch->annotate_ids('user', 'userid');
202         $grade->annotate_ids('user', 'userid');
203         $highscore->annotate_ids('user', 'userid');
204         $timer->annotate_ids('user', 'userid');
205         $override->annotate_ids('user', 'userid');
206         $override->annotate_ids('group', 'groupid');
208         // Annotate the file areas in user by the lesson module.
209         $lesson->annotate_files('mod_lesson', 'intro', null);
210         $lesson->annotate_files('mod_lesson', 'mediafile', null);
211         $page->annotate_files('mod_lesson', 'page_contents', 'id');
212         $answer->annotate_files('mod_lesson', 'page_answers', 'id');
213         $answer->annotate_files('mod_lesson', 'page_responses', 'id');
214         $attempt->annotate_files('mod_lesson', 'essay_responses', 'id');
216         // Prepare and return the structure we have just created for the lesson module.
217         return $this->prepare_activity_structure($lesson);
218     }