Merge branch 'MDL-45445_master' of https://github.com/markn86/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     }
337     if ( $typeconfig['sendemailaddr'] == LTI_SETTING_ALWAYS ||
338          ( $typeconfig['sendemailaddr'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendemailaddr == LTI_SETTING_ALWAYS ) ) {
339         $requestparams['lis_person_contact_email_primary'] = $USER->email;
340     }
342     // Concatenate the custom parameters from the administrator and the instructor
343     // Instructor parameters are only taken into consideration if the administrator
344     // has giver permission
345     $customstr = $typeconfig['customparameters'];
346     $instructorcustomstr = $instance->instructorcustomparameters;
347     $custom = array();
348     $instructorcustom = array();
349     if ($customstr) {
350         $custom = lti_split_custom_parameters($customstr);
351     }
352     if (isset($typeconfig['allowinstructorcustom']) && $typeconfig['allowinstructorcustom'] == LTI_SETTING_NEVER) {
353         $requestparams = array_merge($custom, $requestparams);
354     } else {
355         if ($instructorcustomstr) {
356             $instructorcustom = lti_split_custom_parameters($instructorcustomstr);
357         }
358         foreach ($instructorcustom as $key => $val) {
359             // Ignore the instructor's parameter
360             if (!array_key_exists($key, $custom)) {
361                 $custom[$key] = $val;
362             }
363         }
364         $requestparams = array_merge($custom, $requestparams);
365     }
367     // Make sure we let the tool know what LMS they are being called from
368     $requestparams["ext_lms"] = "moodle-2";
369     $requestparams['tool_consumer_info_product_family_code'] = 'moodle';
370     $requestparams['tool_consumer_info_version'] = strval($CFG->version);
372     // Add oauth_callback to be compliant with the 1.0A spec
373     $requestparams['oauth_callback'] = 'about:blank';
375     //The submit button needs to be part of the signature as it gets posted with the form.
376     //This needs to be here to support launching without javascript.
377     $submittext = get_string('press_to_submit', 'lti');
378     $requestparams['ext_submit'] = $submittext;
380     $requestparams['lti_version'] = 'LTI-1p0';
381     $requestparams['lti_message_type'] = 'basic-lti-launch-request';
383     return $requestparams;
386 function lti_get_tool_table($tools, $id) {
387     global $CFG, $OUTPUT, $USER;
388     $html = '';
390     $typename = get_string('typename', 'lti');
391     $baseurl = get_string('baseurl', 'lti');
392     $action = get_string('action', 'lti');
393     $createdon = get_string('createdon', 'lti');
395     if ($id == 'lti_configured') {
396         $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>';
397     }
399     if (!empty($tools)) {
400         $html .= "
401         <div id=\"{$id}_container\" style=\"margin-top:.5em;margin-bottom:.5em\">
402             <table id=\"{$id}_tools\">
403                 <thead>
404                     <tr>
405                         <th>$typename</th>
406                         <th>$baseurl</th>
407                         <th>$createdon</th>
408                         <th>$action</th>
409                     </tr>
410                 </thead>
411         ";
413         foreach ($tools as $type) {
414             $date = userdate($type->timecreated, get_string('strftimedatefullshort', 'core_langconfig'));
415             $accept = get_string('accept', 'lti');
416             $update = get_string('update', 'lti');
417             $delete = get_string('delete', 'lti');
419             $baseurl = new moodle_url('/mod/lti/typessettings.php', array(
420                     'action' => 'accept',
421                     'id' => $type->id,
422                     'sesskey' => sesskey(),
423                     'tab' => $id
424                 ));
426             $accepthtml = $OUTPUT->action_icon($baseurl,
427                     new pix_icon('t/check', $accept, '', array('class' => 'iconsmall')), null,
428                     array('title' => $accept, 'class' => 'editing_accept'));
430             $deleteaction = 'delete';
432             if ($type->state == LTI_TOOL_STATE_CONFIGURED) {
433                 $accepthtml = '';
434             }
436             if ($type->state != LTI_TOOL_STATE_REJECTED) {
437                 $deleteaction = 'reject';
438                 $delete = get_string('reject', 'lti');
439             }
441             $updateurl = clone($baseurl);
442             $updateurl->param('action', 'update');
443             $updatehtml = $OUTPUT->action_icon($updateurl,
444                     new pix_icon('t/edit', $update, '', array('class' => 'iconsmall')), null,
445                     array('title' => $update, 'class' => 'editing_update'));
447             $deleteurl = clone($baseurl);
448             $deleteurl->param('action', $deleteaction);
449             $deletehtml = $OUTPUT->action_icon($deleteurl,
450                     new pix_icon('t/delete', $delete, '', array('class' => 'iconsmall')), null,
451                     array('title' => $delete, 'class' => 'editing_delete'));
452             $html .= "
453             <tr>
454                 <td>
455                     {$type->name}
456                 </td>
457                 <td>
458                     {$type->baseurl}
459                 </td>
460                 <td>
461                     {$date}
462                 </td>
463                 <td align=\"center\">
464                     {$accepthtml}{$updatehtml}{$deletehtml}
465                 </td>
466             </tr>
467             ";
468         }
469         $html .= '</table></div>';
470     } else {
471         $html .= get_string('no_' . $id, 'lti');
472     }
474     return $html;
477 /**
478  * Splits the custom parameters field to the various parameters
479  *
480  * @param string $customstr     String containing the parameters
481  *
482  * @return Array of custom parameters
483  */
484 function lti_split_custom_parameters($customstr) {
485     $lines = preg_split("/[\n;]/", $customstr);
486     $retval = array();
487     foreach ($lines as $line) {
488         $pos = strpos($line, "=");
489         if ( $pos === false || $pos < 1 ) {
490             continue;
491         }
492         $key = trim(core_text::substr($line, 0, $pos));
493         $val = trim(core_text::substr($line, $pos+1, strlen($line)));
494         $key = lti_map_keyname($key);
495         $retval['custom_'.$key] = $val;
496     }
497     return $retval;
500 /**
501  * Used for building the names of the different custom parameters
502  *
503  * @param string $key   Parameter name
504  *
505  * @return string       Processed name
506  */
507 function lti_map_keyname($key) {
508     $newkey = "";
509     $key = core_text::strtolower(trim($key));
510     foreach (str_split($key) as $ch) {
511         if ( ($ch >= 'a' && $ch <= 'z') || ($ch >= '0' && $ch <= '9') ) {
512             $newkey .= $ch;
513         } else {
514             $newkey .= '_';
515         }
516     }
517     return $newkey;
520 /**
521  * Gets the IMS role string for the specified user and LTI course module.
522  *
523  * @param mixed $user User object or user id
524  * @param int $cmid The course module id of the LTI activity
525  * @return string A role string suitable for passing with an LTI launch
526  */
527 function lti_get_ims_role($user, $cmid, $courseid) {
528     $roles = array();
530     if (empty($cmid)) {
531         //If no cmid is passed, check if the user is a teacher in the course
532         //This allows other modules to programmatically "fake" a launch without
533         //a real LTI instance
534         $coursecontext = context_course::instance($courseid);
536         if (has_capability('moodle/course:manageactivities', $coursecontext)) {
537             array_push($roles, 'Instructor');
538         } else {
539             array_push($roles, 'Learner');
540         }
541     } else {
542         $context = context_module::instance($cmid);
544         if (has_capability('mod/lti:manage', $context)) {
545             array_push($roles, 'Instructor');
546         } else {
547             array_push($roles, 'Learner');
548         }
549     }
551     if (is_siteadmin($user)) {
552         array_push($roles, 'urn:lti:sysrole:ims/lis/Administrator', 'urn:lti:instrole:ims/lis/Administrator');
553     }
555     return join(',', $roles);
558 /**
559  * Returns configuration details for the tool
560  *
561  * @param int $typeid   Basic LTI tool typeid
562  *
563  * @return array        Tool Configuration
564  */
565 function lti_get_type_config($typeid) {
566     global $DB;
568     $query = "SELECT name, value
569                 FROM {lti_types_config}
570                WHERE typeid = :typeid1
571            UNION ALL
572               SELECT 'toolurl' AS name, " . $DB->sql_compare_text('baseurl', 1333) . " AS value
573                 FROM {lti_types}
574                WHERE id = :typeid2";
576     $typeconfig = array();
577     $configs = $DB->get_records_sql($query, array('typeid1' => $typeid, 'typeid2' => $typeid));
579     if (!empty($configs)) {
580         foreach ($configs as $config) {
581             $typeconfig[$config->name] = $config->value;
582         }
583     }
585     return $typeconfig;
588 function lti_get_tools_by_url($url, $state, $courseid = null) {
589     $domain = lti_get_domain_from_url($url);
591     return lti_get_tools_by_domain($domain, $state, $courseid);
594 function lti_get_tools_by_domain($domain, $state = null, $courseid = null) {
595     global $DB, $SITE;
597     $filters = array('tooldomain' => $domain);
599     $statefilter = '';
600     $coursefilter = '';
602     if ($state) {
603         $statefilter = 'AND state = :state';
604     }
606     if ($courseid && $courseid != $SITE->id) {
607         $coursefilter = 'OR course = :courseid';
608     }
610     $query = "SELECT *
611                 FROM {lti_types}
612                WHERE tooldomain = :tooldomain
613                  AND (course = :siteid $coursefilter)
614                  $statefilter";
616     return $DB->get_records_sql($query, array(
617         'courseid' => $courseid,
618         'siteid' => $SITE->id,
619         'tooldomain' => $domain,
620         'state' => $state
621     ));
624 /**
625  * Returns all basicLTI tools configured by the administrator
626  *
627  */
628 function lti_filter_get_types($course) {
629     global $DB;
631     if (!empty($course)) {
632         $filter = array('course' => $course);
633     } else {
634         $filter = array();
635     }
637     return $DB->get_records('lti_types', $filter);
640 /**
641  * Given an array of tools, filter them based on their state
642  *
643  * @param array $tools An array of lti_types records
644  * @param int $state One of the LTI_TOOL_STATE_* constants
645  * @return array
646  */
647 function lti_filter_tool_types(array $tools, $state) {
648     $return = array();
649     foreach ($tools as $key => $tool) {
650         if ($tool->state == $state) {
651             $return[$key] = $tool;
652         }
653     }
654     return $return;
657 function lti_get_types_for_add_instance() {
658     global $DB, $SITE, $COURSE;
660     $query = "SELECT *
661                 FROM {lti_types}
662                WHERE coursevisible = 1
663                  AND (course = :siteid OR course = :courseid)
664                  AND state = :active";
666     $admintypes = $DB->get_records_sql($query, array('siteid' => $SITE->id, 'courseid' => $COURSE->id, 'active' => LTI_TOOL_STATE_CONFIGURED));
668     $types = array();
669     $types[0] = (object)array('name' => get_string('automatic', 'lti'), 'course' => 0);
671     foreach ($admintypes as $type) {
672         $types[$type->id] = $type;
673     }
675     return $types;
678 function lti_get_domain_from_url($url) {
679     $matches = array();
681     if (preg_match(LTI_URL_DOMAIN_REGEX, $url, $matches)) {
682         return $matches[1];
683     }
686 function lti_get_tool_by_url_match($url, $courseid = null, $state = LTI_TOOL_STATE_CONFIGURED) {
687     $possibletools = lti_get_tools_by_url($url, $state, $courseid);
689     return lti_get_best_tool_by_url($url, $possibletools, $courseid);
692 function lti_get_url_thumbprint($url) {
693     // Parse URL requires a schema otherwise everything goes into 'path'.  Fixed 5.4.7 or later.
694     if (preg_match('/https?:\/\//', $url) !== 1) {
695         $url = 'http://'.$url;
696     }
697     $urlparts = parse_url(strtolower($url));
698     if (!isset($urlparts['path'])) {
699         $urlparts['path'] = '';
700     }
702     if (!isset($urlparts['host'])) {
703         $urlparts['host'] = '';
704     }
706     if (substr($urlparts['host'], 0, 4) === 'www.') {
707         $urlparts['host'] = substr($urlparts['host'], 4);
708     }
710     return $urllower = $urlparts['host'] . '/' . $urlparts['path'];
713 function lti_get_best_tool_by_url($url, $tools, $courseid = null) {
714     if (count($tools) === 0) {
715         return null;
716     }
718     $urllower = lti_get_url_thumbprint($url);
720     foreach ($tools as $tool) {
721         $tool->_matchscore = 0;
723         $toolbaseurllower = lti_get_url_thumbprint($tool->baseurl);
725         if ($urllower === $toolbaseurllower) {
726             //100 points for exact thumbprint match
727             $tool->_matchscore += 100;
728         } else if (substr($urllower, 0, strlen($toolbaseurllower)) === $toolbaseurllower) {
729             //50 points if tool thumbprint starts with the base URL thumbprint
730             $tool->_matchscore += 50;
731         }
733         //Prefer course tools over site tools
734         if (!empty($courseid)) {
735             //Minus 10 points for not matching the course id (global tools)
736             if ($tool->course != $courseid) {
737                 $tool->_matchscore -= 10;
738             }
739         }
740     }
742     $bestmatch = array_reduce($tools, function($value, $tool) {
743         if ($tool->_matchscore > $value->_matchscore) {
744             return $tool;
745         } else {
746             return $value;
747         }
749     }, (object)array('_matchscore' => -1));
751     //None of the tools are suitable for this URL
752     if ($bestmatch->_matchscore <= 0) {
753         return null;
754     }
756     return $bestmatch;
759 function lti_get_shared_secrets_by_key($key) {
760     global $DB;
762     //Look up the shared secret for the specified key in both the types_config table (for configured tools)
763     //And in the lti resource table for ad-hoc tools
764     $query = "SELECT t2.value
765                 FROM {lti_types_config} t1
766                 JOIN {lti_types_config} t2 ON t1.typeid = t2.typeid
767                 JOIN {lti_types} type ON t2.typeid = type.id
768               WHERE t1.name = 'resourcekey'
769                 AND t1.value = :key1
770                 AND t2.name = 'password'
771                 AND type.state = :configured
772               UNION
773              SELECT password AS value
774                FROM {lti}
775               WHERE resourcekey = :key2";
777     $sharedsecrets = $DB->get_records_sql($query, array('configured' => LTI_TOOL_STATE_CONFIGURED, 'key1' => $key, 'key2' => $key));
779     $values = array_map(function($item) {
780         return $item->value;
781     }, $sharedsecrets);
783     //There should really only be one shared secret per key. But, we can't prevent
784     //more than one getting entered. For instance, if the same key is used for two tool providers.
785     return $values;
788 /**
789  * Delete a Basic LTI configuration
790  *
791  * @param int $id   Configuration id
792  */
793 function lti_delete_type($id) {
794     global $DB;
796     //We should probably just copy the launch URL to the tool instances in this case... using a single query
797     /*
798     $instances = $DB->get_records('lti', array('typeid' => $id));
799     foreach ($instances as $instance) {
800         $instance->typeid = 0;
801         $DB->update_record('lti', $instance);
802     }*/
804     $DB->delete_records('lti_types', array('id' => $id));
805     $DB->delete_records('lti_types_config', array('typeid' => $id));
808 function lti_set_state_for_type($id, $state) {
809     global $DB;
811     $DB->update_record('lti_types', array('id' => $id, 'state' => $state));
814 /**
815  * Transforms a basic LTI object to an array
816  *
817  * @param object $ltiobject    Basic LTI object
818  *
819  * @return array Basic LTI configuration details
820  */
821 function lti_get_config($ltiobject) {
822     $typeconfig = array();
823     $typeconfig = (array)$ltiobject;
824     $additionalconfig = lti_get_type_config($ltiobject->typeid);
825     $typeconfig = array_merge($typeconfig, $additionalconfig);
826     return $typeconfig;
829 /**
830  *
831  * Generates some of the tool configuration based on the instance details
832  *
833  * @param int $id
834  *
835  * @return Instance configuration
836  *
837  */
838 function lti_get_type_config_from_instance($id) {
839     global $DB;
841     $instance = $DB->get_record('lti', array('id' => $id));
842     $config = lti_get_config($instance);
844     $type = new stdClass();
845     $type->lti_fix = $id;
846     if (isset($config['toolurl'])) {
847         $type->lti_toolurl = $config['toolurl'];
848     }
849     if (isset($config['instructorchoicesendname'])) {
850         $type->lti_sendname = $config['instructorchoicesendname'];
851     }
852     if (isset($config['instructorchoicesendemailaddr'])) {
853         $type->lti_sendemailaddr = $config['instructorchoicesendemailaddr'];
854     }
855     if (isset($config['instructorchoiceacceptgrades'])) {
856         $type->lti_acceptgrades = $config['instructorchoiceacceptgrades'];
857     }
858     if (isset($config['instructorchoiceallowroster'])) {
859         $type->lti_allowroster = $config['instructorchoiceallowroster'];
860     }
862     if (isset($config['instructorcustomparameters'])) {
863         $type->lti_allowsetting = $config['instructorcustomparameters'];
864     }
865     return $type;
868 /**
869  * Generates some of the tool configuration based on the admin configuration details
870  *
871  * @param int $id
872  *
873  * @return Configuration details
874  */
875 function lti_get_type_type_config($id) {
876     global $DB;
878     $basicltitype = $DB->get_record('lti_types', array('id' => $id));
879     $config = lti_get_type_config($id);
881     $type = new stdClass();
883     $type->lti_typename = $basicltitype->name;
885     $type->typeid = $basicltitype->id;
887     $type->lti_toolurl = $basicltitype->baseurl;
889     if (isset($config['resourcekey'])) {
890         $type->lti_resourcekey = $config['resourcekey'];
891     }
892     if (isset($config['password'])) {
893         $type->lti_password = $config['password'];
894     }
896     if (isset($config['sendname'])) {
897         $type->lti_sendname = $config['sendname'];
898     }
899     if (isset($config['instructorchoicesendname'])) {
900         $type->lti_instructorchoicesendname = $config['instructorchoicesendname'];
901     }
902     if (isset($config['sendemailaddr'])) {
903         $type->lti_sendemailaddr = $config['sendemailaddr'];
904     }
905     if (isset($config['instructorchoicesendemailaddr'])) {
906         $type->lti_instructorchoicesendemailaddr = $config['instructorchoicesendemailaddr'];
907     }
908     if (isset($config['acceptgrades'])) {
909         $type->lti_acceptgrades = $config['acceptgrades'];
910     }
911     if (isset($config['instructorchoiceacceptgrades'])) {
912         $type->lti_instructorchoiceacceptgrades = $config['instructorchoiceacceptgrades'];
913     }
914     if (isset($config['allowroster'])) {
915         $type->lti_allowroster = $config['allowroster'];
916     }
917     if (isset($config['instructorchoiceallowroster'])) {
918         $type->lti_instructorchoiceallowroster = $config['instructorchoiceallowroster'];
919     }
921     if (isset($config['customparameters'])) {
922         $type->lti_customparameters = $config['customparameters'];
923     }
925     if (isset($config['forcessl'])) {
926         $type->lti_forcessl = $config['forcessl'];
927     }
929     if (isset($config['organizationid'])) {
930         $type->lti_organizationid = $config['organizationid'];
931     }
932     if (isset($config['organizationurl'])) {
933         $type->lti_organizationurl = $config['organizationurl'];
934     }
935     if (isset($config['organizationdescr'])) {
936         $type->lti_organizationdescr = $config['organizationdescr'];
937     }
938     if (isset($config['launchcontainer'])) {
939         $type->lti_launchcontainer = $config['launchcontainer'];
940     }
942     if (isset($config['coursevisible'])) {
943         $type->lti_coursevisible = $config['coursevisible'];
944     }
946     if (isset($config['debuglaunch'])) {
947         $type->lti_debuglaunch = $config['debuglaunch'];
948     }
950     if (isset($config['module_class_type'])) {
951         $type->lti_module_class_type = $config['module_class_type'];
952     }
954     return $type;
957 function lti_prepare_type_for_save($type, $config) {
958     $type->baseurl = $config->lti_toolurl;
959     $type->tooldomain = lti_get_domain_from_url($config->lti_toolurl);
960     $type->name = $config->lti_typename;
962     $type->coursevisible = !empty($config->lti_coursevisible) ? $config->lti_coursevisible : 0;
963     $config->lti_coursevisible = $type->coursevisible;
965     $type->forcessl = !empty($config->lti_forcessl) ? $config->lti_forcessl : 0;
966     $config->lti_forcessl = $type->forcessl;
968     $type->timemodified = time();
970     unset ($config->lti_typename);
971     unset ($config->lti_toolurl);
974 function lti_update_type($type, $config) {
975     global $DB;
977     lti_prepare_type_for_save($type, $config);
979     if ($DB->update_record('lti_types', $type)) {
980         foreach ($config as $key => $value) {
981             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
982                 $record = new StdClass();
983                 $record->typeid = $type->id;
984                 $record->name = substr($key, 4);
985                 $record->value = $value;
987                 lti_update_config($record);
988             }
989         }
990     }
993 function lti_add_type($type, $config) {
994     global $USER, $SITE, $DB;
996     lti_prepare_type_for_save($type, $config);
998     if (!isset($type->state)) {
999         $type->state = LTI_TOOL_STATE_PENDING;
1000     }
1002     if (!isset($type->timecreated)) {
1003         $type->timecreated = time();
1004     }
1006     if (!isset($type->createdby)) {
1007         $type->createdby = $USER->id;
1008     }
1010     if (!isset($type->course)) {
1011         $type->course = $SITE->id;
1012     }
1014     //Create a salt value to be used for signing passed data to extension services
1015     //The outcome service uses the service salt on the instance. This can be used
1016     //for communication with services not related to a specific LTI instance.
1017     $config->lti_servicesalt = uniqid('', true);
1019     $id = $DB->insert_record('lti_types', $type);
1021     if ($id) {
1022         foreach ($config as $key => $value) {
1023             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
1024                 $record = new StdClass();
1025                 $record->typeid = $id;
1026                 $record->name = substr($key, 4);
1027                 $record->value = $value;
1029                 lti_add_config($record);
1030             }
1031         }
1032     }
1034     return $id;
1037 /**
1038  * Add a tool configuration in the database
1039  *
1040  * @param $config   Tool configuration
1041  *
1042  * @return int Record id number
1043  */
1044 function lti_add_config($config) {
1045     global $DB;
1047     return $DB->insert_record('lti_types_config', $config);
1050 /**
1051  * Updates a tool configuration in the database
1052  *
1053  * @param $config   Tool configuration
1054  *
1055  * @return Record id number
1056  */
1057 function lti_update_config($config) {
1058     global $DB;
1060     $return = true;
1061     $old = $DB->get_record('lti_types_config', array('typeid' => $config->typeid, 'name' => $config->name));
1063     if ($old) {
1064         $config->id = $old->id;
1065         $return = $DB->update_record('lti_types_config', $config);
1066     } else {
1067         $return = $DB->insert_record('lti_types_config', $config);
1068     }
1069     return $return;
1072 /**
1073  * Signs the petition to launch the external tool using OAuth
1074  *
1075  * @param $oldparms     Parameters to be passed for signing
1076  * @param $endpoint     url of the external tool
1077  * @param $method       Method for sending the parameters (e.g. POST)
1078  * @param $oauth_consumoer_key          Key
1079  * @param $oauth_consumoer_secret       Secret
1080  * @param $submittext  The text for the submit button
1081  * @param $orgid       LMS name
1082  * @param $orgdesc     LMS key
1083  */
1084 function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret) {
1085     //global $lastbasestring;
1086     $parms = $oldparms;
1088     $testtoken = '';
1090     // TODO: Switch to core oauthlib once implemented - MDL-30149
1091     $hmacmethod = new lti\OAuthSignatureMethod_HMAC_SHA1();
1092     $testconsumer = new lti\OAuthConsumer($oauthconsumerkey, $oauthconsumersecret, null);
1093     $accreq = lti\OAuthRequest::from_consumer_and_token($testconsumer, $testtoken, $method, $endpoint, $parms);
1094     $accreq->sign_request($hmacmethod, $testconsumer, $testtoken);
1096     // Pass this back up "out of band" for debugging
1097     //$lastbasestring = $accreq->get_signature_base_string();
1099     $newparms = $accreq->get_parameters();
1101     return $newparms;
1104 /**
1105  * Posts the launch petition HTML
1106  *
1107  * @param $newparms     Signed parameters
1108  * @param $endpoint     URL of the external tool
1109  * @param $debug        Debug (true/false)
1110  */
1111 function lti_post_launch_html($newparms, $endpoint, $debug=false) {
1112     $r = "<form action=\"".$endpoint."\" name=\"ltiLaunchForm\" id=\"ltiLaunchForm\" method=\"post\" encType=\"application/x-www-form-urlencoded\">\n";
1114     $submittext = $newparms['ext_submit'];
1116     // Contruct html for the launch parameters
1117     foreach ($newparms as $key => $value) {
1118         $key = htmlspecialchars($key);
1119         $value = htmlspecialchars($value);
1120         if ( $key == "ext_submit" ) {
1121             $r .= "<input type=\"submit\" name=\"";
1122         } else {
1123             $r .= "<input type=\"hidden\" name=\"";
1124         }
1125         $r .= $key;
1126         $r .= "\" value=\"";
1127         $r .= $value;
1128         $r .= "\"/>\n";
1129     }
1131     if ( $debug ) {
1132         $r .= "<script language=\"javascript\"> \n";
1133         $r .= "  //<![CDATA[ \n";
1134         $r .= "function basicltiDebugToggle() {\n";
1135         $r .= "    var ele = document.getElementById(\"basicltiDebug\");\n";
1136         $r .= "    if (ele.style.display == \"block\") {\n";
1137         $r .= "        ele.style.display = \"none\";\n";
1138         $r .= "    }\n";
1139         $r .= "    else {\n";
1140         $r .= "        ele.style.display = \"block\";\n";
1141         $r .= "    }\n";
1142         $r .= "} \n";
1143         $r .= "  //]]> \n";
1144         $r .= "</script>\n";
1145         $r .= "<a id=\"displayText\" href=\"javascript:basicltiDebugToggle();\">";
1146         $r .= get_string("toggle_debug_data", "lti")."</a>\n";
1147         $r .= "<div id=\"basicltiDebug\" style=\"display:none\">\n";
1148         $r .=  "<b>".get_string("basiclti_endpoint", "lti")."</b><br/>\n";
1149         $r .= $endpoint . "<br/>\n&nbsp;<br/>\n";
1150         $r .=  "<b>".get_string("basiclti_parameters", "lti")."</b><br/>\n";
1151         foreach ($newparms as $key => $value) {
1152             $key = htmlspecialchars($key);
1153             $value = htmlspecialchars($value);
1154             $r .= "$key = $value<br/>\n";
1155         }
1156         $r .= "&nbsp;<br/>\n";
1157         //$r .= "<p><b>".get_string("basiclti_base_string", "lti")."</b><br/>\n".$lastbasestring."</p>\n";
1158         $r .= "</div>\n";
1159     }
1160     $r .= "</form>\n";
1162     if ( ! $debug ) {
1163         $ext_submit = "ext_submit";
1164         $ext_submit_text = $submittext;
1165         $r .= " <script type=\"text/javascript\"> \n" .
1166             "  //<![CDATA[ \n" .
1167             "    document.getElementById(\"ltiLaunchForm\").style.display = \"none\";\n" .
1168             "    nei = document.createElement('input');\n" .
1169             "    nei.setAttribute('type', 'hidden');\n" .
1170             "    nei.setAttribute('name', '".$ext_submit."');\n" .
1171             "    nei.setAttribute('value', '".$ext_submit_text."');\n" .
1172             "    document.getElementById(\"ltiLaunchForm\").appendChild(nei);\n" .
1173             "    document.ltiLaunchForm.submit(); \n" .
1174             "  //]]> \n" .
1175             " </script> \n";
1176     }
1177     return $r;
1180 function lti_get_type($typeid) {
1181     global $DB;
1183     return $DB->get_record('lti_types', array('id' => $typeid));
1186 function lti_get_launch_container($lti, $toolconfig) {
1187     if (empty($lti->launchcontainer)) {
1188         $lti->launchcontainer = LTI_LAUNCH_CONTAINER_DEFAULT;
1189     }
1191     if ($lti->launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1192         if (isset($toolconfig['launchcontainer'])) {
1193             $launchcontainer = $toolconfig['launchcontainer'];
1194         }
1195     } else {
1196         $launchcontainer = $lti->launchcontainer;
1197     }
1199     if (empty($launchcontainer) || $launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1200         $launchcontainer = LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS;
1201     }
1203     $devicetype = core_useragent::get_device_type();
1205     //Scrolling within the object element doesn't work on iOS or Android
1206     //Opening the popup window also had some issues in testing
1207     //For mobile devices, always take up the entire screen to ensure the best experience
1208     if ($devicetype === core_useragent::DEVICETYPE_MOBILE || $devicetype === core_useragent::DEVICETYPE_TABLET ) {
1209         $launchcontainer = LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW;
1210     }
1212     return $launchcontainer;
1215 function lti_request_is_using_ssl() {
1216     global $CFG;
1217     return (stripos($CFG->httpswwwroot, 'https://') === 0);
1220 function lti_ensure_url_is_https($url) {
1221     if (!strstr($url, '://')) {
1222         $url = 'https://' . $url;
1223     } else {
1224         //If the URL starts with http, replace with https
1225         if (stripos($url, 'http://') === 0) {
1226             $url = 'https://' . substr($url, 7);
1227         }
1228     }
1230     return $url;
1233 /**
1234  * Determines if we should try to log the request
1235  *
1236  * @param string $rawbody
1237  * @return bool
1238  */
1239 function lti_should_log_request($rawbody) {
1240     global $CFG;
1242     if (empty($CFG->mod_lti_log_users)) {
1243         return false;
1244     }
1246     $logusers = explode(',', $CFG->mod_lti_log_users);
1247     if (empty($logusers)) {
1248         return false;
1249     }
1251     try {
1252         $xml = new SimpleXMLElement($rawbody);
1253         $ns  = $xml->getNamespaces();
1254         $ns  = array_shift($ns);
1255         $xml->registerXPathNamespace('lti', $ns);
1256         $requestuserid = '';
1257         if ($node = $xml->xpath('//lti:userId')) {
1258             $node = $node[0];
1259             $requestuserid = clean_param((string) $node, PARAM_INT);
1260         } else if ($node = $xml->xpath('//lti:sourcedId')) {
1261             $node = $node[0];
1262             $resultjson = json_decode((string) $node);
1263             $requestuserid = clean_param($resultjson->data->userid, PARAM_INT);
1264         }
1265     } catch (Exception $e) {
1266         return false;
1267     }
1269     if (empty($requestuserid) or !in_array($requestuserid, $logusers)) {
1270         return false;
1271     }
1273     return true;
1276 /**
1277  * Logs the request to a file in temp dir
1278  *
1279  * @param string $rawbody
1280  */
1281 function lti_log_request($rawbody) {
1282     if ($tempdir = make_temp_directory('mod_lti', false)) {
1283         if ($tempfile = tempnam($tempdir, 'mod_lti_request'.date('YmdHis'))) {
1284             file_put_contents($tempfile, $rawbody);
1285             chmod($tempfile, 0644);
1286         }
1287     }
1290 /**
1291  * Fetches LTI type configuration for an LTI instance
1292  *
1293  * @param stdClass $instance
1294  * @return array Can be empty if no type is found
1295  */
1296 function lti_get_type_config_by_instance($instance) {
1297     $typeid = null;
1298     if (empty($instance->typeid)) {
1299         $tool = lti_get_tool_by_url_match($instance->toolurl, $instance->course);
1300         if ($tool) {
1301             $typeid = $tool->id;
1302         }
1303     } else {
1304         $typeid = $instance->typeid;
1305     }
1306     if (!empty($typeid)) {
1307         return lti_get_type_config($typeid);
1308     }
1309     return array();
1312 /**
1313  * Enforce type config settings onto the LTI instance
1314  *
1315  * @param stdClass $instance
1316  * @param array $typeconfig
1317  */
1318 function lti_force_type_config_settings($instance, array $typeconfig) {
1319     $forced = array(
1320         'instructorchoicesendname'      => 'sendname',
1321         'instructorchoicesendemailaddr' => 'sendemailaddr',
1322         'instructorchoiceacceptgrades'  => 'acceptgrades',
1323     );
1325     foreach ($forced as $instanceparam => $typeconfigparam) {
1326         if (array_key_exists($typeconfigparam, $typeconfig) && $typeconfig[$typeconfigparam] != LTI_SETTING_DELEGATE) {
1327             $instance->$instanceparam = $typeconfig[$typeconfigparam];
1328         }
1329     }