MDL-20534 lti: Updating the tool consumer information strings to match newest spec...
[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
39  * @subpackage lti
40  * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
41  *  marc.alier@upc.edu
42  * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
43  * @author     Marc Alier
44  * @author     Jordi Piguillem
45  * @author     Nikolas Galanis
46  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
47  */
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);
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     }
162     if (empty($key) || empty($secret)) {
163         $returnurlparams['unsigned'] = '1';
165         //Add the return URL. We send the launch container along to help us avoid frames-within-frames when the user returns
166         $url = new moodle_url('/mod/lti/return.php', $returnurlparams);
167         $returnurl = $url->out(false);
169         if ($typeconfig['forcessl'] == '1') {
170             $returnurl = lti_ensure_url_is_https($returnurl);
171         }
173         $requestparams['launch_presentation_return_url'] = $returnurl;
174     }
176     if (!empty($key) && !empty($secret)) {
177         $parms = lti_sign_parameters($requestparams, $endpoint, "POST", $key, $secret);
178     } else {
179         //If no key and secret, do the launch unsigned.
180         $parms = $requestparams;
181     }
183     $debuglaunch = ( $instance->debuglaunch == 1 );
185     $content = lti_post_launch_html($parms, $endpoint, $debuglaunch);
187     echo $content;
190 function lti_build_sourcedid($instanceid, $userid, $launchid = null, $servicesalt) {
191     $data = new stdClass();
193     $data->instanceid = $instanceid;
194     $data->userid = $userid;
195     if (!empty($launchid)) {
196         $data->launchid = $launchid;
197     } else {
198         $data->launchid = mt_rand();
199     }
201     $json = json_encode($data);
203     $hash = hash('sha256', $json . $servicesalt, false);
205     $container = new stdClass();
206     $container->data = $data;
207     $container->hash = $hash;
209     return $container;
212 /**
213  * This function builds the request that must be sent to the tool producer
214  *
215  * @param object    $instance       Basic LTI instance object
216  * @param object    $typeconfig     Basic LTI tool configuration
217  * @param object    $course         Course object
218  *
219  * @return array    $request        Request details
220  */
221 function lti_build_request($instance, $typeconfig, $course) {
222     global $USER, $CFG;
224     if (empty($instance->cmid)) {
225         $instance->cmid = 0;
226     }
228     $role = lti_get_ims_role($USER, $instance->cmid, $instance->course);
230     $locale = $course->lang;
231     if ( strlen($locale) < 1 ) {
232          $locale = $CFG->lang;
233     }
235     $requestparams = array(
236         "resource_link_id" => $instance->id,
237         "resource_link_title" => $instance->name,
238         "resource_link_description" => $instance->intro,
239         "user_id" => $USER->id,
240         "roles" => $role,
241         "context_id" => $course->id,
242         "context_label" => $course->shortname,
243         "context_title" => $course->fullname,
244         "launch_presentation_locale" => $locale,
245     );
247     $placementsecret = $instance->servicesalt;
249     if ( isset($placementsecret) ) {
250         $sourcedid = json_encode(lti_build_sourcedid($instance->id, $USER->id, null, $placementsecret));
251     }
253     if ( isset($placementsecret) &&
254          ( $typeconfig['acceptgrades'] == LTI_SETTING_ALWAYS ||
255          ( $typeconfig['acceptgrades'] == LTI_SETTING_DELEGATE && $instance->instructorchoiceacceptgrades == LTI_SETTING_ALWAYS ) ) ) {
256         $requestparams['lis_result_sourcedid'] = $sourcedid;
258         $serviceurl = $CFG->wwwroot . '/mod/lti/service.php';
259         if ($typeconfig['forcessl'] == '1') {
260             $serviceurl = lti_ensure_url_is_https($serviceurl);
261         }
263         $requestparams['ext_ims_lis_basic_outcome_url'] = $serviceurl;
264     }
266     /*if ( isset($placementsecret) &&
267          ( $typeconfig['allowroster'] == LTI_SETTING_ALWAYS ||
268          ( $typeconfig['allowroster'] == LTI_SETTING_DELEGATE && $instance->instructorchoiceallowroster == LTI_SETTING_ALWAYS ) ) ) {
269         $requestparams["ext_ims_lis_memberships_id"] = $sourcedid;
270         $requestparams["ext_ims_lis_memberships_url"] = $CFG->wwwroot.'/mod/lti/service.php';
271     }*/
273     // Send user's name and email data if appropriate
274     if ( $typeconfig['sendname'] == LTI_SETTING_ALWAYS ||
275          ( $typeconfig['sendname'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendname == LTI_SETTING_ALWAYS ) ) {
276         $requestparams['lis_person_name_given'] =  $USER->firstname;
277         $requestparams['lis_person_name_family'] =  $USER->lastname;
278         $requestparams['lis_person_name_full'] =  $USER->firstname." ".$USER->lastname;
279     }
281     if ( $typeconfig['sendemailaddr'] == LTI_SETTING_ALWAYS ||
282          ( $typeconfig['sendemailaddr'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendemailaddr == LTI_SETTING_ALWAYS ) ) {
283         $requestparams['lis_person_contact_email_primary'] = $USER->email;
284     }
286     //Add outcome service URL
287     $url = new moodle_url('/mod/lti/service.php');
288     $requestparams['lis_outcome_service_url'] = $url->out();
290     // Concatenate the custom parameters from the administrator and the instructor
291     // Instructor parameters are only taken into consideration if the administrator
292     // has giver permission
293     $customstr = $typeconfig['customparameters'];
294     $instructorcustomstr = $instance->instructorcustomparameters;
295     $custom = array();
296     $instructorcustom = array();
297     if ($customstr) {
298         $custom = lti_split_custom_parameters($customstr);
299     }
300     if (!isset($typeconfig['allowinstructorcustom']) || $typeconfig['allowinstructorcustom'] == LTI_SETTING_NEVER) {
301         $requestparams = array_merge($custom, $requestparams);
302     } else {
303         if ($instructorcustomstr) {
304             $instructorcustom = lti_split_custom_parameters($instructorcustomstr);
305         }
306         foreach ($instructorcustom as $key => $val) {
307             // Ignore the instructor's parameter
308             if (!array_key_exists($key, $custom)) {
309                 $custom[$key] = $val;
310             }
311         }
312         $requestparams = array_merge($custom, $requestparams);
313     }
315     // Make sure we let the tool know what LMS they are being called from
316     $requestparams['ext_lms'] = 'moodle-2';
317     $requestparams['tool_consumer_info_product_family_code'] = 'moodle';
318     $requestparams['tool_consumer_info_version'] = strval($CFG->version);
320     // Add oauth_callback to be compliant with the 1.0A spec
321     $requestparams['oauth_callback'] = 'about:blank';
323     //The submit button needs to be part of the signature as it gets posted with the form.
324     //This needs to be here to support launching without javascript.
325     $submittext = get_string('press_to_submit', 'lti');
326     $requestparams['ext_submit'] = $submittext;
328     $requestparams['lti_version'] = 'LTI-1p0';
329     $requestparams['lti_message_type'] = 'basic-lti-launch-request';
330     /* Suppress this for now - Chuck
331     if ( $orgdesc ) $requestparams["tool_consumer_instance_description"] = $orgdesc;
332     */
334     return $requestparams;
337 function lti_get_tool_table($tools, $id) {
338     global $CFG, $USER;
339     $html = '';
341     $typename = get_string('typename', 'lti');
342     $baseurl = get_string('baseurl', 'lti');
343     $action = get_string('action', 'lti');
344     $createdon = get_string('createdon', 'lti');
346     if ($id == 'lti_configured') {
347         $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>';
348     }
350     if (!empty($tools)) {
351         $html .= "
352         <div id=\"{$id}_container\" style=\"margin-top:.5em;margin-bottom:.5em\">
353             <table id=\"{$id}_tools\">
354                 <thead>
355                     <tr>
356                         <th>$typename</th>
357                         <th>$baseurl</th>
358                         <th>$createdon</th>
359                         <th>$action</th>
360                     </tr>
361                 </thead>
362         ";
364         foreach ($tools as $type) {
365             $date = userdate($type->timecreated);
366             $accept = get_string('accept', 'lti');
367             $update = get_string('update', 'lti');
368             $delete = get_string('delete', 'lti');
370             $accepthtml = "
371                 <a class=\"editing_accept\" href=\"{$CFG->wwwroot}/mod/lti/typessettings.php?action=accept&amp;id={$type->id}&amp;sesskey={$USER->sesskey}&amp;tab={$id}\" title=\"{$accept}\">
372                     <img class=\"iconsmall\" alt=\"{$accept}\" src=\"{$CFG->wwwroot}/pix/t/clear.gif\"/>
373                 </a>
374             ";
376             $deleteaction = 'delete';
378             if ($type->state == LTI_TOOL_STATE_CONFIGURED) {
379                 $accepthtml = '';
380             }
382             if ($type->state != LTI_TOOL_STATE_REJECTED) {
383                 $deleteaction = 'reject';
384                 $delete = get_string('reject', 'lti');
385             }
387             $html .= "
388             <tr>
389                 <td>
390                     {$type->name}
391                 </td>
392                 <td>
393                     {$type->baseurl}
394                 </td>
395                 <td>
396                     {$date}
397                 </td>
398                 <td align=\"center\">
399                     {$accepthtml}
400                     <a class=\"editing_update\" href=\"{$CFG->wwwroot}/mod/lti/typessettings.php?action=update&amp;id={$type->id}&amp;sesskey={$USER->sesskey}&amp;tab={$id}\" title=\"{$update}\">
401                         <img class=\"iconsmall\" alt=\"{$update}\" src=\"{$CFG->wwwroot}/pix/t/edit.gif\"/>
402                     </a>
403                     <a class=\"editing_delete\" href=\"{$CFG->wwwroot}/mod/lti/typessettings.php?action={$deleteaction}&amp;id={$type->id}&amp;sesskey={$USER->sesskey}&amp;tab={$id}\" title=\"{$delete}\">
404                         <img class=\"iconsmall\" alt=\"{$delete}\" src=\"{$CFG->wwwroot}/pix/t/delete.gif\"/>
405                     </a>
406                 </td>
407             </tr>
408             ";
409         }
410         $html .= '</table></div>';
411     } else {
412         $html .= get_string('no_' . $id, 'lti');
413     }
415     return $html;
418 /**
419  * Splits the custom parameters field to the various parameters
420  *
421  * @param string $customstr     String containing the parameters
422  *
423  * @return Array of custom parameters
424  */
425 function lti_split_custom_parameters($customstr) {
426     $textlib = textlib_get_instance();
428     $lines = preg_split("/[\n;]/", $customstr);
429     $retval = array();
430     foreach ($lines as $line) {
431         $pos = strpos($line, "=");
432         if ( $pos === false || $pos < 1 ) {
433             continue;
434         }
435         $key = trim($textlib->substr($line, 0, $pos));
436         $val = trim($textlib->substr($line, $pos+1));
437         $key = lti_map_keyname($key);
438         $retval['custom_'.$key] = $val;
439     }
440     return $retval;
443 /**
444  * Used for building the names of the different custom parameters
445  *
446  * @param string $key   Parameter name
447  *
448  * @return string       Processed name
449  */
450 function lti_map_keyname($key) {
451     $textlib = textlib_get_instance();
453     $newkey = "";
454     $key = $textlib->strtolower(trim($key));
455     foreach (str_split($key) as $ch) {
456         if ( ($ch >= 'a' && $ch <= 'z') || ($ch >= '0' && $ch <= '9') ) {
457             $newkey .= $ch;
458         } else {
459             $newkey .= '_';
460         }
461     }
462     return $newkey;
465 /**
466  * Gets the IMS role string for the specified user and LTI course module.
467  *
468  * @param mixed $user User object or user id
469  * @param int $cmid The course module id of the LTI activity
470  * @return string A role string suitable for passing with an LTI launch
471  */
472 function lti_get_ims_role($user, $cmid, $courseid) {
473     $roles = array();
475     if (empty($cmid)) {
476         //If no cmid is passed, check if the user is a teacher in the course
477         //This allows other modules to programmatically "fake" a launch without
478         //a real LTI instance
479         $coursecontext = get_context_instance(CONTEXT_COURSE, $courseid);
481         if (has_capability('moodle/course:manageactivities', $coursecontext)) {
482             array_push($roles, 'Instructor');
483         } else {
484             array_push($roles, 'Learner');
485         }
486     } else {
487         $context = get_context_instance(CONTEXT_MODULE, $cmid);
489         if (has_capability('mod/lti:manage', $context)) {
490             array_push($roles, 'Instructor');
491         } else {
492             array_push($roles, 'Learner');
493         }
494     }
496     if (is_siteadmin($user)) {
497         array_push($roles, 'urn:lti:sysrole:ims/lis/Administrator');
498     }
500     return join(',', $roles);
503 /**
504  * Returns configuration details for the tool
505  *
506  * @param int $typeid   Basic LTI tool typeid
507  *
508  * @return array        Tool Configuration
509  */
510 function lti_get_type_config($typeid) {
511     global $DB;
513     $query = "SELECT name, value
514                 FROM {lti_types_config}
515                WHERE typeid = :typeid1
516            UNION ALL
517               SELECT 'toolurl' AS name, baseurl AS value
518                 FROM {lti_types}
519                WHERE id = :typeid2";
521     $typeconfig = array();
522     $configs = $DB->get_records_sql($query, array('typeid1' => $typeid, 'typeid2' => $typeid));
524     if (!empty($configs)) {
525         foreach ($configs as $config) {
526             $typeconfig[$config->name] = $config->value;
527         }
528     }
530     return $typeconfig;
533 function lti_get_tools_by_url($url, $state, $courseid = null) {
534     $domain = lti_get_domain_from_url($url);
536     return lti_get_tools_by_domain($domain, $state, $courseid);
539 function lti_get_tools_by_domain($domain, $state = null, $courseid = null) {
540     global $DB, $SITE;
542     $filters = array('tooldomain' => $domain);
544     $statefilter = '';
545     $coursefilter = '';
547     if ($state) {
548         $statefilter = 'AND state = :state';
549     }
551     if ($courseid && $courseid != $SITE->id) {
552         $coursefilter = 'OR course = :courseid';
553     }
555     $query = "SELECT *
556                 FROM {lti_types}
557                WHERE tooldomain = :tooldomain
558                  AND (course = :siteid $coursefilter)
559                  $statefilter";
561     return $DB->get_records_sql($query, array(
562         'courseid' => $courseid,
563         'siteid' => $SITE->id,
564         'tooldomain' => $domain,
565         'state' => $state
566     ));
569 /**
570  * Returns all basicLTI tools configured by the administrator
571  *
572  */
573 function lti_filter_get_types($course) {
574     global $DB;
576     if (!empty($course)) {
577         $filter = array('course' => $course);
578     } else {
579         $filter = array();
580     }
582     return $DB->get_records('lti_types', $filter);
585 function lti_get_types_for_add_instance() {
586     global $DB, $SITE, $COURSE;
588     $query = "SELECT *
589                 FROM {lti_types}
590                WHERE coursevisible = 1
591                  AND (course = :siteid OR course = :courseid)
592                  AND state = :active";
594     $admintypes = $DB->get_records_sql($query, array('siteid' => $SITE->id, 'courseid' => $COURSE->id, 'active' => LTI_TOOL_STATE_CONFIGURED));
596     $types = array();
597     $types[0] = (object)array('name' => get_string('automatic', 'lti'), 'course' => $SITE->id);
599     foreach ($admintypes as $type) {
600         $types[$type->id] = $type;
601     }
603     return $types;
606 function lti_get_domain_from_url($url) {
607     $matches = array();
609     if (preg_match(LTI_URL_DOMAIN_REGEX, $url, $matches)) {
610         return $matches[1];
611     }
614 function lti_get_tool_by_url_match($url, $courseid = null, $state = LTI_TOOL_STATE_CONFIGURED) {
615     $possibletools = lti_get_tools_by_url($url, $state, $courseid);
617     return lti_get_best_tool_by_url($url, $possibletools, $courseid);
620 function lti_get_url_thumbprint($url) {
621     $urlparts = parse_url(strtolower($url));
622     if (!isset($urlparts['path'])) {
623         $urlparts['path'] = '';
624     }
626     if (!isset($urlparts['host'])) {
627         $urlparts['host'] = '';
628     }
630     if (substr($urlparts['host'], 0, 4) === 'www.') {
631         $urlparts['host'] = substr($urlparts['host'], 4);
632     }
634     return $urllower = $urlparts['host'] . '/' . $urlparts['path'];
637 function lti_get_best_tool_by_url($url, $tools, $courseid = null) {
638     if (count($tools) === 0) {
639         return null;
640     }
642     $urllower = lti_get_url_thumbprint($url);
644     foreach ($tools as $tool) {
645         $tool->_matchscore = 0;
647         $toolbaseurllower = lti_get_url_thumbprint($tool->baseurl);
649         if ($urllower === $toolbaseurllower) {
650             //100 points for exact thumbprint match
651             $tool->_matchscore += 100;
652         } else if (substr($urllower, 0, strlen($toolbaseurllower)) === $toolbaseurllower) {
653             //50 points if tool thumbprint starts with the base URL thumbprint
654             $tool->_matchscore += 50;
655         }
657         //Prefer course tools over site tools
658         if (!empty($courseid)) {
659             //Minus 25 points for not matching the course id (global tools)
660             if ($tool->course != $courseid) {
661                 $tool->_matchscore -= 10;
662             }
663         }
664     }
666     $bestmatch = array_reduce($tools, function($value, $tool) {
667         if ($tool->_matchscore > $value->_matchscore) {
668             return $tool;
669         } else {
670             return $value;
671         }
673     }, (object)array('_matchscore' => -1));
675     //None of the tools are suitable for this URL
676     if ($bestmatch->_matchscore <= 0) {
677         return null;
678     }
680     return $bestmatch;
683 function lti_get_shared_secrets_by_key($key) {
684     global $DB;
686     //Look up the shared secret for the specified key in both the types_config table (for configured tools)
687     //And in the lti resource table for ad-hoc tools
688     $query = "SELECT t2.value
689                 FROM {lti_types_config} t1
690                 JOIN {lti_types_config} t2 ON t1.typeid = t2.typeid
691                 JOIN {lti_types} type ON t2.typeid = type.id
692               WHERE t1.name = 'resourcekey'
693                 AND t1.value = :key1
694                 AND t2.name = 'password'
695                 AND type.state = :configured
696               UNION
697              SELECT password AS value
698                FROM {lti}
699               WHERE resourcekey = :key2";
701     $sharedsecrets = $DB->get_records_sql($query, array('configured' => LTI_TOOL_STATE_CONFIGURED, 'key1' => $key, 'key2' => $key));
703     $values = array_map(function($item) {
704         return $item->value;
705     }, $sharedsecrets);
707     //There should really only be one shared secret per key. But, we can't prevent
708     //more than one getting entered. For instance, if the same key is used for two tool providers.
709     return $values;
712 /**
713  * Prints the various configured tool types
714  *
715  */
716 function lti_filter_print_types() {
717     global $CFG;
719     $types = lti_filter_get_types();
720     if (!empty($types)) {
721         echo '<ul>';
722         foreach ($types as $type) {
723             echo '<li>'.
724             $type->name.
725             '<span class="commands">'.
726             '<a class="editing_update" href="typessettings.php?action=update&amp;id='.$type->id.'&amp;sesskey='.sesskey().'" title="Update">'.
727             '<img class="iconsmall" alt="Update" src="'.$CFG->wwwroot.'/pix/t/edit.gif"/>'.
728             '</a>'.
729             '<a class="editing_delete" href="typessettings.php?action=delete&amp;id='.$type->id.'&amp;sesskey='.sesskey().'" title="Delete">'.
730             '<img class="iconsmall" alt="Delete" src="'.$CFG->wwwroot.'/pix/t/delete.gif"/>'.
731             '</a>'.
732             '</span>'.
733             '</li>';
735         }
736         echo '</ul>';
737     } else {
738         echo '<div class="message">';
739         echo get_string('notypes', 'lti');
740         echo '</div>';
741     }
744 /**
745  * Delete a Basic LTI configuration
746  *
747  * @param int $id   Configuration id
748  */
749 function lti_delete_type($id) {
750     global $DB;
752     //We should probably just copy the launch URL to the tool instances in this case... using a single query
753     /*
754     $instances = $DB->get_records('lti', array('typeid' => $id));
755     foreach ($instances as $instance) {
756         $instance->typeid = 0;
757         $DB->update_record('lti', $instance);
758     }*/
760     $DB->delete_records('lti_types', array('id' => $id));
761     $DB->delete_records('lti_types_config', array('typeid' => $id));
764 function lti_set_state_for_type($id, $state) {
765     global $DB;
767     $DB->update_record('lti_types', array('id' => $id, 'state' => $state));
770 /**
771  * Transforms a basic LTI object to an array
772  *
773  * @param object $ltiobject    Basic LTI object
774  *
775  * @return array Basic LTI configuration details
776  */
777 function lti_get_config($ltiobject) {
778     $typeconfig = array();
779     $typeconfig = (array)$ltiobject;
780     $additionalconfig = lti_get_type_config($ltiobject->typeid);
781     $typeconfig = array_merge($typeconfig, $additionalconfig);
782     return $typeconfig;
785 /**
786  *
787  * Generates some of the tool configuration based on the instance details
788  *
789  * @param int $id
790  *
791  * @return Instance configuration
792  *
793  */
794 function lti_get_type_config_from_instance($id) {
795     global $DB;
797     $instance = $DB->get_record('lti', array('id' => $id));
798     $config = lti_get_config($instance);
800     $type = new stdClass();
801     $type->lti_fix = $id;
802     if (isset($config['toolurl'])) {
803         $type->lti_toolurl = $config['toolurl'];
804     }
805     if (isset($config['instructorchoicesendname'])) {
806         $type->lti_sendname = $config['instructorchoicesendname'];
807     }
808     if (isset($config['instructorchoicesendemailaddr'])) {
809         $type->lti_sendemailaddr = $config['instructorchoicesendemailaddr'];
810     }
811     if (isset($config['instructorchoiceacceptgrades'])) {
812         $type->lti_acceptgrades = $config['instructorchoiceacceptgrades'];
813     }
814     if (isset($config['instructorchoiceallowroster'])) {
815         $type->lti_allowroster = $config['instructorchoiceallowroster'];
816     }
818     if (isset($config['instructorcustomparameters'])) {
819         $type->lti_allowsetting = $config['instructorcustomparameters'];
820     }
821     return $type;
824 /**
825  * Generates some of the tool configuration based on the admin configuration details
826  *
827  * @param int $id
828  *
829  * @return Configuration details
830  */
831 function lti_get_type_type_config($id) {
832     global $DB;
834     $basicltitype = $DB->get_record('lti_types', array('id' => $id));
835     $config = lti_get_type_config($id);
837     $type->lti_typename = $basicltitype->name;
839     $type->typeid = $basicltitype->id;
841     $type->lti_toolurl = $basicltitype->baseurl;
843     if (isset($config['resourcekey'])) {
844         $type->lti_resourcekey = $config['resourcekey'];
845     }
846     if (isset($config['password'])) {
847         $type->lti_password = $config['password'];
848     }
850     if (isset($config['sendname'])) {
851         $type->lti_sendname = $config['sendname'];
852     }
853     if (isset($config['instructorchoicesendname'])) {
854         $type->lti_instructorchoicesendname = $config['instructorchoicesendname'];
855     }
856     if (isset($config['sendemailaddr'])) {
857         $type->lti_sendemailaddr = $config['sendemailaddr'];
858     }
859     if (isset($config['instructorchoicesendemailaddr'])) {
860         $type->lti_instructorchoicesendemailaddr = $config['instructorchoicesendemailaddr'];
861     }
862     if (isset($config['acceptgrades'])) {
863         $type->lti_acceptgrades = $config['acceptgrades'];
864     }
865     if (isset($config['instructorchoiceacceptgrades'])) {
866         $type->lti_instructorchoiceacceptgrades = $config['instructorchoiceacceptgrades'];
867     }
868     if (isset($config['allowroster'])) {
869         $type->lti_allowroster = $config['allowroster'];
870     }
871     if (isset($config['instructorchoiceallowroster'])) {
872         $type->lti_instructorchoiceallowroster = $config['instructorchoiceallowroster'];
873     }
875     if (isset($config['customparameters'])) {
876         $type->lti_customparameters = $config['customparameters'];
877     }
879     if (isset($config['forcessl'])) {
880         $type->lti_forcessl = $config['forcessl'];
881     }
883     if (isset($config['organizationid'])) {
884         $type->lti_organizationid = $config['organizationid'];
885     }
886     if (isset($config['organizationurl'])) {
887         $type->lti_organizationurl = $config['organizationurl'];
888     }
889     if (isset($config['organizationdescr'])) {
890         $type->lti_organizationdescr = $config['organizationdescr'];
891     }
892     if (isset($config['launchcontainer'])) {
893         $type->lti_launchcontainer = $config['launchcontainer'];
894     }
896     if (isset($config['coursevisible'])) {
897         $type->lti_coursevisible = $config['coursevisible'];
898     }
900     if (isset($config['debuglaunch'])) {
901         $type->lti_debuglaunch = $config['debuglaunch'];
902     }
904     if (isset($config['module_class_type'])) {
905             $type->lti_module_class_type = $config['module_class_type'];
906     }
908     return $type;
911 function lti_prepare_type_for_save($type, $config) {
912     $type->baseurl = $config->lti_toolurl;
913     $type->tooldomain = lti_get_domain_from_url($config->lti_toolurl);
914     $type->name = $config->lti_typename;
916     $type->coursevisible = !empty($config->lti_coursevisible) ? $config->lti_coursevisible : 0;
917     $config->lti_coursevisible = $type->coursevisible;
919     $type->forcessl = !empty($config->lti_forcessl) ? $config->lti_forcessl : 0;
920     $config->lti_forcessl = $type->forcessl;
922     $type->timemodified = time();
924     unset ($config->lti_typename);
925     unset ($config->lti_toolurl);
928 function lti_update_type($type, $config) {
929     global $DB;
931     lti_prepare_type_for_save($type, $config);
933     if ($DB->update_record('lti_types', $type)) {
934         foreach ($config as $key => $value) {
935             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
936                 $record = new StdClass();
937                 $record->typeid = $type->id;
938                 $record->name = substr($key, 4);
939                 $record->value = $value;
941                 lti_update_config($record);
942             }
943         }
944     }
947 function lti_add_type($type, $config) {
948     global $USER, $SITE, $DB;
950     lti_prepare_type_for_save($type, $config);
952     if (!isset($type->state)) {
953         $type->state = LTI_TOOL_STATE_PENDING;
954     }
956     if (!isset($type->timecreated)) {
957         $type->timecreated = time();
958     }
960     if (!isset($type->createdby)) {
961         $type->createdby = $USER->id;
962     }
964     if (!isset($type->course)) {
965         $type->course = $SITE->id;
966     }
968     //Create a salt value to be used for signing passed data to extension services
969     //The outcome service uses the service salt on the instance. This can be used
970     //for communication with services not related to a specific LTI instance.
971     $config->lti_servicesalt = uniqid('', true);
973     $id = $DB->insert_record('lti_types', $type);
975     if ($id) {
976         foreach ($config as $key => $value) {
977             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
978                 $record = new StdClass();
979                 $record->typeid = $id;
980                 $record->name = substr($key, 4);
981                 $record->value = $value;
983                 lti_add_config($record);
984             }
985         }
986     }
988     return $id;
991 /**
992  * Add a tool configuration in the database
993  *
994  * @param $config   Tool configuration
995  *
996  * @return int Record id number
997  */
998 function lti_add_config($config) {
999     global $DB;
1001     return $DB->insert_record('lti_types_config', $config);
1004 /**
1005  * Updates a tool configuration in the database
1006  *
1007  * @param $config   Tool configuration
1008  *
1009  * @return Record id number
1010  */
1011 function lti_update_config($config) {
1012     global $DB;
1014     $return = true;
1015     $old = $DB->get_record('lti_types_config', array('typeid' => $config->typeid, 'name' => $config->name));
1017     if ($old) {
1018         $config->id = $old->id;
1019         $return = $DB->update_record('lti_types_config', $config);
1020     } else {
1021         $return = $DB->insert_record('lti_types_config', $config);
1022     }
1023     return $return;
1026 /**
1027  * Signs the petition to launch the external tool using OAuth
1028  *
1029  * @param $oldparms     Parameters to be passed for signing
1030  * @param $endpoint     url of the external tool
1031  * @param $method       Method for sending the parameters (e.g. POST)
1032  * @param $oauth_consumoer_key          Key
1033  * @param $oauth_consumoer_secret       Secret
1034  * @param $submittext  The text for the submit button
1035  * @param $orgid       LMS name
1036  * @param $orgdesc     LMS key
1037  */
1038 function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret) {
1039     //global $lastbasestring;
1040     $parms = $oldparms;
1042     $testtoken = '';
1044     // TODO: Switch to core oauthlib once implemented - MDL-30149
1045     $hmacmethod = new lti\OAuthSignatureMethod_HMAC_SHA1();
1046     $testconsumer = new lti\OAuthConsumer($oauthconsumerkey, $oauthconsumersecret, null);
1047     $accreq = lti\OAuthRequest::from_consumer_and_token($testconsumer, $testtoken, $method, $endpoint, $parms);
1048     $accreq->sign_request($hmacmethod, $testconsumer, $testtoken);
1050     // Pass this back up "out of band" for debugging
1051     //$lastbasestring = $accreq->get_signature_base_string();
1053     $newparms = $accreq->get_parameters();
1055     return $newparms;
1058 /**
1059  * Posts the launch petition HTML
1060  *
1061  * @param $newparms     Signed parameters
1062  * @param $endpoint     URL of the external tool
1063  * @param $debug        Debug (true/false)
1064  */
1065 function lti_post_launch_html($newparms, $endpoint, $debug=false) {
1066     //global $lastbasestring;
1068     $r = "<form action=\"".$endpoint."\" name=\"ltiLaunchForm\" id=\"ltiLaunchForm\" method=\"post\" encType=\"application/x-www-form-urlencoded\">\n";
1070     $submittext = $newparms['ext_submit'];
1072     // Contruct html for the launch parameters
1073     foreach ($newparms as $key => $value) {
1074         $key = htmlspecialchars($key);
1075         $value = htmlspecialchars($value);
1076         if ( $key == "ext_submit" ) {
1077             $r .= "<input type=\"submit\" name=\"";
1078         } else {
1079             $r .= "<input type=\"hidden\" name=\"";
1080         }
1081         $r .= $key;
1082         $r .= "\" value=\"";
1083         $r .= $value;
1084         $r .= "\"/>\n";
1085     }
1087     if ( $debug ) {
1088         $r .= "<script language=\"javascript\"> \n";
1089         $r .= "  //<![CDATA[ \n";
1090         $r .= "function basicltiDebugToggle() {\n";
1091         $r .= "    var ele = document.getElementById(\"basicltiDebug\");\n";
1092         $r .= "    if (ele.style.display == \"block\") {\n";
1093         $r .= "        ele.style.display = \"none\";\n";
1094         $r .= "    }\n";
1095         $r .= "    else {\n";
1096         $r .= "        ele.style.display = \"block\";\n";
1097         $r .= "    }\n";
1098         $r .= "} \n";
1099         $r .= "  //]]> \n";
1100         $r .= "</script>\n";
1101         $r .= "<a id=\"displayText\" href=\"javascript:basicltiDebugToggle();\">";
1102         $r .= get_string("toggle_debug_data", "lti")."</a>\n";
1103         $r .= "<div id=\"basicltiDebug\" style=\"display:none\">\n";
1104         $r .=  "<b>".get_string("basiclti_endpoint", "lti")."</b><br/>\n";
1105         $r .= $endpoint . "<br/>\n&nbsp;<br/>\n";
1106         $r .=  "<b>".get_string("basiclti_parameters", "lti")."</b><br/>\n";
1107         foreach ($newparms as $key => $value) {
1108             $key = htmlspecialchars($key);
1109             $value = htmlspecialchars($value);
1110             $r .= "$key = $value<br/>\n";
1111         }
1112         $r .= "&nbsp;<br/>\n";
1113         //$r .= "<p><b>".get_string("basiclti_base_string", "lti")."</b><br/>\n".$lastbasestring."</p>\n";
1114         $r .= "</div>\n";
1115     }
1116     $r .= "</form>\n";
1118     if ( ! $debug ) {
1119         $ext_submit = "ext_submit";
1120         $ext_submit_text = $submittext;
1121         $r .= " <script type=\"text/javascript\"> \n" .
1122             "  //<![CDATA[ \n" .
1123             "    document.getElementById(\"ltiLaunchForm\").style.display = \"none\";\n" .
1124             "    nei = document.createElement('input');\n" .
1125             "    nei.setAttribute('type', 'hidden');\n" .
1126             "    nei.setAttribute('name', '".$ext_submit."');\n" .
1127             "    nei.setAttribute('value', '".$ext_submit_text."');\n" .
1128             "    document.getElementById(\"ltiLaunchForm\").appendChild(nei);\n" .
1129             "    document.ltiLaunchForm.submit(); \n" .
1130             "  //]]> \n" .
1131             " </script> \n";
1132     }
1133     return $r;
1136 function lti_get_type($typeid) {
1137     global $DB;
1139     return $DB->get_record('lti_types', array('id' => $typeid));
1142 function lti_get_launch_container($lti, $toolconfig) {
1143     if (empty($lti->launchcontainer)) {
1144         $lti->launchcontainer = LTI_LAUNCH_CONTAINER_DEFAULT;
1145     }
1147     if ($lti->launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1148         if (isset($toolconfig['launchcontainer'])) {
1149             $launchcontainer = $toolconfig['launchcontainer'];
1150         }
1151     } else {
1152         $launchcontainer = $lti->launchcontainer;
1153     }
1155     if (empty($launchcontainer) || $launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1156         $launchcontainer = LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS;
1157     }
1159     $devicetype = get_device_type();
1161     //Scrolling within the object element doesn't work on iOS or Android
1162     //Opening the popup window also had some issues in testing
1163     //For mobile devices, always take up the entire screen to ensure the best experience
1164     if ($devicetype === 'mobile' || $devicetype === 'tablet' ) {
1165         $launchcontainer = LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW;
1166     }
1168     return $launchcontainer;
1171 function lti_request_is_using_ssl() {
1172     global $ME;
1173     return (stripos($ME, 'https://') === 0);
1176 function lti_ensure_url_is_https($url) {
1177     if (!strstr($url, '://')) {
1178         $url = 'https://' . $url;
1179     } else {
1180         //If the URL starts with http, replace with https
1181         if (stripos($url, 'http://') === 0) {
1182             $url = 'https://' . substr($url, 8);
1183         }
1184     }
1186     return $url;