mod/lti/backup/moodle2/restore_lti_stepslib.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16 //
  17 // This file is part of BasicLTI4Moodle
  18 //
  19 // BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
  20 // consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
  21 // based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
  22 // specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
  23 // are already supporting or going to support BasicLTI. This project Implements the consumer
  24 // for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
  25 // BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
  26 // at the GESSI research group at UPC.
  27 // SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
  28 // by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
  29 // Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
  30 //
  31 // BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
  32 // of the Universitat Politecnica de Catalunya http://www.upc.edu
  33 // Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu.
  34
  35 /**
  36  * This file contains all the restore steps that will be used
  37  * by the restore_lti_activity_task
  38  *
  39  * @package mod_lti
  40  * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
  41  *  marc.alier@upc.edu
  42  * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
  43  * @author     Marc Alier
  44  * @author     Jordi Piguillem
  45  * @author     Nikolas Galanis
  46  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  47  */
  48
  49 defined('MOODLE_INTERNAL') || die;
  50
  51 /**
  52  * Structure step to restore one lti activity
  53  */
  54 class restore_lti_activity_structure_step extends restore_activity_structure_step {
  55
  56     protected function define_structure() {
  57
  58         $paths = array();
  59         $lti = new restore_path_element('lti', '/activity/lti');
  60         $paths[] = $lti;
  61
  62         // Add support for subplugin structures.
  63         $this->add_subplugin_structure('ltisource', $lti);
  64         $this->add_subplugin_structure('ltiservice', $lti);
  65
  66         // Return the paths wrapped into standard activity structure.
  67         return $this->prepare_activity_structure($paths);
  68     }
  69
  70     protected function process_lti($data) {
  71         global $DB;
  72
  73         $data = (object)$data;
  74         $oldid = $data->id;
  75         $data->course = $this->get_courseid();
  76         $data->servicesalt = uniqid('', true);
  77
  78          // Grade used to be a float (whole numbers only), restore as int.
  79         $data->grade = (int) $data->grade;
  80
  81         // Clean any course or site typeid. All modules
  82         // are restored as self-contained. Note this is
  83         // an interim solution until the issue below is implemented.
  84         // TODO: MDL-34161 - Fix restore to support course/site tools & submissions.
  85         $data->typeid = 0;
  86
  87         // Try to decrypt resourcekey and password. Null if not possible (DB default).
  88         // Note these fields were originally encrypted on backup using {link @encrypted_final_element}.
  89         $data->resourcekey = $this->decrypt($data->resourcekey);
  90         $data->password = $this->decrypt($data->password);
  91
  92         $newitemid = $DB->insert_record('lti', $data);
  93
  94         // Immediately after inserting "activity" record, call this.
  95         $this->apply_activity_instance($newitemid);
  96     }
  97
  98     protected function after_execute() {
  99         // Add lti related files, no need to match by itemname (just internally handled context).
 100         $this->add_related_files('mod_lti', 'intro', null);
 101     }
 102 }