MDL-20534
[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         //Add outcome service URL
259         $serviceurl = new moodle_url('/mod/lti/service.php');
260         $serviceurl = $serviceurl->out();
261         
262         if ($typeconfig['forcessl'] == '1') {
263             $serviceurl = lti_ensure_url_is_https($serviceurl);
264         }
265         
266         $requestparams['lis_outcome_service_url'] = $serviceurl;
267     }
269     // Send user's name and email data if appropriate
270     if ( $typeconfig['sendname'] == LTI_SETTING_ALWAYS ||
271          ( $typeconfig['sendname'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendname == LTI_SETTING_ALWAYS ) ) {
272         $requestparams['lis_person_name_given'] =  $USER->firstname;
273         $requestparams['lis_person_name_family'] =  $USER->lastname;
274         $requestparams['lis_person_name_full'] =  $USER->firstname." ".$USER->lastname;
275     }
277     if ( $typeconfig['sendemailaddr'] == LTI_SETTING_ALWAYS ||
278          ( $typeconfig['sendemailaddr'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendemailaddr == LTI_SETTING_ALWAYS ) ) {
279         $requestparams['lis_person_contact_email_primary'] = $USER->email;
280     }
282     // Concatenate the custom parameters from the administrator and the instructor
283     // Instructor parameters are only taken into consideration if the administrator
284     // has giver permission
285     $customstr = $typeconfig['customparameters'];
286     $instructorcustomstr = $instance->instructorcustomparameters;
287     $custom = array();
288     $instructorcustom = array();
289     if ($customstr) {
290         $custom = lti_split_custom_parameters($customstr);
291     }
292     if (!isset($typeconfig['allowinstructorcustom']) || $typeconfig['allowinstructorcustom'] == LTI_SETTING_NEVER) {
293         $requestparams = array_merge($custom, $requestparams);
294     } else {
295         if ($instructorcustomstr) {
296             $instructorcustom = lti_split_custom_parameters($instructorcustomstr);
297         }
298         foreach ($instructorcustom as $key => $val) {
299             // Ignore the instructor's parameter
300             if (!array_key_exists($key, $custom)) {
301                 $custom[$key] = $val;
302             }
303         }
304         $requestparams = array_merge($custom, $requestparams);
305     }
307     // Make sure we let the tool know what LMS they are being called from
308     $requestparams["ext_lms"] = "moodle-2";
309     $requestparams['tool_consumer_info_product_family_code'] = 'moodle';
310     $requestparams['tool_consumer_info_version'] = strval($CFG->version);
312     // Add oauth_callback to be compliant with the 1.0A spec
313     $requestparams['oauth_callback'] = 'about:blank';
315     //The submit button needs to be part of the signature as it gets posted with the form.
316     //This needs to be here to support launching without javascript.
317     $submittext = get_string('press_to_submit', 'lti');
318     $requestparams['ext_submit'] = $submittext;
320     $requestparams['lti_version'] = 'LTI-1p0';
321     $requestparams['lti_message_type'] = 'basic-lti-launch-request';
323     return $requestparams;
326 function lti_get_tool_table($tools, $id) {
327     global $CFG, $USER;
328     $html = '';
330     $typename = get_string('typename', 'lti');
331     $baseurl = get_string('baseurl', 'lti');
332     $action = get_string('action', 'lti');
333     $createdon = get_string('createdon', 'lti');
335     if ($id == 'lti_configured') {
336         $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>';
337     }
339     if (!empty($tools)) {
340         $html .= "
341         <div id=\"{$id}_container\" style=\"margin-top:.5em;margin-bottom:.5em\">
342             <table id=\"{$id}_tools\">
343                 <thead>
344                     <tr>
345                         <th>$typename</th>
346                         <th>$baseurl</th>
347                         <th>$createdon</th>
348                         <th>$action</th>
349                     </tr>
350                 </thead>
351         ";
353         foreach ($tools as $type) {
354             $date = userdate($type->timecreated);
355             $accept = get_string('accept', 'lti');
356             $update = get_string('update', 'lti');
357             $delete = get_string('delete', 'lti');
359             $accepthtml = "
360                 <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}\">
361                     <img class=\"iconsmall\" alt=\"{$accept}\" src=\"{$CFG->wwwroot}/pix/t/clear.gif\"/>
362                 </a>
363             ";
365             $deleteaction = 'delete';
367             if ($type->state == LTI_TOOL_STATE_CONFIGURED) {
368                 $accepthtml = '';
369             }
371             if ($type->state != LTI_TOOL_STATE_REJECTED) {
372                 $deleteaction = 'reject';
373                 $delete = get_string('reject', 'lti');
374             }
376             $html .= "
377             <tr>
378                 <td>
379                     {$type->name}
380                 </td>
381                 <td>
382                     {$type->baseurl}
383                 </td>
384                 <td>
385                     {$date}
386                 </td>
387                 <td align=\"center\">
388                     {$accepthtml}
389                     <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}\">
390                         <img class=\"iconsmall\" alt=\"{$update}\" src=\"{$CFG->wwwroot}/pix/t/edit.gif\"/>
391                     </a>
392                     <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}\">
393                         <img class=\"iconsmall\" alt=\"{$delete}\" src=\"{$CFG->wwwroot}/pix/t/delete.gif\"/>
394                     </a>
395                 </td>
396             </tr>
397             ";
398         }
399         $html .= '</table></div>';
400     } else {
401         $html .= get_string('no_' . $id, 'lti');
402     }
404     return $html;
407 /**
408  * Splits the custom parameters field to the various parameters
409  *
410  * @param string $customstr     String containing the parameters
411  *
412  * @return Array of custom parameters
413  */
414 function lti_split_custom_parameters($customstr) {
415     $textlib = textlib_get_instance();
417     $lines = preg_split("/[\n;]/", $customstr);
418     $retval = array();
419     foreach ($lines as $line) {
420         $pos = strpos($line, "=");
421         if ( $pos === false || $pos < 1 ) {
422             continue;
423         }
424         $key = trim($textlib->substr($line, 0, $pos));
425         $val = trim($textlib->substr($line, $pos+1, strlen($line)));
426         $key = lti_map_keyname($key);
427         $retval['custom_'.$key] = $val;
428     }
429     return $retval;
432 /**
433  * Used for building the names of the different custom parameters
434  *
435  * @param string $key   Parameter name
436  *
437  * @return string       Processed name
438  */
439 function lti_map_keyname($key) {
440     $textlib = textlib_get_instance();
442     $newkey = "";
443     $key = $textlib->strtolower(trim($key));
444     foreach (str_split($key) as $ch) {
445         if ( ($ch >= 'a' && $ch <= 'z') || ($ch >= '0' && $ch <= '9') ) {
446             $newkey .= $ch;
447         } else {
448             $newkey .= '_';
449         }
450     }
451     return $newkey;
454 /**
455  * Gets the IMS role string for the specified user and LTI course module.
456  *
457  * @param mixed $user User object or user id
458  * @param int $cmid The course module id of the LTI activity
459  * @return string A role string suitable for passing with an LTI launch
460  */
461 function lti_get_ims_role($user, $cmid, $courseid) {
462     $roles = array();
464     if (empty($cmid)) {
465         //If no cmid is passed, check if the user is a teacher in the course
466         //This allows other modules to programmatically "fake" a launch without
467         //a real LTI instance
468         $coursecontext = get_context_instance(CONTEXT_COURSE, $courseid);
470         if (has_capability('moodle/course:manageactivities', $coursecontext)) {
471             array_push($roles, 'Instructor');
472         } else {
473             array_push($roles, 'Learner');
474         }
475     } else {
476         $context = get_context_instance(CONTEXT_MODULE, $cmid);
478         if (has_capability('mod/lti:manage', $context)) {
479             array_push($roles, 'Instructor');
480         } else {
481             array_push($roles, 'Learner');
482         }
483     }
485     if (is_siteadmin($user)) {
486         array_push($roles, 'urn:lti:sysrole:ims/lis/Administrator');
487     }
489     return join(',', $roles);
492 /**
493  * Returns configuration details for the tool
494  *
495  * @param int $typeid   Basic LTI tool typeid
496  *
497  * @return array        Tool Configuration
498  */
499 function lti_get_type_config($typeid) {
500     global $DB;
502     $query = "SELECT name, value
503                 FROM {lti_types_config}
504                WHERE typeid = :typeid1
505            UNION ALL
506               SELECT 'toolurl' AS name, baseurl AS value
507                 FROM {lti_types}
508                WHERE id = :typeid2";
510     $typeconfig = array();
511     $configs = $DB->get_records_sql($query, array('typeid1' => $typeid, 'typeid2' => $typeid));
513     if (!empty($configs)) {
514         foreach ($configs as $config) {
515             $typeconfig[$config->name] = $config->value;
516         }
517     }
519     return $typeconfig;
522 function lti_get_tools_by_url($url, $state, $courseid = null) {
523     $domain = lti_get_domain_from_url($url);
525     return lti_get_tools_by_domain($domain, $state, $courseid);
528 function lti_get_tools_by_domain($domain, $state = null, $courseid = null) {
529     global $DB, $SITE;
531     $filters = array('tooldomain' => $domain);
533     $statefilter = '';
534     $coursefilter = '';
536     if ($state) {
537         $statefilter = 'AND state = :state';
538     }
540     if ($courseid && $courseid != $SITE->id) {
541         $coursefilter = 'OR course = :courseid';
542     }
544     $query = "SELECT *
545                 FROM {lti_types}
546                WHERE tooldomain = :tooldomain
547                  AND (course = :siteid $coursefilter)
548                  $statefilter";
550     return $DB->get_records_sql($query, array(
551         'courseid' => $courseid,
552         'siteid' => $SITE->id,
553         'tooldomain' => $domain,
554         'state' => $state
555     ));
558 /**
559  * Returns all basicLTI tools configured by the administrator
560  *
561  */
562 function lti_filter_get_types($course) {
563     global $DB;
565     if (!empty($course)) {
566         $filter = array('course' => $course);
567     } else {
568         $filter = array();
569     }
571     return $DB->get_records('lti_types', $filter);
574 function lti_get_types_for_add_instance() {
575     global $DB, $SITE, $COURSE;
577     $query = "SELECT *
578                 FROM {lti_types}
579                WHERE coursevisible = 1
580                  AND (course = :siteid OR course = :courseid)
581                  AND state = :active";
583     $admintypes = $DB->get_records_sql($query, array('siteid' => $SITE->id, 'courseid' => $COURSE->id, 'active' => LTI_TOOL_STATE_CONFIGURED));
585     $types = array();
586     $types[0] = (object)array('name' => get_string('automatic', 'lti'), 'course' => $SITE->id);
588     foreach ($admintypes as $type) {
589         $types[$type->id] = $type;
590     }
592     return $types;
595 function lti_get_domain_from_url($url) {
596     $matches = array();
598     if (preg_match(LTI_URL_DOMAIN_REGEX, $url, $matches)) {
599         return $matches[1];
600     }
603 function lti_get_tool_by_url_match($url, $courseid = null, $state = LTI_TOOL_STATE_CONFIGURED) {
604     $possibletools = lti_get_tools_by_url($url, $state, $courseid);
606     return lti_get_best_tool_by_url($url, $possibletools, $courseid);
609 function lti_get_url_thumbprint($url) {
610     $urlparts = parse_url(strtolower($url));
611     if (!isset($urlparts['path'])) {
612         $urlparts['path'] = '';
613     }
615     if (!isset($urlparts['host'])) {
616         $urlparts['host'] = '';
617     }
619     if (substr($urlparts['host'], 0, 4) === 'www.') {
620         $urlparts['host'] = substr($urlparts['host'], 4);
621     }
623     return $urllower = $urlparts['host'] . '/' . $urlparts['path'];
626 function lti_get_best_tool_by_url($url, $tools, $courseid = null) {
627     if (count($tools) === 0) {
628         return null;
629     }
631     $urllower = lti_get_url_thumbprint($url);
633     foreach ($tools as $tool) {
634         $tool->_matchscore = 0;
636         $toolbaseurllower = lti_get_url_thumbprint($tool->baseurl);
638         if ($urllower === $toolbaseurllower) {
639             //100 points for exact thumbprint match
640             $tool->_matchscore += 100;
641         } else if (substr($urllower, 0, strlen($toolbaseurllower)) === $toolbaseurllower) {
642             //50 points if tool thumbprint starts with the base URL thumbprint
643             $tool->_matchscore += 50;
644         }
646         //Prefer course tools over site tools
647         if (!empty($courseid)) {
648             //Minus 25 points for not matching the course id (global tools)
649             if ($tool->course != $courseid) {
650                 $tool->_matchscore -= 10;
651             }
652         }
653     }
655     $bestmatch = array_reduce($tools, function($value, $tool) {
656         if ($tool->_matchscore > $value->_matchscore) {
657             return $tool;
658         } else {
659             return $value;
660         }
662     }, (object)array('_matchscore' => -1));
664     //None of the tools are suitable for this URL
665     if ($bestmatch->_matchscore <= 0) {
666         return null;
667     }
669     return $bestmatch;
672 function lti_get_shared_secrets_by_key($key) {
673     global $DB;
675     //Look up the shared secret for the specified key in both the types_config table (for configured tools)
676     //And in the lti resource table for ad-hoc tools
677     $query = "SELECT t2.value
678                 FROM {lti_types_config} t1
679                 JOIN {lti_types_config} t2 ON t1.typeid = t2.typeid
680                 JOIN {lti_types} type ON t2.typeid = type.id
681               WHERE t1.name = 'resourcekey'
682                 AND t1.value = :key1
683                 AND t2.name = 'password'
684                 AND type.state = :configured
685               UNION
686              SELECT password AS value
687                FROM {lti}
688               WHERE resourcekey = :key2";
690     $sharedsecrets = $DB->get_records_sql($query, array('configured' => LTI_TOOL_STATE_CONFIGURED, 'key1' => $key, 'key2' => $key));
692     $values = array_map(function($item) {
693         return $item->value;
694     }, $sharedsecrets);
696     //There should really only be one shared secret per key. But, we can't prevent
697     //more than one getting entered. For instance, if the same key is used for two tool providers.
698     return $values;
701 /**
702  * Prints the various configured tool types
703  *
704  */
705 function lti_filter_print_types() {
706     global $CFG;
708     $types = lti_filter_get_types();
709     if (!empty($types)) {
710         echo '<ul>';
711         foreach ($types as $type) {
712             echo '<li>'.
713             $type->name.
714             '<span class="commands">'.
715             '<a class="editing_update" href="typessettings.php?action=update&amp;id='.$type->id.'&amp;sesskey='.sesskey().'" title="Update">'.
716             '<img class="iconsmall" alt="Update" src="'.$CFG->wwwroot.'/pix/t/edit.gif"/>'.
717             '</a>'.
718             '<a class="editing_delete" href="typessettings.php?action=delete&amp;id='.$type->id.'&amp;sesskey='.sesskey().'" title="Delete">'.
719             '<img class="iconsmall" alt="Delete" src="'.$CFG->wwwroot.'/pix/t/delete.gif"/>'.
720             '</a>'.
721             '</span>'.
722             '</li>';
724         }
725         echo '</ul>';
726     } else {
727         echo '<div class="message">';
728         echo get_string('notypes', 'lti');
729         echo '</div>';
730     }
733 /**
734  * Delete a Basic LTI configuration
735  *
736  * @param int $id   Configuration id
737  */
738 function lti_delete_type($id) {
739     global $DB;
741     //We should probably just copy the launch URL to the tool instances in this case... using a single query
742     /*
743     $instances = $DB->get_records('lti', array('typeid' => $id));
744     foreach ($instances as $instance) {
745         $instance->typeid = 0;
746         $DB->update_record('lti', $instance);
747     }*/
749     $DB->delete_records('lti_types', array('id' => $id));
750     $DB->delete_records('lti_types_config', array('typeid' => $id));
753 function lti_set_state_for_type($id, $state) {
754     global $DB;
756     $DB->update_record('lti_types', array('id' => $id, 'state' => $state));
759 /**
760  * Transforms a basic LTI object to an array
761  *
762  * @param object $ltiobject    Basic LTI object
763  *
764  * @return array Basic LTI configuration details
765  */
766 function lti_get_config($ltiobject) {
767     $typeconfig = array();
768     $typeconfig = (array)$ltiobject;
769     $additionalconfig = lti_get_type_config($ltiobject->typeid);
770     $typeconfig = array_merge($typeconfig, $additionalconfig);
771     return $typeconfig;
774 /**
775  *
776  * Generates some of the tool configuration based on the instance details
777  *
778  * @param int $id
779  *
780  * @return Instance configuration
781  *
782  */
783 function lti_get_type_config_from_instance($id) {
784     global $DB;
786     $instance = $DB->get_record('lti', array('id' => $id));
787     $config = lti_get_config($instance);
789     $type = new stdClass();
790     $type->lti_fix = $id;
791     if (isset($config['toolurl'])) {
792         $type->lti_toolurl = $config['toolurl'];
793     }
794     if (isset($config['instructorchoicesendname'])) {
795         $type->lti_sendname = $config['instructorchoicesendname'];
796     }
797     if (isset($config['instructorchoicesendemailaddr'])) {
798         $type->lti_sendemailaddr = $config['instructorchoicesendemailaddr'];
799     }
800     if (isset($config['instructorchoiceacceptgrades'])) {
801         $type->lti_acceptgrades = $config['instructorchoiceacceptgrades'];
802     }
803     if (isset($config['instructorchoiceallowroster'])) {
804         $type->lti_allowroster = $config['instructorchoiceallowroster'];
805     }
807     if (isset($config['instructorcustomparameters'])) {
808         $type->lti_allowsetting = $config['instructorcustomparameters'];
809     }
810     return $type;
813 /**
814  * Generates some of the tool configuration based on the admin configuration details
815  *
816  * @param int $id
817  *
818  * @return Configuration details
819  */
820 function lti_get_type_type_config($id) {
821     global $DB;
823     $basicltitype = $DB->get_record('lti_types', array('id' => $id));
824     $config = lti_get_type_config($id);
826     $type->lti_typename = $basicltitype->name;
828     $type->typeid = $basicltitype->id;
830     $type->lti_toolurl = $basicltitype->baseurl;
832     if (isset($config['resourcekey'])) {
833         $type->lti_resourcekey = $config['resourcekey'];
834     }
835     if (isset($config['password'])) {
836         $type->lti_password = $config['password'];
837     }
839     if (isset($config['sendname'])) {
840         $type->lti_sendname = $config['sendname'];
841     }
842     if (isset($config['instructorchoicesendname'])) {
843         $type->lti_instructorchoicesendname = $config['instructorchoicesendname'];
844     }
845     if (isset($config['sendemailaddr'])) {
846         $type->lti_sendemailaddr = $config['sendemailaddr'];
847     }
848     if (isset($config['instructorchoicesendemailaddr'])) {
849         $type->lti_instructorchoicesendemailaddr = $config['instructorchoicesendemailaddr'];
850     }
851     if (isset($config['acceptgrades'])) {
852         $type->lti_acceptgrades = $config['acceptgrades'];
853     }
854     if (isset($config['instructorchoiceacceptgrades'])) {
855         $type->lti_instructorchoiceacceptgrades = $config['instructorchoiceacceptgrades'];
856     }
857     if (isset($config['allowroster'])) {
858         $type->lti_allowroster = $config['allowroster'];
859     }
860     if (isset($config['instructorchoiceallowroster'])) {
861         $type->lti_instructorchoiceallowroster = $config['instructorchoiceallowroster'];
862     }
864     if (isset($config['customparameters'])) {
865         $type->lti_customparameters = $config['customparameters'];
866     }
868     if (isset($config['forcessl'])) {
869         $type->lti_forcessl = $config['forcessl'];
870     }
872     if (isset($config['organizationid'])) {
873         $type->lti_organizationid = $config['organizationid'];
874     }
875     if (isset($config['organizationurl'])) {
876         $type->lti_organizationurl = $config['organizationurl'];
877     }
878     if (isset($config['organizationdescr'])) {
879         $type->lti_organizationdescr = $config['organizationdescr'];
880     }
881     if (isset($config['launchcontainer'])) {
882         $type->lti_launchcontainer = $config['launchcontainer'];
883     }
885     if (isset($config['coursevisible'])) {
886         $type->lti_coursevisible = $config['coursevisible'];
887     }
889     if (isset($config['debuglaunch'])) {
890         $type->lti_debuglaunch = $config['debuglaunch'];
891     }
893     if (isset($config['module_class_type'])) {
894             $type->lti_module_class_type = $config['module_class_type'];
895     }
897     return $type;
900 function lti_prepare_type_for_save($type, $config) {
901     $type->baseurl = $config->lti_toolurl;
902     $type->tooldomain = lti_get_domain_from_url($config->lti_toolurl);
903     $type->name = $config->lti_typename;
905     $type->coursevisible = !empty($config->lti_coursevisible) ? $config->lti_coursevisible : 0;
906     $config->lti_coursevisible = $type->coursevisible;
908     $type->forcessl = !empty($config->lti_forcessl) ? $config->lti_forcessl : 0;
909     $config->lti_forcessl = $type->forcessl;
911     $type->timemodified = time();
913     unset ($config->lti_typename);
914     unset ($config->lti_toolurl);
917 function lti_update_type($type, $config) {
918     global $DB;
920     lti_prepare_type_for_save($type, $config);
922     if ($DB->update_record('lti_types', $type)) {
923         foreach ($config as $key => $value) {
924             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
925                 $record = new StdClass();
926                 $record->typeid = $type->id;
927                 $record->name = substr($key, 4);
928                 $record->value = $value;
930                 lti_update_config($record);
931             }
932         }
933     }
936 function lti_add_type($type, $config) {
937     global $USER, $SITE, $DB;
939     lti_prepare_type_for_save($type, $config);
941     if (!isset($type->state)) {
942         $type->state = LTI_TOOL_STATE_PENDING;
943     }
945     if (!isset($type->timecreated)) {
946         $type->timecreated = time();
947     }
949     if (!isset($type->createdby)) {
950         $type->createdby = $USER->id;
951     }
953     if (!isset($type->course)) {
954         $type->course = $SITE->id;
955     }
957     //Create a salt value to be used for signing passed data to extension services
958     //The outcome service uses the service salt on the instance. This can be used
959     //for communication with services not related to a specific LTI instance.
960     $config->lti_servicesalt = uniqid('', true);
962     $id = $DB->insert_record('lti_types', $type);
964     if ($id) {
965         foreach ($config as $key => $value) {
966             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
967                 $record = new StdClass();
968                 $record->typeid = $id;
969                 $record->name = substr($key, 4);
970                 $record->value = $value;
972                 lti_add_config($record);
973             }
974         }
975     }
977     return $id;
980 /**
981  * Add a tool configuration in the database
982  *
983  * @param $config   Tool configuration
984  *
985  * @return int Record id number
986  */
987 function lti_add_config($config) {
988     global $DB;
990     return $DB->insert_record('lti_types_config', $config);
993 /**
994  * Updates a tool configuration in the database
995  *
996  * @param $config   Tool configuration
997  *
998  * @return Record id number
999  */
1000 function lti_update_config($config) {
1001     global $DB;
1003     $return = true;
1004     $old = $DB->get_record('lti_types_config', array('typeid' => $config->typeid, 'name' => $config->name));
1006     if ($old) {
1007         $config->id = $old->id;
1008         $return = $DB->update_record('lti_types_config', $config);
1009     } else {
1010         $return = $DB->insert_record('lti_types_config', $config);
1011     }
1012     return $return;
1015 /**
1016  * Signs the petition to launch the external tool using OAuth
1017  *
1018  * @param $oldparms     Parameters to be passed for signing
1019  * @param $endpoint     url of the external tool
1020  * @param $method       Method for sending the parameters (e.g. POST)
1021  * @param $oauth_consumoer_key          Key
1022  * @param $oauth_consumoer_secret       Secret
1023  * @param $submittext  The text for the submit button
1024  * @param $orgid       LMS name
1025  * @param $orgdesc     LMS key
1026  */
1027 function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret) {
1028     //global $lastbasestring;
1029     $parms = $oldparms;
1031     $testtoken = '';
1033     // TODO: Switch to core oauthlib once implemented - MDL-30149
1034     $hmacmethod = new lti\OAuthSignatureMethod_HMAC_SHA1();
1035     $testconsumer = new lti\OAuthConsumer($oauthconsumerkey, $oauthconsumersecret, null);
1036     $accreq = lti\OAuthRequest::from_consumer_and_token($testconsumer, $testtoken, $method, $endpoint, $parms);
1037     $accreq->sign_request($hmacmethod, $testconsumer, $testtoken);
1039     // Pass this back up "out of band" for debugging
1040     //$lastbasestring = $accreq->get_signature_base_string();
1042     $newparms = $accreq->get_parameters();
1044     return $newparms;
1047 /**
1048  * Posts the launch petition HTML
1049  *
1050  * @param $newparms     Signed parameters
1051  * @param $endpoint     URL of the external tool
1052  * @param $debug        Debug (true/false)
1053  */
1054 function lti_post_launch_html($newparms, $endpoint, $debug=false) {
1055     //global $lastbasestring;
1057     $r = "<form action=\"".$endpoint."\" name=\"ltiLaunchForm\" id=\"ltiLaunchForm\" method=\"post\" encType=\"application/x-www-form-urlencoded\">\n";
1059     $submittext = $newparms['ext_submit'];
1061     // Contruct html for the launch parameters
1062     foreach ($newparms as $key => $value) {
1063         $key = htmlspecialchars($key);
1064         $value = htmlspecialchars($value);
1065         if ( $key == "ext_submit" ) {
1066             $r .= "<input type=\"submit\" name=\"";
1067         } else {
1068             $r .= "<input type=\"hidden\" name=\"";
1069         }
1070         $r .= $key;
1071         $r .= "\" value=\"";
1072         $r .= $value;
1073         $r .= "\"/>\n";
1074     }
1076     if ( $debug ) {
1077         $r .= "<script language=\"javascript\"> \n";
1078         $r .= "  //<![CDATA[ \n";
1079         $r .= "function basicltiDebugToggle() {\n";
1080         $r .= "    var ele = document.getElementById(\"basicltiDebug\");\n";
1081         $r .= "    if (ele.style.display == \"block\") {\n";
1082         $r .= "        ele.style.display = \"none\";\n";
1083         $r .= "    }\n";
1084         $r .= "    else {\n";
1085         $r .= "        ele.style.display = \"block\";\n";
1086         $r .= "    }\n";
1087         $r .= "} \n";
1088         $r .= "  //]]> \n";
1089         $r .= "</script>\n";
1090         $r .= "<a id=\"displayText\" href=\"javascript:basicltiDebugToggle();\">";
1091         $r .= get_string("toggle_debug_data", "lti")."</a>\n";
1092         $r .= "<div id=\"basicltiDebug\" style=\"display:none\">\n";
1093         $r .=  "<b>".get_string("basiclti_endpoint", "lti")."</b><br/>\n";
1094         $r .= $endpoint . "<br/>\n&nbsp;<br/>\n";
1095         $r .=  "<b>".get_string("basiclti_parameters", "lti")."</b><br/>\n";
1096         foreach ($newparms as $key => $value) {
1097             $key = htmlspecialchars($key);
1098             $value = htmlspecialchars($value);
1099             $r .= "$key = $value<br/>\n";
1100         }
1101         $r .= "&nbsp;<br/>\n";
1102         //$r .= "<p><b>".get_string("basiclti_base_string", "lti")."</b><br/>\n".$lastbasestring."</p>\n";
1103         $r .= "</div>\n";
1104     }
1105     $r .= "</form>\n";
1107     if ( ! $debug ) {
1108         $ext_submit = "ext_submit";
1109         $ext_submit_text = $submittext;
1110         $r .= " <script type=\"text/javascript\"> \n" .
1111             "  //<![CDATA[ \n" .
1112             "    document.getElementById(\"ltiLaunchForm\").style.display = \"none\";\n" .
1113             "    nei = document.createElement('input');\n" .
1114             "    nei.setAttribute('type', 'hidden');\n" .
1115             "    nei.setAttribute('name', '".$ext_submit."');\n" .
1116             "    nei.setAttribute('value', '".$ext_submit_text."');\n" .
1117             "    document.getElementById(\"ltiLaunchForm\").appendChild(nei);\n" .
1118             "    document.ltiLaunchForm.submit(); \n" .
1119             "  //]]> \n" .
1120             " </script> \n";
1121     }
1122     return $r;
1125 function lti_get_type($typeid) {
1126     global $DB;
1128     return $DB->get_record('lti_types', array('id' => $typeid));
1131 function lti_get_launch_container($lti, $toolconfig) {
1132     if (empty($lti->launchcontainer)) {
1133         $lti->launchcontainer = LTI_LAUNCH_CONTAINER_DEFAULT;
1134     }
1136     if ($lti->launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1137         if (isset($toolconfig['launchcontainer'])) {
1138             $launchcontainer = $toolconfig['launchcontainer'];
1139         }
1140     } else {
1141         $launchcontainer = $lti->launchcontainer;
1142     }
1144     if (empty($launchcontainer) || $launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1145         $launchcontainer = LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS;
1146     }
1148     $devicetype = get_device_type();
1150     //Scrolling within the object element doesn't work on iOS or Android
1151     //Opening the popup window also had some issues in testing
1152     //For mobile devices, always take up the entire screen to ensure the best experience
1153     if ($devicetype === 'mobile' || $devicetype === 'tablet' ) {
1154         $launchcontainer = LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW;
1155     }
1157     return $launchcontainer;
1160 function lti_request_is_using_ssl() {
1161     global $ME;
1162     return (stripos($ME, 'https://') === 0);
1165 function lti_ensure_url_is_https($url) {
1166     if (!strstr($url, '://')) {
1167         $url = 'https://' . $url;
1168     } else {
1169         //If the URL starts with http, replace with https
1170         if (stripos($url, 'http://') === 0) {
1171             $url = 'https://' . substr($url, 8);
1172         }
1173     }
1175     return $url;