backup/moodle2/backup_stepslib.php

   1 <?php
   2
   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/>.
  17
  18 /**
  19  * @package moodlecore
  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  */
  24
  25 /**
  26  * Define all the backup steps that will be used by common tasks in backup
  27  */
  28
  29 /**
  30  * create the temp dir where backup/restore will happen,
  31  * delete old directories and create temp ids table
  32  */
  33 class create_and_clean_temp_stuff extends backup_execution_step {
  34
  35     protected function define_execution() {
  36         backup_helper::check_and_create_backup_dir($this->get_backupid());// Create backup temp dir
  37         backup_helper::clear_backup_dir($this->get_backupid());           // Empty temp dir, just in case
  38         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));    // Delete > 4 hours temp dirs
  39         backup_controller_dbops::create_backup_ids_temp_table($this->get_backupid()); // Create ids temp table
  40     }
  41 }
  42
  43 /**
  44  * delete the temp dir used by backup/restore (conditionally),
  45  * delete old directories and drop tem ids table. Note we delete
  46  * the directory but not the corresponding log file that will be
  47  * there for, at least, 4 hours - only delete_old_backup_dirs()
  48  * deletes log files (for easier access to them)
  49  */
  50 class drop_and_clean_temp_stuff extends backup_execution_step {
  51
  52     protected function define_execution() {
  53         global $CFG;
  54         backup_controller_dbops::drop_backup_ids_temp_table($this->get_backupid()); // Drop ids temp table
  55         backup_helper::delete_old_backup_dirs(time() - (4 * 60 * 60));              // Delete > 4 hours temp dirs
  56         if (empty($CFG->keeptempdirectoriesonbackup)) { // Conditionally
  57             backup_helper::delete_backup_dir($this->get_backupid()); // Empty backup dir
  58         }
  59     }
  60 }
  61
  62 /**
  63  * Create the directory where all the task (activity/block...) information will be stored
  64  */
  65 class create_taskbasepath_directory extends backup_execution_step {
  66
  67     protected function define_execution() {
  68         global $CFG;
  69         $basepath = $this->task->get_taskbasepath();
  70         if (!check_dir_exists($basepath, true, true)) {
  71             throw new backup_step_exception('cannot_create_taskbasepath_directory', $basepath);
  72         }
  73     }
  74 }
  75
  76 /**
  77  * Abstract structure step, parent of all the activity structure steps. Used to wrap the
  78  * activity structure definition within the main <activity ...> tag. Also provides
  79  * subplugin support for activities (that must be properly declared)
  80  */
  81 abstract class backup_activity_structure_step extends backup_structure_step {
  82
  83     /**
  84      * Add subplugin structure to any element in the activity backup tree
  85      *
  86      * @param string $subplugintype type of subplugin as defined in activity db/subplugins.php
  87      * @param backup_nested_element $element element in the activity backup tree that
  88      *                                       we are going to add subplugin information to
  89      * @param bool $multiple to define if multiple subplugins can produce information
  90      *                       for each instance of $element (true) or no (false)
  91      */
  92     protected function add_subplugin_structure($subplugintype, $element, $multiple) {
  93
  94         global $CFG;
  95
  96         // Check the requested subplugintype is a valid one
  97         $subpluginsfile = $CFG->dirroot . '/mod/' . $this->task->get_modulename() . '/db/subplugins.php';
  98         if (!file_exists($subpluginsfile)) {
  99              throw new backup_step_exception('activity_missing_subplugins_php_file', $this->task->get_modulename());
 100         }
 101         include($subpluginsfile);
 102         if (!array_key_exists($subplugintype, $subplugins)) {
 103              throw new backup_step_exception('incorrect_subplugin_type', $subplugintype);
 104         }
 105
 106         // Arrived here, subplugin is correct, let's create the optigroup
 107         $optigroupname = $subplugintype . '_' . $element->get_name() . '_subplugin';
 108         $optigroup = new backup_optigroup($optigroupname, null, $multiple);
 109         $element->add_child($optigroup); // Add optigroup to stay connected since beginning
 110
 111         // Get all the optigroup_elements, looking across all the subplugin dirs
 112         $elements = array();
 113         $subpluginsdirs = get_plugin_list($subplugintype);
 114         foreach ($subpluginsdirs as $name => $subpluginsdir) {
 115             $classname = 'backup_' . $subplugintype . '_' . $name . '_subplugin';
 116             $backupfile = $subpluginsdir . '/backup/moodle2/' . $classname . '.class.php';
 117             if (file_exists($backupfile)) {
 118                 require_once($backupfile);
 119                 $backupsubplugin = new $classname($subplugintype, $name, $optigroup);
 120                 // Add subplugin returned structure to optigroup
 121                 $backupsubplugin->define_subplugin_structure($element->get_name());
 122             }
 123         }
 124     }
 125
 126     /**
 127      * Wraps any activity backup structure within the common 'activity' element
 128      * that will include common to all activities information like id, context...
 129      */
 130     protected function prepare_activity_structure($activitystructure) {
 131
 132         // Create the wrap element
 133         $activity = new backup_nested_element('activity', array('id', 'moduleid', 'modulename', 'contextid'), null);
 134
 135         // Build the tree
 136         $activity->add_child($activitystructure);
 137
 138         // Set the source
 139         $activityarr = array((object)array(
 140             'id'         => $this->task->get_activityid(),
 141             'moduleid'   => $this->task->get_moduleid(),
 142             'modulename' => $this->task->get_modulename(),
 143             'contextid'  => $this->task->get_contextid()));
 144
 145         $activity->set_source_array($activityarr);
 146
 147         // Return the root element (activity)
 148         return $activity;
 149     }
 150 }
 151
 152 /**
 153  * Abstract structure step, parent of all the block structure steps. Used to wrap the
 154  * block structure definition within the main <block ...> tag
 155  */
 156 abstract class backup_block_structure_step extends backup_structure_step {
 157
 158     protected function prepare_block_structure($blockstructure) {
 159
 160         // Create the wrap element
 161         $block = new backup_nested_element('block', array('id', 'blockname', 'contextid'), null);
 162
 163         // Build the tree
 164         $block->add_child($blockstructure);
 165
 166         // Set the source
 167         $blockarr = array((object)array(
 168             'id'         => $this->task->get_blockid(),
 169             'blockname'  => $this->task->get_blockname(),
 170             'contextid'  => $this->task->get_contextid()));
 171
 172         $block->set_source_array($blockarr);
 173
 174         // Return the root element (block)
 175         return $block;
 176     }
 177 }
 178
 179 /**
 180  * structure step that will generate the module.xml file for the activity,
 181  * accumulating various information about the activity, annotating groupings
 182  * and completion/avail conf
 183  */
 184 class backup_module_structure_step extends backup_structure_step {
 185
 186     protected function define_structure() {
 187
 188         // Define each element separated
 189
 190         $module = new backup_nested_element('module', array('id', 'version'), array(
 191             'modulename', 'sectionid', 'sectionnumber', 'idnumber',
 192             'added', 'score', 'indent', 'visible',
 193             'visibleold', 'groupmode', 'groupingid', 'groupmembersonly',
 194             'completion', 'completiongradeitemnumber', 'completionview', 'completionexpected',
 195             'availablefrom', 'availableuntil', 'showavailability'));
 196
 197         $availinfo = new backup_nested_element('availability_info');
 198         $availability = new backup_nested_element('availability', array('id'), array(
 199             'sourcecmid', 'requiredcompletion', 'gradeitemid', 'grademin', 'grademax'));
 200
 201         // Define the tree
 202         $module->add_child($availinfo);
 203         $availinfo->add_child($availability);
 204
 205         // Set the sources
 206
 207         $module->set_source_sql('
 208             SELECT cm.*, m.version, m.name AS modulename, s.id AS sectionid, s.section AS sectionnumber
 209               FROM {course_modules} cm
 210               JOIN {modules} m ON m.id = cm.module
 211               JOIN {course_sections} s ON s.id = cm.section
 212              WHERE cm.id = ?', array(backup::VAR_MODID));
 213
 214         $availability->set_source_table('course_modules_availability', array('coursemoduleid' => backup::VAR_MODID));
 215
 216         // Define annotations
 217         $module->annotate_ids('grouping', 'groupingid');
 218
 219         // Return the root element ($module)
 220         return $module;
 221     }
 222 }
 223
 224 /**
 225  * structure step that will generate the section.xml file for the section
 226  * annotating files
 227  */
 228 class backup_section_structure_step extends backup_structure_step {
 229
 230     protected function define_structure() {
 231
 232         // Define each element separated
 233
 234         $section = new backup_nested_element('section', array('id'), array(
 235             'number', 'name', 'summary', 'summaryformat', 'sequence', 'visible'));
 236
 237         // Define sources
 238
 239         $section->set_source_table('course_sections', array('id' => backup::VAR_SECTIONID));
 240
 241         // Aliases
 242         $section->set_source_alias('section', 'number');
 243
 244         // Set annotations
 245         $section->annotate_files('course', 'section', 'id');
 246
 247         return $section;
 248     }
 249 }
 250
 251 /**
 252  * structure step that will generate the course.xml file for the course, including
 253  * course category reference, tags, modules restriction information
 254  * and some annotations (files & groupings)
 255  */
 256 class backup_course_structure_step extends backup_structure_step {
 257
 258     protected function define_structure() {
 259         global $DB;
 260
 261         // Define each element separated
 262
 263         $course = new backup_nested_element('course', array('id', 'contextid'), array(
 264             'shortname', 'fullname', 'idnumber',
 265             'summary', 'summaryformat', 'format', 'showgrades',
 266             'newsitems', 'startdate',
 267             'numsections', 'marker', 'maxbytes', 'showreports',
 268             'visible', 'hiddensections', 'groupmode', 'groupmodeforce',
 269             'defaultgroupingid', 'lang', 'theme',
 270             'timecreated', 'timemodified',
 271             'requested', 'restrictmodules',
 272             'enablecompletion'));
 273
 274         $category = new backup_nested_element('category', array('id'), array(
 275             'name', 'description'));
 276
 277         $tags = new backup_nested_element('tags');
 278
 279         $tag = new backup_nested_element('tag', array('id'), array(
 280             'name', 'rawname'));
 281
 282         $allowedmodules = new backup_nested_element('allowed_modules');
 283
 284         $module = new backup_nested_element('module', array('modulename'));
 285
 286         // Build the tree
 287
 288         $course->add_child($category);
 289
 290         $course->add_child($tags);
 291         $tags->add_child($tag);
 292
 293         $course->add_child($allowedmodules);
 294         $allowedmodules->add_child($module);
 295
 296         // Set the sources
 297
 298         $courserec = $DB->get_record('course', array('id' => $this->task->get_courseid()));
 299         $courserec->contextid = $this->task->get_contextid();
 300
 301         $course->set_source_array(array($courserec));
 302
 303         $categoryrec = $DB->get_record('course_categories', array('id' => $courserec->category));
 304
 305         $category->set_source_array(array($categoryrec));
 306
 307         $tag->set_source_sql('SELECT t.id, t.name, t.rawname
 308                                 FROM {tag} t
 309                                 JOIN {tag_instance} ti ON ti.tagid = t.id
 310                                WHERE ti.itemtype = ?
 311                                  AND ti.itemid = ?', array(
 312                                      backup_helper::is_sqlparam('course'),
 313                                      backup::VAR_PARENTID));
 314
 315         $module->set_source_sql('SELECT m.name AS modulename
 316                                    FROM {modules} m
 317                                    JOIN {course_allowed_modules} cam ON m.id = cam.module
 318                                   WHERE course = ?', array(backup::VAR_COURSEID));
 319
 320         // Some annotations
 321
 322         $course->annotate_ids('grouping', 'defaultgroupingid');
 323
 324         $course->annotate_files('course', 'summary', null);
 325         $course->annotate_files('course', 'legacy', null);
 326
 327         // Return root element ($course)
 328
 329         return $course;
 330     }
 331 }
 332
 333 /**
 334  * structure step that will generate the enrolments.xml file for the given course
 335  */
 336 class backup_enrolments_structure_step extends backup_structure_step {
 337
 338     protected function define_structure() {
 339
 340         // To know if we are including users
 341         $users = $this->get_setting_value('users');
 342
 343         // Define each element separated
 344
 345         $enrolments = new backup_nested_element('enrolments');
 346
 347         $enrols = new backup_nested_element('enrols');
 348
 349         $enrol = new backup_nested_element('enrol', array('id'), array(
 350             'enrol', 'status', 'sortorder', 'name', 'enrolperiod', 'enrolstartdate',
 351             'enrolenddate', 'expirynotify', 'expirytreshold', 'notifyall',
 352             'password', 'cost', 'currency', 'roleid', 'customint1', 'customint2', 'customint3',
 353             'customint4', 'customchar1', 'customchar2', 'customdec1', 'customdec2',
 354             'customtext1', 'customtext2', 'timecreated', 'timemodified'));
 355
 356         $userenrolments = new backup_nested_element('user_enrolments');
 357
 358         $enrolment = new backup_nested_element('enrolment', array('id'), array(
 359             'status', 'userid', 'timestart', 'timeend', 'modifierid',
 360             'timemodified'));
 361
 362         // Build the tree
 363         $enrolments->add_child($enrols);
 364         $enrols->add_child($enrol);
 365         $enrol->add_child($userenrolments);
 366         $userenrolments->add_child($enrolment);
 367
 368         // Define sources
 369
 370         $enrol->set_source_table('enrol', array('courseid' => backup::VAR_COURSEID));
 371
 372         // User enrolments only added only if users included
 373         if ($users) {
 374             $enrolment->set_source_table('user_enrolments', array('enrolid' => backup::VAR_PARENTID));
 375             $enrolment->annotate_ids('user', 'userid');
 376         }
 377
 378         $enrol->annotate_ids('role', 'roleid');
 379
 380         //TODO: let plugins annotate custom fields too and add more children
 381
 382         return $enrolments;
 383     }
 384 }
 385
 386 /**
 387  * structure step that will generate the roles.xml file for the given context, observing
 388  * the role_assignments setting to know if that part needs to be included
 389  */
 390 class backup_roles_structure_step extends backup_structure_step {
 391
 392     protected function define_structure() {
 393
 394         // To know if we are including role assignments
 395         $roleassignments = $this->get_setting_value('role_assignments');
 396
 397         // Define each element separated
 398
 399         $roles = new backup_nested_element('roles');
 400
 401         $overrides = new backup_nested_element('role_overrides');
 402
 403         $override = new backup_nested_element('override', array('id'), array(
 404             'roleid', 'capability', 'permission', 'timemodified',
 405             'modifierid'));
 406
 407         $assignments = new backup_nested_element('role_assignments');
 408
 409         $assignment = new backup_nested_element('assignment', array('id'), array(
 410             'roleid', 'userid', 'timemodified', 'modifierid', 'component', 'itemid',
 411             'sortorder'));
 412
 413         // Build the tree
 414         $roles->add_child($overrides);
 415         $roles->add_child($assignments);
 416
 417         $overrides->add_child($override);
 418         $assignments->add_child($assignment);
 419
 420         // Define sources
 421
 422         $override->set_source_table('role_capabilities', array('contextid' => backup::VAR_CONTEXTID));
 423
 424         // Assignments only added if specified
 425         if ($roleassignments) {
 426             $assignment->set_source_table('role_assignments', array('contextid' => backup::VAR_CONTEXTID));
 427         }
 428
 429         // Define id annotations
 430         $override->annotate_ids('role', 'roleid');
 431
 432         $assignment->annotate_ids('role', 'roleid');
 433
 434         $assignment->annotate_ids('user', 'userid');
 435
 436         //TODO: how do we annotate the itemid? the meaning depends on the content of component table (skodak)
 437
 438         return $roles;
 439     }
 440 }
 441
 442 /**
 443  * structure step that will generate the roles.xml containing the
 444  * list of roles used along the whole backup process. Just raw
 445  * list of used roles from role table
 446  */
 447 class backup_final_roles_structure_step extends backup_structure_step {
 448
 449     protected function define_structure() {
 450
 451         // Define elements
 452
 453         $rolesdef = new backup_nested_element('roles_definition');
 454
 455         $role = new backup_nested_element('role', array('id'), array(
 456             'name', 'shortname', 'nameincourse', 'description',
 457             'sortorder', 'archetype'));
 458
 459         // Build the tree
 460
 461         $rolesdef->add_child($role);
 462
 463         // Define sources
 464
 465         $role->set_source_sql("SELECT r.*, rn.name AS nameincourse
 466                                  FROM {role} r
 467                                  JOIN {backup_ids_temp} bi ON r.id = bi.itemid
 468                             LEFT JOIN {role_names} rn ON r.id = rn.roleid AND rn.contextid = ?
 469                                 WHERE bi.backupid = ?
 470                                   AND bi.itemname = 'rolefinal'", array(backup::VAR_CONTEXTID, backup::VAR_BACKUPID));
 471
 472         // Return main element (rolesdef)
 473         return $rolesdef;
 474     }
 475 }
 476
 477 /**
 478  * structure step that will generate the scales.xml containing the
 479  * list of scales used along the whole backup process.
 480  */
 481 class backup_final_scales_structure_step extends backup_structure_step {
 482
 483     protected function define_structure() {
 484
 485         // Define elements
 486
 487         $scalesdef = new backup_nested_element('scales_definition');
 488
 489         $scale = new backup_nested_element('scale', array('id'), array(
 490             'courseid', 'userid', 'name', 'scale',
 491             'description', 'descriptionformat', 'timemodified'));
 492
 493         // Build the tree
 494
 495         $scalesdef->add_child($scale);
 496
 497         // Define sources
 498
 499         $scale->set_source_sql("SELECT s.*
 500                                   FROM {scale} s
 501                                   JOIN {backup_ids_temp} bi ON s.id = bi.itemid
 502                                  WHERE bi.backupid = ?
 503                                    AND bi.itemname = 'scalefinal'", array(backup::VAR_BACKUPID));
 504
 505         // Return main element (scalesdef)
 506         return $scalesdef;
 507     }
 508 }
 509
 510 /**
 511  * structure step that will generate the outcomes.xml containing the
 512  * list of outcomes used along the whole backup process.
 513  */
 514 class backup_final_outcomes_structure_step extends backup_structure_step {
 515
 516     protected function define_structure() {
 517
 518         // Define elements
 519
 520         $outcomesdef = new backup_nested_element('outcomes_definition');
 521
 522         $outcome = new backup_nested_element('outcome', array('id'), array(
 523             'courseid', 'userid', 'shortname', 'fullname',
 524             'scaleid', 'description', 'descriptionformat', 'timecreated',
 525             'timemodified','usermodified'));
 526
 527         // Build the tree
 528
 529         $outcomesdef->add_child($outcome);
 530
 531         // Define sources
 532
 533         $outcome->set_source_sql("SELECT o.*
 534                                     FROM {grade_outcomes} o
 535                                     JOIN {backup_ids_temp} bi ON o.id = bi.itemid
 536                                    WHERE bi.backupid = ?
 537                                      AND bi.itemname = 'outcomefinal'", array(backup::VAR_BACKUPID));
 538
 539         // Return main element (outcomesdef)
 540         return $outcomesdef;
 541     }
 542 }
 543
 544 /**
 545  * structure step in charge of constructing the filters.xml file for all the filters found
 546  * in activity
 547  */
 548 class backup_filters_structure_step extends backup_structure_step {
 549
 550     protected function define_structure() {
 551
 552         // Define each element separated
 553
 554         $filters = new backup_nested_element('filters');
 555
 556         $actives = new backup_nested_element('filter_actives');
 557
 558         $active = new backup_nested_element('filter_active', null, array('filter', 'active'));
 559
 560         $configs = new backup_nested_element('filter_configs');
 561
 562         $config = new backup_nested_element('filter_config', null, array('filter', 'name', 'value'));
 563
 564         // Build the tree
 565
 566         $filters->add_child($actives);
 567         $filters->add_child($configs);
 568
 569         $actives->add_child($active);
 570         $configs->add_child($config);
 571
 572         // Define sources
 573
 574         list($activearr, $configarr) = filter_get_all_local_settings($this->task->get_contextid());
 575
 576         $active->set_source_array($activearr);
 577         $config->set_source_array($configarr);
 578
 579         // Return the root element (filters)
 580         return $filters;
 581     }
 582 }
 583
 584 /**
 585  * structure step in charge of constructing the comments.xml file for all the comments found
 586  * in a given context
 587  */
 588 class backup_comments_structure_step extends backup_structure_step {
 589
 590     protected function define_structure() {
 591
 592         // Define each element separated
 593
 594         $comments = new backup_nested_element('comments');
 595
 596         $comment = new backup_nested_element('comment', array('id'), array(
 597             'commentarea', 'itemid', 'content', 'format',
 598             'userid', 'timecreated'));
 599
 600         // Build the tree
 601
 602         $comments->add_child($comment);
 603
 604         // Define sources
 605
 606         $comment->set_source_table('comments', array('contextid' => backup::VAR_CONTEXTID));
 607
 608         // Define id annotations
 609
 610         $comment->annotate_ids('user', 'userid');
 611
 612         // Return the root element (comments)
 613         return $comments;
 614     }
 615 }
 616
 617 /**
 618  * structure step in charge of constructing the gradebook.xml file for all the gradebook config in the course
 619  * NOTE: the backup of the grade items themselves is handled by backup_activity_grades_structure_step
 620  */
 621 class backup_gradebook_structure_step extends backup_structure_step {
 622
 623     protected function define_structure() {
 624
 625         // are we including user info?
 626         $userinfo = $this->get_setting_value('users');
 627
 628         $gradebook = new backup_nested_element('gradebook');
 629
 630         //grade_letters are done in backup_activity_grades_structure_step()
 631
 632         //calculated grade items
 633         $grade_items = new backup_nested_element('grade_items');
 634         $grade_item = new backup_nested_element('grade_item', array('id'), array(
 635             'categoryid', 'itemname', 'itemtype', 'itemmodule',
 636             'iteminstance', 'itemnumber', 'iteminfo', 'idnumber',
 637             'calculation', 'gradetype', 'grademax', 'grademin',
 638             'scaleid', 'outcomeid', 'gradepass', 'multfactor',
 639             'plusfactor', 'aggregationcoef', 'sortorder', 'display',
 640             'decimals', 'hidden', 'locked', 'locktime',
 641             'needsupdate', 'timecreated', 'timemodified'));
 642
 643         $grade_grades = new backup_nested_element('grade_grades');
 644         $grade_grade = new backup_nested_element('grade_grade', array('id'), array(
 645             'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
 646             'rawscaleid', 'usermodified', 'finalgrade', 'hidden',
 647             'locked', 'locktime', 'exported', 'overridden',
 648             'excluded', 'feedback', 'feedbackformat', 'information',
 649             'informationformat', 'timecreated', 'timemodified'));
 650
 651         //grade_categories
 652         $grade_categories = new backup_nested_element('grade_categories');
 653         $grade_category   = new backup_nested_element('grade_category', null, array('courseid',
 654                 'parent', 'depth', 'path', 'fullname', 'aggregation', 'keephigh',
 655                 'dropload', 'aggregateonlygraded', 'aggregateoutcomes', 'aggregatesubcats',
 656                 'timecreated', 'timemodified'));
 657
 658         $letters = new backup_nested_element('grade_letters');
 659         $letter = new backup_nested_element('grade_letter', 'id', array(
 660             'lowerboundary', 'letter'));
 661
 662
 663         // Build the tree
 664
 665         $gradebook->add_child($grade_items);
 666         $grade_items->add_child($grade_item);
 667         $grade_item->add_child($grade_grades);
 668         $grade_grades->add_child($grade_grade);
 669
 670         //$grade_item->add_child($grade_scale);
 671
 672         $gradebook->add_child($grade_categories);
 673         $grade_categories->add_child($grade_category);
 674
 675         $gradebook->add_child($letters);
 676         $letters->add_child($letter);
 677
 678         // Define sources
 679
 680         //if itemtype == manual then item is a calculated item so isn't attached to an activity and we need to back it up here
 681         $grade_items_array = grade_item::fetch_all(array('itemtype' => 'manual', 'courseid' => $this->get_courseid()));
 682
 683         //$grade_items_array==false and not an empty array if no items. set_source_array() fails if you pass a bool
 684         if ($grade_items_array) {
 685             $grade_item->set_source_array($grade_items_array);
 686         }
 687
 688         if ($userinfo) {
 689             $grade_grade->set_source_table('grade_grades', array('itemid' => backup::VAR_PARENTID));
 690         }
 691
 692         $grade_category_sql = "SELECT gc.*, gi.sortorder
 693                                FROM {grade_categories} gc
 694                                JOIN {grade_items} gi ON (gi.iteminstance = gc.id)
 695                                WHERE gc.courseid = :courseid
 696                                AND (gi.itemtype='course' OR gi.itemtype='category')
 697                                ORDER BY gc.parent ASC";//need parent categories before their children
 698         $grade_category_params = array('courseid'=>backup::VAR_COURSEID);
 699         $grade_category->set_source_sql($grade_category_sql, $grade_category_params);
 700
 701         $letter->set_source_table('grade_letters', array('contextid' => backup::VAR_CONTEXTID));
 702
 703         // Annotations
 704         $grade_item->annotate_ids('scalefinal', 'scaleid'); // Straight as scalefinal because it's > 0
 705         $grade_item->annotate_ids('outcome', 'outcomeid');
 706
 707         // Return the root element
 708         return $gradebook;
 709     }
 710 }
 711
 712 /**
 713  * structure step in charge if constructing the completion.xml file for all the users completion
 714  * information in a given activity
 715  */
 716 class backup_userscompletion_structure_step extends backup_structure_step {
 717
 718     protected function define_structure() {
 719
 720         // Define each element separated
 721
 722         $completions = new backup_nested_element('completions');
 723
 724         $completion = new backup_nested_element('completion', array('id'), array(
 725             'userid', 'completionstate', 'viewed', 'timemodified'));
 726
 727         // Build the tree
 728
 729         $completions->add_child($completion);
 730
 731         // Define sources
 732
 733         $completion->set_source_table('course_modules_completion', array('coursemoduleid' => backup::VAR_MODID));
 734
 735         // Define id annotations
 736
 737         $completion->annotate_ids('user', 'userid');
 738
 739         // Return the root element (completions)
 740         return $completions;
 741     }
 742 }
 743
 744 /**
 745  * structure step in charge of constructing the main groups.xml file for all the groups and
 746  * groupings information already annotated
 747  */
 748 class backup_groups_structure_step extends backup_structure_step {
 749
 750     protected function define_structure() {
 751
 752         // To know if we are including users
 753         $users = $this->get_setting_value('users');
 754
 755         // Define each element separated
 756
 757         $groups = new backup_nested_element('groups');
 758
 759         $group = new backup_nested_element('group', array('id'), array(
 760             'name', 'description', 'descriptionformat', 'enrolmentkey',
 761             'picture', 'hidepicture', 'timecreated', 'timemodified'));
 762
 763         $members = new backup_nested_element('group_members');
 764
 765         $member = new backup_nested_element('group_member', array('id'), array(
 766             'userid', 'timeadded'));
 767
 768         $groupings = new backup_nested_element('groupings');
 769
 770         $grouping = new backup_nested_element('grouping', 'id', array(
 771             'name', 'description', 'descriptionformat', 'configdata',
 772             'timecreated', 'timemodified'));
 773
 774         $groupinggroups = new backup_nested_element('grouping_groups');
 775
 776         $groupinggroup = new backup_nested_element('grouping_group', array('id'), array(
 777             'groupid', 'timeadded'));
 778
 779         // Build the tree
 780
 781         $groups->add_child($group);
 782         $groups->add_child($groupings);
 783
 784         $group->add_child($members);
 785         $members->add_child($member);
 786
 787         $groupings->add_child($grouping);
 788         $grouping->add_child($groupinggroups);
 789         $groupinggroups->add_child($groupinggroup);
 790
 791         // Define sources
 792
 793         $group->set_source_sql("
 794             SELECT g.*
 795               FROM {groups} g
 796               JOIN {backup_ids_temp} bi ON g.id = bi.itemid
 797              WHERE bi.backupid = ?
 798                AND bi.itemname = 'groupfinal'", array(backup::VAR_BACKUPID));
 799
 800         // This only happens if we are including users
 801         if ($users) {
 802             $member->set_source_table('groups_members', array('groupid' => backup::VAR_PARENTID));
 803         }
 804
 805         $grouping->set_source_sql("
 806             SELECT g.*
 807               FROM {groupings} g
 808               JOIN {backup_ids_temp} bi ON g.id = bi.itemid
 809              WHERE bi.backupid = ?
 810                AND bi.itemname = 'groupingfinal'", array(backup::VAR_BACKUPID));
 811
 812         $groupinggroup->set_source_table('groupings_groups', array('groupingid' => backup::VAR_PARENTID));
 813
 814         // Define id annotations (as final)
 815
 816         $member->annotate_ids('userfinal', 'userid');
 817
 818         // Define file annotations
 819
 820         $group->annotate_files('group', 'description', 'id');
 821         $group->annotate_files('group', 'icon', 'id');
 822
 823         // Return the root element (groups)
 824         return $groups;
 825     }
 826 }
 827
 828 /**
 829  * structure step in charge of constructing the main users.xml file for all the users already
 830  * annotated (final). Includes custom profile fields, preferences, tags, role assignments and
 831  * overrides.
 832  */
 833 class backup_users_structure_step extends backup_structure_step {
 834
 835     protected function define_structure() {
 836         global $CFG;
 837
 838         // To know if we are anonymizing users
 839         $anonymize = $this->get_setting_value('anonymize');
 840         // To know if we are including role assignments
 841         $roleassignments = $this->get_setting_value('role_assignments');
 842
 843         // Define each element separated
 844
 845         $users = new backup_nested_element('users');
 846
 847         // Create the array of user fields by hand, as far as we have various bits to control
 848         // anonymize option, password backup, mnethostid...
 849
 850         // First, the fields not needing anonymization nor special handling
 851         $normalfields = array(
 852             'confirmed', 'policyagreed', 'deleted',
 853             'lang', 'theme', 'timezone', 'firstaccess',
 854             'lastaccess', 'lastlogin', 'currentlogin', 'secret',
 855             'mailformat', 'maildigest', 'maildisplay', 'htmleditor',
 856             'ajax', 'autosubscribe', 'trackforums', 'timecreated',
 857             'timemodified', 'trustbitmask', 'screenreader');
 858
 859         // Then, the fields potentially needing anonymization
 860         $anonfields = array(
 861             'username', 'idnumber', 'firstname', 'lastname',
 862             'email', 'emailstop', 'lastip', 'picture',
 863             'url', 'description', 'description_format', 'imagealt', 'auth');
 864
 865         // Add anonymized fields to $userfields with custom final element
 866         foreach ($anonfields as $field) {
 867             if ($anonymize) {
 868                 $userfields[] = new anonymizer_final_element($field);
 869             } else {
 870                 $userfields[] = $field; // No anonymization, normally added
 871             }
 872         }
 873
 874         // mnethosturl requires special handling (custom final element)
 875         $userfields[] = new mnethosturl_final_element('mnethosturl');
 876
 877         // password added conditionally
 878         if (!empty($CFG->includeuserpasswordsinbackup)) {
 879             $userfields[] = 'password';
 880         }
 881
 882         // Merge all the fields
 883         $userfields = array_merge($userfields, $normalfields);
 884
 885         $user = new backup_nested_element('user', array('id', 'contextid'), $userfields);
 886
 887         $customfields = new backup_nested_element('custom_fields');
 888
 889         $customfield = new backup_nested_element('custom_field', array('id'), array(
 890             'field_name', 'field_type', 'field_data'));
 891
 892         $tags = new backup_nested_element('tags');
 893
 894         $tag = new backup_nested_element('tag', array('id'), array(
 895             'name', 'rawname'));
 896
 897         $preferences = new backup_nested_element('preferences');
 898
 899         $preference = new backup_nested_element('preference', array('id'), array(
 900             'name', 'value'));
 901
 902         $roles = new backup_nested_element('roles');
 903
 904         $overrides = new backup_nested_element('role_overrides');
 905
 906         $override = new backup_nested_element('override', array('id'), array(
 907             'roleid', 'capability', 'permission', 'timemodified',
 908             'modifierid'));
 909
 910         $assignments = new backup_nested_element('role_assignments');
 911
 912         $assignment = new backup_nested_element('assignment', array('id'), array(
 913             'roleid', 'userid', 'timemodified', 'modifierid', 'component', //TODO: MDL-22793 add itemid here
 914             'sortorder'));
 915
 916         // Build the tree
 917
 918         $users->add_child($user);
 919
 920         $user->add_child($customfields);
 921         $customfields->add_child($customfield);
 922
 923         $user->add_child($tags);
 924         $tags->add_child($tag);
 925
 926         $user->add_child($preferences);
 927         $preferences->add_child($preference);
 928
 929         $user->add_child($roles);
 930
 931         $roles->add_child($overrides);
 932         $roles->add_child($assignments);
 933
 934         $overrides->add_child($override);
 935         $assignments->add_child($assignment);
 936
 937         // Define sources
 938
 939         $user->set_source_sql('SELECT u.*, c.id AS contextid, m.wwwroot AS mnethosturl
 940                                  FROM {user} u
 941                                  JOIN {backup_ids_temp} bi ON bi.itemid = u.id
 942                                  JOIN {context} c ON c.instanceid = u.id
 943                             LEFT JOIN {mnet_host} m ON m.id = u.mnethostid
 944                                 WHERE bi.backupid = ?
 945                                   AND bi.itemname = ?
 946                                   AND c.contextlevel = ?', array(
 947                                       backup_helper::is_sqlparam($this->get_backupid()),
 948                                       backup_helper::is_sqlparam('userfinal'),
 949                                       backup_helper::is_sqlparam(CONTEXT_USER)));
 950
 951         // All the rest on information is only added if we arent
 952         // in an anonymized backup
 953         if (!$anonymize) {
 954             $customfield->set_source_sql('SELECT f.id, f.shortname, f.datatype, d.data
 955                                             FROM {user_info_field} f
 956                                             JOIN {user_info_data} d ON d.fieldid = f.id
 957                                            WHERE d.userid = ?', array(backup::VAR_PARENTID));
 958
 959             $customfield->set_source_alias('shortname', 'field_name');
 960             $customfield->set_source_alias('datatype',  'field_type');
 961             $customfield->set_source_alias('data',      'field_data');
 962
 963             $tag->set_source_sql('SELECT t.id, t.name, t.rawname
 964                                     FROM {tag} t
 965                                     JOIN {tag_instance} ti ON ti.tagid = t.id
 966                                    WHERE ti.itemtype = ?
 967                                      AND ti.itemid = ?', array(
 968                                          backup_helper::is_sqlparam('user'),
 969                                          backup::VAR_PARENTID));
 970
 971             $preference->set_source_table('user_preferences', array('userid' => backup::VAR_PARENTID));
 972
 973             $override->set_source_table('role_capabilities', array('contextid' => '/users/user/contextid'));
 974
 975             // Assignments only added if specified
 976             if ($roleassignments) {
 977                 $assignment->set_source_table('role_assignments', array('contextid' => '/users/user/contextid'));
 978             }
 979
 980             // Define id annotations (as final)
 981             $override->annotate_ids('rolefinal', 'roleid');
 982         }
 983
 984         // Return root element (users)
 985         return $users;
 986     }
 987 }
 988
 989 /**
 990  * structure step in charge of constructing the block.xml file for one
 991  * given block (instance and positions). If the block has custom DB structure
 992  * that will go to a separate file (different step defined in block class)
 993  */
 994 class backup_block_instance_structure_step extends backup_structure_step {
 995
 996     protected function define_structure() {
 997         global $DB;
 998
 999         // Define each element separated
1000
1001         $block = new backup_nested_element('block', array('id', 'contextid', 'version'), array(
1002             'blockname', 'parentcontextid', 'showinsubcontexts', 'pagetypepattern',
1003             'subpagepattern', 'defaultregion', 'defaultweight', 'configdata'));
1004
1005         $positions = new backup_nested_element('block_positions', null, array(
1006             'contextid', 'pagetype', 'subpage', 'visible',
1007             'region', 'weight'));
1008
1009         // Build the tree
1010
1011         $block->add_child($positions);
1012
1013         // Transform configdata information if needed (process links and friends)
1014         $blockrec = $DB->get_record('block_instances', array('id' => $this->task->get_blockid()));
1015         if ($attrstotransform = $this->task->get_configdata_encoded_attributes()) {
1016             $configdata = (array)unserialize(base64_decode($blockrec->configdata));
1017             foreach ($configdata as $attribute => $value) {
1018                 if (in_array($attribute, $attrstotransform)) {
1019                     $configdata[$attribute] = $this->contenttransformer->process($value);
1020                 }
1021             }
1022             $blockrec->configdata = base64_encode(serialize((object)$configdata));
1023         }
1024         $blockrec->contextid = $this->task->get_contextid();
1025         // Get the version of the block
1026         $blockrec->version = $DB->get_field('block', 'version', array('name' => $this->task->get_blockname()));
1027
1028         // Define sources
1029
1030         $block->set_source_array(array($blockrec));
1031
1032         $positions->set_source_table('block_positions', array('blockinstanceid' => backup::VAR_PARENTID));
1033
1034         // Return the root element (block)
1035         return $block;
1036     }
1037 }
1038
1039 /**
1040  * structure step in charge of constructing the logs.xml file for all the log records found
1041  * in activity
1042  */
1043 class backup_activity_logs_structure_step extends backup_structure_step {
1044
1045     protected function define_structure() {
1046
1047         // Define each element separated
1048
1049         $logs = new backup_nested_element('logs');
1050
1051         $log = new backup_nested_element('log', array('id'), array(
1052             'time', 'userid', 'ip', 'module',
1053             'action', 'url', 'info'));
1054
1055         // Build the tree
1056
1057         $logs->add_child($log);
1058
1059         // Define sources
1060
1061         $log->set_source_table('log', array('cmid' => backup::VAR_MODID));
1062
1063         // Annotations
1064         // NOTE: We don't annotate users from logs as far as they MUST be
1065         //       always annotated by the activity.
1066
1067         // Return the root element (logs)
1068
1069         return $logs;
1070     }
1071 }
1072
1073 /**
1074  * structure in charge of constructing the inforef.xml file for all the items we want
1075  * to have referenced there (users, roles, files...)
1076  */
1077 class backup_inforef_structure_step extends backup_structure_step {
1078
1079     protected function define_structure() {
1080
1081         // Items we want to include in the inforef file. NOTE: Important to keep this
1082         // list 100% sync with the one in next step! Until we get better place for it (backup:CONST)
1083         $items = array('user', 'grouping', 'group', 'role', 'file', 'scale', 'outcome', 'grade_item');
1084
1085         // Build the tree
1086
1087         $inforef = new backup_nested_element('inforef');
1088
1089         // For each item, conditionally, if there are already records, build element
1090         foreach ($items as $itemname) {
1091             if (backup_structure_dbops::annotations_exist($this->get_backupid(), $itemname)) {
1092                 $elementroot = new backup_nested_element($itemname . 'ref');
1093                 $element = new backup_nested_element($itemname, array('id'));
1094                 $inforef->add_child($elementroot);
1095                 $elementroot->add_child($element);
1096                 $element->set_source_sql("
1097                     SELECT itemid AS id
1098                      FROM {backup_ids_temp}
1099                     WHERE backupid = ?
1100                       AND itemname = ?",
1101                    array(backup::VAR_BACKUPID, backup_helper::is_sqlparam($itemname)));
1102             }
1103         }
1104
1105         // We don't annotate anything there, but rely in the next step
1106         // (move_inforef_annotations_to_final) that will change all the
1107         // already saved 'inforref' entries to their 'final' annotations.
1108         return $inforef;
1109     }
1110 }
1111
1112 /**
1113  * This step will get all the annotations already processed to inforef.xml file and
1114  * transform them into 'final' annotations.
1115  */
1116 class move_inforef_annotations_to_final extends backup_execution_step {
1117
1118     protected function define_execution() {
1119
1120         // Items we want to include in the inforef file. NOTE: Important to keep this
1121         // list 100% sync with the one in prev step! Until we get better place for it (backup:CONST)
1122         $items = array('user', 'grouping', 'group', 'role', 'file', 'scale', 'outcome', 'grade_item');
1123         foreach ($items as $itemname) {
1124             // Delegate to dbops
1125             backup_structure_dbops::move_annotations_to_final($this->get_backupid(), $itemname);
1126         }
1127     }
1128 }
1129
1130 /**
1131  * structure in charge of constructing the files.xml file with all the
1132  * annotated (final) files along the process. At, the same time, and
1133  * using one specialised nested_element, will copy them form moodle storage
1134  * to backup storage
1135  */
1136 class backup_final_files_structure_step extends backup_structure_step {
1137
1138     protected function define_structure() {
1139
1140         // Define elements
1141
1142         $files = new backup_nested_element('files');
1143
1144         $file = new file_nested_element('file', array('id'), array(
1145             'contenthash', 'contextid', 'component', 'filearea', 'itemid',
1146             'filepath', 'filename', 'userid', 'filesize',
1147             'mimetype', 'status', 'timecreated', 'timemodified',
1148             'source', 'author', 'license', 'sortorder'));
1149
1150         // Build the tree
1151
1152         $files->add_child($file);
1153
1154         // Define sources
1155
1156         $file->set_source_sql("SELECT f.*
1157                                  FROM {files} f
1158                                  JOIN {backup_ids_temp} bi ON f.id = bi.itemid
1159                                 WHERE bi.backupid = ?
1160                                   AND bi.itemname = 'filefinal'", array(backup::VAR_BACKUPID));
1161
1162         return $files;
1163     }
1164 }
1165
1166 /**
1167  * Structure step in charge of creating the main moodle_backup.xml file
1168  * where all the information related to the backup, settings, license and
1169  * other information needed on restore is added*/
1170 class backup_main_structure_step extends backup_structure_step {
1171
1172     protected function define_structure() {
1173
1174         global $CFG;
1175
1176         $info = array();
1177
1178         $info['name'] = $this->get_setting_value('filename');
1179         $info['moodle_version'] = $CFG->version;
1180         $info['moodle_release'] = $CFG->release;
1181         $info['backup_version'] = $CFG->backup_version;
1182         $info['backup_release'] = $CFG->backup_release;
1183         $info['backup_date']    = time();
1184         $info['backup_uniqueid']= $this->get_backupid();
1185         $info['original_wwwroot']=$CFG->wwwroot;
1186         $info['original_site_identifier'] = get_site_identifier();
1187         $info['original_course_id'] = $this->get_courseid();
1188
1189         // Get more information from controller
1190         list($dinfo, $cinfo, $sinfo) = backup_controller_dbops::get_moodle_backup_information($this->get_backupid());
1191
1192         // Define elements
1193
1194         $moodle_backup = new backup_nested_element('moodle_backup');
1195
1196         $information = new backup_nested_element('information', null, array(
1197             'name', 'moodle_version', 'moodle_release', 'backup_version',
1198             'backup_release', 'backup_date', 'original_wwwroot',
1199             'original_site_identifier', 'original_course_id'));
1200
1201         $details = new backup_nested_element('details');
1202
1203         $detail = new backup_nested_element('detail', array('backup_id'), array(
1204             'type', 'format', 'interactive', 'mode',
1205             'execution', 'executiontime'));
1206
1207         $contents = new backup_nested_element('contents');
1208
1209         $activities = new backup_nested_element('activities');
1210
1211         $activity = new backup_nested_element('activity', null, array(
1212             'moduleid', 'sectionid', 'modulename', 'title',
1213             'directory'));
1214
1215         $sections = new backup_nested_element('sections');
1216
1217         $section = new backup_nested_element('section', null, array(
1218             'sectionid', 'title', 'directory'));
1219
1220         $course = new backup_nested_element('course', null, array(
1221             'courseid', 'title', 'directory'));
1222
1223         $settings = new backup_nested_element('settings');
1224
1225         $setting = new backup_nested_element('setting', null, array(
1226             'level', 'section', 'activity', 'name', 'value'));
1227
1228         // Build the tree
1229
1230         $moodle_backup->add_child($information);
1231
1232         $information->add_child($details);
1233         $details->add_child($detail);
1234
1235         $information->add_child($contents);
1236         if (!empty($cinfo['activities'])) {
1237             $contents->add_child($activities);
1238             $activities->add_child($activity);
1239         }
1240         if (!empty($cinfo['sections'])) {
1241             $contents->add_child($sections);
1242             $sections->add_child($section);
1243         }
1244         if (!empty($cinfo['course'])) {
1245             $contents->add_child($course);
1246         }
1247
1248         $information->add_child($settings);
1249         $settings->add_child($setting);
1250
1251
1252         // Set the sources
1253
1254         $information->set_source_array(array((object)$info));
1255
1256         $detail->set_source_array($dinfo);
1257
1258         $activity->set_source_array($cinfo['activities']);
1259
1260         $section->set_source_array($cinfo['sections']);
1261
1262         $course->set_source_array($cinfo['course']);
1263
1264         $setting->set_source_array($sinfo);
1265
1266         // Prepare some information to be sent to main moodle_backup.xml file
1267         return $moodle_backup;
1268     }
1269
1270 }
1271
1272 /**
1273  * Execution step that will generate the final zip file with all the contents
1274  */
1275 class backup_zip_contents extends backup_execution_step {
1276
1277     protected function define_execution() {
1278
1279         // Get basepath
1280         $basepath = $this->get_basepath();
1281
1282         // Get the list of files in directory
1283         $filestemp = get_directory_list($basepath, '', false, true, true);
1284         $files = array();
1285         foreach ($filestemp as $file) { // Add zip paths and fs paths to all them
1286             $files[$file] = $basepath . '/' . $file;
1287         }
1288
1289         // Add the log file if exists
1290         $logfilepath = $basepath . '.log';
1291         if (file_exists($logfilepath)) {
1292              $files['moodle_backup.log'] = $logfilepath;
1293         }
1294
1295         // Calculate the zip fullpath (in OS temp area it's always backup.zip)
1296         $zipfile = $basepath . '/backup.zip';
1297
1298         // Get the zip packer
1299         $zippacker = get_file_packer('application/zip');
1300
1301         // Zip files
1302         $zippacker->archive_to_pathname($files, $zipfile);
1303     }
1304 }
1305
1306 /**
1307  * This step will send the generated backup file to its final destination
1308  */
1309 class backup_store_backup_file extends backup_execution_step {
1310
1311     protected function define_execution() {
1312
1313         // Get basepath
1314         $basepath = $this->get_basepath();
1315
1316         // Calculate the zip fullpath (in OS temp area it's always backup.zip)
1317         $zipfile = $basepath . '/backup.zip';
1318
1319         // Perform storage and return it (TODO: shouldn't be array but proper result object)
1320         return array('backup_destination' => backup_helper::store_backup_file($this->get_backupid(), $zipfile));
1321     }
1322 }
1323
1324
1325 /**
1326  * This step will search for all the activity (not calculations, categories nor aggregations) grade items
1327  * and put them to the backup_ids tables, to be used later as base to backup them
1328  */
1329 class backup_activity_grade_items_to_ids extends backup_execution_step {
1330
1331     protected function define_execution() {
1332
1333         // Fetch all activity grade items
1334         if ($items = grade_item::fetch_all(array(
1335                          'itemtype' => 'mod', 'itemmodule' => $this->task->get_modulename(),
1336                          'iteminstance' => $this->task->get_activityid(), 'courseid' => $this->task->get_courseid()))) {
1337             // Annotate them in backup_ids
1338             foreach ($items as $item) {
1339                 backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'grade_item', $item->id);
1340             }
1341         }
1342     }
1343 }
1344
1345 /**
1346  * This step will annotate all the groups belonging to already annotated groupings
1347  */
1348 class backup_annotate_groups_from_groupings extends backup_execution_step {
1349
1350     protected function define_execution() {
1351         global $DB;
1352
1353         // Fetch all the annotated groupings
1354         if ($groupings = $DB->get_records('backup_ids_temp', array(
1355                 'backupid' => $this->get_backupid(), 'itemname' => 'grouping'))) {
1356             foreach ($groupings as $grouping) {
1357                 if ($groups = $DB->get_records('groupings_groups', array(
1358                         'groupingid' => $grouping->itemid))) {
1359                     foreach ($groups as $group) {
1360                         backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'group', $group->groupid);
1361                     }
1362                 }
1363             }
1364         }
1365     }
1366 }
1367
1368 /**
1369  * This step will annotate all the scales belonging to already annotated outcomes
1370  */
1371 class backup_annotate_scales_from_outcomes extends backup_execution_step {
1372
1373     protected function define_execution() {
1374         global $DB;
1375
1376         // Fetch all the annotated outcomes
1377         if ($outcomes = $DB->get_records('backup_ids_temp', array(
1378                 'backupid' => $this->get_backupid(), 'itemname' => 'outcome'))) {
1379             foreach ($outcomes as $outcome) {
1380                 if ($scale = $DB->get_record('grade_outcomes', array(
1381                         'id' => $outcome->itemid))) {
1382                     // Annotate as scalefinal because it's > 0
1383                     backup_structure_dbops::insert_backup_ids_record($this->get_backupid(), 'scalefinal', $scale->scaleid);
1384                 }
1385             }
1386         }
1387     }
1388 }
1389
1390 /**
1391  * This step will generate all the user annotations for the already
1392  * annotated (final) users. Need to do this here because each user
1393  * has its own context and structure tasks only are able to handle
1394  * one context. Also, this step will guarantee that every user has
1395  * its context created (req for other steps)
1396  */
1397 class backup_annotate_all_user_files extends backup_execution_step {
1398
1399     protected function define_execution() {
1400         global $DB;
1401
1402         // List of fileareas we are going to annotate
1403         $fileareas = array('private', 'profile', 'icon');
1404
1405         // Fetch all annotated (final) users
1406         $rs = $DB->get_recordset('backup_ids_temp', array(
1407             'backupid' => $this->get_backupid(), 'itemname' => 'userfinal'));
1408         foreach ($rs as $record) {
1409             $userid = $record->itemid;
1410             $userctxid = get_context_instance(CONTEXT_USER, $userid)->id;
1411             // Proceed with every user filearea
1412             foreach ($fileareas as $filearea) {
1413                 // We don't need to specify itemid ($userid - 5th param) as far as by
1414                 // context we can get all the associated files. See MDL-22092
1415                 backup_structure_dbops::annotate_files($this->get_backupid(), $userctxid, 'user', $filearea, null);
1416             }
1417         }
1418         $rs->close();
1419     }
1420 }
1421
1422 /**
1423  * structure step in charge of constructing the grades.xml file for all the grade items
1424  * and letters related to one activity
1425  */
1426 class backup_activity_grades_structure_step extends backup_structure_step {
1427
1428     protected function define_structure() {
1429
1430         // To know if we are including userinfo
1431         $userinfo = $this->get_setting_value('userinfo');
1432
1433         // Define each element separated
1434
1435         $book = new backup_nested_element('activity_gradebook');
1436
1437         $items = new backup_nested_element('grade_items');
1438
1439         $item = new backup_nested_element('grade_item', array('id'), array(
1440             'categoryid', 'itemname', 'itemtype', 'itemmodule',
1441             'iteminstance', 'itemnumber', 'iteminfo', 'idnumber',
1442             'calculation', 'gradetype', 'grademax', 'grademin',
1443             'scaleid', 'outcomeid', 'gradepass', 'multfactor',
1444             'plusfactor', 'aggregationcoef', 'sortorder', 'display',
1445             'decimals', 'hidden', 'locked', 'locktime',
1446             'needsupdate', 'timecreated', 'timemodified'));
1447
1448         $grades = new backup_nested_element('grade_grades');
1449
1450         $grade = new backup_nested_element('grade_grade', array('id'), array(
1451             'userid', 'rawgrade', 'rawgrademax', 'rawgrademin',
1452             'rawscaleid', 'usermodified', 'finalgrade', 'hidden',
1453             'locked', 'locktime', 'exported', 'overridden',
1454             'excluded', 'feedback', 'feedbackformat', 'information',
1455             'informationformat', 'timecreated', 'timemodified'));
1456
1457         $letters = new backup_nested_element('grade_letters');
1458
1459         $letter = new backup_nested_element('grade_letter', 'id', array(
1460             'lowerboundary', 'letter'));
1461
1462         // Build the tree
1463
1464         $book->add_child($items);
1465         $items->add_child($item);
1466
1467         $item->add_child($grades);
1468         $grades->add_child($grade);
1469
1470         $book->add_child($letters);
1471         $letters->add_child($letter);
1472
1473         // Define sources
1474
1475         $item->set_source_sql("SELECT gi.*
1476                                FROM {grade_items} gi
1477                                JOIN {backup_ids_temp} bi ON gi.id = bi.itemid
1478                                WHERE bi.backupid = ?
1479                                AND bi.itemname = 'grade_item'", array(backup::VAR_BACKUPID));
1480
1481         // This only happens if we are including user info
1482         if ($userinfo) {
1483             $grade->set_source_table('grade_grades', array('itemid' => backup::VAR_PARENTID));
1484         }
1485
1486         $letter->set_source_table('grade_letters', array('contextid' => backup::VAR_CONTEXTID));
1487
1488         // Annotations
1489
1490         $item->annotate_ids('scalefinal', 'scaleid'); // Straight as scalefinal because it's > 0
1491         $item->annotate_ids('outcome', 'outcomeid');
1492
1493         $grade->annotate_ids('user', 'userid');
1494         $grade->annotate_ids('user', 'usermodified');
1495
1496         // Return the root element (book)
1497
1498         return $book;
1499     }
1500 }