Merge branch 'MDL-45645_LTIUsernameParam' of https://github.com/moodlerooms/moodle
[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 object    $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     $requestparams = array(
288         'resource_link_id' => $instance->id,
289         'resource_link_title' => $instance->name,
290         'resource_link_description' => $instance->intro,
291         'user_id' => $USER->id,
292         'roles' => $role,
293         'context_id' => $course->id,
294         'context_label' => $course->shortname,
295         'context_title' => $course->fullname,
296         'launch_presentation_locale' => current_language()
297     );
299     if (property_exists($instance, 'resource_link_id') and !empty($instance->resource_link_id)) {
300         $requestparams['resource_link_id'] = $instance->resource_link_id;
301     }
302     $placementsecret = $instance->servicesalt;
304     if ( isset($placementsecret) ) {
305         $sourcedid = json_encode(lti_build_sourcedid($instance->id, $USER->id, $placementsecret, $typeid));
306         $requestparams['lis_result_sourcedid'] = $sourcedid;
307     }
309     if ( isset($placementsecret) &&
310          ( $typeconfig['acceptgrades'] == LTI_SETTING_ALWAYS ||
311          ( $typeconfig['acceptgrades'] == LTI_SETTING_DELEGATE && $instance->instructorchoiceacceptgrades == LTI_SETTING_ALWAYS ) ) ) {
313         //Add outcome service URL
314         $serviceurl = new moodle_url('/mod/lti/service.php');
315         $serviceurl = $serviceurl->out();
317         $forcessl = false;
318         if (!empty($CFG->mod_lti_forcessl)) {
319             $forcessl = true;
320         }
322         if ($typeconfig['forcessl'] == '1' or $forcessl) {
323             $serviceurl = lti_ensure_url_is_https($serviceurl);
324         }
326         $requestparams['lis_outcome_service_url'] = $serviceurl;
327     }
329     // Send user's name and email data if appropriate
330     if ( $typeconfig['sendname'] == LTI_SETTING_ALWAYS ||
331          ( $typeconfig['sendname'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendname == LTI_SETTING_ALWAYS ) ) {
332         $requestparams['lis_person_name_given'] =  $USER->firstname;
333         $requestparams['lis_person_name_family'] =  $USER->lastname;
334         $requestparams['lis_person_name_full'] =  $USER->firstname." ".$USER->lastname;
335         $requestparams['ext_user_username'] = $USER->username;
336     }
338     if ( $typeconfig['sendemailaddr'] == LTI_SETTING_ALWAYS ||
339          ( $typeconfig['sendemailaddr'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendemailaddr == LTI_SETTING_ALWAYS ) ) {
340         $requestparams['lis_person_contact_email_primary'] = $USER->email;
341     }
343     // Concatenate the custom parameters from the administrator and the instructor
344     // Instructor parameters are only taken into consideration if the administrator
345     // has giver permission
346     $customstr = $typeconfig['customparameters'];
347     $instructorcustomstr = $instance->instructorcustomparameters;
348     $custom = array();
349     $instructorcustom = array();
350     if ($customstr) {
351         $custom = lti_split_custom_parameters($customstr);
352     }
353     if (isset($typeconfig['allowinstructorcustom']) && $typeconfig['allowinstructorcustom'] == LTI_SETTING_NEVER) {
354         $requestparams = array_merge($custom, $requestparams);
355     } else {
356         if ($instructorcustomstr) {
357             $instructorcustom = lti_split_custom_parameters($instructorcustomstr);
358         }
359         foreach ($instructorcustom as $key => $val) {
360             // Ignore the instructor's parameter
361             if (!array_key_exists($key, $custom)) {
362                 $custom[$key] = $val;
363             }
364         }
365         $requestparams = array_merge($custom, $requestparams);
366     }
368     // Make sure we let the tool know what LMS they are being called from
369     $requestparams["ext_lms"] = "moodle-2";
370     $requestparams['tool_consumer_info_product_family_code'] = 'moodle';
371     $requestparams['tool_consumer_info_version'] = strval($CFG->version);
373     // Add oauth_callback to be compliant with the 1.0A spec
374     $requestparams['oauth_callback'] = 'about:blank';
376     //The submit button needs to be part of the signature as it gets posted with the form.
377     //This needs to be here to support launching without javascript.
378     $submittext = get_string('press_to_submit', 'lti');
379     $requestparams['ext_submit'] = $submittext;
381     $requestparams['lti_version'] = 'LTI-1p0';
382     $requestparams['lti_message_type'] = 'basic-lti-launch-request';
384     return $requestparams;
387 function lti_get_tool_table($tools, $id) {
388     global $CFG, $OUTPUT, $USER;
389     $html = '';
391     $typename = get_string('typename', 'lti');
392     $baseurl = get_string('baseurl', 'lti');
393     $action = get_string('action', 'lti');
394     $createdon = get_string('createdon', 'lti');
396     if ($id == 'lti_configured') {
397         $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>';
398     }
400     if (!empty($tools)) {
401         $html .= "
402         <div id=\"{$id}_container\" style=\"margin-top:.5em;margin-bottom:.5em\">
403             <table id=\"{$id}_tools\">
404                 <thead>
405                     <tr>
406                         <th>$typename</th>
407                         <th>$baseurl</th>
408                         <th>$createdon</th>
409                         <th>$action</th>
410                     </tr>
411                 </thead>
412         ";
414         foreach ($tools as $type) {
415             $date = userdate($type->timecreated, get_string('strftimedatefullshort', 'core_langconfig'));
416             $accept = get_string('accept', 'lti');
417             $update = get_string('update', 'lti');
418             $delete = get_string('delete', 'lti');
420             $baseurl = new moodle_url('/mod/lti/typessettings.php', array(
421                     'action' => 'accept',
422                     'id' => $type->id,
423                     'sesskey' => sesskey(),
424                     'tab' => $id
425                 ));
427             $accepthtml = $OUTPUT->action_icon($baseurl,
428                     new pix_icon('t/check', $accept, '', array('class' => 'iconsmall')), null,
429                     array('title' => $accept, 'class' => 'editing_accept'));
431             $deleteaction = 'delete';
433             if ($type->state == LTI_TOOL_STATE_CONFIGURED) {
434                 $accepthtml = '';
435             }
437             if ($type->state != LTI_TOOL_STATE_REJECTED) {
438                 $deleteaction = 'reject';
439                 $delete = get_string('reject', 'lti');
440             }
442             $updateurl = clone($baseurl);
443             $updateurl->param('action', 'update');
444             $updatehtml = $OUTPUT->action_icon($updateurl,
445                     new pix_icon('t/edit', $update, '', array('class' => 'iconsmall')), null,
446                     array('title' => $update, 'class' => 'editing_update'));
448             $deleteurl = clone($baseurl);
449             $deleteurl->param('action', $deleteaction);
450             $deletehtml = $OUTPUT->action_icon($deleteurl,
451                     new pix_icon('t/delete', $delete, '', array('class' => 'iconsmall')), null,
452                     array('title' => $delete, 'class' => 'editing_delete'));
453             $html .= "
454             <tr>
455                 <td>
456                     {$type->name}
457                 </td>
458                 <td>
459                     {$type->baseurl}
460                 </td>
461                 <td>
462                     {$date}
463                 </td>
464                 <td align=\"center\">
465                     {$accepthtml}{$updatehtml}{$deletehtml}
466                 </td>
467             </tr>
468             ";
469         }
470         $html .= '</table></div>';
471     } else {
472         $html .= get_string('no_' . $id, 'lti');
473     }
475     return $html;
478 /**
479  * Splits the custom parameters field to the various parameters
480  *
481  * @param string $customstr     String containing the parameters
482  *
483  * @return Array of custom parameters
484  */
485 function lti_split_custom_parameters($customstr) {
486     $lines = preg_split("/[\n;]/", $customstr);
487     $retval = array();
488     foreach ($lines as $line) {
489         $pos = strpos($line, "=");
490         if ( $pos === false || $pos < 1 ) {
491             continue;
492         }
493         $key = trim(core_text::substr($line, 0, $pos));
494         $val = trim(core_text::substr($line, $pos+1, strlen($line)));
495         $key = lti_map_keyname($key);
496         $retval['custom_'.$key] = $val;
497     }
498     return $retval;
501 /**
502  * Used for building the names of the different custom parameters
503  *
504  * @param string $key   Parameter name
505  *
506  * @return string       Processed name
507  */
508 function lti_map_keyname($key) {
509     $newkey = "";
510     $key = core_text::strtolower(trim($key));
511     foreach (str_split($key) as $ch) {
512         if ( ($ch >= 'a' && $ch <= 'z') || ($ch >= '0' && $ch <= '9') ) {
513             $newkey .= $ch;
514         } else {
515             $newkey .= '_';
516         }
517     }
518     return $newkey;
521 /**
522  * Gets the IMS role string for the specified user and LTI course module.
523  *
524  * @param mixed $user User object or user id
525  * @param int $cmid The course module id of the LTI activity
526  * @return string A role string suitable for passing with an LTI launch
527  */
528 function lti_get_ims_role($user, $cmid, $courseid) {
529     $roles = array();
531     if (empty($cmid)) {
532         //If no cmid is passed, check if the user is a teacher in the course
533         //This allows other modules to programmatically "fake" a launch without
534         //a real LTI instance
535         $coursecontext = context_course::instance($courseid);
537         if (has_capability('moodle/course:manageactivities', $coursecontext)) {
538             array_push($roles, 'Instructor');
539         } else {
540             array_push($roles, 'Learner');
541         }
542     } else {
543         $context = context_module::instance($cmid);
545         if (has_capability('mod/lti:manage', $context)) {
546             array_push($roles, 'Instructor');
547         } else {
548             array_push($roles, 'Learner');
549         }
550     }
552     if (is_siteadmin($user)) {
553         array_push($roles, 'urn:lti:sysrole:ims/lis/Administrator', 'urn:lti:instrole:ims/lis/Administrator');
554     }
556     return join(',', $roles);
559 /**
560  * Returns configuration details for the tool
561  *
562  * @param int $typeid   Basic LTI tool typeid
563  *
564  * @return array        Tool Configuration
565  */
566 function lti_get_type_config($typeid) {
567     global $DB;
569     $query = "SELECT name, value
570                 FROM {lti_types_config}
571                WHERE typeid = :typeid1
572            UNION ALL
573               SELECT 'toolurl' AS name, " . $DB->sql_compare_text('baseurl', 1333) . " AS value
574                 FROM {lti_types}
575                WHERE id = :typeid2";
577     $typeconfig = array();
578     $configs = $DB->get_records_sql($query, array('typeid1' => $typeid, 'typeid2' => $typeid));
580     if (!empty($configs)) {
581         foreach ($configs as $config) {
582             $typeconfig[$config->name] = $config->value;
583         }
584     }
586     return $typeconfig;
589 function lti_get_tools_by_url($url, $state, $courseid = null) {
590     $domain = lti_get_domain_from_url($url);
592     return lti_get_tools_by_domain($domain, $state, $courseid);
595 function lti_get_tools_by_domain($domain, $state = null, $courseid = null) {
596     global $DB, $SITE;
598     $filters = array('tooldomain' => $domain);
600     $statefilter = '';
601     $coursefilter = '';
603     if ($state) {
604         $statefilter = 'AND state = :state';
605     }
607     if ($courseid && $courseid != $SITE->id) {
608         $coursefilter = 'OR course = :courseid';
609     }
611     $query = "SELECT *
612                 FROM {lti_types}
613                WHERE tooldomain = :tooldomain
614                  AND (course = :siteid $coursefilter)
615                  $statefilter";
617     return $DB->get_records_sql($query, array(
618         'courseid' => $courseid,
619         'siteid' => $SITE->id,
620         'tooldomain' => $domain,
621         'state' => $state
622     ));
625 /**
626  * Returns all basicLTI tools configured by the administrator
627  *
628  */
629 function lti_filter_get_types($course) {
630     global $DB;
632     if (!empty($course)) {
633         $filter = array('course' => $course);
634     } else {
635         $filter = array();
636     }
638     return $DB->get_records('lti_types', $filter);
641 /**
642  * Given an array of tools, filter them based on their state
643  *
644  * @param array $tools An array of lti_types records
645  * @param int $state One of the LTI_TOOL_STATE_* constants
646  * @return array
647  */
648 function lti_filter_tool_types(array $tools, $state) {
649     $return = array();
650     foreach ($tools as $key => $tool) {
651         if ($tool->state == $state) {
652             $return[$key] = $tool;
653         }
654     }
655     return $return;
658 function lti_get_types_for_add_instance() {
659     global $DB, $SITE, $COURSE;
661     $query = "SELECT *
662                 FROM {lti_types}
663                WHERE coursevisible = 1
664                  AND (course = :siteid OR course = :courseid)
665                  AND state = :active";
667     $admintypes = $DB->get_records_sql($query, array('siteid' => $SITE->id, 'courseid' => $COURSE->id, 'active' => LTI_TOOL_STATE_CONFIGURED));
669     $types = array();
670     $types[0] = (object)array('name' => get_string('automatic', 'lti'), 'course' => 0);
672     foreach ($admintypes as $type) {
673         $types[$type->id] = $type;
674     }
676     return $types;
679 function lti_get_domain_from_url($url) {
680     $matches = array();
682     if (preg_match(LTI_URL_DOMAIN_REGEX, $url, $matches)) {
683         return $matches[1];
684     }
687 function lti_get_tool_by_url_match($url, $courseid = null, $state = LTI_TOOL_STATE_CONFIGURED) {
688     $possibletools = lti_get_tools_by_url($url, $state, $courseid);
690     return lti_get_best_tool_by_url($url, $possibletools, $courseid);
693 function lti_get_url_thumbprint($url) {
694     // Parse URL requires a schema otherwise everything goes into 'path'.  Fixed 5.4.7 or later.
695     if (preg_match('/https?:\/\//', $url) !== 1) {
696         $url = 'http://'.$url;
697     }
698     $urlparts = parse_url(strtolower($url));
699     if (!isset($urlparts['path'])) {
700         $urlparts['path'] = '';
701     }
703     if (!isset($urlparts['host'])) {
704         $urlparts['host'] = '';
705     }
707     if (substr($urlparts['host'], 0, 4) === 'www.') {
708         $urlparts['host'] = substr($urlparts['host'], 4);
709     }
711     return $urllower = $urlparts['host'] . '/' . $urlparts['path'];
714 function lti_get_best_tool_by_url($url, $tools, $courseid = null) {
715     if (count($tools) === 0) {
716         return null;
717     }
719     $urllower = lti_get_url_thumbprint($url);
721     foreach ($tools as $tool) {
722         $tool->_matchscore = 0;
724         $toolbaseurllower = lti_get_url_thumbprint($tool->baseurl);
726         if ($urllower === $toolbaseurllower) {
727             //100 points for exact thumbprint match
728             $tool->_matchscore += 100;
729         } else if (substr($urllower, 0, strlen($toolbaseurllower)) === $toolbaseurllower) {
730             //50 points if tool thumbprint starts with the base URL thumbprint
731             $tool->_matchscore += 50;
732         }
734         //Prefer course tools over site tools
735         if (!empty($courseid)) {
736             //Minus 10 points for not matching the course id (global tools)
737             if ($tool->course != $courseid) {
738                 $tool->_matchscore -= 10;
739             }
740         }
741     }
743     $bestmatch = array_reduce($tools, function($value, $tool) {
744         if ($tool->_matchscore > $value->_matchscore) {
745             return $tool;
746         } else {
747             return $value;
748         }
750     }, (object)array('_matchscore' => -1));
752     //None of the tools are suitable for this URL
753     if ($bestmatch->_matchscore <= 0) {
754         return null;
755     }
757     return $bestmatch;
760 function lti_get_shared_secrets_by_key($key) {
761     global $DB;
763     //Look up the shared secret for the specified key in both the types_config table (for configured tools)
764     //And in the lti resource table for ad-hoc tools
765     $query = "SELECT t2.value
766                 FROM {lti_types_config} t1
767                 JOIN {lti_types_config} t2 ON t1.typeid = t2.typeid
768                 JOIN {lti_types} type ON t2.typeid = type.id
769               WHERE t1.name = 'resourcekey'
770                 AND t1.value = :key1
771                 AND t2.name = 'password'
772                 AND type.state = :configured
773               UNION
774              SELECT password AS value
775                FROM {lti}
776               WHERE resourcekey = :key2";
778     $sharedsecrets = $DB->get_records_sql($query, array('configured' => LTI_TOOL_STATE_CONFIGURED, 'key1' => $key, 'key2' => $key));
780     $values = array_map(function($item) {
781         return $item->value;
782     }, $sharedsecrets);
784     //There should really only be one shared secret per key. But, we can't prevent
785     //more than one getting entered. For instance, if the same key is used for two tool providers.
786     return $values;
789 /**
790  * Delete a Basic LTI configuration
791  *
792  * @param int $id   Configuration id
793  */
794 function lti_delete_type($id) {
795     global $DB;
797     //We should probably just copy the launch URL to the tool instances in this case... using a single query
798     /*
799     $instances = $DB->get_records('lti', array('typeid' => $id));
800     foreach ($instances as $instance) {
801         $instance->typeid = 0;
802         $DB->update_record('lti', $instance);
803     }*/
805     $DB->delete_records('lti_types', array('id' => $id));
806     $DB->delete_records('lti_types_config', array('typeid' => $id));
809 function lti_set_state_for_type($id, $state) {
810     global $DB;
812     $DB->update_record('lti_types', array('id' => $id, 'state' => $state));
815 /**
816  * Transforms a basic LTI object to an array
817  *
818  * @param object $ltiobject    Basic LTI object
819  *
820  * @return array Basic LTI configuration details
821  */
822 function lti_get_config($ltiobject) {
823     $typeconfig = array();
824     $typeconfig = (array)$ltiobject;
825     $additionalconfig = lti_get_type_config($ltiobject->typeid);
826     $typeconfig = array_merge($typeconfig, $additionalconfig);
827     return $typeconfig;
830 /**
831  *
832  * Generates some of the tool configuration based on the instance details
833  *
834  * @param int $id
835  *
836  * @return Instance configuration
837  *
838  */
839 function lti_get_type_config_from_instance($id) {
840     global $DB;
842     $instance = $DB->get_record('lti', array('id' => $id));
843     $config = lti_get_config($instance);
845     $type = new stdClass();
846     $type->lti_fix = $id;
847     if (isset($config['toolurl'])) {
848         $type->lti_toolurl = $config['toolurl'];
849     }
850     if (isset($config['instructorchoicesendname'])) {
851         $type->lti_sendname = $config['instructorchoicesendname'];
852     }
853     if (isset($config['instructorchoicesendemailaddr'])) {
854         $type->lti_sendemailaddr = $config['instructorchoicesendemailaddr'];
855     }
856     if (isset($config['instructorchoiceacceptgrades'])) {
857         $type->lti_acceptgrades = $config['instructorchoiceacceptgrades'];
858     }
859     if (isset($config['instructorchoiceallowroster'])) {
860         $type->lti_allowroster = $config['instructorchoiceallowroster'];
861     }
863     if (isset($config['instructorcustomparameters'])) {
864         $type->lti_allowsetting = $config['instructorcustomparameters'];
865     }
866     return $type;
869 /**
870  * Generates some of the tool configuration based on the admin configuration details
871  *
872  * @param int $id
873  *
874  * @return Configuration details
875  */
876 function lti_get_type_type_config($id) {
877     global $DB;
879     $basicltitype = $DB->get_record('lti_types', array('id' => $id));
880     $config = lti_get_type_config($id);
882     $type = new stdClass();
884     $type->lti_typename = $basicltitype->name;
886     $type->typeid = $basicltitype->id;
888     $type->lti_toolurl = $basicltitype->baseurl;
890     if (isset($config['resourcekey'])) {
891         $type->lti_resourcekey = $config['resourcekey'];
892     }
893     if (isset($config['password'])) {
894         $type->lti_password = $config['password'];
895     }
897     if (isset($config['sendname'])) {
898         $type->lti_sendname = $config['sendname'];
899     }
900     if (isset($config['instructorchoicesendname'])) {
901         $type->lti_instructorchoicesendname = $config['instructorchoicesendname'];
902     }
903     if (isset($config['sendemailaddr'])) {
904         $type->lti_sendemailaddr = $config['sendemailaddr'];
905     }
906     if (isset($config['instructorchoicesendemailaddr'])) {
907         $type->lti_instructorchoicesendemailaddr = $config['instructorchoicesendemailaddr'];
908     }
909     if (isset($config['acceptgrades'])) {
910         $type->lti_acceptgrades = $config['acceptgrades'];
911     }
912     if (isset($config['instructorchoiceacceptgrades'])) {
913         $type->lti_instructorchoiceacceptgrades = $config['instructorchoiceacceptgrades'];
914     }
915     if (isset($config['allowroster'])) {
916         $type->lti_allowroster = $config['allowroster'];
917     }
918     if (isset($config['instructorchoiceallowroster'])) {
919         $type->lti_instructorchoiceallowroster = $config['instructorchoiceallowroster'];
920     }
922     if (isset($config['customparameters'])) {
923         $type->lti_customparameters = $config['customparameters'];
924     }
926     if (isset($config['forcessl'])) {
927         $type->lti_forcessl = $config['forcessl'];
928     }
930     if (isset($config['organizationid'])) {
931         $type->lti_organizationid = $config['organizationid'];
932     }
933     if (isset($config['organizationurl'])) {
934         $type->lti_organizationurl = $config['organizationurl'];
935     }
936     if (isset($config['organizationdescr'])) {
937         $type->lti_organizationdescr = $config['organizationdescr'];
938     }
939     if (isset($config['launchcontainer'])) {
940         $type->lti_launchcontainer = $config['launchcontainer'];
941     }
943     if (isset($config['coursevisible'])) {
944         $type->lti_coursevisible = $config['coursevisible'];
945     }
947     if (isset($config['debuglaunch'])) {
948         $type->lti_debuglaunch = $config['debuglaunch'];
949     }
951     if (isset($config['module_class_type'])) {
952         $type->lti_module_class_type = $config['module_class_type'];
953     }
955     return $type;
958 function lti_prepare_type_for_save($type, $config) {
959     $type->baseurl = $config->lti_toolurl;
960     $type->tooldomain = lti_get_domain_from_url($config->lti_toolurl);
961     $type->name = $config->lti_typename;
963     $type->coursevisible = !empty($config->lti_coursevisible) ? $config->lti_coursevisible : 0;
964     $config->lti_coursevisible = $type->coursevisible;
966     $type->forcessl = !empty($config->lti_forcessl) ? $config->lti_forcessl : 0;
967     $config->lti_forcessl = $type->forcessl;
969     $type->timemodified = time();
971     unset ($config->lti_typename);
972     unset ($config->lti_toolurl);
975 function lti_update_type($type, $config) {
976     global $DB;
978     lti_prepare_type_for_save($type, $config);
980     if ($DB->update_record('lti_types', $type)) {
981         foreach ($config as $key => $value) {
982             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
983                 $record = new StdClass();
984                 $record->typeid = $type->id;
985                 $record->name = substr($key, 4);
986                 $record->value = $value;
988                 lti_update_config($record);
989             }
990         }
991     }
994 function lti_add_type($type, $config) {
995     global $USER, $SITE, $DB;
997     lti_prepare_type_for_save($type, $config);
999     if (!isset($type->state)) {
1000         $type->state = LTI_TOOL_STATE_PENDING;
1001     }
1003     if (!isset($type->timecreated)) {
1004         $type->timecreated = time();
1005     }
1007     if (!isset($type->createdby)) {
1008         $type->createdby = $USER->id;
1009     }
1011     if (!isset($type->course)) {
1012         $type->course = $SITE->id;
1013     }
1015     //Create a salt value to be used for signing passed data to extension services
1016     //The outcome service uses the service salt on the instance. This can be used
1017     //for communication with services not related to a specific LTI instance.
1018     $config->lti_servicesalt = uniqid('', true);
1020     $id = $DB->insert_record('lti_types', $type);
1022     if ($id) {
1023         foreach ($config as $key => $value) {
1024             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
1025                 $record = new StdClass();
1026                 $record->typeid = $id;
1027                 $record->name = substr($key, 4);
1028                 $record->value = $value;
1030                 lti_add_config($record);
1031             }
1032         }
1033     }
1035     return $id;
1038 /**
1039  * Add a tool configuration in the database
1040  *
1041  * @param $config   Tool configuration
1042  *
1043  * @return int Record id number
1044  */
1045 function lti_add_config($config) {
1046     global $DB;
1048     return $DB->insert_record('lti_types_config', $config);
1051 /**
1052  * Updates a tool configuration in the database
1053  *
1054  * @param $config   Tool configuration
1055  *
1056  * @return Record id number
1057  */
1058 function lti_update_config($config) {
1059     global $DB;
1061     $return = true;
1062     $old = $DB->get_record('lti_types_config', array('typeid' => $config->typeid, 'name' => $config->name));
1064     if ($old) {
1065         $config->id = $old->id;
1066         $return = $DB->update_record('lti_types_config', $config);
1067     } else {
1068         $return = $DB->insert_record('lti_types_config', $config);
1069     }
1070     return $return;
1073 /**
1074  * Signs the petition to launch the external tool using OAuth
1075  *
1076  * @param $oldparms     Parameters to be passed for signing
1077  * @param $endpoint     url of the external tool
1078  * @param $method       Method for sending the parameters (e.g. POST)
1079  * @param $oauth_consumoer_key          Key
1080  * @param $oauth_consumoer_secret       Secret
1081  * @param $submittext  The text for the submit button
1082  * @param $orgid       LMS name
1083  * @param $orgdesc     LMS key
1084  */
1085 function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret) {
1086     //global $lastbasestring;
1087     $parms = $oldparms;
1089     $testtoken = '';
1091     // TODO: Switch to core oauthlib once implemented - MDL-30149
1092     $hmacmethod = new lti\OAuthSignatureMethod_HMAC_SHA1();
1093     $testconsumer = new lti\OAuthConsumer($oauthconsumerkey, $oauthconsumersecret, null);
1094     $accreq = lti\OAuthRequest::from_consumer_and_token($testconsumer, $testtoken, $method, $endpoint, $parms);
1095     $accreq->sign_request($hmacmethod, $testconsumer, $testtoken);
1097     // Pass this back up "out of band" for debugging
1098     //$lastbasestring = $accreq->get_signature_base_string();
1100     $newparms = $accreq->get_parameters();
1102     return $newparms;
1105 /**
1106  * Posts the launch petition HTML
1107  *
1108  * @param $newparms     Signed parameters
1109  * @param $endpoint     URL of the external tool
1110  * @param $debug        Debug (true/false)
1111  */
1112 function lti_post_launch_html($newparms, $endpoint, $debug=false) {
1113     $r = "<form action=\"".$endpoint."\" name=\"ltiLaunchForm\" id=\"ltiLaunchForm\" method=\"post\" encType=\"application/x-www-form-urlencoded\">\n";
1115     $submittext = $newparms['ext_submit'];
1117     // Contruct html for the launch parameters
1118     foreach ($newparms as $key => $value) {
1119         $key = htmlspecialchars($key);
1120         $value = htmlspecialchars($value);
1121         if ( $key == "ext_submit" ) {
1122             $r .= "<input type=\"submit\" name=\"";
1123         } else {
1124             $r .= "<input type=\"hidden\" name=\"";
1125         }
1126         $r .= $key;
1127         $r .= "\" value=\"";
1128         $r .= $value;
1129         $r .= "\"/>\n";
1130     }
1132     if ( $debug ) {
1133         $r .= "<script language=\"javascript\"> \n";
1134         $r .= "  //<![CDATA[ \n";
1135         $r .= "function basicltiDebugToggle() {\n";
1136         $r .= "    var ele = document.getElementById(\"basicltiDebug\");\n";
1137         $r .= "    if (ele.style.display == \"block\") {\n";
1138         $r .= "        ele.style.display = \"none\";\n";
1139         $r .= "    }\n";
1140         $r .= "    else {\n";
1141         $r .= "        ele.style.display = \"block\";\n";
1142         $r .= "    }\n";
1143         $r .= "} \n";
1144         $r .= "  //]]> \n";
1145         $r .= "</script>\n";
1146         $r .= "<a id=\"displayText\" href=\"javascript:basicltiDebugToggle();\">";
1147         $r .= get_string("toggle_debug_data", "lti")."</a>\n";
1148         $r .= "<div id=\"basicltiDebug\" style=\"display:none\">\n";
1149         $r .=  "<b>".get_string("basiclti_endpoint", "lti")."</b><br/>\n";
1150         $r .= $endpoint . "<br/>\n&nbsp;<br/>\n";
1151         $r .=  "<b>".get_string("basiclti_parameters", "lti")."</b><br/>\n";
1152         foreach ($newparms as $key => $value) {
1153             $key = htmlspecialchars($key);
1154             $value = htmlspecialchars($value);
1155             $r .= "$key = $value<br/>\n";
1156         }
1157         $r .= "&nbsp;<br/>\n";
1158         //$r .= "<p><b>".get_string("basiclti_base_string", "lti")."</b><br/>\n".$lastbasestring."</p>\n";
1159         $r .= "</div>\n";
1160     }
1161     $r .= "</form>\n";
1163     if ( ! $debug ) {
1164         $ext_submit = "ext_submit";
1165         $ext_submit_text = $submittext;
1166         $r .= " <script type=\"text/javascript\"> \n" .
1167             "  //<![CDATA[ \n" .
1168             "    document.getElementById(\"ltiLaunchForm\").style.display = \"none\";\n" .
1169             "    nei = document.createElement('input');\n" .
1170             "    nei.setAttribute('type', 'hidden');\n" .
1171             "    nei.setAttribute('name', '".$ext_submit."');\n" .
1172             "    nei.setAttribute('value', '".$ext_submit_text."');\n" .
1173             "    document.getElementById(\"ltiLaunchForm\").appendChild(nei);\n" .
1174             "    document.ltiLaunchForm.submit(); \n" .
1175             "  //]]> \n" .
1176             " </script> \n";
1177     }
1178     return $r;
1181 function lti_get_type($typeid) {
1182     global $DB;
1184     return $DB->get_record('lti_types', array('id' => $typeid));
1187 function lti_get_launch_container($lti, $toolconfig) {
1188     if (empty($lti->launchcontainer)) {
1189         $lti->launchcontainer = LTI_LAUNCH_CONTAINER_DEFAULT;
1190     }
1192     if ($lti->launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1193         if (isset($toolconfig['launchcontainer'])) {
1194             $launchcontainer = $toolconfig['launchcontainer'];
1195         }
1196     } else {
1197         $launchcontainer = $lti->launchcontainer;
1198     }
1200     if (empty($launchcontainer) || $launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1201         $launchcontainer = LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS;
1202     }
1204     $devicetype = core_useragent::get_device_type();
1206     //Scrolling within the object element doesn't work on iOS or Android
1207     //Opening the popup window also had some issues in testing
1208     //For mobile devices, always take up the entire screen to ensure the best experience
1209     if ($devicetype === core_useragent::DEVICETYPE_MOBILE || $devicetype === core_useragent::DEVICETYPE_TABLET ) {
1210         $launchcontainer = LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW;
1211     }
1213     return $launchcontainer;
1216 function lti_request_is_using_ssl() {
1217     global $CFG;
1218     return (stripos($CFG->httpswwwroot, 'https://') === 0);
1221 function lti_ensure_url_is_https($url) {
1222     if (!strstr($url, '://')) {
1223         $url = 'https://' . $url;
1224     } else {
1225         //If the URL starts with http, replace with https
1226         if (stripos($url, 'http://') === 0) {
1227             $url = 'https://' . substr($url, 7);
1228         }
1229     }
1231     return $url;
1234 /**
1235  * Determines if we should try to log the request
1236  *
1237  * @param string $rawbody
1238  * @return bool
1239  */
1240 function lti_should_log_request($rawbody) {
1241     global $CFG;
1243     if (empty($CFG->mod_lti_log_users)) {
1244         return false;
1245     }
1247     $logusers = explode(',', $CFG->mod_lti_log_users);
1248     if (empty($logusers)) {
1249         return false;
1250     }
1252     try {
1253         $xml = new SimpleXMLElement($rawbody);
1254         $ns  = $xml->getNamespaces();
1255         $ns  = array_shift($ns);
1256         $xml->registerXPathNamespace('lti', $ns);
1257         $requestuserid = '';
1258         if ($node = $xml->xpath('//lti:userId')) {
1259             $node = $node[0];
1260             $requestuserid = clean_param((string) $node, PARAM_INT);
1261         } else if ($node = $xml->xpath('//lti:sourcedId')) {
1262             $node = $node[0];
1263             $resultjson = json_decode((string) $node);
1264             $requestuserid = clean_param($resultjson->data->userid, PARAM_INT);
1265         }
1266     } catch (Exception $e) {
1267         return false;
1268     }
1270     if (empty($requestuserid) or !in_array($requestuserid, $logusers)) {
1271         return false;
1272     }
1274     return true;
1277 /**
1278  * Logs the request to a file in temp dir
1279  *
1280  * @param string $rawbody
1281  */
1282 function lti_log_request($rawbody) {
1283     if ($tempdir = make_temp_directory('mod_lti', false)) {
1284         if ($tempfile = tempnam($tempdir, 'mod_lti_request'.date('YmdHis'))) {
1285             file_put_contents($tempfile, $rawbody);
1286             chmod($tempfile, 0644);
1287         }
1288     }
1291 /**
1292  * Fetches LTI type configuration for an LTI instance
1293  *
1294  * @param stdClass $instance
1295  * @return array Can be empty if no type is found
1296  */
1297 function lti_get_type_config_by_instance($instance) {
1298     $typeid = null;
1299     if (empty($instance->typeid)) {
1300         $tool = lti_get_tool_by_url_match($instance->toolurl, $instance->course);
1301         if ($tool) {
1302             $typeid = $tool->id;
1303         }
1304     } else {
1305         $typeid = $instance->typeid;
1306     }
1307     if (!empty($typeid)) {
1308         return lti_get_type_config($typeid);
1309     }
1310     return array();
1313 /**
1314  * Enforce type config settings onto the LTI instance
1315  *
1316  * @param stdClass $instance
1317  * @param array $typeconfig
1318  */
1319 function lti_force_type_config_settings($instance, array $typeconfig) {
1320     $forced = array(
1321         'instructorchoicesendname'      => 'sendname',
1322         'instructorchoicesendemailaddr' => 'sendemailaddr',
1323         'instructorchoiceacceptgrades'  => 'acceptgrades',
1324     );
1326     foreach ($forced as $instanceparam => $typeconfigparam) {
1327         if (array_key_exists($typeconfigparam, $typeconfig) && $typeconfig[$typeconfigparam] != LTI_SETTING_DELEGATE) {
1328             $instance->$instanceparam = $typeconfig[$typeconfigparam];
1329         }
1330     }