MDL-47629 quiz review: display cloze feedback on top of "Check" button
[moodle.git] / mod / lti / locallib.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
35 /**
36  * This file contains the library of functions and constants for the lti module
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  */
49 defined('MOODLE_INTERNAL') || die;
51 // TODO: Switch to core oauthlib once implemented - MDL-30149
52 use moodle\mod\lti as lti;
54 require_once($CFG->dirroot.'/mod/lti/OAuth.php');
56 define('LTI_URL_DOMAIN_REGEX', '/(?:https?:\/\/)?(?:www\.)?([^\/]+)(?:\/|$)/i');
58 define('LTI_LAUNCH_CONTAINER_DEFAULT', 1);
59 define('LTI_LAUNCH_CONTAINER_EMBED', 2);
60 define('LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS', 3);
61 define('LTI_LAUNCH_CONTAINER_WINDOW', 4);
62 define('LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW', 5);
64 define('LTI_TOOL_STATE_ANY', 0);
65 define('LTI_TOOL_STATE_CONFIGURED', 1);
66 define('LTI_TOOL_STATE_PENDING', 2);
67 define('LTI_TOOL_STATE_REJECTED', 3);
69 define('LTI_SETTING_NEVER', 0);
70 define('LTI_SETTING_ALWAYS', 1);
71 define('LTI_SETTING_DELEGATE', 2);
73 /**
74  * Prints a Basic LTI activity
75  *
76  * $param int $basicltiid       Basic LTI activity id
77  */
78 function lti_view($instance) {
79     global $PAGE, $CFG;
81     if (empty($instance->typeid)) {
82         $tool = lti_get_tool_by_url_match($instance->toolurl, $instance->course);
83         if ($tool) {
84             $typeid = $tool->id;
85         } else {
86             $typeid = null;
87         }
88     } else {
89         $typeid = $instance->typeid;
90     }
92     if ($typeid) {
93         $typeconfig = lti_get_type_config($typeid);
94     } else {
95         //There is no admin configuration for this tool. Use configuration in the lti instance record plus some defaults.
96         $typeconfig = (array)$instance;
98         $typeconfig['sendname'] = $instance->instructorchoicesendname;
99         $typeconfig['sendemailaddr'] = $instance->instructorchoicesendemailaddr;
100         $typeconfig['customparameters'] = $instance->instructorcustomparameters;
101         $typeconfig['acceptgrades'] = $instance->instructorchoiceacceptgrades;
102         $typeconfig['allowroster'] = $instance->instructorchoiceallowroster;
103         $typeconfig['forcessl'] = '0';
104     }
106     //Default the organizationid if not specified
107     if (empty($typeconfig['organizationid'])) {
108         $urlparts = parse_url($CFG->wwwroot);
110         $typeconfig['organizationid'] = $urlparts['host'];
111     }
113     if (!empty($instance->resourcekey)) {
114         $key = $instance->resourcekey;
115     } else if (!empty($typeconfig['resourcekey'])) {
116         $key = $typeconfig['resourcekey'];
117     } else {
118         $key = '';
119     }
121     if (!empty($instance->password)) {
122         $secret = $instance->password;
123     } else if (!empty($typeconfig['password'])) {
124         $secret = $typeconfig['password'];
125     } else {
126         $secret = '';
127     }
129     $endpoint = !empty($instance->toolurl) ? $instance->toolurl : $typeconfig['toolurl'];
130     $endpoint = trim($endpoint);
132     //If the current request is using SSL and a secure tool URL is specified, use it
133     if (lti_request_is_using_ssl() && !empty($instance->securetoolurl)) {
134         $endpoint = trim($instance->securetoolurl);
135     }
137     //If SSL is forced, use the secure tool url if specified. Otherwise, make sure https is on the normal launch URL.
138     if ($typeconfig['forcessl'] == '1') {
139         if (!empty($instance->securetoolurl)) {
140             $endpoint = trim($instance->securetoolurl);
141         }
143         $endpoint = lti_ensure_url_is_https($endpoint);
144     } else {
145         if (!strstr($endpoint, '://')) {
146             $endpoint = 'http://' . $endpoint;
147         }
148     }
150     $orgid = $typeconfig['organizationid'];
152     $course = $PAGE->course;
153     $requestparams = lti_build_request($instance, $typeconfig, $course, $typeid);
155     $launchcontainer = lti_get_launch_container($instance, $typeconfig);
156     $returnurlparams = array('course' => $course->id, 'launch_container' => $launchcontainer, 'instanceid' => $instance->id);
158     if ( $orgid ) {
159         $requestparams["tool_consumer_instance_guid"] = $orgid;
160     }
161     if (!empty($CFG->mod_lti_institution_name)) {
162         $requestparams['tool_consumer_instance_name'] = $CFG->mod_lti_institution_name;
163     } else {
164         $requestparams['tool_consumer_instance_name'] = get_site()->fullname;
165     }
166     if (empty($key) || empty($secret)) {
167         $returnurlparams['unsigned'] = '1';
168     }
170     // Add the return URL. We send the launch container along to help us avoid frames-within-frames when the user returns.
171     $url = new moodle_url('/mod/lti/return.php', $returnurlparams);
172     $returnurl = $url->out(false);
174     if ($typeconfig['forcessl'] == '1') {
175         $returnurl = lti_ensure_url_is_https($returnurl);
176     }
178     $target = null;
179     switch($launchcontainer) {
180         case LTI_LAUNCH_CONTAINER_EMBED:
181         case LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS:
182             $target = 'iframe';
183             break;
184         case LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW:
185             $target = 'frame';
186             break;
187         case LTI_LAUNCH_CONTAINER_WINDOW:
188             $target = 'window';
189             break;
190     }
191     if (!is_null($target)) {
192         $requestparams['launch_presentation_document_target'] = $target;
193     }
195     $requestparams['launch_presentation_return_url'] = $returnurl;
197     // Allow request params to be updated by sub-plugins.
198     $plugins = core_component::get_plugin_list('ltisource');
199     foreach (array_keys($plugins) as $plugin) {
200         $pluginparams = component_callback('ltisource_'.$plugin, 'before_launch',
201             array($instance, $endpoint, $requestparams), array());
203         if (!empty($pluginparams) && is_array($pluginparams)) {
204             $requestparams = array_merge($requestparams, $pluginparams);
205         }
206     }
208     if (!empty($key) && !empty($secret)) {
209         $parms = lti_sign_parameters($requestparams, $endpoint, "POST", $key, $secret);
211         $endpointurl = new moodle_url($endpoint);
212         $endpointparams = $endpointurl->params();
214         // Strip querystring params in endpoint url from $parms to avoid duplication.
215         if (!empty($endpointparams) && !empty($parms)) {
216             foreach (array_keys($endpointparams) as $paramname) {
217                 if (isset($parms[$paramname])) {
218                     unset($parms[$paramname]);
219                 }
220             }
221         }
223     } else {
224         //If no key and secret, do the launch unsigned.
225         $parms = $requestparams;
226     }
228     $debuglaunch = ( $instance->debuglaunch == 1 );
230     $content = lti_post_launch_html($parms, $endpoint, $debuglaunch);
232     echo $content;
235 /**
236  * Build source ID
237  *
238  * @param int $instanceid
239  * @param int $userid
240  * @param string $servicesalt
241  * @param null|int $typeid
242  * @param null|int $launchid
243  * @return stdClass
244  */
245 function lti_build_sourcedid($instanceid, $userid, $servicesalt, $typeid = null, $launchid = null) {
246     $data = new stdClass();
248     $data->instanceid = $instanceid;
249     $data->userid = $userid;
250     $data->typeid = $typeid;
251     if (!empty($launchid)) {
252         $data->launchid = $launchid;
253     } else {
254         $data->launchid = mt_rand();
255     }
257     $json = json_encode($data);
259     $hash = hash('sha256', $json . $servicesalt, false);
261     $container = new stdClass();
262     $container->data = $data;
263     $container->hash = $hash;
265     return $container;
268 /**
269  * This function builds the request that must be sent to the tool producer
270  *
271  * @param object    $instance       Basic LTI instance object
272  * @param array     $typeconfig     Basic LTI tool configuration
273  * @param object    $course         Course object
274  * @param int|null  $typeid         Basic LTI tool ID
275  *
276  * @return array    $request        Request details
277  */
278 function lti_build_request($instance, $typeconfig, $course, $typeid = null) {
279     global $USER, $CFG;
281     if (empty($instance->cmid)) {
282         $instance->cmid = 0;
283     }
285     $role = lti_get_ims_role($USER, $instance->cmid, $instance->course);
287     $intro = '';
288     if (!empty($instance->cmid)) {
289         $intro = format_module_intro('lti', $instance, $instance->cmid);
290         $intro = html_to_text($intro, 0, false);
292         // This may look weird, but this is required for new lines
293         // so we generate the same OAuth signature as the tool provider.
294         $intro = str_replace("\n", "\r\n", $intro);
295     }
296     $requestparams = array(
297         'resource_link_id' => $instance->id,
298         'resource_link_title' => $instance->name,
299         'resource_link_description' => $intro,
300         'user_id' => $USER->id,
301         'roles' => $role,
302         'context_id' => $course->id,
303         'context_label' => $course->shortname,
304         'context_title' => $course->fullname,
305         'launch_presentation_locale' => current_language()
306     );
308     if (property_exists($instance, 'resource_link_id') and !empty($instance->resource_link_id)) {
309         $requestparams['resource_link_id'] = $instance->resource_link_id;
310     }
311     $placementsecret = $instance->servicesalt;
313     if ( isset($placementsecret) ) {
314         $sourcedid = json_encode(lti_build_sourcedid($instance->id, $USER->id, $placementsecret, $typeid));
315         $requestparams['lis_result_sourcedid'] = $sourcedid;
316     }
318     if ( isset($placementsecret) &&
319          ( $typeconfig['acceptgrades'] == LTI_SETTING_ALWAYS ||
320          ( $typeconfig['acceptgrades'] == LTI_SETTING_DELEGATE && $instance->instructorchoiceacceptgrades == LTI_SETTING_ALWAYS ) ) ) {
322         //Add outcome service URL
323         $serviceurl = new moodle_url('/mod/lti/service.php');
324         $serviceurl = $serviceurl->out();
326         $forcessl = false;
327         if (!empty($CFG->mod_lti_forcessl)) {
328             $forcessl = true;
329         }
331         if ($typeconfig['forcessl'] == '1' or $forcessl) {
332             $serviceurl = lti_ensure_url_is_https($serviceurl);
333         }
335         $requestparams['lis_outcome_service_url'] = $serviceurl;
336     }
338     // Send user's name and email data if appropriate
339     if ( $typeconfig['sendname'] == LTI_SETTING_ALWAYS ||
340          ( $typeconfig['sendname'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendname == LTI_SETTING_ALWAYS ) ) {
341         $requestparams['lis_person_name_given'] =  $USER->firstname;
342         $requestparams['lis_person_name_family'] =  $USER->lastname;
343         $requestparams['lis_person_name_full'] =  $USER->firstname." ".$USER->lastname;
344         $requestparams['ext_user_username'] = $USER->username;
345     }
347     if ( $typeconfig['sendemailaddr'] == LTI_SETTING_ALWAYS ||
348          ( $typeconfig['sendemailaddr'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendemailaddr == LTI_SETTING_ALWAYS ) ) {
349         $requestparams['lis_person_contact_email_primary'] = $USER->email;
350     }
352     // Concatenate the custom parameters from the administrator and the instructor
353     // Instructor parameters are only taken into consideration if the administrator
354     // has giver permission
355     $customstr = $typeconfig['customparameters'];
356     $instructorcustomstr = $instance->instructorcustomparameters;
357     $custom = array();
358     $instructorcustom = array();
359     if ($customstr) {
360         $custom = lti_split_custom_parameters($customstr);
361     }
362     if (isset($typeconfig['allowinstructorcustom']) && $typeconfig['allowinstructorcustom'] == LTI_SETTING_NEVER) {
363         $requestparams = array_merge($custom, $requestparams);
364     } else {
365         if ($instructorcustomstr) {
366             $instructorcustom = lti_split_custom_parameters($instructorcustomstr);
367         }
368         foreach ($instructorcustom as $key => $val) {
369             // Ignore the instructor's parameter
370             if (!array_key_exists($key, $custom)) {
371                 $custom[$key] = $val;
372             }
373         }
374         $requestparams = array_merge($custom, $requestparams);
375     }
377     // Make sure we let the tool know what LMS they are being called from
378     $requestparams["ext_lms"] = "moodle-2";
379     $requestparams['tool_consumer_info_product_family_code'] = 'moodle';
380     $requestparams['tool_consumer_info_version'] = strval($CFG->version);
382     // Add oauth_callback to be compliant with the 1.0A spec
383     $requestparams['oauth_callback'] = 'about:blank';
385     //The submit button needs to be part of the signature as it gets posted with the form.
386     //This needs to be here to support launching without javascript.
387     $submittext = get_string('press_to_submit', 'lti');
388     $requestparams['ext_submit'] = $submittext;
390     $requestparams['lti_version'] = 'LTI-1p0';
391     $requestparams['lti_message_type'] = 'basic-lti-launch-request';
393     return $requestparams;
396 function lti_get_tool_table($tools, $id) {
397     global $CFG, $OUTPUT, $USER;
398     $html = '';
400     $typename = get_string('typename', 'lti');
401     $baseurl = get_string('baseurl', 'lti');
402     $action = get_string('action', 'lti');
403     $createdon = get_string('createdon', 'lti');
405     if ($id == 'lti_configured') {
406         $html .= '<div><a style="margin-top:.25em" href="'.$CFG->wwwroot.'/mod/lti/typessettings.php?action=add&amp;sesskey='.$USER->sesskey.'">'.get_string('addtype', 'lti').'</a></div>';
407     }
409     if (!empty($tools)) {
410         $html .= "
411         <div id=\"{$id}_container\" style=\"margin-top:.5em;margin-bottom:.5em\">
412             <table id=\"{$id}_tools\">
413                 <thead>
414                     <tr>
415                         <th>$typename</th>
416                         <th>$baseurl</th>
417                         <th>$createdon</th>
418                         <th>$action</th>
419                     </tr>
420                 </thead>
421         ";
423         foreach ($tools as $type) {
424             $date = userdate($type->timecreated, get_string('strftimedatefullshort', 'core_langconfig'));
425             $accept = get_string('accept', 'lti');
426             $update = get_string('update', 'lti');
427             $delete = get_string('delete', 'lti');
429             $baseurl = new moodle_url('/mod/lti/typessettings.php', array(
430                     'action' => 'accept',
431                     'id' => $type->id,
432                     'sesskey' => sesskey(),
433                     'tab' => $id
434                 ));
436             $accepthtml = $OUTPUT->action_icon($baseurl,
437                     new pix_icon('t/check', $accept, '', array('class' => 'iconsmall')), null,
438                     array('title' => $accept, 'class' => 'editing_accept'));
440             $deleteaction = 'delete';
442             if ($type->state == LTI_TOOL_STATE_CONFIGURED) {
443                 $accepthtml = '';
444             }
446             if ($type->state != LTI_TOOL_STATE_REJECTED) {
447                 $deleteaction = 'reject';
448                 $delete = get_string('reject', 'lti');
449             }
451             $updateurl = clone($baseurl);
452             $updateurl->param('action', 'update');
453             $updatehtml = $OUTPUT->action_icon($updateurl,
454                     new pix_icon('t/edit', $update, '', array('class' => 'iconsmall')), null,
455                     array('title' => $update, 'class' => 'editing_update'));
457             $deleteurl = clone($baseurl);
458             $deleteurl->param('action', $deleteaction);
459             $deletehtml = $OUTPUT->action_icon($deleteurl,
460                     new pix_icon('t/delete', $delete, '', array('class' => 'iconsmall')), null,
461                     array('title' => $delete, 'class' => 'editing_delete'));
462             $html .= "
463             <tr>
464                 <td>
465                     {$type->name}
466                 </td>
467                 <td>
468                     {$type->baseurl}
469                 </td>
470                 <td>
471                     {$date}
472                 </td>
473                 <td align=\"center\">
474                     {$accepthtml}{$updatehtml}{$deletehtml}
475                 </td>
476             </tr>
477             ";
478         }
479         $html .= '</table></div>';
480     } else {
481         $html .= get_string('no_' . $id, 'lti');
482     }
484     return $html;
487 /**
488  * Splits the custom parameters field to the various parameters
489  *
490  * @param string $customstr     String containing the parameters
491  *
492  * @return Array of custom parameters
493  */
494 function lti_split_custom_parameters($customstr) {
495     $lines = preg_split("/[\n;]/", $customstr);
496     $retval = array();
497     foreach ($lines as $line) {
498         $pos = strpos($line, "=");
499         if ( $pos === false || $pos < 1 ) {
500             continue;
501         }
502         $key = trim(core_text::substr($line, 0, $pos));
503         $val = trim(core_text::substr($line, $pos+1, strlen($line)));
504         $key = lti_map_keyname($key);
505         $retval['custom_'.$key] = $val;
506     }
507     return $retval;
510 /**
511  * Used for building the names of the different custom parameters
512  *
513  * @param string $key   Parameter name
514  *
515  * @return string       Processed name
516  */
517 function lti_map_keyname($key) {
518     $newkey = "";
519     $key = core_text::strtolower(trim($key));
520     foreach (str_split($key) as $ch) {
521         if ( ($ch >= 'a' && $ch <= 'z') || ($ch >= '0' && $ch <= '9') ) {
522             $newkey .= $ch;
523         } else {
524             $newkey .= '_';
525         }
526     }
527     return $newkey;
530 /**
531  * Gets the IMS role string for the specified user and LTI course module.
532  *
533  * @param mixed $user User object or user id
534  * @param int $cmid The course module id of the LTI activity
535  * @return string A role string suitable for passing with an LTI launch
536  */
537 function lti_get_ims_role($user, $cmid, $courseid) {
538     $roles = array();
540     if (empty($cmid)) {
541         //If no cmid is passed, check if the user is a teacher in the course
542         //This allows other modules to programmatically "fake" a launch without
543         //a real LTI instance
544         $coursecontext = context_course::instance($courseid);
546         if (has_capability('moodle/course:manageactivities', $coursecontext)) {
547             array_push($roles, 'Instructor');
548         } else {
549             array_push($roles, 'Learner');
550         }
551     } else {
552         $context = context_module::instance($cmid);
554         if (has_capability('mod/lti:manage', $context)) {
555             array_push($roles, 'Instructor');
556         } else {
557             array_push($roles, 'Learner');
558         }
559     }
561     if (is_siteadmin($user)) {
562         array_push($roles, 'urn:lti:sysrole:ims/lis/Administrator', 'urn:lti:instrole:ims/lis/Administrator');
563     }
565     return join(',', $roles);
568 /**
569  * Returns configuration details for the tool
570  *
571  * @param int $typeid   Basic LTI tool typeid
572  *
573  * @return array        Tool Configuration
574  */
575 function lti_get_type_config($typeid) {
576     global $DB;
578     $query = "SELECT name, value
579                 FROM {lti_types_config}
580                WHERE typeid = :typeid1
581            UNION ALL
582               SELECT 'toolurl' AS name, " . $DB->sql_compare_text('baseurl', 1333) . " AS value
583                 FROM {lti_types}
584                WHERE id = :typeid2";
586     $typeconfig = array();
587     $configs = $DB->get_records_sql($query, array('typeid1' => $typeid, 'typeid2' => $typeid));
589     if (!empty($configs)) {
590         foreach ($configs as $config) {
591             $typeconfig[$config->name] = $config->value;
592         }
593     }
595     return $typeconfig;
598 function lti_get_tools_by_url($url, $state, $courseid = null) {
599     $domain = lti_get_domain_from_url($url);
601     return lti_get_tools_by_domain($domain, $state, $courseid);
604 function lti_get_tools_by_domain($domain, $state = null, $courseid = null) {
605     global $DB, $SITE;
607     $filters = array('tooldomain' => $domain);
609     $statefilter = '';
610     $coursefilter = '';
612     if ($state) {
613         $statefilter = 'AND state = :state';
614     }
616     if ($courseid && $courseid != $SITE->id) {
617         $coursefilter = 'OR course = :courseid';
618     }
620     $query = "SELECT *
621                 FROM {lti_types}
622                WHERE tooldomain = :tooldomain
623                  AND (course = :siteid $coursefilter)
624                  $statefilter";
626     return $DB->get_records_sql($query, array(
627         'courseid' => $courseid,
628         'siteid' => $SITE->id,
629         'tooldomain' => $domain,
630         'state' => $state
631     ));
634 /**
635  * Returns all basicLTI tools configured by the administrator
636  *
637  */
638 function lti_filter_get_types($course) {
639     global $DB;
641     if (!empty($course)) {
642         $filter = array('course' => $course);
643     } else {
644         $filter = array();
645     }
647     return $DB->get_records('lti_types', $filter);
650 /**
651  * Given an array of tools, filter them based on their state
652  *
653  * @param array $tools An array of lti_types records
654  * @param int $state One of the LTI_TOOL_STATE_* constants
655  * @return array
656  */
657 function lti_filter_tool_types(array $tools, $state) {
658     $return = array();
659     foreach ($tools as $key => $tool) {
660         if ($tool->state == $state) {
661             $return[$key] = $tool;
662         }
663     }
664     return $return;
667 function lti_get_types_for_add_instance() {
668     global $DB, $SITE, $COURSE;
670     $query = "SELECT *
671                 FROM {lti_types}
672                WHERE coursevisible = 1
673                  AND (course = :siteid OR course = :courseid)
674                  AND state = :active";
676     $admintypes = $DB->get_records_sql($query, array('siteid' => $SITE->id, 'courseid' => $COURSE->id, 'active' => LTI_TOOL_STATE_CONFIGURED));
678     $types = array();
679     $types[0] = (object)array('name' => get_string('automatic', 'lti'), 'course' => 0);
681     foreach ($admintypes as $type) {
682         $types[$type->id] = $type;
683     }
685     return $types;
688 function lti_get_domain_from_url($url) {
689     $matches = array();
691     if (preg_match(LTI_URL_DOMAIN_REGEX, $url, $matches)) {
692         return $matches[1];
693     }
696 function lti_get_tool_by_url_match($url, $courseid = null, $state = LTI_TOOL_STATE_CONFIGURED) {
697     $possibletools = lti_get_tools_by_url($url, $state, $courseid);
699     return lti_get_best_tool_by_url($url, $possibletools, $courseid);
702 function lti_get_url_thumbprint($url) {
703     // Parse URL requires a schema otherwise everything goes into 'path'.  Fixed 5.4.7 or later.
704     if (preg_match('/https?:\/\//', $url) !== 1) {
705         $url = 'http://'.$url;
706     }
707     $urlparts = parse_url(strtolower($url));
708     if (!isset($urlparts['path'])) {
709         $urlparts['path'] = '';
710     }
712     if (!isset($urlparts['host'])) {
713         $urlparts['host'] = '';
714     }
716     if (substr($urlparts['host'], 0, 4) === 'www.') {
717         $urlparts['host'] = substr($urlparts['host'], 4);
718     }
720     return $urllower = $urlparts['host'] . '/' . $urlparts['path'];
723 function lti_get_best_tool_by_url($url, $tools, $courseid = null) {
724     if (count($tools) === 0) {
725         return null;
726     }
728     $urllower = lti_get_url_thumbprint($url);
730     foreach ($tools as $tool) {
731         $tool->_matchscore = 0;
733         $toolbaseurllower = lti_get_url_thumbprint($tool->baseurl);
735         if ($urllower === $toolbaseurllower) {
736             //100 points for exact thumbprint match
737             $tool->_matchscore += 100;
738         } else if (substr($urllower, 0, strlen($toolbaseurllower)) === $toolbaseurllower) {
739             //50 points if tool thumbprint starts with the base URL thumbprint
740             $tool->_matchscore += 50;
741         }
743         //Prefer course tools over site tools
744         if (!empty($courseid)) {
745             //Minus 10 points for not matching the course id (global tools)
746             if ($tool->course != $courseid) {
747                 $tool->_matchscore -= 10;
748             }
749         }
750     }
752     $bestmatch = array_reduce($tools, function($value, $tool) {
753         if ($tool->_matchscore > $value->_matchscore) {
754             return $tool;
755         } else {
756             return $value;
757         }
759     }, (object)array('_matchscore' => -1));
761     //None of the tools are suitable for this URL
762     if ($bestmatch->_matchscore <= 0) {
763         return null;
764     }
766     return $bestmatch;
769 function lti_get_shared_secrets_by_key($key) {
770     global $DB;
772     //Look up the shared secret for the specified key in both the types_config table (for configured tools)
773     //And in the lti resource table for ad-hoc tools
774     $query = "SELECT t2.value
775                 FROM {lti_types_config} t1
776                 JOIN {lti_types_config} t2 ON t1.typeid = t2.typeid
777                 JOIN {lti_types} type ON t2.typeid = type.id
778               WHERE t1.name = 'resourcekey'
779                 AND t1.value = :key1
780                 AND t2.name = 'password'
781                 AND type.state = :configured
782               UNION
783              SELECT password AS value
784                FROM {lti}
785               WHERE resourcekey = :key2";
787     $sharedsecrets = $DB->get_records_sql($query, array('configured' => LTI_TOOL_STATE_CONFIGURED, 'key1' => $key, 'key2' => $key));
789     $values = array_map(function($item) {
790         return $item->value;
791     }, $sharedsecrets);
793     //There should really only be one shared secret per key. But, we can't prevent
794     //more than one getting entered. For instance, if the same key is used for two tool providers.
795     return $values;
798 /**
799  * Delete a Basic LTI configuration
800  *
801  * @param int $id   Configuration id
802  */
803 function lti_delete_type($id) {
804     global $DB;
806     //We should probably just copy the launch URL to the tool instances in this case... using a single query
807     /*
808     $instances = $DB->get_records('lti', array('typeid' => $id));
809     foreach ($instances as $instance) {
810         $instance->typeid = 0;
811         $DB->update_record('lti', $instance);
812     }*/
814     $DB->delete_records('lti_types', array('id' => $id));
815     $DB->delete_records('lti_types_config', array('typeid' => $id));
818 function lti_set_state_for_type($id, $state) {
819     global $DB;
821     $DB->update_record('lti_types', array('id' => $id, 'state' => $state));
824 /**
825  * Transforms a basic LTI object to an array
826  *
827  * @param object $ltiobject    Basic LTI object
828  *
829  * @return array Basic LTI configuration details
830  */
831 function lti_get_config($ltiobject) {
832     $typeconfig = array();
833     $typeconfig = (array)$ltiobject;
834     $additionalconfig = lti_get_type_config($ltiobject->typeid);
835     $typeconfig = array_merge($typeconfig, $additionalconfig);
836     return $typeconfig;
839 /**
840  *
841  * Generates some of the tool configuration based on the instance details
842  *
843  * @param int $id
844  *
845  * @return Instance configuration
846  *
847  */
848 function lti_get_type_config_from_instance($id) {
849     global $DB;
851     $instance = $DB->get_record('lti', array('id' => $id));
852     $config = lti_get_config($instance);
854     $type = new stdClass();
855     $type->lti_fix = $id;
856     if (isset($config['toolurl'])) {
857         $type->lti_toolurl = $config['toolurl'];
858     }
859     if (isset($config['instructorchoicesendname'])) {
860         $type->lti_sendname = $config['instructorchoicesendname'];
861     }
862     if (isset($config['instructorchoicesendemailaddr'])) {
863         $type->lti_sendemailaddr = $config['instructorchoicesendemailaddr'];
864     }
865     if (isset($config['instructorchoiceacceptgrades'])) {
866         $type->lti_acceptgrades = $config['instructorchoiceacceptgrades'];
867     }
868     if (isset($config['instructorchoiceallowroster'])) {
869         $type->lti_allowroster = $config['instructorchoiceallowroster'];
870     }
872     if (isset($config['instructorcustomparameters'])) {
873         $type->lti_allowsetting = $config['instructorcustomparameters'];
874     }
875     return $type;
878 /**
879  * Generates some of the tool configuration based on the admin configuration details
880  *
881  * @param int $id
882  *
883  * @return Configuration details
884  */
885 function lti_get_type_type_config($id) {
886     global $DB;
888     $basicltitype = $DB->get_record('lti_types', array('id' => $id));
889     $config = lti_get_type_config($id);
891     $type = new stdClass();
893     $type->lti_typename = $basicltitype->name;
895     $type->typeid = $basicltitype->id;
897     $type->lti_toolurl = $basicltitype->baseurl;
899     if (isset($config['resourcekey'])) {
900         $type->lti_resourcekey = $config['resourcekey'];
901     }
902     if (isset($config['password'])) {
903         $type->lti_password = $config['password'];
904     }
906     if (isset($config['sendname'])) {
907         $type->lti_sendname = $config['sendname'];
908     }
909     if (isset($config['instructorchoicesendname'])) {
910         $type->lti_instructorchoicesendname = $config['instructorchoicesendname'];
911     }
912     if (isset($config['sendemailaddr'])) {
913         $type->lti_sendemailaddr = $config['sendemailaddr'];
914     }
915     if (isset($config['instructorchoicesendemailaddr'])) {
916         $type->lti_instructorchoicesendemailaddr = $config['instructorchoicesendemailaddr'];
917     }
918     if (isset($config['acceptgrades'])) {
919         $type->lti_acceptgrades = $config['acceptgrades'];
920     }
921     if (isset($config['instructorchoiceacceptgrades'])) {
922         $type->lti_instructorchoiceacceptgrades = $config['instructorchoiceacceptgrades'];
923     }
924     if (isset($config['allowroster'])) {
925         $type->lti_allowroster = $config['allowroster'];
926     }
927     if (isset($config['instructorchoiceallowroster'])) {
928         $type->lti_instructorchoiceallowroster = $config['instructorchoiceallowroster'];
929     }
931     if (isset($config['customparameters'])) {
932         $type->lti_customparameters = $config['customparameters'];
933     }
935     if (isset($config['forcessl'])) {
936         $type->lti_forcessl = $config['forcessl'];
937     }
939     if (isset($config['organizationid'])) {
940         $type->lti_organizationid = $config['organizationid'];
941     }
942     if (isset($config['organizationurl'])) {
943         $type->lti_organizationurl = $config['organizationurl'];
944     }
945     if (isset($config['organizationdescr'])) {
946         $type->lti_organizationdescr = $config['organizationdescr'];
947     }
948     if (isset($config['launchcontainer'])) {
949         $type->lti_launchcontainer = $config['launchcontainer'];
950     }
952     if (isset($config['coursevisible'])) {
953         $type->lti_coursevisible = $config['coursevisible'];
954     }
956     if (isset($config['debuglaunch'])) {
957         $type->lti_debuglaunch = $config['debuglaunch'];
958     }
960     if (isset($config['module_class_type'])) {
961         $type->lti_module_class_type = $config['module_class_type'];
962     }
964     return $type;
967 function lti_prepare_type_for_save($type, $config) {
968     $type->baseurl = $config->lti_toolurl;
969     $type->tooldomain = lti_get_domain_from_url($config->lti_toolurl);
970     $type->name = $config->lti_typename;
972     $type->coursevisible = !empty($config->lti_coursevisible) ? $config->lti_coursevisible : 0;
973     $config->lti_coursevisible = $type->coursevisible;
975     $type->forcessl = !empty($config->lti_forcessl) ? $config->lti_forcessl : 0;
976     $config->lti_forcessl = $type->forcessl;
978     $type->timemodified = time();
980     unset ($config->lti_typename);
981     unset ($config->lti_toolurl);
984 function lti_update_type($type, $config) {
985     global $DB;
987     lti_prepare_type_for_save($type, $config);
989     if ($DB->update_record('lti_types', $type)) {
990         foreach ($config as $key => $value) {
991             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
992                 $record = new StdClass();
993                 $record->typeid = $type->id;
994                 $record->name = substr($key, 4);
995                 $record->value = $value;
997                 lti_update_config($record);
998             }
999         }
1000     }
1003 function lti_add_type($type, $config) {
1004     global $USER, $SITE, $DB;
1006     lti_prepare_type_for_save($type, $config);
1008     if (!isset($type->state)) {
1009         $type->state = LTI_TOOL_STATE_PENDING;
1010     }
1012     if (!isset($type->timecreated)) {
1013         $type->timecreated = time();
1014     }
1016     if (!isset($type->createdby)) {
1017         $type->createdby = $USER->id;
1018     }
1020     if (!isset($type->course)) {
1021         $type->course = $SITE->id;
1022     }
1024     //Create a salt value to be used for signing passed data to extension services
1025     //The outcome service uses the service salt on the instance. This can be used
1026     //for communication with services not related to a specific LTI instance.
1027     $config->lti_servicesalt = uniqid('', true);
1029     $id = $DB->insert_record('lti_types', $type);
1031     if ($id) {
1032         foreach ($config as $key => $value) {
1033             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
1034                 $record = new StdClass();
1035                 $record->typeid = $id;
1036                 $record->name = substr($key, 4);
1037                 $record->value = $value;
1039                 lti_add_config($record);
1040             }
1041         }
1042     }
1044     return $id;
1047 /**
1048  * Add a tool configuration in the database
1049  *
1050  * @param $config   Tool configuration
1051  *
1052  * @return int Record id number
1053  */
1054 function lti_add_config($config) {
1055     global $DB;
1057     return $DB->insert_record('lti_types_config', $config);
1060 /**
1061  * Updates a tool configuration in the database
1062  *
1063  * @param $config   Tool configuration
1064  *
1065  * @return Record id number
1066  */
1067 function lti_update_config($config) {
1068     global $DB;
1070     $return = true;
1071     $old = $DB->get_record('lti_types_config', array('typeid' => $config->typeid, 'name' => $config->name));
1073     if ($old) {
1074         $config->id = $old->id;
1075         $return = $DB->update_record('lti_types_config', $config);
1076     } else {
1077         $return = $DB->insert_record('lti_types_config', $config);
1078     }
1079     return $return;
1082 /**
1083  * Signs the petition to launch the external tool using OAuth
1084  *
1085  * @param $oldparms     Parameters to be passed for signing
1086  * @param $endpoint     url of the external tool
1087  * @param $method       Method for sending the parameters (e.g. POST)
1088  * @param $oauth_consumoer_key          Key
1089  * @param $oauth_consumoer_secret       Secret
1090  * @param $submittext  The text for the submit button
1091  * @param $orgid       LMS name
1092  * @param $orgdesc     LMS key
1093  */
1094 function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret) {
1095     //global $lastbasestring;
1096     $parms = $oldparms;
1098     $testtoken = '';
1100     // TODO: Switch to core oauthlib once implemented - MDL-30149
1101     $hmacmethod = new lti\OAuthSignatureMethod_HMAC_SHA1();
1102     $testconsumer = new lti\OAuthConsumer($oauthconsumerkey, $oauthconsumersecret, null);
1103     $accreq = lti\OAuthRequest::from_consumer_and_token($testconsumer, $testtoken, $method, $endpoint, $parms);
1104     $accreq->sign_request($hmacmethod, $testconsumer, $testtoken);
1106     // Pass this back up "out of band" for debugging
1107     //$lastbasestring = $accreq->get_signature_base_string();
1109     $newparms = $accreq->get_parameters();
1111     return $newparms;
1114 /**
1115  * Posts the launch petition HTML
1116  *
1117  * @param $newparms     Signed parameters
1118  * @param $endpoint     URL of the external tool
1119  * @param $debug        Debug (true/false)
1120  */
1121 function lti_post_launch_html($newparms, $endpoint, $debug=false) {
1122     $r = "<form action=\"".$endpoint."\" name=\"ltiLaunchForm\" id=\"ltiLaunchForm\" method=\"post\" encType=\"application/x-www-form-urlencoded\">\n";
1124     $submittext = $newparms['ext_submit'];
1126     // Contruct html for the launch parameters
1127     foreach ($newparms as $key => $value) {
1128         $key = htmlspecialchars($key);
1129         $value = htmlspecialchars($value);
1130         if ( $key == "ext_submit" ) {
1131             $r .= "<input type=\"submit\" name=\"";
1132         } else {
1133             $r .= "<input type=\"hidden\" name=\"";
1134         }
1135         $r .= $key;
1136         $r .= "\" value=\"";
1137         $r .= $value;
1138         $r .= "\"/>\n";
1139     }
1141     if ( $debug ) {
1142         $r .= "<script language=\"javascript\"> \n";
1143         $r .= "  //<![CDATA[ \n";
1144         $r .= "function basicltiDebugToggle() {\n";
1145         $r .= "    var ele = document.getElementById(\"basicltiDebug\");\n";
1146         $r .= "    if (ele.style.display == \"block\") {\n";
1147         $r .= "        ele.style.display = \"none\";\n";
1148         $r .= "    }\n";
1149         $r .= "    else {\n";
1150         $r .= "        ele.style.display = \"block\";\n";
1151         $r .= "    }\n";
1152         $r .= "} \n";
1153         $r .= "  //]]> \n";
1154         $r .= "</script>\n";
1155         $r .= "<a id=\"displayText\" href=\"javascript:basicltiDebugToggle();\">";
1156         $r .= get_string("toggle_debug_data", "lti")."</a>\n";
1157         $r .= "<div id=\"basicltiDebug\" style=\"display:none\">\n";
1158         $r .=  "<b>".get_string("basiclti_endpoint", "lti")."</b><br/>\n";
1159         $r .= $endpoint . "<br/>\n&nbsp;<br/>\n";
1160         $r .=  "<b>".get_string("basiclti_parameters", "lti")."</b><br/>\n";
1161         foreach ($newparms as $key => $value) {
1162             $key = htmlspecialchars($key);
1163             $value = htmlspecialchars($value);
1164             $r .= "$key = $value<br/>\n";
1165         }
1166         $r .= "&nbsp;<br/>\n";
1167         //$r .= "<p><b>".get_string("basiclti_base_string", "lti")."</b><br/>\n".$lastbasestring."</p>\n";
1168         $r .= "</div>\n";
1169     }
1170     $r .= "</form>\n";
1172     if ( ! $debug ) {
1173         $ext_submit = "ext_submit";
1174         $ext_submit_text = $submittext;
1175         $r .= " <script type=\"text/javascript\"> \n" .
1176             "  //<![CDATA[ \n" .
1177             "    document.getElementById(\"ltiLaunchForm\").style.display = \"none\";\n" .
1178             "    nei = document.createElement('input');\n" .
1179             "    nei.setAttribute('type', 'hidden');\n" .
1180             "    nei.setAttribute('name', '".$ext_submit."');\n" .
1181             "    nei.setAttribute('value', '".$ext_submit_text."');\n" .
1182             "    document.getElementById(\"ltiLaunchForm\").appendChild(nei);\n" .
1183             "    document.ltiLaunchForm.submit(); \n" .
1184             "  //]]> \n" .
1185             " </script> \n";
1186     }
1187     return $r;
1190 function lti_get_type($typeid) {
1191     global $DB;
1193     return $DB->get_record('lti_types', array('id' => $typeid));
1196 function lti_get_launch_container($lti, $toolconfig) {
1197     if (empty($lti->launchcontainer)) {
1198         $lti->launchcontainer = LTI_LAUNCH_CONTAINER_DEFAULT;
1199     }
1201     if ($lti->launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1202         if (isset($toolconfig['launchcontainer'])) {
1203             $launchcontainer = $toolconfig['launchcontainer'];
1204         }
1205     } else {
1206         $launchcontainer = $lti->launchcontainer;
1207     }
1209     if (empty($launchcontainer) || $launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1210         $launchcontainer = LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS;
1211     }
1213     $devicetype = core_useragent::get_device_type();
1215     //Scrolling within the object element doesn't work on iOS or Android
1216     //Opening the popup window also had some issues in testing
1217     //For mobile devices, always take up the entire screen to ensure the best experience
1218     if ($devicetype === core_useragent::DEVICETYPE_MOBILE || $devicetype === core_useragent::DEVICETYPE_TABLET ) {
1219         $launchcontainer = LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW;
1220     }
1222     return $launchcontainer;
1225 function lti_request_is_using_ssl() {
1226     global $CFG;
1227     return (stripos($CFG->httpswwwroot, 'https://') === 0);
1230 function lti_ensure_url_is_https($url) {
1231     if (!strstr($url, '://')) {
1232         $url = 'https://' . $url;
1233     } else {
1234         //If the URL starts with http, replace with https
1235         if (stripos($url, 'http://') === 0) {
1236             $url = 'https://' . substr($url, 7);
1237         }
1238     }
1240     return $url;
1243 /**
1244  * Determines if we should try to log the request
1245  *
1246  * @param string $rawbody
1247  * @return bool
1248  */
1249 function lti_should_log_request($rawbody) {
1250     global $CFG;
1252     if (empty($CFG->mod_lti_log_users)) {
1253         return false;
1254     }
1256     $logusers = explode(',', $CFG->mod_lti_log_users);
1257     if (empty($logusers)) {
1258         return false;
1259     }
1261     try {
1262         $xml = new SimpleXMLElement($rawbody);
1263         $ns  = $xml->getNamespaces();
1264         $ns  = array_shift($ns);
1265         $xml->registerXPathNamespace('lti', $ns);
1266         $requestuserid = '';
1267         if ($node = $xml->xpath('//lti:userId')) {
1268             $node = $node[0];
1269             $requestuserid = clean_param((string) $node, PARAM_INT);
1270         } else if ($node = $xml->xpath('//lti:sourcedId')) {
1271             $node = $node[0];
1272             $resultjson = json_decode((string) $node);
1273             $requestuserid = clean_param($resultjson->data->userid, PARAM_INT);
1274         }
1275     } catch (Exception $e) {
1276         return false;
1277     }
1279     if (empty($requestuserid) or !in_array($requestuserid, $logusers)) {
1280         return false;
1281     }
1283     return true;
1286 /**
1287  * Logs the request to a file in temp dir
1288  *
1289  * @param string $rawbody
1290  */
1291 function lti_log_request($rawbody) {
1292     if ($tempdir = make_temp_directory('mod_lti', false)) {
1293         if ($tempfile = tempnam($tempdir, 'mod_lti_request'.date('YmdHis'))) {
1294             file_put_contents($tempfile, $rawbody);
1295             chmod($tempfile, 0644);
1296         }
1297     }
1300 /**
1301  * Fetches LTI type configuration for an LTI instance
1302  *
1303  * @param stdClass $instance
1304  * @return array Can be empty if no type is found
1305  */
1306 function lti_get_type_config_by_instance($instance) {
1307     $typeid = null;
1308     if (empty($instance->typeid)) {
1309         $tool = lti_get_tool_by_url_match($instance->toolurl, $instance->course);
1310         if ($tool) {
1311             $typeid = $tool->id;
1312         }
1313     } else {
1314         $typeid = $instance->typeid;
1315     }
1316     if (!empty($typeid)) {
1317         return lti_get_type_config($typeid);
1318     }
1319     return array();
1322 /**
1323  * Enforce type config settings onto the LTI instance
1324  *
1325  * @param stdClass $instance
1326  * @param array $typeconfig
1327  */
1328 function lti_force_type_config_settings($instance, array $typeconfig) {
1329     $forced = array(
1330         'instructorchoicesendname'      => 'sendname',
1331         'instructorchoicesendemailaddr' => 'sendemailaddr',
1332         'instructorchoiceacceptgrades'  => 'acceptgrades',
1333     );
1335     foreach ($forced as $instanceparam => $typeconfigparam) {
1336         if (array_key_exists($typeconfigparam, $typeconfig) && $typeconfig[$typeconfigparam] != LTI_SETTING_DELEGATE) {
1337             $instance->$instanceparam = $typeconfig[$typeconfigparam];
1338         }
1339     }