Search moodle.org's
Developer Documentation

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
  • Differences Between: [Versions 37 and 311] [Versions 38 and 311] [Versions 39 and 311]

       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 defines the main lti configuration form
      37   *
      38   * @package mod_lti
      39   * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
      40   *  marc.alier@upc.edu
      41   * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
      42   * @author     Marc Alier
      43   * @author     Jordi Piguillem
      44   * @author     Nikolas Galanis
      45   * @author     Chris Scribner
      46   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
      47   */
      48  
      49  defined('MOODLE_INTERNAL') || die;
      50  
      51  require_once($CFG->dirroot.'/course/moodleform_mod.php');
      52  require_once($CFG->dirroot.'/mod/lti/locallib.php');
      53  
      54  class mod_lti_mod_form extends moodleform_mod {
      55  
      56      public function definition() {
      57          global $PAGE, $OUTPUT, $COURSE;
      58  
      59          if ($type = optional_param('type', false, PARAM_ALPHA)) {
      60              component_callback("ltisource_$type", 'add_instance_hook');
      61          }
      62  
      63          // Type ID parameter being passed when adding an preconfigured tool from activity chooser.
      64          $typeid = optional_param('typeid', false, PARAM_INT);
      65  
      66          $showoptions = has_capability('mod/lti:addmanualinstance', $this->context);
      67          // Show configuration details only if not preset (when new) or user has the capabilities to do so (when editing).
      68          if ($this->_instance) {
      69              $showtypes = has_capability('mod/lti:addpreconfiguredinstance', $this->context);
      70              if (!$showoptions && $this->current->typeid == 0) {
      71                  // If you cannot add a manual instance and this is already a manual instance, then
      72                  // remove the 'types' selector.
      73                  $showtypes = false;
      74              }
      75          } else {
      76              $showtypes = !$typeid;
      77          }
      78  
      79          $this->typeid = 0;
      80  
      81          $mform =& $this->_form;
      82  
      83          // Adding the "general" fieldset, where all the common settings are shown.
      84          $mform->addElement('html', "<div data-attribute='dynamic-import' hidden aria-hidden='true' role='alert'></div>");
      85          $mform->addElement('header', 'general', get_string('general', 'form'));
      86  
      87          // Adding the standard "name" field.
      88          $mform->addElement('text', 'name', get_string('basicltiname', 'lti'), array('size' => '64'));
      89          $mform->setType('name', PARAM_TEXT);
      90          $mform->addRule('name', null, 'required', null, 'client');
      91          $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
      92          // Adding the optional "intro" and "introformat" pair of fields.
      93          $this->standard_intro_elements(get_string('basicltiintro', 'lti'));
      94          $mform->setAdvanced('introeditor');
      95  
      96          // Display the label to the right of the checkbox so it looks better & matches rest of the form.
      97          if ($mform->elementExists('showdescription')) {
      98              $coursedesc = $mform->getElement('showdescription');
      99              if (!empty($coursedesc)) {
     100                  $coursedesc->setText(' ' . $coursedesc->getLabel());
     101                  $coursedesc->setLabel('&nbsp');
     102              }
     103          }
     104  
     105          $mform->setAdvanced('showdescription');
     106  
     107          $mform->addElement('checkbox', 'showtitlelaunch', get_string('display_name', 'lti'));
     108          $mform->setAdvanced('showtitlelaunch');
     109          $mform->setDefault('showtitlelaunch', true);
     110          $mform->addHelpButton('showtitlelaunch', 'display_name', 'lti');
     111  
     112          $mform->addElement('checkbox', 'showdescriptionlaunch', get_string('display_description', 'lti'));
     113          $mform->setAdvanced('showdescriptionlaunch');
     114          $mform->addHelpButton('showdescriptionlaunch', 'display_description', 'lti');
     115  
     116          // Tool settings.
     117          $toolproxy = array();
     118          // Array of tool type IDs that don't support ContentItemSelectionRequest.
     119          $noncontentitemtypes = [];
     120  
     121          if ($showtypes) {
     122              $tooltypes = $mform->addElement('select', 'typeid', get_string('external_tool_type', 'lti'));
     123              if ($typeid) {
     124                  $mform->getElement('typeid')->setValue($typeid);
     125              }
     126              $mform->addHelpButton('typeid', 'external_tool_type', 'lti');
     127  
     128              foreach (lti_get_types_for_add_instance() as $id => $type) {
     129                  if (!empty($type->toolproxyid)) {
     130                      $toolproxy[] = $type->id;
     131                      $attributes = array('globalTool' => 1, 'toolproxy' => 1);
     132                      $enabledcapabilities = explode("\n", $type->enabledcapability);
     133                      if (!in_array('Result.autocreate', $enabledcapabilities) ||
     134                          in_array('BasicOutcome.url', $enabledcapabilities)) {
     135                          $attributes['nogrades'] = 1;
     136                      }
     137                      if (!in_array('Person.name.full', $enabledcapabilities) &&
     138                          !in_array('Person.name.family', $enabledcapabilities) &&
     139                          !in_array('Person.name.given', $enabledcapabilities)) {
     140                          $attributes['noname'] = 1;
     141                      }
     142                      if (!in_array('Person.email.primary', $enabledcapabilities)) {
     143                          $attributes['noemail'] = 1;
     144                      }
     145                  } else if ($type->course == $COURSE->id) {
     146                      $attributes = array('editable' => 1, 'courseTool' => 1, 'domain' => $type->tooldomain);
     147                  } else if ($id != 0) {
     148                      $attributes = array('globalTool' => 1, 'domain' => $type->tooldomain);
     149                  } else {
     150                      $attributes = array();
     151                  }
     152  
     153                  if ($id) {
     154                      $config = lti_get_type_config($id);
     155                      if (!empty($config['contentitem'])) {
     156                          $attributes['data-contentitem'] = 1;
     157                          $attributes['data-id'] = $id;
     158                      } else {
     159                          $noncontentitemtypes[] = $id;
     160                      }
     161                  }
     162                  $tooltypes->addOption($type->name, $id, $attributes);
     163              }
     164          } else {
     165              $mform->addElement('hidden', 'typeid', $typeid);
     166              $mform->setType('typeid', PARAM_INT);
     167              if ($typeid) {
     168                  $config = lti_get_type_config($typeid);
     169                  if (!empty($config['contentitem'])) {
     170                      $mform->addElement('hidden', 'contentitem', 1);
     171                      $mform->setType('contentitem', PARAM_INT);
     172                  }
     173              }
     174          }
     175  
     176          // Add button that launches the content-item selection dialogue.
     177          // Set contentitem URL.
     178          $contentitemurl = new moodle_url('/mod/lti/contentitem.php');
     179          $contentbuttonattributes = [
     180              'data-contentitemurl' => $contentitemurl->out(false)
     181          ];
     182          if (!$showtypes) {
     183              if (!$typeid || empty(lti_get_type_config($typeid)['contentitem'])) {
     184                  $contentbuttonattributes['disabled'] = 'disabled';
     185              }
     186          }
     187          $contentbuttonlabel = get_string('selectcontent', 'lti');
     188          $contentbutton = $mform->addElement('button', 'selectcontent', $contentbuttonlabel, $contentbuttonattributes);
     189          // Disable select content button if the selected tool doesn't support content item or it's set to Automatic.
     190          if ($showtypes) {
     191              $allnoncontentitemtypes = $noncontentitemtypes;
     192              $allnoncontentitemtypes[] = '0'; // Add option value for "Automatic, based on tool URL".
     193              $mform->disabledIf('selectcontent', 'typeid', 'in', $allnoncontentitemtypes);
     194          }
     195  
     196          if ($showoptions) {
     197              $mform->addElement('text', 'toolurl', get_string('launch_url', 'lti'), array('size' => '64'));
     198              $mform->setType('toolurl', PARAM_URL);
     199              $mform->addHelpButton('toolurl', 'launch_url', 'lti');
     200              $mform->hideIf('toolurl', 'typeid', 'in', $noncontentitemtypes);
     201  
     202              $mform->addElement('text', 'securetoolurl', get_string('secure_launch_url', 'lti'), array('size' => '64'));
     203              $mform->setType('securetoolurl', PARAM_URL);
     204              $mform->setAdvanced('securetoolurl');
     205              $mform->addHelpButton('securetoolurl', 'secure_launch_url', 'lti');
     206              $mform->hideIf('securetoolurl', 'typeid', 'in', $noncontentitemtypes);
     207          } else {
     208              // We still need those on page to support deep linking return, but hidden to avoid instructor modification.
     209              $mform->addElement('hidden', 'toolurl', '', array('id' => 'id_toolurl'));
     210              $mform->setType('toolurl', PARAM_URL);
     211              $mform->addElement('hidden', 'securetoolurl', '', array('id' => 'id_securetoolurl'));
     212              $mform->setType('securetoolurl', PARAM_URL);
     213          }
     214  
     215          $mform->addElement('hidden', 'urlmatchedtypeid', '', array('id' => 'id_urlmatchedtypeid'));
     216          $mform->setType('urlmatchedtypeid', PARAM_INT);
     217  
     218          $mform->addElement('hidden', 'lineitemresourceid', '', array( 'id' => 'id_lineitemresourceid' ));
     219          $mform->setType('lineitemresourceid', PARAM_TEXT);
     220  
     221          $mform->addElement('hidden', 'lineitemtag', '', array( 'id' => 'id_lineitemtag'));
     222          $mform->setType('lineitemtag', PARAM_TEXT);
     223  
     224          $launchoptions = array();
     225          $launchoptions[LTI_LAUNCH_CONTAINER_DEFAULT] = get_string('default', 'lti');
     226          $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
     227          $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
     228          $launchoptions[LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW] = get_string('existing_window', 'lti');
     229          $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
     230  
     231          $mform->addElement('select', 'launchcontainer', get_string('launchinpopup', 'lti'), $launchoptions);
     232          $mform->setDefault('launchcontainer', LTI_LAUNCH_CONTAINER_DEFAULT);
     233          $mform->addHelpButton('launchcontainer', 'launchinpopup', 'lti');
     234          $mform->setAdvanced('launchcontainer');
     235  
     236          if ($showoptions) {
     237              $mform->addElement('text', 'resourcekey', get_string('resourcekey', 'lti'));
     238              $mform->setType('resourcekey', PARAM_TEXT);
     239              $mform->setAdvanced('resourcekey');
     240              $mform->addHelpButton('resourcekey', 'resourcekey', 'lti');
     241              $mform->setForceLtr('resourcekey');
     242              $mform->hideIf('resourcekey', 'typeid', 'in', $noncontentitemtypes);
     243  
     244              $mform->addElement('passwordunmask', 'password', get_string('password', 'lti'));
     245              $mform->setType('password', PARAM_TEXT);
     246              $mform->setAdvanced('password');
     247              $mform->addHelpButton('password', 'password', 'lti');
     248              $mform->hideIf('password', 'typeid', 'in', $noncontentitemtypes);
     249  
     250              $mform->addElement('textarea', 'instructorcustomparameters', get_string('custom', 'lti'), array('rows' => 4, 'cols' => 60));
     251              $mform->setType('instructorcustomparameters', PARAM_TEXT);
     252              $mform->setAdvanced('instructorcustomparameters');
     253              $mform->addHelpButton('instructorcustomparameters', 'custom', 'lti');
     254              $mform->setForceLtr('instructorcustomparameters');
     255  
     256              $mform->addElement('text', 'icon', get_string('icon_url', 'lti'), array('size' => '64'));
     257              $mform->setType('icon', PARAM_URL);
     258              $mform->setAdvanced('icon');
     259              $mform->addHelpButton('icon', 'icon_url', 'lti');
     260              $mform->hideIf('icon', 'typeid', 'in', $noncontentitemtypes);
     261  
     262              $mform->addElement('text', 'secureicon', get_string('secure_icon_url', 'lti'), array('size' => '64'));
     263              $mform->setType('secureicon', PARAM_URL);
     264              $mform->setAdvanced('secureicon');
     265              $mform->addHelpButton('secureicon', 'secure_icon_url', 'lti');
     266              $mform->hideIf('secureicon', 'typeid', 'in', $noncontentitemtypes);
     267          } else {
     268              // Keep those in the form to allow deep linking.
     269              $mform->addElement('hidden', 'resourcekey', '', array('id' => 'id_resourcekey'));
     270              $mform->setType('resourcekey', PARAM_TEXT);
     271              $mform->addElement('hidden', 'password', '', array('id' => 'id_password'));
     272              $mform->setType('password', PARAM_TEXT);
     273              $mform->addElement('hidden', 'instructorcustomparameters', '', array('id' => 'id_instructorcustomparameters'));
     274              $mform->setType('instructorcustomparameters', PARAM_TEXT);
     275              $mform->addElement('hidden', 'icon', '', array('id' => 'id_icon'));
     276              $mform->setType('icon', PARAM_URL);
     277              $mform->addElement('hidden', 'secureicon', '', array('id' => 'id_secureicon'));
     278              $mform->setType('secureicon', PARAM_URL);
     279          }
     280  
     281          // Add privacy preferences fieldset where users choose whether to send their data.
     282          $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
     283  
     284          $mform->addElement('advcheckbox', 'instructorchoicesendname', get_string('share_name', 'lti'));
     285          $mform->setDefault('instructorchoicesendname', '1');
     286          $mform->addHelpButton('instructorchoicesendname', 'share_name', 'lti');
     287          $mform->disabledIf('instructorchoicesendname', 'typeid', 'in', $toolproxy);
     288  
     289          $mform->addElement('advcheckbox', 'instructorchoicesendemailaddr', get_string('share_email', 'lti'));
     290          $mform->setDefault('instructorchoicesendemailaddr', '1');
     291          $mform->addHelpButton('instructorchoicesendemailaddr', 'share_email', 'lti');
     292          $mform->disabledIf('instructorchoicesendemailaddr', 'typeid', 'in', $toolproxy);
     293  
     294          $mform->addElement('advcheckbox', 'instructorchoiceacceptgrades', get_string('accept_grades', 'lti'));
     295          $mform->setDefault('instructorchoiceacceptgrades', '1');
     296          $mform->addHelpButton('instructorchoiceacceptgrades', 'accept_grades', 'lti');
     297          $mform->disabledIf('instructorchoiceacceptgrades', 'typeid', 'in', $toolproxy);
     298  
     299          // Add standard course module grading elements.
     300          $this->standard_grading_coursemodule_elements();
     301  
     302          // Add standard elements, common to all modules.
     303          $this->standard_coursemodule_elements();
     304          $mform->setAdvanced('cmidnumber');
     305  
     306          // Add standard buttons, common to all modules.
     307          $this->add_action_buttons();
     308  
     309          $editurl = new moodle_url('/mod/lti/instructor_edit_tool_type.php',
     310                  array('sesskey' => sesskey(), 'course' => $COURSE->id));
     311          $ajaxurl = new moodle_url('/mod/lti/ajax.php');
     312  
     313          // All these icon uses are incorrect. LTI JS needs updating to use AMD modules and templates so it can use
     314          // the mustache pix helper - until then LTI will have inconsistent icons.
     315          $jsinfo = (object)array(
     316                          'edit_icon_url' => (string)$OUTPUT->image_url('t/edit'),
     317                          'add_icon_url' => (string)$OUTPUT->image_url('t/add'),
     318                          'delete_icon_url' => (string)$OUTPUT->image_url('t/delete'),
     319                          'green_check_icon_url' => (string)$OUTPUT->image_url('i/valid'),
     320                          'warning_icon_url' => (string)$OUTPUT->image_url('warning', 'lti'),
     321                          'instructor_tool_type_edit_url' => $editurl->out(false),
     322                          'ajax_url' => $ajaxurl->out(true),
     323                          'courseId' => $COURSE->id
     324                    );
     325  
     326          $module = array(
     327              'name' => 'mod_lti_edit',
     328              'fullpath' => '/mod/lti/mod_form.js',
     329              'requires' => array('base', 'io', 'querystring-stringify-simple', 'node', 'event', 'json-parse'),
     330              'strings' => array(
     331                  array('addtype', 'lti'),
     332                  array('edittype', 'lti'),
     333                  array('deletetype', 'lti'),
     334                  array('delete_confirmation', 'lti'),
     335                  array('cannot_edit', 'lti'),
     336                  array('cannot_delete', 'lti'),
     337                  array('global_tool_types', 'lti'),
     338                  array('course_tool_types', 'lti'),
     339                  array('using_tool_configuration', 'lti'),
     340                  array('using_tool_cartridge', 'lti'),
     341                  array('domain_mismatch', 'lti'),
     342                  array('custom_config', 'lti'),
     343                  array('tool_config_not_found', 'lti'),
     344                  array('tooltypeadded', 'lti'),
     345                  array('tooltypedeleted', 'lti'),
     346                  array('tooltypenotdeleted', 'lti'),
     347                  array('tooltypeupdated', 'lti'),
     348                  array('forced_help', 'lti')
     349              ),
     350          );
     351  
     352          if (!empty($typeid)) {
     353              $mform->setAdvanced('typeid');
     354              $mform->setAdvanced('toolurl');
     355          }
     356  
     357          $PAGE->requires->js_init_call('M.mod_lti.editor.init', array(json_encode($jsinfo)), true, $module);
     358      }
     359  
     360      /**
     361       * Sets the current values handled by services in case of update.
     362       *
     363       * @param object $defaultvalues default values to populate the form with.
     364       */
     365      public function set_data($defaultvalues) {
     366          $services = lti_get_services();
     367          if (is_object($defaultvalues)) {
     368              foreach ($services as $service) {
     369                  $service->set_instance_form_values( $defaultvalues );
     370              }
     371          }
     372          parent::set_data($defaultvalues);
     373      }
     374  }