Merge branch 'MDL-52821-master' of https://github.com/xow/moodle
[moodle.git] / mod / lti / locallib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 //
17 // This file is part of BasicLTI4Moodle
18 //
19 // BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
20 // consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
21 // based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
22 // specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
23 // are already supporting or going to support BasicLTI. This project Implements the consumer
24 // for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
25 // BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
26 // at the GESSI research group at UPC.
27 // SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
28 // by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
29 // Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
30 //
31 // BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
32 // of the Universitat Politecnica de Catalunya http://www.upc.edu
33 // Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu.
35 /**
36  * This file contains the library of functions and constants for the lti module
37  *
38  * @package mod_lti
39  * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
40  *  marc.alier@upc.edu
41  * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
42  * @author     Marc Alier
43  * @author     Jordi Piguillem
44  * @author     Nikolas Galanis
45  * @author     Chris Scribner
46  * @copyright  2015 Vital Source Technologies http://vitalsource.com
47  * @author     Stephen Vickers
48  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
49  */
51 defined('MOODLE_INTERNAL') || die;
53 // TODO: Switch to core oauthlib once implemented - MDL-30149.
54 use moodle\mod\lti as lti;
56 require_once($CFG->dirroot.'/mod/lti/OAuth.php');
57 require_once($CFG->libdir.'/weblib.php');
59 define('LTI_URL_DOMAIN_REGEX', '/(?:https?:\/\/)?(?:www\.)?([^\/]+)(?:\/|$)/i');
61 define('LTI_LAUNCH_CONTAINER_DEFAULT', 1);
62 define('LTI_LAUNCH_CONTAINER_EMBED', 2);
63 define('LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS', 3);
64 define('LTI_LAUNCH_CONTAINER_WINDOW', 4);
65 define('LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW', 5);
67 define('LTI_TOOL_STATE_ANY', 0);
68 define('LTI_TOOL_STATE_CONFIGURED', 1);
69 define('LTI_TOOL_STATE_PENDING', 2);
70 define('LTI_TOOL_STATE_REJECTED', 3);
71 define('LTI_TOOL_PROXY_TAB', 4);
73 define('LTI_TOOL_PROXY_STATE_CONFIGURED', 1);
74 define('LTI_TOOL_PROXY_STATE_PENDING', 2);
75 define('LTI_TOOL_PROXY_STATE_ACCEPTED', 3);
76 define('LTI_TOOL_PROXY_STATE_REJECTED', 4);
78 define('LTI_SETTING_NEVER', 0);
79 define('LTI_SETTING_ALWAYS', 1);
80 define('LTI_SETTING_DELEGATE', 2);
82 /**
83  * Return the launch data required for opening the external tool.
84  *
85  * @param  stdClass $instance the external tool activity settings
86  * @return array the endpoint URL and parameters (including the signature)
87  * @since  Moodle 3.0
88  */
89 function lti_get_launch_data($instance) {
90     global $PAGE, $CFG;
92     if (empty($instance->typeid)) {
93         $tool = lti_get_tool_by_url_match($instance->toolurl, $instance->course);
94         if ($tool) {
95             $typeid = $tool->id;
96         } else {
97             $typeid = null;
98         }
99     } else {
100         $typeid = $instance->typeid;
101         $tool = lti_get_type($typeid);
102     }
104     if ($typeid) {
105         $typeconfig = lti_get_type_config($typeid);
106     } else {
107         // There is no admin configuration for this tool. Use configuration in the lti instance record plus some defaults.
108         $typeconfig = (array)$instance;
110         $typeconfig['sendname'] = $instance->instructorchoicesendname;
111         $typeconfig['sendemailaddr'] = $instance->instructorchoicesendemailaddr;
112         $typeconfig['customparameters'] = $instance->instructorcustomparameters;
113         $typeconfig['acceptgrades'] = $instance->instructorchoiceacceptgrades;
114         $typeconfig['allowroster'] = $instance->instructorchoiceallowroster;
115         $typeconfig['forcessl'] = '0';
116     }
118     // Default the organizationid if not specified.
119     if (empty($typeconfig['organizationid'])) {
120         $urlparts = parse_url($CFG->wwwroot);
122         $typeconfig['organizationid'] = $urlparts['host'];
123     }
125     if (isset($tool->toolproxyid)) {
126         $toolproxy = lti_get_tool_proxy($tool->toolproxyid);
127         $key = $toolproxy->guid;
128         $secret = $toolproxy->secret;
129     } else {
130         $toolproxy = null;
131         if (!empty($instance->resourcekey)) {
132             $key = $instance->resourcekey;
133         } else if (!empty($typeconfig['resourcekey'])) {
134             $key = $typeconfig['resourcekey'];
135         } else {
136             $key = '';
137         }
138         if (!empty($instance->password)) {
139             $secret = $instance->password;
140         } else if (!empty($typeconfig['password'])) {
141             $secret = $typeconfig['password'];
142         } else {
143             $secret = '';
144         }
145     }
147     $endpoint = !empty($instance->toolurl) ? $instance->toolurl : $typeconfig['toolurl'];
148     $endpoint = trim($endpoint);
150     // If the current request is using SSL and a secure tool URL is specified, use it.
151     if (lti_request_is_using_ssl() && !empty($instance->securetoolurl)) {
152         $endpoint = trim($instance->securetoolurl);
153     }
155     // If SSL is forced, use the secure tool url if specified. Otherwise, make sure https is on the normal launch URL.
156     if (isset($typeconfig['forcessl']) && ($typeconfig['forcessl'] == '1')) {
157         if (!empty($instance->securetoolurl)) {
158             $endpoint = trim($instance->securetoolurl);
159         }
161         $endpoint = lti_ensure_url_is_https($endpoint);
162     } else {
163         if (!strstr($endpoint, '://')) {
164             $endpoint = 'http://' . $endpoint;
165         }
166     }
168     $orgid = $typeconfig['organizationid'];
170     $course = $PAGE->course;
171     $islti2 = isset($tool->toolproxyid);
172     $allparams = lti_build_request($instance, $typeconfig, $course, $typeid, $islti2);
173     if ($islti2) {
174         $requestparams = lti_build_request_lti2($tool, $allparams);
175     } else {
176         $requestparams = $allparams;
177     }
178     $requestparams = array_merge($requestparams, lti_build_standard_request($instance, $orgid, $islti2));
179     $customstr = '';
180     if (isset($typeconfig['customparameters'])) {
181         $customstr = $typeconfig['customparameters'];
182     }
183     $requestparams = array_merge($requestparams, lti_build_custom_parameters($toolproxy, $tool, $instance, $allparams, $customstr,
184         $instance->instructorcustomparameters, $islti2));
186     $launchcontainer = lti_get_launch_container($instance, $typeconfig);
187     $returnurlparams = array('course' => $course->id,
188                              'launch_container' => $launchcontainer,
189                              'instanceid' => $instance->id,
190                              'sesskey' => sesskey());
192     // Add the return URL. We send the launch container along to help us avoid frames-within-frames when the user returns.
193     $url = new \moodle_url('/mod/lti/return.php', $returnurlparams);
194     $returnurl = $url->out(false);
196     if (isset($typeconfig['forcessl']) && ($typeconfig['forcessl'] == '1')) {
197         $returnurl = lti_ensure_url_is_https($returnurl);
198     }
200     $target = '';
201     switch($launchcontainer) {
202         case LTI_LAUNCH_CONTAINER_EMBED:
203         case LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS:
204             $target = 'iframe';
205             break;
206         case LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW:
207             $target = 'frame';
208             break;
209         case LTI_LAUNCH_CONTAINER_WINDOW:
210             $target = 'window';
211             break;
212     }
213     if (!empty($target)) {
214         $requestparams['launch_presentation_document_target'] = $target;
215     }
217     $requestparams['launch_presentation_return_url'] = $returnurl;
219     // Allow request params to be updated by sub-plugins.
220     $plugins = core_component::get_plugin_list('ltisource');
221     foreach (array_keys($plugins) as $plugin) {
222         $pluginparams = component_callback('ltisource_'.$plugin, 'before_launch',
223             array($instance, $endpoint, $requestparams), array());
225         if (!empty($pluginparams) && is_array($pluginparams)) {
226             $requestparams = array_merge($requestparams, $pluginparams);
227         }
228     }
230     if (!empty($key) && !empty($secret)) {
231         $parms = lti_sign_parameters($requestparams, $endpoint, "POST", $key, $secret);
233         $endpointurl = new \moodle_url($endpoint);
234         $endpointparams = $endpointurl->params();
236         // Strip querystring params in endpoint url from $parms to avoid duplication.
237         if (!empty($endpointparams) && !empty($parms)) {
238             foreach (array_keys($endpointparams) as $paramname) {
239                 if (isset($parms[$paramname])) {
240                     unset($parms[$paramname]);
241                 }
242             }
243         }
245     } else {
246         // If no key and secret, do the launch unsigned.
247         $returnurlparams['unsigned'] = '1';
248         $parms = $requestparams;
249     }
251     return array($endpoint, $parms);
254 /**
255  * Launch an external tool activity.
256  *
257  * @param  stdClass $instance the external tool activity settings
258  * @return string The HTML code containing the javascript code for the launch
259  */
260 function lti_launch_tool($instance) {
262     list($endpoint, $parms) = lti_get_launch_data($instance);
263     $debuglaunch = ( $instance->debuglaunch == 1 );
265     $content = lti_post_launch_html($parms, $endpoint, $debuglaunch);
267     echo $content;
270 /**
271  * Prepares an LTI registration request message
272  *
273  * $param object $instance       Tool Proxy instance object
274  */
275 function lti_register($toolproxy) {
276     global $PAGE, $CFG;
278     $key = $toolproxy->guid;
279     $secret = $toolproxy->secret;
280     $endpoint = $toolproxy->regurl;
282     $requestparams = array();
283     $requestparams['lti_message_type'] = 'ToolProxyRegistrationRequest';
284     $requestparams['lti_version'] = 'LTI-2p0';
285     $requestparams['reg_key'] = $key;
286     $requestparams['reg_password'] = $secret;
288     // Change the status to pending.
289     $toolproxy->state = LTI_TOOL_PROXY_STATE_PENDING;
290     lti_update_tool_proxy($toolproxy);
292     // Add the profile URL.
293     $profileservice = lti_get_service_by_name('profile');
294     $profileservice->set_tool_proxy($toolproxy);
295     $requestparams['tc_profile_url'] = $profileservice->parse_value('$ToolConsumerProfile.url');
297     // Add the return URL.
298     $returnurlparams = array('id' => $toolproxy->id, 'sesskey' => sesskey());
299     $url = new \moodle_url('/mod/lti/registrationreturn.php', $returnurlparams);
300     $returnurl = $url->out(false);
302     $requestparams['launch_presentation_return_url'] = $returnurl;
303     $content = lti_post_launch_html($requestparams, $endpoint, false);
305     echo $content;
308 /**
309  * Build source ID
310  *
311  * @param int $instanceid
312  * @param int $userid
313  * @param string $servicesalt
314  * @param null|int $typeid
315  * @param null|int $launchid
316  * @return stdClass
317  */
318 function lti_build_sourcedid($instanceid, $userid, $servicesalt, $typeid = null, $launchid = null) {
319     $data = new \stdClass();
321     $data->instanceid = $instanceid;
322     $data->userid = $userid;
323     $data->typeid = $typeid;
324     if (!empty($launchid)) {
325         $data->launchid = $launchid;
326     } else {
327         $data->launchid = mt_rand();
328     }
330     $json = json_encode($data);
332     $hash = hash('sha256', $json . $servicesalt, false);
334     $container = new \stdClass();
335     $container->data = $data;
336     $container->hash = $hash;
338     return $container;
341 /**
342  * This function builds the request that must be sent to the tool producer
343  *
344  * @param object    $instance       Basic LTI instance object
345  * @param array     $typeconfig     Basic LTI tool configuration
346  * @param object    $course         Course object
347  * @param int|null  $typeid         Basic LTI tool ID
348  * @param boolean   $islti2         True if an LTI 2 tool is being launched
349  *
350  * @return array                    Request details
351  */
352 function lti_build_request($instance, $typeconfig, $course, $typeid = null, $islti2 = false) {
353     global $USER, $CFG;
355     if (empty($instance->cmid)) {
356         $instance->cmid = 0;
357     }
359     $role = lti_get_ims_role($USER, $instance->cmid, $instance->course, $islti2);
361     $intro = '';
362     if (!empty($instance->cmid)) {
363         $intro = format_module_intro('lti', $instance, $instance->cmid);
364         $intro = html_to_text($intro, 0, false);
366         // This may look weird, but this is required for new lines
367         // so we generate the same OAuth signature as the tool provider.
368         $intro = str_replace("\n", "\r\n", $intro);
369     }
370     $requestparams = array(
371         'resource_link_title' => $instance->name,
372         'resource_link_description' => $intro,
373         'user_id' => $USER->id,
374         'lis_person_sourcedid' => $USER->idnumber,
375         'roles' => $role,
376         'context_id' => $course->id,
377         'context_label' => $course->shortname,
378         'context_title' => $course->fullname,
379     );
380     if (!empty($instance->id)) {
381         $requestparams['resource_link_id'] = $instance->id;
382     }
383     if (!empty($instance->resource_link_id)) {
384         $requestparams['resource_link_id'] = $instance->resource_link_id;
385     }
386     if ($course->format == 'site') {
387         $requestparams['context_type'] = 'Group';
388     } else {
389         $requestparams['context_type'] = 'CourseSection';
390         $requestparams['lis_course_section_sourcedid'] = $course->idnumber;
391     }
392     $placementsecret = $instance->servicesalt;
394     if ( !empty($instance->id) && isset($placementsecret) && ($islti2 ||
395          $typeconfig['acceptgrades'] == LTI_SETTING_ALWAYS ||
396          ($typeconfig['acceptgrades'] == LTI_SETTING_DELEGATE && $instance->instructorchoiceacceptgrades == LTI_SETTING_ALWAYS))) {
398         $sourcedid = json_encode(lti_build_sourcedid($instance->id, $USER->id, $placementsecret, $typeid));
399         $requestparams['lis_result_sourcedid'] = $sourcedid;
401         // Add outcome service URL.
402         $serviceurl = new \moodle_url('/mod/lti/service.php');
403         $serviceurl = $serviceurl->out();
405         $forcessl = false;
406         if (!empty($CFG->mod_lti_forcessl)) {
407             $forcessl = true;
408         }
410         if ((isset($typeconfig['forcessl']) && ($typeconfig['forcessl'] == '1')) or $forcessl) {
411             $serviceurl = lti_ensure_url_is_https($serviceurl);
412         }
414         $requestparams['lis_outcome_service_url'] = $serviceurl;
415     }
417     // Send user's name and email data if appropriate.
418     if ($islti2 || $typeconfig['sendname'] == LTI_SETTING_ALWAYS ||
419          ( $typeconfig['sendname'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendname == LTI_SETTING_ALWAYS ) ) {
420         $requestparams['lis_person_name_given'] = $USER->firstname;
421         $requestparams['lis_person_name_family'] = $USER->lastname;
422         $requestparams['lis_person_name_full'] = $USER->firstname . ' ' . $USER->lastname;
423         $requestparams['ext_user_username'] = $USER->username;
424     }
426     if ($islti2 || $typeconfig['sendemailaddr'] == LTI_SETTING_ALWAYS ||
427          ($typeconfig['sendemailaddr'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendemailaddr == LTI_SETTING_ALWAYS)) {
428         $requestparams['lis_person_contact_email_primary'] = $USER->email;
429     }
431     return $requestparams;
434 /**
435  * This function builds the request that must be sent to an LTI 2 tool provider
436  *
437  * @param object    $tool           Basic LTI tool object
438  * @param array     $params         Custom launch parameters
439  *
440  * @return array                    Request details
441  */
442 function lti_build_request_lti2($tool, $params) {
444     $requestparams = array();
446     $capabilities = lti_get_capabilities();
447     $enabledcapabilities = explode("\n", $tool->enabledcapability);
448     foreach ($enabledcapabilities as $capability) {
449         if (array_key_exists($capability, $capabilities)) {
450             $val = $capabilities[$capability];
451             if ($val && (substr($val, 0, 1) != '$')) {
452                 if (isset($params[$val])) {
453                     $requestparams[$capabilities[$capability]] = $params[$capabilities[$capability]];
454                 }
455             }
456         }
457     }
459     return $requestparams;
463 /**
464  * This function builds the standard parameters for an LTI 1 or 2 request that must be sent to the tool producer
465  *
466  * @param object    $instance       Basic LTI instance object
467  * @param string    $orgid          Organisation ID
468  * @param boolean   $islti2         True if an LTI 2 tool is being launched
469  *
470  * @return array                    Request details
471  */
472 function lti_build_standard_request($instance, $orgid, $islti2) {
473     global $CFG;
475     $requestparams = array();
477     $requestparams['resource_link_id'] = $instance->id;
478     if (property_exists($instance, 'resource_link_id') and !empty($instance->resource_link_id)) {
479         $requestparams['resource_link_id'] = $instance->resource_link_id;
480     }
482     $requestparams['launch_presentation_locale'] = current_language();
484     // Make sure we let the tool know what LMS they are being called from.
485     $requestparams['ext_lms'] = 'moodle-2';
486     $requestparams['tool_consumer_info_product_family_code'] = 'moodle';
487     $requestparams['tool_consumer_info_version'] = strval($CFG->version);
489     // Add oauth_callback to be compliant with the 1.0A spec.
490     $requestparams['oauth_callback'] = 'about:blank';
492     if (!$islti2) {
493         $requestparams['lti_version'] = 'LTI-1p0';
494     } else {
495         $requestparams['lti_version'] = 'LTI-2p0';
496     }
497     $requestparams['lti_message_type'] = 'basic-lti-launch-request';
499     if ($orgid) {
500         $requestparams["tool_consumer_instance_guid"] = $orgid;
501     }
502     if (!empty($CFG->mod_lti_institution_name)) {
503         $requestparams['tool_consumer_instance_name'] = $CFG->mod_lti_institution_name;
504     } else {
505         $requestparams['tool_consumer_instance_name'] = get_site()->fullname;
506     }
507     $requestparams['tool_consumer_instance_description'] = html_to_text(get_site()->summary, 0);
509     return $requestparams;
512 /**
513  * This function builds the custom parameters
514  *
515  * @param object    $toolproxy      Tool proxy instance object
516  * @param object    $tool           Tool instance object
517  * @param object    $instance       Tool placement instance object
518  * @param array     $params         LTI launch parameters
519  * @param string    $customstr      Custom parameters defined for tool
520  * @param string    $instructorcustomstr      Custom parameters defined for this placement
521  * @param boolean   $islti2         True if an LTI 2 tool is being launched
522  *
523  * @return array                    Custom parameters
524  */
525 function lti_build_custom_parameters($toolproxy, $tool, $instance, $params, $customstr, $instructorcustomstr, $islti2) {
527     // Concatenate the custom parameters from the administrator and the instructor
528     // Instructor parameters are only taken into consideration if the administrator
529     // has given permission.
530     $custom = array();
531     if ($customstr) {
532         $custom = lti_split_custom_parameters($toolproxy, $tool, $params, $customstr, $islti2);
533     }
534     if (!isset($typeconfig['allowinstructorcustom']) || $typeconfig['allowinstructorcustom'] != LTI_SETTING_NEVER) {
535         if ($instructorcustomstr) {
536             $custom = array_merge(lti_split_custom_parameters($toolproxy, $tool, $params,
537                 $instructorcustomstr, $islti2), $custom);
538         }
539     }
540     if ($islti2) {
541         $custom = array_merge(lti_split_custom_parameters($toolproxy, $tool, $params,
542             $tool->parameter, true), $custom);
543         $settings = lti_get_tool_settings($tool->toolproxyid);
544         $custom = array_merge($custom, lti_get_custom_parameters($toolproxy, $tool, $params, $settings));
545         $settings = lti_get_tool_settings($tool->toolproxyid, $instance->course);
546         $custom = array_merge($custom, lti_get_custom_parameters($toolproxy, $tool, $params, $settings));
547         $settings = lti_get_tool_settings($tool->toolproxyid, $instance->course, $instance->id);
548         $custom = array_merge($custom, lti_get_custom_parameters($toolproxy, $tool, $params, $settings));
549     }
551     return $custom;
554 function lti_get_tool_table($tools, $id) {
555     global $CFG, $OUTPUT, $USER;
556     $html = '';
558     $typename = get_string('typename', 'lti');
559     $baseurl = get_string('baseurl', 'lti');
560     $action = get_string('action', 'lti');
561     $createdon = get_string('createdon', 'lti');
563     if (!empty($tools)) {
564         $html .= "
565         <div id=\"{$id}_tools_container\" style=\"margin-top:.5em;margin-bottom:.5em\">
566             <table id=\"{$id}_tools\">
567                 <thead>
568                     <tr>
569                         <th>$typename</th>
570                         <th>$baseurl</th>
571                         <th>$createdon</th>
572                         <th>$action</th>
573                     </tr>
574                 </thead>
575         ";
577         foreach ($tools as $type) {
578             $date = userdate($type->timecreated, get_string('strftimedatefullshort', 'core_langconfig'));
579             $accept = get_string('accept', 'lti');
580             $update = get_string('update', 'lti');
581             $delete = get_string('delete', 'lti');
583             if (empty($type->toolproxyid)) {
584                 $baseurl = new \moodle_url('/mod/lti/typessettings.php', array(
585                         'action' => 'accept',
586                         'id' => $type->id,
587                         'sesskey' => sesskey(),
588                         'tab' => $id
589                     ));
590                 $ref = $type->baseurl;
591             } else {
592                 $baseurl = new \moodle_url('/mod/lti/toolssettings.php', array(
593                         'action' => 'accept',
594                         'id' => $type->id,
595                         'sesskey' => sesskey(),
596                         'tab' => $id
597                     ));
598                 $ref = $type->tpname;
599             }
601             $accepthtml = $OUTPUT->action_icon($baseurl,
602                     new \pix_icon('t/check', $accept, '', array('class' => 'iconsmall')), null,
603                     array('title' => $accept, 'class' => 'editing_accept'));
605             $deleteaction = 'delete';
607             if ($type->state == LTI_TOOL_STATE_CONFIGURED) {
608                 $accepthtml = '';
609             }
611             if ($type->state != LTI_TOOL_STATE_REJECTED) {
612                 $deleteaction = 'reject';
613                 $delete = get_string('reject', 'lti');
614             }
616             $updateurl = clone($baseurl);
617             $updateurl->param('action', 'update');
618             $updatehtml = $OUTPUT->action_icon($updateurl,
619                     new \pix_icon('t/edit', $update, '', array('class' => 'iconsmall')), null,
620                     array('title' => $update, 'class' => 'editing_update'));
622             if (($type->state != LTI_TOOL_STATE_REJECTED) || empty($type->toolproxyid)) {
623                 $deleteurl = clone($baseurl);
624                 $deleteurl->param('action', $deleteaction);
625                 $deletehtml = $OUTPUT->action_icon($deleteurl,
626                         new \pix_icon('t/delete', $delete, '', array('class' => 'iconsmall')), null,
627                         array('title' => $delete, 'class' => 'editing_delete'));
628             } else {
629                 $deletehtml = '';
630             }
631             $html .= "
632             <tr>
633                 <td>
634                     {$type->name}
635                 </td>
636                 <td>
637                     {$ref}
638                 </td>
639                 <td>
640                     {$date}
641                 </td>
642                 <td align=\"center\">
643                     {$accepthtml}{$updatehtml}{$deletehtml}
644                 </td>
645             </tr>
646             ";
647         }
648         $html .= '</table></div>';
649     } else {
650         $html .= get_string('no_' . $id, 'lti');
651     }
653     return $html;
656 /**
657  * This function builds the tab for a category of tool proxies
658  *
659  * @param object    $toolproxies    Tool proxy instance objects
660  * @param string    $id             Category ID
661  *
662  * @return string                   HTML for tab
663  */
664 function lti_get_tool_proxy_table($toolproxies, $id) {
665     global $OUTPUT;
667     if (!empty($toolproxies)) {
668         $typename = get_string('typename', 'lti');
669         $url = get_string('registrationurl', 'lti');
670         $action = get_string('action', 'lti');
671         $createdon = get_string('createdon', 'lti');
673         $html = <<< EOD
674         <div id="{$id}_tool_proxies_container" style="margin-top: 0.5em; margin-bottom: 0.5em">
675             <table id="{$id}_tool_proxies">
676                 <thead>
677                     <tr>
678                         <th>{$typename}</th>
679                         <th>{$url}</th>
680                         <th>{$createdon}</th>
681                         <th>{$action}</th>
682                     </tr>
683                 </thead>
684 EOD;
685         foreach ($toolproxies as $toolproxy) {
686             $date = userdate($toolproxy->timecreated, get_string('strftimedatefullshort', 'core_langconfig'));
687             $accept = get_string('register', 'lti');
688             $update = get_string('update', 'lti');
689             $delete = get_string('delete', 'lti');
691             $baseurl = new \moodle_url('/mod/lti/registersettings.php', array(
692                     'action' => 'accept',
693                     'id' => $toolproxy->id,
694                     'sesskey' => sesskey(),
695                     'tab' => $id
696                 ));
698             $registerurl = new \moodle_url('/mod/lti/register.php', array(
699                     'id' => $toolproxy->id,
700                     'sesskey' => sesskey(),
701                     'tab' => 'tool_proxy'
702                 ));
704             $accepthtml = $OUTPUT->action_icon($registerurl,
705                     new \pix_icon('t/check', $accept, '', array('class' => 'iconsmall')), null,
706                     array('title' => $accept, 'class' => 'editing_accept'));
708             $deleteaction = 'delete';
710             if ($toolproxy->state != LTI_TOOL_PROXY_STATE_CONFIGURED) {
711                 $accepthtml = '';
712             }
714             if (($toolproxy->state == LTI_TOOL_PROXY_STATE_CONFIGURED) || ($toolproxy->state == LTI_TOOL_PROXY_STATE_PENDING)) {
715                 $delete = get_string('cancel', 'lti');
716             }
718             $updateurl = clone($baseurl);
719             $updateurl->param('action', 'update');
720             $updatehtml = $OUTPUT->action_icon($updateurl,
721                     new \pix_icon('t/edit', $update, '', array('class' => 'iconsmall')), null,
722                     array('title' => $update, 'class' => 'editing_update'));
724             $deleteurl = clone($baseurl);
725             $deleteurl->param('action', $deleteaction);
726             $deletehtml = $OUTPUT->action_icon($deleteurl,
727                     new \pix_icon('t/delete', $delete, '', array('class' => 'iconsmall')), null,
728                     array('title' => $delete, 'class' => 'editing_delete'));
729             $html .= <<< EOD
730             <tr>
731                 <td>
732                     {$toolproxy->name}
733                 </td>
734                 <td>
735                     {$toolproxy->regurl}
736                 </td>
737                 <td>
738                     {$date}
739                 </td>
740                 <td align="center">
741                     {$accepthtml}{$updatehtml}{$deletehtml}
742                 </td>
743             </tr>
744 EOD;
745         }
746         $html .= '</table></div>';
747     } else {
748         $html = get_string('no_' . $id, 'lti');
749     }
751     return $html;
754 /**
755  * Extracts the enabled capabilities into an array, including those implicitly declared in a parameter
756  *
757  * @param object    $tool           Tool instance object
758  *
759  * @return Array of enabled capabilities
760  */
761 function lti_get_enabled_capabilities($tool) {
762     if (!empty($tool->enabledcapability)) {
763         $enabledcapabilities = explode("\n", $tool->enabledcapability);
764     } else {
765         $enabledcapabilities = array();
766     }
767     $paramstr = str_replace("\r\n", "\n", $tool->parameter);
768     $paramstr = str_replace("\n\r", "\n", $paramstr);
769     $paramstr = str_replace("\r", "\n", $paramstr);
770     $params = explode("\n", $paramstr);
771     foreach ($params as $param) {
772         $pos = strpos($param, '=');
773         if (($pos === false) || ($pos < 1)) {
774             continue;
775         }
776         $value = trim(core_text::substr($param, $pos + 1, strlen($param)));
777         if (substr($value, 0, 1) == '$') {
778             $value = substr($value, 1);
779             if (!in_array($value, $enabledcapabilities)) {
780                 $enabledcapabilities[] = $value;
781             }
782         }
783     }
784     return $enabledcapabilities;
787 /**
788  * Splits the custom parameters field to the various parameters
789  *
790  * @param object    $toolproxy      Tool proxy instance object
791  * @param object    $tool           Tool instance object
792  * @param array     $params         LTI launch parameters
793  * @param string    $customstr      String containing the parameters
794  * @param boolean   $islti2         True if an LTI 2 tool is being launched
795  *
796  * @return Array of custom parameters
797  */
798 function lti_split_custom_parameters($toolproxy, $tool, $params, $customstr, $islti2 = false) {
799     $customstr = str_replace("\r\n", "\n", $customstr);
800     $customstr = str_replace("\n\r", "\n", $customstr);
801     $customstr = str_replace("\r", "\n", $customstr);
802     $lines = explode("\n", $customstr);  // Or should this split on "/[\n;]/"?
803     $retval = array();
804     foreach ($lines as $line) {
805         $pos = strpos($line, '=');
806         if ( $pos === false || $pos < 1 ) {
807             continue;
808         }
809         $key = trim(core_text::substr($line, 0, $pos));
810         $val = trim(core_text::substr($line, $pos + 1, strlen($line)));
811         $val = lti_parse_custom_parameter($toolproxy, $tool, $params, $val, $islti2);
812         $key2 = lti_map_keyname($key);
813         $retval['custom_'.$key2] = $val;
814         if ($islti2 && ($key != $key2)) {
815             $retval['custom_'.$key] = $val;
816         }
817     }
818     return $retval;
821 /**
822  * Adds the custom parameters to an array
823  *
824  * @param object    $toolproxy      Tool proxy instance object
825  * @param object    $tool           Tool instance object
826  * @param array     $params         LTI launch parameters
827  * @param array     $parameters     Array containing the parameters
828  *
829  * @return array    Array of custom parameters
830  */
831 function lti_get_custom_parameters($toolproxy, $tool, $params, $parameters) {
832     $retval = array();
833     foreach ($parameters as $key => $val) {
834         $key2 = lti_map_keyname($key);
835         $val = lti_parse_custom_parameter($toolproxy, $tool, $params, $val, true);
836         $retval['custom_'.$key2] = $val;
837         if ($key != $key2) {
838             $retval['custom_'.$key] = $val;
839         }
840     }
841     return $retval;
844 /**
845  * Parse a custom parameter to replace any substitution variables
846  *
847  * @param object    $toolproxy      Tool proxy instance object
848  * @param object    $tool           Tool instance object
849  * @param array     $params         LTI launch parameters
850  * @param string    $value          Custom parameter value
851  * @param boolean   $islti2         True if an LTI 2 tool is being launched
852  *
853  * @return Parsed value of custom parameter
854  */
855 function lti_parse_custom_parameter($toolproxy, $tool, $params, $value, $islti2) {
856     global $USER, $COURSE;
858     if ($value) {
859         if (substr($value, 0, 1) == '\\') {
860             $value = substr($value, 1);
861         } else if (substr($value, 0, 1) == '$') {
862             $value1 = substr($value, 1);
863             $enabledcapabilities = lti_get_enabled_capabilities($tool);
864             if (!$islti2 || in_array($value1, $enabledcapabilities)) {
865                 $capabilities = lti_get_capabilities();
866                 if (array_key_exists($value1, $capabilities)) {
867                     $val = $capabilities[$value1];
868                     if ($val) {
869                         if (substr($val, 0, 1) != '$') {
870                             $value = $params[$val];
871                         } else {
872                             $valarr = explode('->', substr($val, 1), 2);
873                             $value = "{${$valarr[0]}->{$valarr[1]}}";
874                             $value = str_replace('<br />' , ' ', $value);
875                             $value = str_replace('<br>' , ' ', $value);
876                             $value = format_string($value);
877                         }
878                     }
879                 } else if ($islti2) {
880                     $val = $value;
881                     $services = lti_get_services();
882                     foreach ($services as $service) {
883                         $service->set_tool_proxy($toolproxy);
884                         $value = $service->parse_value($val);
885                         if ($val != $value) {
886                             break;
887                         }
888                     }
889                 }
890             }
891         }
892     }
893     return $value;
896 /**
897  * Used for building the names of the different custom parameters
898  *
899  * @param string $key   Parameter name
900  *
901  * @return string       Processed name
902  */
903 function lti_map_keyname($key) {
904     $newkey = "";
905     $key = core_text::strtolower(trim($key));
906     foreach (str_split($key) as $ch) {
907         if ( ($ch >= 'a' && $ch <= 'z') || ($ch >= '0' && $ch <= '9') ) {
908             $newkey .= $ch;
909         } else {
910             $newkey .= '_';
911         }
912     }
913     return $newkey;
916 /**
917  * Gets the IMS role string for the specified user and LTI course module.
918  *
919  * @param mixed    $user      User object or user id
920  * @param int      $cmid      The course module id of the LTI activity
921  * @param int      $courseid  The course id of the LTI activity
922  * @param boolean  $islti2    True if an LTI 2 tool is being launched
923  *
924  * @return string A role string suitable for passing with an LTI launch
925  */
926 function lti_get_ims_role($user, $cmid, $courseid, $islti2) {
927     $roles = array();
929     if (empty($cmid)) {
930         // If no cmid is passed, check if the user is a teacher in the course
931         // This allows other modules to programmatically "fake" a launch without
932         // a real LTI instance.
933         $coursecontext = context_course::instance($courseid);
935         if (has_capability('moodle/course:manageactivities', $coursecontext, $user)) {
936             array_push($roles, 'Instructor');
937         } else {
938             array_push($roles, 'Learner');
939         }
940     } else {
941         $context = context_module::instance($cmid);
943         if (has_capability('mod/lti:manage', $context)) {
944             array_push($roles, 'Instructor');
945         } else {
946             array_push($roles, 'Learner');
947         }
948     }
950     if (is_siteadmin($user)) {
951         if (!$islti2) {
952             array_push($roles, 'urn:lti:sysrole:ims/lis/Administrator', 'urn:lti:instrole:ims/lis/Administrator');
953         } else {
954             array_push($roles, 'http://purl.imsglobal.org/vocab/lis/v2/person#Administrator');
955         }
956     }
958     return join(',', $roles);
961 /**
962  * Returns configuration details for the tool
963  *
964  * @param int $typeid   Basic LTI tool typeid
965  *
966  * @return array        Tool Configuration
967  */
968 function lti_get_type_config($typeid) {
969     global $DB;
971     $query = "SELECT name, value
972                 FROM {lti_types_config}
973                WHERE typeid = :typeid1
974            UNION ALL
975               SELECT 'toolurl' AS name, " . $DB->sql_compare_text('baseurl', 1333) . " AS value
976                 FROM {lti_types}
977                WHERE id = :typeid2
978            UNION ALL
979               SELECT 'icon' AS name, " . $DB->sql_compare_text('icon', 1333) . " AS value
980                 FROM {lti_types}
981                WHERE id = :typeid3
982            UNION ALL
983               SELECT 'secureicon' AS name, " . $DB->sql_compare_text('secureicon', 1333) . " AS value
984                 FROM {lti_types}
985                WHERE id = :typeid4";
987     $typeconfig = array();
988     $configs = $DB->get_records_sql($query,
989         array('typeid1' => $typeid, 'typeid2' => $typeid, 'typeid3' => $typeid, 'typeid4' => $typeid));
991     if (!empty($configs)) {
992         foreach ($configs as $config) {
993             $typeconfig[$config->name] = $config->value;
994         }
995     }
997     return $typeconfig;
1000 function lti_get_tools_by_url($url, $state, $courseid = null) {
1001     $domain = lti_get_domain_from_url($url);
1003     return lti_get_tools_by_domain($domain, $state, $courseid);
1006 function lti_get_tools_by_domain($domain, $state = null, $courseid = null) {
1007     global $DB, $SITE;
1009     $filters = array('tooldomain' => $domain);
1011     $statefilter = '';
1012     $coursefilter = '';
1014     if ($state) {
1015         $statefilter = 'AND state = :state';
1016     }
1018     if ($courseid && $courseid != $SITE->id) {
1019         $coursefilter = 'OR course = :courseid';
1020     }
1022     $query = "SELECT *
1023                 FROM {lti_types}
1024                WHERE tooldomain = :tooldomain
1025                  AND (course = :siteid $coursefilter)
1026                  $statefilter";
1028     return $DB->get_records_sql($query, array(
1029         'courseid' => $courseid,
1030         'siteid' => $SITE->id,
1031         'tooldomain' => $domain,
1032         'state' => $state
1033     ));
1036 /**
1037  * Returns all basicLTI tools configured by the administrator
1038  *
1039  */
1040 function lti_filter_get_types($course) {
1041     global $DB;
1043     if (!empty($course)) {
1044         $where = "WHERE t.course = :course";
1045         $params = array('course' => $course);
1046     } else {
1047         $where = '';
1048         $params = array();
1049     }
1050     $query = "SELECT t.id, t.name, t.baseurl, t.state, t.toolproxyid, t.timecreated, tp.name tpname
1051                 FROM {lti_types} t LEFT OUTER JOIN {lti_tool_proxies} tp ON t.toolproxyid = tp.id
1052                 {$where}";
1053     return $DB->get_records_sql($query, $params);
1056 /**
1057  * Given an array of tools, filter them based on their state
1058  *
1059  * @param array $tools An array of lti_types records
1060  * @param int $state One of the LTI_TOOL_STATE_* constants
1061  * @return array
1062  */
1063 function lti_filter_tool_types(array $tools, $state) {
1064     $return = array();
1065     foreach ($tools as $key => $tool) {
1066         if ($tool->state == $state) {
1067             $return[$key] = $tool;
1068         }
1069     }
1070     return $return;
1073 function lti_get_types_for_add_instance() {
1074     global $DB, $SITE, $COURSE;
1076     $query = "SELECT *
1077                 FROM {lti_types}
1078                WHERE coursevisible = 1
1079                  AND (course = :siteid OR course = :courseid)
1080                  AND state = :active";
1082     $admintypes = $DB->get_records_sql($query,
1083         array('siteid' => $SITE->id, 'courseid' => $COURSE->id, 'active' => LTI_TOOL_STATE_CONFIGURED));
1085     $types = array();
1086     $types[0] = (object)array('name' => get_string('automatic', 'lti'), 'course' => 0, 'toolproxyid' => null);
1088     foreach ($admintypes as $type) {
1089         $types[$type->id] = $type;
1090     }
1092     return $types;
1095 function lti_get_domain_from_url($url) {
1096     $matches = array();
1098     if (preg_match(LTI_URL_DOMAIN_REGEX, $url, $matches)) {
1099         return $matches[1];
1100     }
1103 function lti_get_tool_by_url_match($url, $courseid = null, $state = LTI_TOOL_STATE_CONFIGURED) {
1104     $possibletools = lti_get_tools_by_url($url, $state, $courseid);
1106     return lti_get_best_tool_by_url($url, $possibletools, $courseid);
1109 function lti_get_url_thumbprint($url) {
1110     // Parse URL requires a schema otherwise everything goes into 'path'.  Fixed 5.4.7 or later.
1111     if (preg_match('/https?:\/\//', $url) !== 1) {
1112         $url = 'http://'.$url;
1113     }
1114     $urlparts = parse_url(strtolower($url));
1115     if (!isset($urlparts['path'])) {
1116         $urlparts['path'] = '';
1117     }
1119     if (!isset($urlparts['host'])) {
1120         $urlparts['host'] = '';
1121     }
1123     if (substr($urlparts['host'], 0, 4) === 'www.') {
1124         $urlparts['host'] = substr($urlparts['host'], 4);
1125     }
1127     return $urllower = $urlparts['host'] . '/' . $urlparts['path'];
1130 function lti_get_best_tool_by_url($url, $tools, $courseid = null) {
1131     if (count($tools) === 0) {
1132         return null;
1133     }
1135     $urllower = lti_get_url_thumbprint($url);
1137     foreach ($tools as $tool) {
1138         $tool->_matchscore = 0;
1140         $toolbaseurllower = lti_get_url_thumbprint($tool->baseurl);
1142         if ($urllower === $toolbaseurllower) {
1143             // 100 points for exact thumbprint match.
1144             $tool->_matchscore += 100;
1145         } else if (substr($urllower, 0, strlen($toolbaseurllower)) === $toolbaseurllower) {
1146             // 50 points if tool thumbprint starts with the base URL thumbprint.
1147             $tool->_matchscore += 50;
1148         }
1150         // Prefer course tools over site tools.
1151         if (!empty($courseid)) {
1152             // Minus 10 points for not matching the course id (global tools).
1153             if ($tool->course != $courseid) {
1154                 $tool->_matchscore -= 10;
1155             }
1156         }
1157     }
1159     $bestmatch = array_reduce($tools, function($value, $tool) {
1160         if ($tool->_matchscore > $value->_matchscore) {
1161             return $tool;
1162         } else {
1163             return $value;
1164         }
1166     }, (object)array('_matchscore' => -1));
1168     // None of the tools are suitable for this URL.
1169     if ($bestmatch->_matchscore <= 0) {
1170         return null;
1171     }
1173     return $bestmatch;
1176 function lti_get_shared_secrets_by_key($key) {
1177     global $DB;
1179     // Look up the shared secret for the specified key in both the types_config table (for configured tools)
1180     // And in the lti resource table for ad-hoc tools.
1181     $query = "SELECT t2.value
1182                 FROM {lti_types_config} t1
1183                 JOIN {lti_types_config} t2 ON t1.typeid = t2.typeid
1184                 JOIN {lti_types} type ON t2.typeid = type.id
1185               WHERE t1.name = 'resourcekey'
1186                 AND t1.value = :key1
1187                 AND t2.name = 'password'
1188                 AND type.state = :configured1
1189                UNION
1190               SELECT tp.secret AS value
1191                 FROM {lti_tool_proxies} tp
1192                 JOIN {lti_types} t ON tp.id = t.toolproxyid
1193               WHERE tp.guid = :key2
1194                 AND t.state = :configured2
1195               UNION
1196              SELECT password AS value
1197                FROM {lti}
1198               WHERE resourcekey = :key3";
1200     $sharedsecrets = $DB->get_records_sql($query, array('configured1' => LTI_TOOL_STATE_CONFIGURED,
1201         'configured2' => LTI_TOOL_STATE_CONFIGURED, 'key1' => $key, 'key2' => $key, 'key3' => $key));
1203     $values = array_map(function($item) {
1204         return $item->value;
1205     }, $sharedsecrets);
1207     // There should really only be one shared secret per key. But, we can't prevent
1208     // more than one getting entered. For instance, if the same key is used for two tool providers.
1209     return $values;
1212 /**
1213  * Delete a Basic LTI configuration
1214  *
1215  * @param int $id   Configuration id
1216  */
1217 function lti_delete_type($id) {
1218     global $DB;
1220     // We should probably just copy the launch URL to the tool instances in this case... using a single query.
1221     /*
1222     $instances = $DB->get_records('lti', array('typeid' => $id));
1223     foreach ($instances as $instance) {
1224         $instance->typeid = 0;
1225         $DB->update_record('lti', $instance);
1226     }*/
1228     $DB->delete_records('lti_types', array('id' => $id));
1229     $DB->delete_records('lti_types_config', array('typeid' => $id));
1232 function lti_set_state_for_type($id, $state) {
1233     global $DB;
1235     $DB->update_record('lti_types', array('id' => $id, 'state' => $state));
1238 /**
1239  * Transforms a basic LTI object to an array
1240  *
1241  * @param object $ltiobject    Basic LTI object
1242  *
1243  * @return array Basic LTI configuration details
1244  */
1245 function lti_get_config($ltiobject) {
1246     $typeconfig = array();
1247     $typeconfig = (array)$ltiobject;
1248     $additionalconfig = lti_get_type_config($ltiobject->typeid);
1249     $typeconfig = array_merge($typeconfig, $additionalconfig);
1250     return $typeconfig;
1253 /**
1254  *
1255  * Generates some of the tool configuration based on the instance details
1256  *
1257  * @param int $id
1258  *
1259  * @return Instance configuration
1260  *
1261  */
1262 function lti_get_type_config_from_instance($id) {
1263     global $DB;
1265     $instance = $DB->get_record('lti', array('id' => $id));
1266     $config = lti_get_config($instance);
1268     $type = new \stdClass();
1269     $type->lti_fix = $id;
1270     if (isset($config['toolurl'])) {
1271         $type->lti_toolurl = $config['toolurl'];
1272     }
1273     if (isset($config['instructorchoicesendname'])) {
1274         $type->lti_sendname = $config['instructorchoicesendname'];
1275     }
1276     if (isset($config['instructorchoicesendemailaddr'])) {
1277         $type->lti_sendemailaddr = $config['instructorchoicesendemailaddr'];
1278     }
1279     if (isset($config['instructorchoiceacceptgrades'])) {
1280         $type->lti_acceptgrades = $config['instructorchoiceacceptgrades'];
1281     }
1282     if (isset($config['instructorchoiceallowroster'])) {
1283         $type->lti_allowroster = $config['instructorchoiceallowroster'];
1284     }
1286     if (isset($config['instructorcustomparameters'])) {
1287         $type->lti_allowsetting = $config['instructorcustomparameters'];
1288     }
1289     return $type;
1292 /**
1293  * Generates some of the tool configuration based on the admin configuration details
1294  *
1295  * @param int $id
1296  *
1297  * @return Configuration details
1298  */
1299 function lti_get_type_type_config($id) {
1300     global $DB;
1302     $basicltitype = $DB->get_record('lti_types', array('id' => $id));
1303     $config = lti_get_type_config($id);
1305     $type = new \stdClass();
1307     $type->lti_typename = $basicltitype->name;
1309     $type->typeid = $basicltitype->id;
1311     $type->toolproxyid = $basicltitype->toolproxyid;
1313     $type->lti_toolurl = $basicltitype->baseurl;
1315     $type->lti_parameters = $basicltitype->parameter;
1317     $type->lti_icon = $basicltitype->icon;
1319     $type->lti_secureicon = $basicltitype->secureicon;
1321     if (isset($config['resourcekey'])) {
1322         $type->lti_resourcekey = $config['resourcekey'];
1323     }
1324     if (isset($config['password'])) {
1325         $type->lti_password = $config['password'];
1326     }
1328     if (isset($config['sendname'])) {
1329         $type->lti_sendname = $config['sendname'];
1330     }
1331     if (isset($config['instructorchoicesendname'])) {
1332         $type->lti_instructorchoicesendname = $config['instructorchoicesendname'];
1333     }
1334     if (isset($config['sendemailaddr'])) {
1335         $type->lti_sendemailaddr = $config['sendemailaddr'];
1336     }
1337     if (isset($config['instructorchoicesendemailaddr'])) {
1338         $type->lti_instructorchoicesendemailaddr = $config['instructorchoicesendemailaddr'];
1339     }
1340     if (isset($config['acceptgrades'])) {
1341         $type->lti_acceptgrades = $config['acceptgrades'];
1342     }
1343     if (isset($config['instructorchoiceacceptgrades'])) {
1344         $type->lti_instructorchoiceacceptgrades = $config['instructorchoiceacceptgrades'];
1345     }
1346     if (isset($config['allowroster'])) {
1347         $type->lti_allowroster = $config['allowroster'];
1348     }
1349     if (isset($config['instructorchoiceallowroster'])) {
1350         $type->lti_instructorchoiceallowroster = $config['instructorchoiceallowroster'];
1351     }
1353     if (isset($config['customparameters'])) {
1354         $type->lti_customparameters = $config['customparameters'];
1355     }
1357     if (isset($config['forcessl'])) {
1358         $type->lti_forcessl = $config['forcessl'];
1359     }
1361     if (isset($config['organizationid'])) {
1362         $type->lti_organizationid = $config['organizationid'];
1363     }
1364     if (isset($config['organizationurl'])) {
1365         $type->lti_organizationurl = $config['organizationurl'];
1366     }
1367     if (isset($config['organizationdescr'])) {
1368         $type->lti_organizationdescr = $config['organizationdescr'];
1369     }
1370     if (isset($config['launchcontainer'])) {
1371         $type->lti_launchcontainer = $config['launchcontainer'];
1372     }
1374     if (isset($config['coursevisible'])) {
1375         $type->lti_coursevisible = $config['coursevisible'];
1376     }
1378     if (isset($config['debuglaunch'])) {
1379         $type->lti_debuglaunch = $config['debuglaunch'];
1380     }
1382     if (isset($config['module_class_type'])) {
1383         $type->lti_module_class_type = $config['module_class_type'];
1384     }
1386     return $type;
1389 function lti_prepare_type_for_save($type, $config) {
1390     if (isset($config->lti_toolurl)) {
1391         $type->baseurl = $config->lti_toolurl;
1392         $type->tooldomain = lti_get_domain_from_url($config->lti_toolurl);
1393     }
1394     if (isset($config->lti_typename)) {
1395         $type->name = $config->lti_typename;
1396     }
1397     $type->coursevisible = !empty($config->lti_coursevisible) ? $config->lti_coursevisible : 0;
1398     $config->lti_coursevisible = $type->coursevisible;
1400     if (isset($config->lti_icon)) {
1401         $type->icon = $config->lti_icon;
1402     }
1403     if (isset($config->lti_secureicon)) {
1404         $type->secureicon = $config->lti_secureicon;
1405     }
1407     if (isset($config->lti_forcessl)) {
1408         $type->forcessl = !empty($config->lti_forcessl) ? $config->lti_forcessl : 0;
1409         $config->lti_forcessl = $type->forcessl;
1410     }
1412     $type->timemodified = time();
1414     unset ($config->lti_typename);
1415     unset ($config->lti_toolurl);
1416     unset ($config->lti_icon);
1417     unset ($config->lti_secureicon);
1420 function lti_update_type($type, $config) {
1421     global $DB, $CFG;
1423     lti_prepare_type_for_save($type, $config);
1425     $clearcache = false;
1426     if (lti_request_is_using_ssl() && !empty($type->secureicon)) {
1427         $clearcache = !isset($config->oldicon) || ($config->oldicon !== $type->secureicon);
1428     } else {
1429         $clearcache = isset($type->icon) && (!isset($config->oldicon) || ($config->oldicon !== $type->icon));
1430     }
1431     unset($config->oldicon);
1433     if ($DB->update_record('lti_types', $type)) {
1434         foreach ($config as $key => $value) {
1435             if (substr($key, 0, 4) == 'lti_' && !is_null($value)) {
1436                 $record = new \StdClass();
1437                 $record->typeid = $type->id;
1438                 $record->name = substr($key, 4);
1439                 $record->value = $value;
1440                 lti_update_config($record);
1441             }
1442         }
1443         require_once($CFG->libdir.'/modinfolib.php');
1444         if ($clearcache) {
1445             rebuild_course_cache();
1446         }
1447     }
1450 function lti_add_type($type, $config) {
1451     global $USER, $SITE, $DB;
1453     lti_prepare_type_for_save($type, $config);
1455     if (!isset($type->state)) {
1456         $type->state = LTI_TOOL_STATE_PENDING;
1457     }
1459     if (!isset($type->timecreated)) {
1460         $type->timecreated = time();
1461     }
1463     if (!isset($type->createdby)) {
1464         $type->createdby = $USER->id;
1465     }
1467     if (!isset($type->course)) {
1468         $type->course = $SITE->id;
1469     }
1471     // Create a salt value to be used for signing passed data to extension services
1472     // The outcome service uses the service salt on the instance. This can be used
1473     // for communication with services not related to a specific LTI instance.
1474     $config->lti_servicesalt = uniqid('', true);
1476     $id = $DB->insert_record('lti_types', $type);
1478     if ($id) {
1479         foreach ($config as $key => $value) {
1480             if (substr($key, 0, 4) == 'lti_' && !is_null($value)) {
1481                 $record = new \StdClass();
1482                 $record->typeid = $id;
1483                 $record->name = substr($key, 4);
1484                 $record->value = $value;
1486                 lti_add_config($record);
1487             }
1488         }
1489     }
1491     return $id;
1494 /**
1495  * Given an array of tool proxies, filter them based on their state
1496  *
1497  * @param array $toolproxies An array of lti_tool_proxies records
1498  * @param int $state One of the LTI_TOOL_PROXY_STATE_* constants
1499  *
1500  * @return array
1501  */
1502 function lti_filter_tool_proxy_types(array $toolproxies, $state) {
1503     $return = array();
1504     foreach ($toolproxies as $key => $toolproxy) {
1505         if ($toolproxy->state == $state) {
1506             $return[$key] = $toolproxy;
1507         }
1508     }
1509     return $return;
1512 /**
1513  * Get the tool proxy instance given its GUID
1514  *
1515  * @param string  $toolproxyguid   Tool proxy GUID value
1516  *
1517  * @return object
1518  */
1519 function lti_get_tool_proxy_from_guid($toolproxyguid) {
1520     global $DB;
1522     $toolproxy = $DB->get_record('lti_tool_proxies', array('guid' => $toolproxyguid));
1524     return $toolproxy;
1527 /**
1528  * Generates some of the tool proxy configuration based on the admin configuration details
1529  *
1530  * @param int $id
1531  *
1532  * @return Tool Proxy details
1533  */
1534 function lti_get_tool_proxy($id) {
1535     global $DB;
1537     $toolproxy = $DB->get_record('lti_tool_proxies', array('id' => $id));
1538     return $toolproxy;
1541 /**
1542  * Generates some of the tool proxy configuration based on the admin configuration details
1543  *
1544  * @param int $id
1545  *
1546  * @return Tool Proxy details
1547  */
1548 function lti_get_tool_proxy_config($id) {
1549     $toolproxy = lti_get_tool_proxy($id);
1551     $tp = new \stdClass();
1552     $tp->lti_registrationname = $toolproxy->name;
1553     $tp->toolproxyid = $toolproxy->id;
1554     $tp->state = $toolproxy->state;
1555     $tp->lti_registrationurl = $toolproxy->regurl;
1556     $tp->lti_capabilities = explode("\n", $toolproxy->capabilityoffered);
1557     $tp->lti_services = explode("\n", $toolproxy->serviceoffered);
1559     return $tp;
1562 /**
1563  * Update the database with a tool proxy instance
1564  *
1565  * @param object   $config    Tool proxy definition
1566  *
1567  * @return int  Record id number
1568  */
1569 function lti_add_tool_proxy($config) {
1570     global $USER, $DB;
1572     $toolproxy = new \stdClass();
1573     if (isset($config->lti_registrationname)) {
1574         $toolproxy->name = trim($config->lti_registrationname);
1575     }
1576     if (isset($config->lti_registrationurl)) {
1577         $toolproxy->regurl = trim($config->lti_registrationurl);
1578     }
1579     if (isset($config->lti_capabilities)) {
1580         $toolproxy->capabilityoffered = implode("\n", $config->lti_capabilities);
1581     }
1582     if (isset($config->lti_services)) {
1583         $toolproxy->serviceoffered = implode("\n", $config->lti_services);
1584     }
1585     if (isset($config->toolproxyid) && !empty($config->toolproxyid)) {
1586         $toolproxy->id = $config->toolproxyid;
1587         if (!isset($toolproxy->state) || ($toolproxy->state != LTI_TOOL_PROXY_STATE_ACCEPTED)) {
1588             $toolproxy->state = LTI_TOOL_PROXY_STATE_CONFIGURED;
1589             $toolproxy->guid = random_string();
1590             $toolproxy->secret = random_string();
1591         }
1592         $id = lti_update_tool_proxy($toolproxy);
1593     } else {
1594         $toolproxy->state = LTI_TOOL_PROXY_STATE_CONFIGURED;
1595         $toolproxy->timemodified = time();
1596         $toolproxy->timecreated = $toolproxy->timemodified;
1597         if (!isset($toolproxy->createdby)) {
1598             $toolproxy->createdby = $USER->id;
1599         }
1600         $toolproxy->guid = random_string();
1601         $toolproxy->secret = random_string();
1602         $id = $DB->insert_record('lti_tool_proxies', $toolproxy);
1603     }
1605     return $id;
1608 /**
1609  * Updates a tool proxy in the database
1610  *
1611  * @param object  $toolproxy   Tool proxy
1612  *
1613  * @return int    Record id number
1614  */
1615 function lti_update_tool_proxy($toolproxy) {
1616     global $DB;
1618     $toolproxy->timemodified = time();
1619     $id = $DB->update_record('lti_tool_proxies', $toolproxy);
1621     return $id;
1624 /**
1625  * Delete a Tool Proxy
1626  *
1627  * @param int $id   Tool Proxy id
1628  */
1629 function lti_delete_tool_proxy($id) {
1630     global $DB;
1631     $DB->delete_records('lti_tool_settings', array('toolproxyid' => $id));
1632     $tools = $DB->get_records('lti_types', array('toolproxyid' => $id));
1633     foreach ($tools as $tool) {
1634         lti_delete_type($tool->id);
1635     }
1636     $DB->delete_records('lti_tool_proxies', array('id' => $id));
1639 /**
1640  * Add a tool configuration in the database
1641  *
1642  * @param object $config   Tool configuration
1643  *
1644  * @return int Record id number
1645  */
1646 function lti_add_config($config) {
1647     global $DB;
1649     return $DB->insert_record('lti_types_config', $config);
1652 /**
1653  * Updates a tool configuration in the database
1654  *
1655  * @param object  $config   Tool configuration
1656  *
1657  * @return Record id number
1658  */
1659 function lti_update_config($config) {
1660     global $DB;
1662     $return = true;
1663     $old = $DB->get_record('lti_types_config', array('typeid' => $config->typeid, 'name' => $config->name));
1665     if ($old) {
1666         $config->id = $old->id;
1667         $return = $DB->update_record('lti_types_config', $config);
1668     } else {
1669         $return = $DB->insert_record('lti_types_config', $config);
1670     }
1671     return $return;
1674 /**
1675  * Gets the tool settings
1676  *
1677  * @param int  $toolproxyid   Id of tool proxy record
1678  * @param int  $courseid      Id of course (null if system settings)
1679  * @param int  $instanceid    Id of course module (null if system or context settings)
1680  *
1681  * @return array  Array settings
1682  */
1683 function lti_get_tool_settings($toolproxyid, $courseid = null, $instanceid = null) {
1684     global $DB;
1686     $settings = array();
1687     $settingsstr = $DB->get_field('lti_tool_settings', 'settings', array('toolproxyid' => $toolproxyid,
1688         'course' => $courseid, 'coursemoduleid' => $instanceid));
1689     if ($settingsstr !== false) {
1690         $settings = json_decode($settingsstr, true);
1691     }
1692     return $settings;
1695 /**
1696  * Sets the tool settings (
1697  *
1698  * @param array  $settings      Array of settings
1699  * @param int    $toolproxyid   Id of tool proxy record
1700  * @param int    $courseid      Id of course (null if system settings)
1701  * @param int    $instanceid    Id of course module (null if system or context settings)
1702  */
1703 function lti_set_tool_settings($settings, $toolproxyid, $courseid = null, $instanceid = null) {
1704     global $DB;
1706     $json = json_encode($settings);
1707     $record = $DB->get_record('lti_tool_settings', array('toolproxyid' => $toolproxyid,
1708         'course' => $courseid, 'coursemoduleid' => $instanceid));
1709     if ($record !== false) {
1710         $DB->update_record('lti_tool_settings', array('id' => $record->id, 'settings' => $json, 'timemodified' => time()));
1711     } else {
1712         $record = new \stdClass();
1713         $record->toolproxyid = $toolproxyid;
1714         $record->course = $courseid;
1715         $record->coursemoduleid = $instanceid;
1716         $record->settings = $json;
1717         $record->timecreated = time();
1718         $record->timemodified = $record->timecreated;
1719         $DB->insert_record('lti_tool_settings', $record);
1720     }
1723 /**
1724  * Signs the petition to launch the external tool using OAuth
1725  *
1726  * @param $oldparms     Parameters to be passed for signing
1727  * @param $endpoint     url of the external tool
1728  * @param $method       Method for sending the parameters (e.g. POST)
1729  * @param $oauth_consumoer_key          Key
1730  * @param $oauth_consumoer_secret       Secret
1731  */
1732 function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret) {
1734     $parms = $oldparms;
1736     $testtoken = '';
1738     // TODO: Switch to core oauthlib once implemented - MDL-30149.
1739     $hmacmethod = new lti\OAuthSignatureMethod_HMAC_SHA1();
1740     $testconsumer = new lti\OAuthConsumer($oauthconsumerkey, $oauthconsumersecret, null);
1741     $accreq = lti\OAuthRequest::from_consumer_and_token($testconsumer, $testtoken, $method, $endpoint, $parms);
1742     $accreq->sign_request($hmacmethod, $testconsumer, $testtoken);
1744     $newparms = $accreq->get_parameters();
1746     return $newparms;
1749 /**
1750  * Posts the launch petition HTML
1751  *
1752  * @param $newparms     Signed parameters
1753  * @param $endpoint     URL of the external tool
1754  * @param $debug        Debug (true/false)
1755  */
1756 function lti_post_launch_html($newparms, $endpoint, $debug=false) {
1757     $r = "<form action=\"" . $endpoint .
1758         "\" name=\"ltiLaunchForm\" id=\"ltiLaunchForm\" method=\"post\" encType=\"application/x-www-form-urlencoded\">\n";
1760     // Contruct html for the launch parameters.
1761     foreach ($newparms as $key => $value) {
1762         $key = htmlspecialchars($key);
1763         $value = htmlspecialchars($value);
1764         if ( $key == "ext_submit" ) {
1765             $r .= "<input type=\"submit\"";
1766         } else {
1767             $r .= "<input type=\"hidden\" name=\"{$key}\"";
1768         }
1769         $r .= " value=\"";
1770         $r .= $value;
1771         $r .= "\"/>\n";
1772     }
1774     if ( $debug ) {
1775         $r .= "<script language=\"javascript\"> \n";
1776         $r .= "  //<![CDATA[ \n";
1777         $r .= "function basicltiDebugToggle() {\n";
1778         $r .= "    var ele = document.getElementById(\"basicltiDebug\");\n";
1779         $r .= "    if (ele.style.display == \"block\") {\n";
1780         $r .= "        ele.style.display = \"none\";\n";
1781         $r .= "    }\n";
1782         $r .= "    else {\n";
1783         $r .= "        ele.style.display = \"block\";\n";
1784         $r .= "    }\n";
1785         $r .= "} \n";
1786         $r .= "  //]]> \n";
1787         $r .= "</script>\n";
1788         $r .= "<a id=\"displayText\" href=\"javascript:basicltiDebugToggle();\">";
1789         $r .= get_string("toggle_debug_data", "lti")."</a>\n";
1790         $r .= "<div id=\"basicltiDebug\" style=\"display:none\">\n";
1791         $r .= "<b>".get_string("basiclti_endpoint", "lti")."</b><br/>\n";
1792         $r .= $endpoint . "<br/>\n&nbsp;<br/>\n";
1793         $r .= "<b>".get_string("basiclti_parameters", "lti")."</b><br/>\n";
1794         foreach ($newparms as $key => $value) {
1795             $key = htmlspecialchars($key);
1796             $value = htmlspecialchars($value);
1797             $r .= "$key = $value<br/>\n";
1798         }
1799         $r .= "&nbsp;<br/>\n";
1800         $r .= "</div>\n";
1801     }
1802     $r .= "</form>\n";
1804     if ( ! $debug ) {
1805         $r .= " <script type=\"text/javascript\"> \n" .
1806             "  //<![CDATA[ \n" .
1807             "    document.ltiLaunchForm.submit(); \n" .
1808             "  //]]> \n" .
1809             " </script> \n";
1810     }
1811     return $r;
1814 function lti_get_type($typeid) {
1815     global $DB;
1817     return $DB->get_record('lti_types', array('id' => $typeid));
1820 function lti_get_launch_container($lti, $toolconfig) {
1821     if (empty($lti->launchcontainer)) {
1822         $lti->launchcontainer = LTI_LAUNCH_CONTAINER_DEFAULT;
1823     }
1825     if ($lti->launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1826         if (isset($toolconfig['launchcontainer'])) {
1827             $launchcontainer = $toolconfig['launchcontainer'];
1828         }
1829     } else {
1830         $launchcontainer = $lti->launchcontainer;
1831     }
1833     if (empty($launchcontainer) || $launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1834         $launchcontainer = LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS;
1835     }
1837     $devicetype = core_useragent::get_device_type();
1839     // Scrolling within the object element doesn't work on iOS or Android
1840     // Opening the popup window also had some issues in testing
1841     // For mobile devices, always take up the entire screen to ensure the best experience.
1842     if ($devicetype === core_useragent::DEVICETYPE_MOBILE || $devicetype === core_useragent::DEVICETYPE_TABLET ) {
1843         $launchcontainer = LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW;
1844     }
1846     return $launchcontainer;
1849 function lti_request_is_using_ssl() {
1850     global $CFG;
1851     return (stripos($CFG->httpswwwroot, 'https://') === 0);
1854 function lti_ensure_url_is_https($url) {
1855     if (!strstr($url, '://')) {
1856         $url = 'https://' . $url;
1857     } else {
1858         // If the URL starts with http, replace with https.
1859         if (stripos($url, 'http://') === 0) {
1860             $url = 'https://' . substr($url, 7);
1861         }
1862     }
1864     return $url;
1867 /**
1868  * Determines if we should try to log the request
1869  *
1870  * @param string $rawbody
1871  * @return bool
1872  */
1873 function lti_should_log_request($rawbody) {
1874     global $CFG;
1876     if (empty($CFG->mod_lti_log_users)) {
1877         return false;
1878     }
1880     $logusers = explode(',', $CFG->mod_lti_log_users);
1881     if (empty($logusers)) {
1882         return false;
1883     }
1885     try {
1886         $xml = new \SimpleXMLElement($rawbody);
1887         $ns  = $xml->getNamespaces();
1888         $ns  = array_shift($ns);
1889         $xml->registerXPathNamespace('lti', $ns);
1890         $requestuserid = '';
1891         if ($node = $xml->xpath('//lti:userId')) {
1892             $node = $node[0];
1893             $requestuserid = clean_param((string) $node, PARAM_INT);
1894         } else if ($node = $xml->xpath('//lti:sourcedId')) {
1895             $node = $node[0];
1896             $resultjson = json_decode((string) $node);
1897             $requestuserid = clean_param($resultjson->data->userid, PARAM_INT);
1898         }
1899     } catch (Exception $e) {
1900         return false;
1901     }
1903     if (empty($requestuserid) or !in_array($requestuserid, $logusers)) {
1904         return false;
1905     }
1907     return true;
1910 /**
1911  * Logs the request to a file in temp dir.
1912  *
1913  * @param string $rawbody
1914  */
1915 function lti_log_request($rawbody) {
1916     if ($tempdir = make_temp_directory('mod_lti', false)) {
1917         if ($tempfile = tempnam($tempdir, 'mod_lti_request'.date('YmdHis'))) {
1918             $content  = "Request Headers:\n";
1919             foreach (moodle\mod\lti\OAuthUtil::get_headers() as $header => $value) {
1920                 $content .= "$header: $value\n";
1921             }
1922             $content .= "Request Body:\n";
1923             $content .= $rawbody;
1925             file_put_contents($tempfile, $content);
1926             chmod($tempfile, 0644);
1927         }
1928     }
1931 /**
1932  * Log an LTI response.
1933  *
1934  * @param string $responsexml The response XML
1935  * @param Exception $e If there was an exception, pass that too
1936  */
1937 function lti_log_response($responsexml, $e = null) {
1938     if ($tempdir = make_temp_directory('mod_lti', false)) {
1939         if ($tempfile = tempnam($tempdir, 'mod_lti_response'.date('YmdHis'))) {
1940             $content = '';
1941             if ($e instanceof Exception) {
1942                 $info = get_exception_info($e);
1944                 $content .= "Exception:\n";
1945                 $content .= "Message: $info->message\n";
1946                 $content .= "Debug info: $info->debuginfo\n";
1947                 $content .= "Backtrace:\n";
1948                 $content .= format_backtrace($info->backtrace, true);
1949                 $content .= "\n";
1950             }
1951             $content .= "Response XML:\n";
1952             $content .= $responsexml;
1954             file_put_contents($tempfile, $content);
1955             chmod($tempfile, 0644);
1956         }
1957     }
1960 /**
1961  * Fetches LTI type configuration for an LTI instance
1962  *
1963  * @param stdClass $instance
1964  * @return array Can be empty if no type is found
1965  */
1966 function lti_get_type_config_by_instance($instance) {
1967     $typeid = null;
1968     if (empty($instance->typeid)) {
1969         $tool = lti_get_tool_by_url_match($instance->toolurl, $instance->course);
1970         if ($tool) {
1971             $typeid = $tool->id;
1972         }
1973     } else {
1974         $typeid = $instance->typeid;
1975     }
1976     if (!empty($typeid)) {
1977         return lti_get_type_config($typeid);
1978     }
1979     return array();
1982 /**
1983  * Enforce type config settings onto the LTI instance
1984  *
1985  * @param stdClass $instance
1986  * @param array $typeconfig
1987  */
1988 function lti_force_type_config_settings($instance, array $typeconfig) {
1989     $forced = array(
1990         'instructorchoicesendname'      => 'sendname',
1991         'instructorchoicesendemailaddr' => 'sendemailaddr',
1992         'instructorchoiceacceptgrades'  => 'acceptgrades',
1993     );
1995     foreach ($forced as $instanceparam => $typeconfigparam) {
1996         if (array_key_exists($typeconfigparam, $typeconfig) && $typeconfig[$typeconfigparam] != LTI_SETTING_DELEGATE) {
1997             $instance->$instanceparam = $typeconfig[$typeconfigparam];
1998         }
1999     }
2002 /**
2003  * Initializes an array with the capabilities supported by the LTI module
2004  *
2005  * @return array List of capability names (without a dollar sign prefix)
2006  */
2007 function lti_get_capabilities() {
2009     $capabilities = array(
2010        'basic-lti-launch-request' => '',
2011        'Context.id' => 'context_id',
2012        'CourseSection.title' => 'context_title',
2013        'CourseSection.label' => 'context_label',
2014        'CourseSection.sourcedId' => 'lis_course_section_sourcedid',
2015        'CourseSection.longDescription' => '$COURSE->summary',
2016        'CourseSection.timeFrame.begin' => '$COURSE->startdate',
2017        'ResourceLink.id' => 'resource_link_id',
2018        'ResourceLink.title' => 'resource_link_title',
2019        'ResourceLink.description' => 'resource_link_description',
2020        'User.id' => 'user_id',
2021        'User.username' => '$USER->username',
2022        'Person.name.full' => 'lis_person_name_full',
2023        'Person.name.given' => 'lis_person_name_given',
2024        'Person.name.family' => 'lis_person_name_family',
2025        'Person.email.primary' => 'lis_person_contact_email_primary',
2026        'Person.sourcedId' => 'lis_person_sourcedid',
2027        'Person.name.middle' => '$USER->middlename',
2028        'Person.address.street1' => '$USER->address',
2029        'Person.address.locality' => '$USER->city',
2030        'Person.address.country' => '$USER->country',
2031        'Person.address.timezone' => '$USER->timezone',
2032        'Person.phone.primary' => '$USER->phone1',
2033        'Person.phone.mobile' => '$USER->phone2',
2034        'Person.webaddress' => '$USER->url',
2035        'Membership.role' => 'roles',
2036        'Result.sourcedId' => 'lis_result_sourcedid',
2037        'Result.autocreate' => 'lis_outcome_service_url');
2039     return $capabilities;
2043 /**
2044  * Initializes an array with the services supported by the LTI module
2045  *
2046  * @return array List of services
2047  */
2048 function lti_get_services() {
2050     $services = array();
2051     $definedservices = core_component::get_plugin_list('ltiservice');
2052     foreach ($definedservices as $name => $location) {
2053         $classname = "\\ltiservice_{$name}\\local\\service\\{$name}";
2054         $services[] = new $classname();
2055     }
2057     return $services;
2061 /**
2062  * Initializes an instance of the named service
2063  *
2064  * @param string $servicename Name of service
2065  *
2066  * @return mod_lti\local\ltiservice\service_base Service
2067  */
2068 function lti_get_service_by_name($servicename) {
2070     $service = false;
2071     $classname = "\\ltiservice_{$servicename}\\local\\service\\{$servicename}";
2072     if (class_exists($classname)) {
2073         $service = new $classname();
2074     }
2076     return $service;
2080 /**
2081  * Finds a service by id
2082  *
2083  * @param array  $services    Array of services
2084  * @param string $resourceid  ID of resource
2085  *
2086  * @return mod_lti\local\ltiservice\service_base Service
2087  */
2088 function lti_get_service_by_resource_id($services, $resourceid) {
2090     $service = false;
2091     foreach ($services as $aservice) {
2092         foreach ($aservice->get_resources() as $resource) {
2093             if ($resource->get_id() === $resourceid) {
2094                 $service = $aservice;
2095                 break 2;
2096             }
2097         }
2098     }
2100     return $service;
2104 /**
2105  * Extracts the named contexts from a tool proxy
2106  *
2107  * @param object $json
2108  *
2109  * @return array Contexts
2110  */
2111 function lti_get_contexts($json) {
2113     $contexts = array();
2114     if (isset($json->{'@context'})) {
2115         foreach ($json->{'@context'} as $context) {
2116             if (is_object($context)) {
2117                 $contexts = array_merge(get_object_vars($context), $contexts);
2118             }
2119         }
2120     }
2122     return $contexts;
2126 /**
2127  * Converts an ID to a fully-qualified ID
2128  *
2129  * @param array $contexts
2130  * @param string $id
2131  *
2132  * @return string Fully-qualified ID
2133  */
2134 function lti_get_fqid($contexts, $id) {
2136     $parts = explode(':', $id, 2);
2137     if (count($parts) > 1) {
2138         if (array_key_exists($parts[0], $contexts)) {
2139             $id = $contexts[$parts[0]] . $parts[1];
2140         }
2141     }
2143     return $id;