Merge branch 'MDL-30328' of git://github.com/scriby/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
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  * @author     Chris Scribner
47  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
48  */
50 defined('MOODLE_INTERNAL') || die;
52 // TODO: Switch to core oauthlib once implemented - MDL-30149
53 use moodle\mod\lti as lti;
55 require_once($CFG->dirroot.'/mod/lti/OAuth.php');
57 define('LTI_URL_DOMAIN_REGEX', '/(?:https?:\/\/)?(?:www\.)?([^\/]+)(?:\/|$)/i');
59 define('LTI_LAUNCH_CONTAINER_DEFAULT', 1);
60 define('LTI_LAUNCH_CONTAINER_EMBED', 2);
61 define('LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS', 3);
62 define('LTI_LAUNCH_CONTAINER_WINDOW', 4);
63 define('LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW', 5);
65 define('LTI_TOOL_STATE_ANY', 0);
66 define('LTI_TOOL_STATE_CONFIGURED', 1);
67 define('LTI_TOOL_STATE_PENDING', 2);
68 define('LTI_TOOL_STATE_REJECTED', 3);
70 define('LTI_SETTING_NEVER', 0);
71 define('LTI_SETTING_ALWAYS', 1);
72 define('LTI_SETTING_DELEGATE', 2);
74 /**
75  * Prints a Basic LTI activity
76  *
77  * $param int $basicltiid       Basic LTI activity id
78  */
79 function lti_view($instance) {
80     global $PAGE, $CFG;
82     if (empty($instance->typeid)) {
83         $tool = lti_get_tool_by_url_match($instance->toolurl, $instance->course);
84         if ($tool) {
85             $typeid = $tool->id;
86         } else {
87             $typeid = null;
88         }
89     } else {
90         $typeid = $instance->typeid;
91     }
93     if ($typeid) {
94         $typeconfig = lti_get_type_config($typeid);
95     } else {
96         //There is no admin configuration for this tool. Use configuration in the lti instance record plus some defaults.
97         $typeconfig = (array)$instance;
99         $typeconfig['sendname'] = $instance->instructorchoicesendname;
100         $typeconfig['sendemailaddr'] = $instance->instructorchoicesendemailaddr;
101         $typeconfig['customparameters'] = $instance->instructorcustomparameters;
102         $typeconfig['acceptgrades'] = $instance->instructorchoiceacceptgrades;
103         $typeconfig['allowroster'] = $instance->instructorchoiceallowroster;
104         $typeconfig['forcessl'] = '0';
105     }
107     //Default the organizationid if not specified
108     if (empty($typeconfig['organizationid'])) {
109         $urlparts = parse_url($CFG->wwwroot);
111         $typeconfig['organizationid'] = $urlparts['host'];
112     }
114     if (!empty($instance->resourcekey)) {
115         $key = $instance->resourcekey;
116     } else if (!empty($typeconfig['resourcekey'])) {
117         $key = $typeconfig['resourcekey'];
118     } else {
119         $key = '';
120     }
122     if (!empty($instance->password)) {
123         $secret = $instance->password;
124     } else if (!empty($typeconfig['password'])) {
125         $secret = $typeconfig['password'];
126     } else {
127         $secret = '';
128     }
130     $endpoint = !empty($instance->toolurl) ? $instance->toolurl : $typeconfig['toolurl'];
131     $endpoint = trim($endpoint);
133     //If the current request is using SSL and a secure tool URL is specified, use it
134     if (lti_request_is_using_ssl() && !empty($instance->securetoolurl)) {
135         $endpoint = trim($instance->securetoolurl);
136     }
138     //If SSL is forced, use the secure tool url if specified. Otherwise, make sure https is on the normal launch URL.
139     if ($typeconfig['forcessl'] == '1') {
140         if (!empty($instance->securetoolurl)) {
141             $endpoint = trim($instance->securetoolurl);
142         }
144         $endpoint = lti_ensure_url_is_https($endpoint);
145     } else {
146         if (!strstr($endpoint, '://')) {
147             $endpoint = 'http://' . $endpoint;
148         }
149     }
151     $orgid = $typeconfig['organizationid'];
153     $course = $PAGE->course;
154     $requestparams = lti_build_request($instance, $typeconfig, $course);
156     $launchcontainer = lti_get_launch_container($instance, $typeconfig);
157     $returnurlparams = array('course' => $course->id, 'launch_container' => $launchcontainer, 'instanceid' => $instance->id);
159     if ( $orgid ) {
160         $requestparams["tool_consumer_instance_guid"] = $orgid;
161     }
163     if (empty($key) || empty($secret)) {
164         $returnurlparams['unsigned'] = '1';
166         //Add the return URL. We send the launch container along to help us avoid frames-within-frames when the user returns
167         $url = new moodle_url('/mod/lti/return.php', $returnurlparams);
168         $returnurl = $url->out(false);
170         if ($typeconfig['forcessl'] == '1') {
171             $returnurl = lti_ensure_url_is_https($returnurl);
172         }
174         $requestparams['launch_presentation_return_url'] = $returnurl;
175     }
177     if (!empty($key) && !empty($secret)) {
178         $parms = lti_sign_parameters($requestparams, $endpoint, "POST", $key, $secret);
179     } else {
180         //If no key and secret, do the launch unsigned.
181         $parms = $requestparams;
182     }
184     $debuglaunch = ( $instance->debuglaunch == 1 );
186     $content = lti_post_launch_html($parms, $endpoint, $debuglaunch);
188     echo $content;
191 function lti_build_sourcedid($instanceid, $userid, $launchid = null, $servicesalt) {
192     $data = new stdClass();
194     $data->instanceid = $instanceid;
195     $data->userid = $userid;
196     if (!empty($launchid)) {
197         $data->launchid = $launchid;
198     } else {
199         $data->launchid = mt_rand();
200     }
202     $json = json_encode($data);
204     $hash = hash('sha256', $json . $servicesalt, false);
206     $container = new stdClass();
207     $container->data = $data;
208     $container->hash = $hash;
210     return $container;
213 /**
214  * This function builds the request that must be sent to the tool producer
215  *
216  * @param object    $instance       Basic LTI instance object
217  * @param object    $typeconfig     Basic LTI tool configuration
218  * @param object    $course         Course object
219  *
220  * @return array    $request        Request details
221  */
222 function lti_build_request($instance, $typeconfig, $course) {
223     global $USER, $CFG;
225     if (empty($instance->cmid)) {
226         $instance->cmid = 0;
227     }
229     $role = lti_get_ims_role($USER, $instance->cmid, $instance->course);
231     $locale = $course->lang;
232     if ( strlen($locale) < 1 ) {
233          $locale = $CFG->lang;
234     }
236     $requestparams = array(
237         'resource_link_id' => $instance->id,
238         'resource_link_title' => $instance->name,
239         'resource_link_description' => $instance->intro,
240         'user_id' => $USER->id,
241         'roles' => $role,
242         'context_id' => $course->id,
243         'context_label' => $course->shortname,
244         'context_title' => $course->fullname,
245         'launch_presentation_locale' => $locale,
246     );
248     $placementsecret = $instance->servicesalt;
250     if ( isset($placementsecret) ) {
251         $sourcedid = json_encode(lti_build_sourcedid($instance->id, $USER->id, null, $placementsecret));
252     }
254     if ( isset($placementsecret) &&
255          ( $typeconfig['acceptgrades'] == LTI_SETTING_ALWAYS ||
256          ( $typeconfig['acceptgrades'] == LTI_SETTING_DELEGATE && $instance->instructorchoiceacceptgrades == LTI_SETTING_ALWAYS ) ) ) {
257         $requestparams['lis_result_sourcedid'] = $sourcedid;
259         //Add outcome service URL
260         $serviceurl = new moodle_url('/mod/lti/service.php');
261         $serviceurl = $serviceurl->out();
262         
263         if ($typeconfig['forcessl'] == '1') {
264             $serviceurl = lti_ensure_url_is_https($serviceurl);
265         }
266         
267         $requestparams['lis_outcome_service_url'] = $serviceurl;
268     }
270     // Send user's name and email data if appropriate
271     if ( $typeconfig['sendname'] == LTI_SETTING_ALWAYS ||
272          ( $typeconfig['sendname'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendname == LTI_SETTING_ALWAYS ) ) {
273         $requestparams['lis_person_name_given'] =  $USER->firstname;
274         $requestparams['lis_person_name_family'] =  $USER->lastname;
275         $requestparams['lis_person_name_full'] =  $USER->firstname." ".$USER->lastname;
276     }
278     if ( $typeconfig['sendemailaddr'] == LTI_SETTING_ALWAYS ||
279          ( $typeconfig['sendemailaddr'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendemailaddr == LTI_SETTING_ALWAYS ) ) {
280         $requestparams['lis_person_contact_email_primary'] = $USER->email;
281     }
283     // Concatenate the custom parameters from the administrator and the instructor
284     // Instructor parameters are only taken into consideration if the administrator
285     // has giver permission
286     $customstr = $typeconfig['customparameters'];
287     $instructorcustomstr = $instance->instructorcustomparameters;
288     $custom = array();
289     $instructorcustom = array();
290     if ($customstr) {
291         $custom = lti_split_custom_parameters($customstr);
292     }
293     if (!isset($typeconfig['allowinstructorcustom']) || $typeconfig['allowinstructorcustom'] == LTI_SETTING_NEVER) {
294         $requestparams = array_merge($custom, $requestparams);
295     } else {
296         if ($instructorcustomstr) {
297             $instructorcustom = lti_split_custom_parameters($instructorcustomstr);
298         }
299         foreach ($instructorcustom as $key => $val) {
300             // Ignore the instructor's parameter
301             if (!array_key_exists($key, $custom)) {
302                 $custom[$key] = $val;
303             }
304         }
305         $requestparams = array_merge($custom, $requestparams);
306     }
308     // Make sure we let the tool know what LMS they are being called from
309     $requestparams["ext_lms"] = "moodle-2";
310     $requestparams['tool_consumer_info_product_family_code'] = 'moodle';
311     $requestparams['tool_consumer_info_version'] = strval($CFG->version);
313     // Add oauth_callback to be compliant with the 1.0A spec
314     $requestparams['oauth_callback'] = 'about:blank';
316     //The submit button needs to be part of the signature as it gets posted with the form.
317     //This needs to be here to support launching without javascript.
318     $submittext = get_string('press_to_submit', 'lti');
319     $requestparams['ext_submit'] = $submittext;
321     $requestparams['lti_version'] = 'LTI-1p0';
322     $requestparams['lti_message_type'] = 'basic-lti-launch-request';
324     return $requestparams;
327 function lti_get_tool_table($tools, $id) {
328     global $CFG, $USER;
329     $html = '';
331     $typename = get_string('typename', 'lti');
332     $baseurl = get_string('baseurl', 'lti');
333     $action = get_string('action', 'lti');
334     $createdon = get_string('createdon', 'lti');
336     if ($id == 'lti_configured') {
337         $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>';
338     }
340     if (!empty($tools)) {
341         $html .= "
342         <div id=\"{$id}_container\" style=\"margin-top:.5em;margin-bottom:.5em\">
343             <table id=\"{$id}_tools\">
344                 <thead>
345                     <tr>
346                         <th>$typename</th>
347                         <th>$baseurl</th>
348                         <th>$createdon</th>
349                         <th>$action</th>
350                     </tr>
351                 </thead>
352         ";
354         foreach ($tools as $type) {
355             $date = userdate($type->timecreated);
356             $accept = get_string('accept', 'lti');
357             $update = get_string('update', 'lti');
358             $delete = get_string('delete', 'lti');
360             $accepthtml = "
361                 <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}\">
362                     <img class=\"iconsmall\" alt=\"{$accept}\" src=\"{$CFG->wwwroot}/pix/t/clear.gif\"/>
363                 </a>
364             ";
366             $deleteaction = 'delete';
368             if ($type->state == LTI_TOOL_STATE_CONFIGURED) {
369                 $accepthtml = '';
370             }
372             if ($type->state != LTI_TOOL_STATE_REJECTED) {
373                 $deleteaction = 'reject';
374                 $delete = get_string('reject', 'lti');
375             }
377             $html .= "
378             <tr>
379                 <td>
380                     {$type->name}
381                 </td>
382                 <td>
383                     {$type->baseurl}
384                 </td>
385                 <td>
386                     {$date}
387                 </td>
388                 <td align=\"center\">
389                     {$accepthtml}
390                     <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}\">
391                         <img class=\"iconsmall\" alt=\"{$update}\" src=\"{$CFG->wwwroot}/pix/t/edit.gif\"/>
392                     </a>
393                     <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}\">
394                         <img class=\"iconsmall\" alt=\"{$delete}\" src=\"{$CFG->wwwroot}/pix/t/delete.gif\"/>
395                     </a>
396                 </td>
397             </tr>
398             ";
399         }
400         $html .= '</table></div>';
401     } else {
402         $html .= get_string('no_' . $id, 'lti');
403     }
405     return $html;
408 /**
409  * Splits the custom parameters field to the various parameters
410  *
411  * @param string $customstr     String containing the parameters
412  *
413  * @return Array of custom parameters
414  */
415 function lti_split_custom_parameters($customstr) {
416     $textlib = textlib_get_instance();
418     $lines = preg_split("/[\n;]/", $customstr);
419     $retval = array();
420     foreach ($lines as $line) {
421         $pos = strpos($line, "=");
422         if ( $pos === false || $pos < 1 ) {
423             continue;
424         }
425         $key = trim($textlib->substr($line, 0, $pos));
426         $val = trim($textlib->substr($line, $pos+1, strlen($line)));
427         $key = lti_map_keyname($key);
428         $retval['custom_'.$key] = $val;
429     }
430     return $retval;
433 /**
434  * Used for building the names of the different custom parameters
435  *
436  * @param string $key   Parameter name
437  *
438  * @return string       Processed name
439  */
440 function lti_map_keyname($key) {
441     $textlib = textlib_get_instance();
443     $newkey = "";
444     $key = $textlib->strtolower(trim($key));
445     foreach (str_split($key) as $ch) {
446         if ( ($ch >= 'a' && $ch <= 'z') || ($ch >= '0' && $ch <= '9') ) {
447             $newkey .= $ch;
448         } else {
449             $newkey .= '_';
450         }
451     }
452     return $newkey;
455 /**
456  * Gets the IMS role string for the specified user and LTI course module.
457  *
458  * @param mixed $user User object or user id
459  * @param int $cmid The course module id of the LTI activity
460  * @return string A role string suitable for passing with an LTI launch
461  */
462 function lti_get_ims_role($user, $cmid, $courseid) {
463     $roles = array();
465     if (empty($cmid)) {
466         //If no cmid is passed, check if the user is a teacher in the course
467         //This allows other modules to programmatically "fake" a launch without
468         //a real LTI instance
469         $coursecontext = get_context_instance(CONTEXT_COURSE, $courseid);
471         if (has_capability('moodle/course:manageactivities', $coursecontext)) {
472             array_push($roles, 'Instructor');
473         } else {
474             array_push($roles, 'Learner');
475         }
476     } else {
477         $context = get_context_instance(CONTEXT_MODULE, $cmid);
479         if (has_capability('mod/lti:manage', $context)) {
480             array_push($roles, 'Instructor');
481         } else {
482             array_push($roles, 'Learner');
483         }
484     }
486     if (is_siteadmin($user)) {
487         array_push($roles, 'urn:lti:sysrole:ims/lis/Administrator');
488     }
490     return join(',', $roles);
493 /**
494  * Returns configuration details for the tool
495  *
496  * @param int $typeid   Basic LTI tool typeid
497  *
498  * @return array        Tool Configuration
499  */
500 function lti_get_type_config($typeid) {
501     global $DB;
503     $query = "SELECT name, value
504                 FROM {lti_types_config}
505                WHERE typeid = :typeid1
506            UNION ALL
507               SELECT 'toolurl' AS name, baseurl AS value
508                 FROM {lti_types}
509                WHERE id = :typeid2";
511     $typeconfig = array();
512     $configs = $DB->get_records_sql($query, array('typeid1' => $typeid, 'typeid2' => $typeid));
514     if (!empty($configs)) {
515         foreach ($configs as $config) {
516             $typeconfig[$config->name] = $config->value;
517         }
518     }
520     return $typeconfig;
523 function lti_get_tools_by_url($url, $state, $courseid = null) {
524     $domain = lti_get_domain_from_url($url);
526     return lti_get_tools_by_domain($domain, $state, $courseid);
529 function lti_get_tools_by_domain($domain, $state = null, $courseid = null) {
530     global $DB, $SITE;
532     $filters = array('tooldomain' => $domain);
534     $statefilter = '';
535     $coursefilter = '';
537     if ($state) {
538         $statefilter = 'AND state = :state';
539     }
541     if ($courseid && $courseid != $SITE->id) {
542         $coursefilter = 'OR course = :courseid';
543     }
545     $query = "SELECT *
546                 FROM {lti_types}
547                WHERE tooldomain = :tooldomain
548                  AND (course = :siteid $coursefilter)
549                  $statefilter";
551     return $DB->get_records_sql($query, array(
552         'courseid' => $courseid,
553         'siteid' => $SITE->id,
554         'tooldomain' => $domain,
555         'state' => $state
556     ));
559 /**
560  * Returns all basicLTI tools configured by the administrator
561  *
562  */
563 function lti_filter_get_types($course) {
564     global $DB;
566     if (!empty($course)) {
567         $filter = array('course' => $course);
568     } else {
569         $filter = array();
570     }
572     return $DB->get_records('lti_types', $filter);
575 function lti_get_types_for_add_instance() {
576     global $DB, $SITE, $COURSE;
578     $query = "SELECT *
579                 FROM {lti_types}
580                WHERE coursevisible = 1
581                  AND (course = :siteid OR course = :courseid)
582                  AND state = :active";
584     $admintypes = $DB->get_records_sql($query, array('siteid' => $SITE->id, 'courseid' => $COURSE->id, 'active' => LTI_TOOL_STATE_CONFIGURED));
586     $types = array();
587     $types[0] = (object)array('name' => get_string('automatic', 'lti'), 'course' => $SITE->id);
589     foreach ($admintypes as $type) {
590         $types[$type->id] = $type;
591     }
593     return $types;
596 function lti_get_domain_from_url($url) {
597     $matches = array();
599     if (preg_match(LTI_URL_DOMAIN_REGEX, $url, $matches)) {
600         return $matches[1];
601     }
604 function lti_get_tool_by_url_match($url, $courseid = null, $state = LTI_TOOL_STATE_CONFIGURED) {
605     $possibletools = lti_get_tools_by_url($url, $state, $courseid);
607     return lti_get_best_tool_by_url($url, $possibletools, $courseid);
610 function lti_get_url_thumbprint($url) {
611     $urlparts = parse_url(strtolower($url));
612     if (!isset($urlparts['path'])) {
613         $urlparts['path'] = '';
614     }
616     if (!isset($urlparts['host'])) {
617         $urlparts['host'] = '';
618     }
620     if (substr($urlparts['host'], 0, 4) === 'www.') {
621         $urlparts['host'] = substr($urlparts['host'], 4);
622     }
624     return $urllower = $urlparts['host'] . '/' . $urlparts['path'];
627 function lti_get_best_tool_by_url($url, $tools, $courseid = null) {
628     if (count($tools) === 0) {
629         return null;
630     }
632     $urllower = lti_get_url_thumbprint($url);
634     foreach ($tools as $tool) {
635         $tool->_matchscore = 0;
637         $toolbaseurllower = lti_get_url_thumbprint($tool->baseurl);
639         if ($urllower === $toolbaseurllower) {
640             //100 points for exact thumbprint match
641             $tool->_matchscore += 100;
642         } else if (substr($urllower, 0, strlen($toolbaseurllower)) === $toolbaseurllower) {
643             //50 points if tool thumbprint starts with the base URL thumbprint
644             $tool->_matchscore += 50;
645         }
647         //Prefer course tools over site tools
648         if (!empty($courseid)) {
649             //Minus 25 points for not matching the course id (global tools)
650             if ($tool->course != $courseid) {
651                 $tool->_matchscore -= 10;
652             }
653         }
654     }
656     $bestmatch = array_reduce($tools, function($value, $tool) {
657         if ($tool->_matchscore > $value->_matchscore) {
658             return $tool;
659         } else {
660             return $value;
661         }
663     }, (object)array('_matchscore' => -1));
665     //None of the tools are suitable for this URL
666     if ($bestmatch->_matchscore <= 0) {
667         return null;
668     }
670     return $bestmatch;
673 function lti_get_shared_secrets_by_key($key) {
674     global $DB;
676     //Look up the shared secret for the specified key in both the types_config table (for configured tools)
677     //And in the lti resource table for ad-hoc tools
678     $query = "SELECT t2.value
679                 FROM {lti_types_config} t1
680                 JOIN {lti_types_config} t2 ON t1.typeid = t2.typeid
681                 JOIN {lti_types} type ON t2.typeid = type.id
682               WHERE t1.name = 'resourcekey'
683                 AND t1.value = :key1
684                 AND t2.name = 'password'
685                 AND type.state = :configured
686               UNION
687              SELECT password AS value
688                FROM {lti}
689               WHERE resourcekey = :key2";
691     $sharedsecrets = $DB->get_records_sql($query, array('configured' => LTI_TOOL_STATE_CONFIGURED, 'key1' => $key, 'key2' => $key));
693     $values = array_map(function($item) {
694         return $item->value;
695     }, $sharedsecrets);
697     //There should really only be one shared secret per key. But, we can't prevent
698     //more than one getting entered. For instance, if the same key is used for two tool providers.
699     return $values;
702 /**
703  * Delete a Basic LTI configuration
704  *
705  * @param int $id   Configuration id
706  */
707 function lti_delete_type($id) {
708     global $DB;
710     //We should probably just copy the launch URL to the tool instances in this case... using a single query
711     /*
712     $instances = $DB->get_records('lti', array('typeid' => $id));
713     foreach ($instances as $instance) {
714         $instance->typeid = 0;
715         $DB->update_record('lti', $instance);
716     }*/
718     $DB->delete_records('lti_types', array('id' => $id));
719     $DB->delete_records('lti_types_config', array('typeid' => $id));
722 function lti_set_state_for_type($id, $state) {
723     global $DB;
725     $DB->update_record('lti_types', array('id' => $id, 'state' => $state));
728 /**
729  * Transforms a basic LTI object to an array
730  *
731  * @param object $ltiobject    Basic LTI object
732  *
733  * @return array Basic LTI configuration details
734  */
735 function lti_get_config($ltiobject) {
736     $typeconfig = array();
737     $typeconfig = (array)$ltiobject;
738     $additionalconfig = lti_get_type_config($ltiobject->typeid);
739     $typeconfig = array_merge($typeconfig, $additionalconfig);
740     return $typeconfig;
743 /**
744  *
745  * Generates some of the tool configuration based on the instance details
746  *
747  * @param int $id
748  *
749  * @return Instance configuration
750  *
751  */
752 function lti_get_type_config_from_instance($id) {
753     global $DB;
755     $instance = $DB->get_record('lti', array('id' => $id));
756     $config = lti_get_config($instance);
758     $type = new stdClass();
759     $type->lti_fix = $id;
760     if (isset($config['toolurl'])) {
761         $type->lti_toolurl = $config['toolurl'];
762     }
763     if (isset($config['instructorchoicesendname'])) {
764         $type->lti_sendname = $config['instructorchoicesendname'];
765     }
766     if (isset($config['instructorchoicesendemailaddr'])) {
767         $type->lti_sendemailaddr = $config['instructorchoicesendemailaddr'];
768     }
769     if (isset($config['instructorchoiceacceptgrades'])) {
770         $type->lti_acceptgrades = $config['instructorchoiceacceptgrades'];
771     }
772     if (isset($config['instructorchoiceallowroster'])) {
773         $type->lti_allowroster = $config['instructorchoiceallowroster'];
774     }
776     if (isset($config['instructorcustomparameters'])) {
777         $type->lti_allowsetting = $config['instructorcustomparameters'];
778     }
779     return $type;
782 /**
783  * Generates some of the tool configuration based on the admin configuration details
784  *
785  * @param int $id
786  *
787  * @return Configuration details
788  */
789 function lti_get_type_type_config($id) {
790     global $DB;
792     $basicltitype = $DB->get_record('lti_types', array('id' => $id));
793     $config = lti_get_type_config($id);
795     $type = new stdClass();
797     $type->lti_typename = $basicltitype->name;
799     $type->typeid = $basicltitype->id;
801     $type->lti_toolurl = $basicltitype->baseurl;
803     if (isset($config['resourcekey'])) {
804         $type->lti_resourcekey = $config['resourcekey'];
805     }
806     if (isset($config['password'])) {
807         $type->lti_password = $config['password'];
808     }
810     if (isset($config['sendname'])) {
811         $type->lti_sendname = $config['sendname'];
812     }
813     if (isset($config['instructorchoicesendname'])) {
814         $type->lti_instructorchoicesendname = $config['instructorchoicesendname'];
815     }
816     if (isset($config['sendemailaddr'])) {
817         $type->lti_sendemailaddr = $config['sendemailaddr'];
818     }
819     if (isset($config['instructorchoicesendemailaddr'])) {
820         $type->lti_instructorchoicesendemailaddr = $config['instructorchoicesendemailaddr'];
821     }
822     if (isset($config['acceptgrades'])) {
823         $type->lti_acceptgrades = $config['acceptgrades'];
824     }
825     if (isset($config['instructorchoiceacceptgrades'])) {
826         $type->lti_instructorchoiceacceptgrades = $config['instructorchoiceacceptgrades'];
827     }
828     if (isset($config['allowroster'])) {
829         $type->lti_allowroster = $config['allowroster'];
830     }
831     if (isset($config['instructorchoiceallowroster'])) {
832         $type->lti_instructorchoiceallowroster = $config['instructorchoiceallowroster'];
833     }
835     if (isset($config['customparameters'])) {
836         $type->lti_customparameters = $config['customparameters'];
837     }
839     if (isset($config['forcessl'])) {
840         $type->lti_forcessl = $config['forcessl'];
841     }
843     if (isset($config['organizationid'])) {
844         $type->lti_organizationid = $config['organizationid'];
845     }
846     if (isset($config['organizationurl'])) {
847         $type->lti_organizationurl = $config['organizationurl'];
848     }
849     if (isset($config['organizationdescr'])) {
850         $type->lti_organizationdescr = $config['organizationdescr'];
851     }
852     if (isset($config['launchcontainer'])) {
853         $type->lti_launchcontainer = $config['launchcontainer'];
854     }
856     if (isset($config['coursevisible'])) {
857         $type->lti_coursevisible = $config['coursevisible'];
858     }
860     if (isset($config['debuglaunch'])) {
861         $type->lti_debuglaunch = $config['debuglaunch'];
862     }
864     if (isset($config['module_class_type'])) {
865         $type->lti_module_class_type = $config['module_class_type'];
866     }
868     return $type;
871 function lti_prepare_type_for_save($type, $config) {
872     $type->baseurl = $config->lti_toolurl;
873     $type->tooldomain = lti_get_domain_from_url($config->lti_toolurl);
874     $type->name = $config->lti_typename;
876     $type->coursevisible = !empty($config->lti_coursevisible) ? $config->lti_coursevisible : 0;
877     $config->lti_coursevisible = $type->coursevisible;
879     $type->forcessl = !empty($config->lti_forcessl) ? $config->lti_forcessl : 0;
880     $config->lti_forcessl = $type->forcessl;
882     $type->timemodified = time();
884     unset ($config->lti_typename);
885     unset ($config->lti_toolurl);
888 function lti_update_type($type, $config) {
889     global $DB;
891     lti_prepare_type_for_save($type, $config);
893     if ($DB->update_record('lti_types', $type)) {
894         foreach ($config as $key => $value) {
895             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
896                 $record = new StdClass();
897                 $record->typeid = $type->id;
898                 $record->name = substr($key, 4);
899                 $record->value = $value;
901                 lti_update_config($record);
902             }
903         }
904     }
907 function lti_add_type($type, $config) {
908     global $USER, $SITE, $DB;
910     lti_prepare_type_for_save($type, $config);
912     if (!isset($type->state)) {
913         $type->state = LTI_TOOL_STATE_PENDING;
914     }
916     if (!isset($type->timecreated)) {
917         $type->timecreated = time();
918     }
920     if (!isset($type->createdby)) {
921         $type->createdby = $USER->id;
922     }
924     if (!isset($type->course)) {
925         $type->course = $SITE->id;
926     }
928     //Create a salt value to be used for signing passed data to extension services
929     //The outcome service uses the service salt on the instance. This can be used
930     //for communication with services not related to a specific LTI instance.
931     $config->lti_servicesalt = uniqid('', true);
933     $id = $DB->insert_record('lti_types', $type);
935     if ($id) {
936         foreach ($config as $key => $value) {
937             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
938                 $record = new StdClass();
939                 $record->typeid = $id;
940                 $record->name = substr($key, 4);
941                 $record->value = $value;
943                 lti_add_config($record);
944             }
945         }
946     }
948     return $id;
951 /**
952  * Add a tool configuration in the database
953  *
954  * @param $config   Tool configuration
955  *
956  * @return int Record id number
957  */
958 function lti_add_config($config) {
959     global $DB;
961     return $DB->insert_record('lti_types_config', $config);
964 /**
965  * Updates a tool configuration in the database
966  *
967  * @param $config   Tool configuration
968  *
969  * @return Record id number
970  */
971 function lti_update_config($config) {
972     global $DB;
974     $return = true;
975     $old = $DB->get_record('lti_types_config', array('typeid' => $config->typeid, 'name' => $config->name));
977     if ($old) {
978         $config->id = $old->id;
979         $return = $DB->update_record('lti_types_config', $config);
980     } else {
981         $return = $DB->insert_record('lti_types_config', $config);
982     }
983     return $return;
986 /**
987  * Signs the petition to launch the external tool using OAuth
988  *
989  * @param $oldparms     Parameters to be passed for signing
990  * @param $endpoint     url of the external tool
991  * @param $method       Method for sending the parameters (e.g. POST)
992  * @param $oauth_consumoer_key          Key
993  * @param $oauth_consumoer_secret       Secret
994  * @param $submittext  The text for the submit button
995  * @param $orgid       LMS name
996  * @param $orgdesc     LMS key
997  */
998 function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret) {
999     //global $lastbasestring;
1000     $parms = $oldparms;
1002     $testtoken = '';
1004     // TODO: Switch to core oauthlib once implemented - MDL-30149
1005     $hmacmethod = new lti\OAuthSignatureMethod_HMAC_SHA1();
1006     $testconsumer = new lti\OAuthConsumer($oauthconsumerkey, $oauthconsumersecret, null);
1007     $accreq = lti\OAuthRequest::from_consumer_and_token($testconsumer, $testtoken, $method, $endpoint, $parms);
1008     $accreq->sign_request($hmacmethod, $testconsumer, $testtoken);
1010     // Pass this back up "out of band" for debugging
1011     //$lastbasestring = $accreq->get_signature_base_string();
1013     $newparms = $accreq->get_parameters();
1015     return $newparms;
1018 /**
1019  * Posts the launch petition HTML
1020  *
1021  * @param $newparms     Signed parameters
1022  * @param $endpoint     URL of the external tool
1023  * @param $debug        Debug (true/false)
1024  */
1025 function lti_post_launch_html($newparms, $endpoint, $debug=false) {
1026     $r = "<form action=\"".$endpoint."\" name=\"ltiLaunchForm\" id=\"ltiLaunchForm\" method=\"post\" encType=\"application/x-www-form-urlencoded\">\n";
1028     $submittext = $newparms['ext_submit'];
1030     // Contruct html for the launch parameters
1031     foreach ($newparms as $key => $value) {
1032         $key = htmlspecialchars($key);
1033         $value = htmlspecialchars($value);
1034         if ( $key == "ext_submit" ) {
1035             $r .= "<input type=\"submit\" name=\"";
1036         } else {
1037             $r .= "<input type=\"hidden\" name=\"";
1038         }
1039         $r .= $key;
1040         $r .= "\" value=\"";
1041         $r .= $value;
1042         $r .= "\"/>\n";
1043     }
1045     if ( $debug ) {
1046         $r .= "<script language=\"javascript\"> \n";
1047         $r .= "  //<![CDATA[ \n";
1048         $r .= "function basicltiDebugToggle() {\n";
1049         $r .= "    var ele = document.getElementById(\"basicltiDebug\");\n";
1050         $r .= "    if (ele.style.display == \"block\") {\n";
1051         $r .= "        ele.style.display = \"none\";\n";
1052         $r .= "    }\n";
1053         $r .= "    else {\n";
1054         $r .= "        ele.style.display = \"block\";\n";
1055         $r .= "    }\n";
1056         $r .= "} \n";
1057         $r .= "  //]]> \n";
1058         $r .= "</script>\n";
1059         $r .= "<a id=\"displayText\" href=\"javascript:basicltiDebugToggle();\">";
1060         $r .= get_string("toggle_debug_data", "lti")."</a>\n";
1061         $r .= "<div id=\"basicltiDebug\" style=\"display:none\">\n";
1062         $r .=  "<b>".get_string("basiclti_endpoint", "lti")."</b><br/>\n";
1063         $r .= $endpoint . "<br/>\n&nbsp;<br/>\n";
1064         $r .=  "<b>".get_string("basiclti_parameters", "lti")."</b><br/>\n";
1065         foreach ($newparms as $key => $value) {
1066             $key = htmlspecialchars($key);
1067             $value = htmlspecialchars($value);
1068             $r .= "$key = $value<br/>\n";
1069         }
1070         $r .= "&nbsp;<br/>\n";
1071         //$r .= "<p><b>".get_string("basiclti_base_string", "lti")."</b><br/>\n".$lastbasestring."</p>\n";
1072         $r .= "</div>\n";
1073     }
1074     $r .= "</form>\n";
1076     if ( ! $debug ) {
1077         $ext_submit = "ext_submit";
1078         $ext_submit_text = $submittext;
1079         $r .= " <script type=\"text/javascript\"> \n" .
1080             "  //<![CDATA[ \n" .
1081             "    document.getElementById(\"ltiLaunchForm\").style.display = \"none\";\n" .
1082             "    nei = document.createElement('input');\n" .
1083             "    nei.setAttribute('type', 'hidden');\n" .
1084             "    nei.setAttribute('name', '".$ext_submit."');\n" .
1085             "    nei.setAttribute('value', '".$ext_submit_text."');\n" .
1086             "    document.getElementById(\"ltiLaunchForm\").appendChild(nei);\n" .
1087             "    document.ltiLaunchForm.submit(); \n" .
1088             "  //]]> \n" .
1089             " </script> \n";
1090     }
1091     return $r;
1094 function lti_get_type($typeid) {
1095     global $DB;
1097     return $DB->get_record('lti_types', array('id' => $typeid));
1100 function lti_get_launch_container($lti, $toolconfig) {
1101     if (empty($lti->launchcontainer)) {
1102         $lti->launchcontainer = LTI_LAUNCH_CONTAINER_DEFAULT;
1103     }
1105     if ($lti->launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1106         if (isset($toolconfig['launchcontainer'])) {
1107             $launchcontainer = $toolconfig['launchcontainer'];
1108         }
1109     } else {
1110         $launchcontainer = $lti->launchcontainer;
1111     }
1113     if (empty($launchcontainer) || $launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1114         $launchcontainer = LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS;
1115     }
1117     $devicetype = get_device_type();
1119     //Scrolling within the object element doesn't work on iOS or Android
1120     //Opening the popup window also had some issues in testing
1121     //For mobile devices, always take up the entire screen to ensure the best experience
1122     if ($devicetype === 'mobile' || $devicetype === 'tablet' ) {
1123         $launchcontainer = LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW;
1124     }
1126     return $launchcontainer;
1129 function lti_request_is_using_ssl() {
1130     global $FULLME;
1131     return (stripos($FULLME, 'https://') === 0);
1134 function lti_ensure_url_is_https($url) {
1135     if (!strstr($url, '://')) {
1136         $url = 'https://' . $url;
1137     } else {
1138         //If the URL starts with http, replace with https
1139         if (stripos($url, 'http://') === 0) {
1140             $url = 'https://' . substr($url, 8);
1141         }
1142     }
1144     return $url;