e9467b969f6a99fce0c9e1c53926535d02aaeed3
[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     $endpoint = $toolproxy->regurl;
278     // Change the status to pending.
279     $toolproxy->state = LTI_TOOL_PROXY_STATE_PENDING;
280     lti_update_tool_proxy($toolproxy);
282     $requestparams = lti_build_registration_request($toolproxy);
284     $content = lti_post_launch_html($requestparams, $endpoint, false);
286     echo $content;
290 /**
291  * Gets the parameters for the regirstration request
292  *
293  * @param object $toolproxy Tool Proxy instance object
294  * @return array Registration request parameters
295  */
296 function lti_build_registration_request($toolproxy) {
297     $key = $toolproxy->guid;
298     $secret = $toolproxy->secret;
300     $requestparams = array();
301     $requestparams['lti_message_type'] = 'ToolProxyRegistrationRequest';
302     $requestparams['lti_version'] = 'LTI-2p0';
303     $requestparams['reg_key'] = $key;
304     $requestparams['reg_password'] = $secret;
306     // Add the profile URL.
307     $profileservice = lti_get_service_by_name('profile');
308     $profileservice->set_tool_proxy($toolproxy);
309     $requestparams['tc_profile_url'] = $profileservice->parse_value('$ToolConsumerProfile.url');
311     // Add the return URL.
312     $returnurlparams = array('id' => $toolproxy->id, 'sesskey' => sesskey());
313     $url = new \moodle_url('/mod/lti/externalregistrationreturn.php', $returnurlparams);
314     $returnurl = $url->out(false);
316     $requestparams['launch_presentation_return_url'] = $returnurl;
318     return $requestparams;
321 /**
322  * Build source ID
323  *
324  * @param int $instanceid
325  * @param int $userid
326  * @param string $servicesalt
327  * @param null|int $typeid
328  * @param null|int $launchid
329  * @return stdClass
330  */
331 function lti_build_sourcedid($instanceid, $userid, $servicesalt, $typeid = null, $launchid = null) {
332     $data = new \stdClass();
334     $data->instanceid = $instanceid;
335     $data->userid = $userid;
336     $data->typeid = $typeid;
337     if (!empty($launchid)) {
338         $data->launchid = $launchid;
339     } else {
340         $data->launchid = mt_rand();
341     }
343     $json = json_encode($data);
345     $hash = hash('sha256', $json . $servicesalt, false);
347     $container = new \stdClass();
348     $container->data = $data;
349     $container->hash = $hash;
351     return $container;
354 /**
355  * This function builds the request that must be sent to the tool producer
356  *
357  * @param object    $instance       Basic LTI instance object
358  * @param array     $typeconfig     Basic LTI tool configuration
359  * @param object    $course         Course object
360  * @param int|null  $typeid         Basic LTI tool ID
361  * @param boolean   $islti2         True if an LTI 2 tool is being launched
362  *
363  * @return array                    Request details
364  */
365 function lti_build_request($instance, $typeconfig, $course, $typeid = null, $islti2 = false) {
366     global $USER, $CFG;
368     if (empty($instance->cmid)) {
369         $instance->cmid = 0;
370     }
372     $role = lti_get_ims_role($USER, $instance->cmid, $instance->course, $islti2);
374     $intro = '';
375     if (!empty($instance->cmid)) {
376         $intro = format_module_intro('lti', $instance, $instance->cmid);
377         $intro = html_to_text($intro, 0, false);
379         // This may look weird, but this is required for new lines
380         // so we generate the same OAuth signature as the tool provider.
381         $intro = str_replace("\n", "\r\n", $intro);
382     }
383     $requestparams = array(
384         'resource_link_title' => $instance->name,
385         'resource_link_description' => $intro,
386         'user_id' => $USER->id,
387         'lis_person_sourcedid' => $USER->idnumber,
388         'roles' => $role,
389         'context_id' => $course->id,
390         'context_label' => $course->shortname,
391         'context_title' => $course->fullname,
392     );
393     if (!empty($instance->id)) {
394         $requestparams['resource_link_id'] = $instance->id;
395     }
396     if (!empty($instance->resource_link_id)) {
397         $requestparams['resource_link_id'] = $instance->resource_link_id;
398     }
399     if ($course->format == 'site') {
400         $requestparams['context_type'] = 'Group';
401     } else {
402         $requestparams['context_type'] = 'CourseSection';
403         $requestparams['lis_course_section_sourcedid'] = $course->idnumber;
404     }
405     $placementsecret = $instance->servicesalt;
407     if ( !empty($instance->id) && isset($placementsecret) && ($islti2 ||
408          $typeconfig['acceptgrades'] == LTI_SETTING_ALWAYS ||
409          ($typeconfig['acceptgrades'] == LTI_SETTING_DELEGATE && $instance->instructorchoiceacceptgrades == LTI_SETTING_ALWAYS))) {
411         $sourcedid = json_encode(lti_build_sourcedid($instance->id, $USER->id, $placementsecret, $typeid));
412         $requestparams['lis_result_sourcedid'] = $sourcedid;
414         // Add outcome service URL.
415         $serviceurl = new \moodle_url('/mod/lti/service.php');
416         $serviceurl = $serviceurl->out();
418         $forcessl = false;
419         if (!empty($CFG->mod_lti_forcessl)) {
420             $forcessl = true;
421         }
423         if ((isset($typeconfig['forcessl']) && ($typeconfig['forcessl'] == '1')) or $forcessl) {
424             $serviceurl = lti_ensure_url_is_https($serviceurl);
425         }
427         $requestparams['lis_outcome_service_url'] = $serviceurl;
428     }
430     // Send user's name and email data if appropriate.
431     if ($islti2 || $typeconfig['sendname'] == LTI_SETTING_ALWAYS ||
432          ( $typeconfig['sendname'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendname == LTI_SETTING_ALWAYS ) ) {
433         $requestparams['lis_person_name_given'] = $USER->firstname;
434         $requestparams['lis_person_name_family'] = $USER->lastname;
435         $requestparams['lis_person_name_full'] = $USER->firstname . ' ' . $USER->lastname;
436         $requestparams['ext_user_username'] = $USER->username;
437     }
439     if ($islti2 || $typeconfig['sendemailaddr'] == LTI_SETTING_ALWAYS ||
440          ($typeconfig['sendemailaddr'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendemailaddr == LTI_SETTING_ALWAYS)) {
441         $requestparams['lis_person_contact_email_primary'] = $USER->email;
442     }
444     return $requestparams;
447 /**
448  * This function builds the request that must be sent to an LTI 2 tool provider
449  *
450  * @param object    $tool           Basic LTI tool object
451  * @param array     $params         Custom launch parameters
452  *
453  * @return array                    Request details
454  */
455 function lti_build_request_lti2($tool, $params) {
457     $requestparams = array();
459     $capabilities = lti_get_capabilities();
460     $enabledcapabilities = explode("\n", $tool->enabledcapability);
461     foreach ($enabledcapabilities as $capability) {
462         if (array_key_exists($capability, $capabilities)) {
463             $val = $capabilities[$capability];
464             if ($val && (substr($val, 0, 1) != '$')) {
465                 if (isset($params[$val])) {
466                     $requestparams[$capabilities[$capability]] = $params[$capabilities[$capability]];
467                 }
468             }
469         }
470     }
472     return $requestparams;
476 /**
477  * This function builds the standard parameters for an LTI 1 or 2 request that must be sent to the tool producer
478  *
479  * @param object    $instance       Basic LTI instance object
480  * @param string    $orgid          Organisation ID
481  * @param boolean   $islti2         True if an LTI 2 tool is being launched
482  *
483  * @return array                    Request details
484  */
485 function lti_build_standard_request($instance, $orgid, $islti2) {
486     global $CFG;
488     $requestparams = array();
490     $requestparams['resource_link_id'] = $instance->id;
491     if (property_exists($instance, 'resource_link_id') and !empty($instance->resource_link_id)) {
492         $requestparams['resource_link_id'] = $instance->resource_link_id;
493     }
495     $requestparams['launch_presentation_locale'] = current_language();
497     // Make sure we let the tool know what LMS they are being called from.
498     $requestparams['ext_lms'] = 'moodle-2';
499     $requestparams['tool_consumer_info_product_family_code'] = 'moodle';
500     $requestparams['tool_consumer_info_version'] = strval($CFG->version);
502     // Add oauth_callback to be compliant with the 1.0A spec.
503     $requestparams['oauth_callback'] = 'about:blank';
505     if (!$islti2) {
506         $requestparams['lti_version'] = 'LTI-1p0';
507     } else {
508         $requestparams['lti_version'] = 'LTI-2p0';
509     }
510     $requestparams['lti_message_type'] = 'basic-lti-launch-request';
512     if ($orgid) {
513         $requestparams["tool_consumer_instance_guid"] = $orgid;
514     }
515     if (!empty($CFG->mod_lti_institution_name)) {
516         $requestparams['tool_consumer_instance_name'] = $CFG->mod_lti_institution_name;
517     } else {
518         $requestparams['tool_consumer_instance_name'] = get_site()->shortname;
519     }
520     $requestparams['tool_consumer_instance_description'] = get_site()->fullname;
522     return $requestparams;
525 /**
526  * This function builds the custom parameters
527  *
528  * @param object    $toolproxy      Tool proxy instance object
529  * @param object    $tool           Tool instance object
530  * @param object    $instance       Tool placement instance object
531  * @param array     $params         LTI launch parameters
532  * @param string    $customstr      Custom parameters defined for tool
533  * @param string    $instructorcustomstr      Custom parameters defined for this placement
534  * @param boolean   $islti2         True if an LTI 2 tool is being launched
535  *
536  * @return array                    Custom parameters
537  */
538 function lti_build_custom_parameters($toolproxy, $tool, $instance, $params, $customstr, $instructorcustomstr, $islti2) {
540     // Concatenate the custom parameters from the administrator and the instructor
541     // Instructor parameters are only taken into consideration if the administrator
542     // has given permission.
543     $custom = array();
544     if ($customstr) {
545         $custom = lti_split_custom_parameters($toolproxy, $tool, $params, $customstr, $islti2);
546     }
547     if (!isset($typeconfig['allowinstructorcustom']) || $typeconfig['allowinstructorcustom'] != LTI_SETTING_NEVER) {
548         if ($instructorcustomstr) {
549             $custom = array_merge(lti_split_custom_parameters($toolproxy, $tool, $params,
550                 $instructorcustomstr, $islti2), $custom);
551         }
552     }
553     if ($islti2) {
554         $custom = array_merge(lti_split_custom_parameters($toolproxy, $tool, $params,
555             $tool->parameter, true), $custom);
556         $settings = lti_get_tool_settings($tool->toolproxyid);
557         $custom = array_merge($custom, lti_get_custom_parameters($toolproxy, $tool, $params, $settings));
558         $settings = lti_get_tool_settings($tool->toolproxyid, $instance->course);
559         $custom = array_merge($custom, lti_get_custom_parameters($toolproxy, $tool, $params, $settings));
560         $settings = lti_get_tool_settings($tool->toolproxyid, $instance->course, $instance->id);
561         $custom = array_merge($custom, lti_get_custom_parameters($toolproxy, $tool, $params, $settings));
562     }
564     return $custom;
567 function lti_get_tool_table($tools, $id) {
568     global $CFG, $OUTPUT, $USER;
569     $html = '';
571     $typename = get_string('typename', 'lti');
572     $baseurl = get_string('baseurl', 'lti');
573     $action = get_string('action', 'lti');
574     $createdon = get_string('createdon', 'lti');
576     if (!empty($tools)) {
577         $html .= "
578         <div id=\"{$id}_tools_container\" style=\"margin-top:.5em;margin-bottom:.5em\">
579             <table id=\"{$id}_tools\">
580                 <thead>
581                     <tr>
582                         <th>$typename</th>
583                         <th>$baseurl</th>
584                         <th>$createdon</th>
585                         <th>$action</th>
586                     </tr>
587                 </thead>
588         ";
590         foreach ($tools as $type) {
591             $date = userdate($type->timecreated, get_string('strftimedatefullshort', 'core_langconfig'));
592             $accept = get_string('accept', 'lti');
593             $update = get_string('update', 'lti');
594             $delete = get_string('delete', 'lti');
596             if (empty($type->toolproxyid)) {
597                 $baseurl = new \moodle_url('/mod/lti/typessettings.php', array(
598                         'action' => 'accept',
599                         'id' => $type->id,
600                         'sesskey' => sesskey(),
601                         'tab' => $id
602                     ));
603                 $ref = $type->baseurl;
604             } else {
605                 $baseurl = new \moodle_url('/mod/lti/toolssettings.php', array(
606                         'action' => 'accept',
607                         'id' => $type->id,
608                         'sesskey' => sesskey(),
609                         'tab' => $id
610                     ));
611                 $ref = $type->tpname;
612             }
614             $accepthtml = $OUTPUT->action_icon($baseurl,
615                     new \pix_icon('t/check', $accept, '', array('class' => 'iconsmall')), null,
616                     array('title' => $accept, 'class' => 'editing_accept'));
618             $deleteaction = 'delete';
620             if ($type->state == LTI_TOOL_STATE_CONFIGURED) {
621                 $accepthtml = '';
622             }
624             if ($type->state != LTI_TOOL_STATE_REJECTED) {
625                 $deleteaction = 'reject';
626                 $delete = get_string('reject', 'lti');
627             }
629             $updateurl = clone($baseurl);
630             $updateurl->param('action', 'update');
631             $updatehtml = $OUTPUT->action_icon($updateurl,
632                     new \pix_icon('t/edit', $update, '', array('class' => 'iconsmall')), null,
633                     array('title' => $update, 'class' => 'editing_update'));
635             if (($type->state != LTI_TOOL_STATE_REJECTED) || empty($type->toolproxyid)) {
636                 $deleteurl = clone($baseurl);
637                 $deleteurl->param('action', $deleteaction);
638                 $deletehtml = $OUTPUT->action_icon($deleteurl,
639                         new \pix_icon('t/delete', $delete, '', array('class' => 'iconsmall')), null,
640                         array('title' => $delete, 'class' => 'editing_delete'));
641             } else {
642                 $deletehtml = '';
643             }
644             $html .= "
645             <tr>
646                 <td>
647                     {$type->name}
648                 </td>
649                 <td>
650                     {$ref}
651                 </td>
652                 <td>
653                     {$date}
654                 </td>
655                 <td align=\"center\">
656                     {$accepthtml}{$updatehtml}{$deletehtml}
657                 </td>
658             </tr>
659             ";
660         }
661         $html .= '</table></div>';
662     } else {
663         $html .= get_string('no_' . $id, 'lti');
664     }
666     return $html;
669 /**
670  * This function builds the tab for a category of tool proxies
671  *
672  * @param object    $toolproxies    Tool proxy instance objects
673  * @param string    $id             Category ID
674  *
675  * @return string                   HTML for tab
676  */
677 function lti_get_tool_proxy_table($toolproxies, $id) {
678     global $OUTPUT;
680     if (!empty($toolproxies)) {
681         $typename = get_string('typename', 'lti');
682         $url = get_string('registrationurl', 'lti');
683         $action = get_string('action', 'lti');
684         $createdon = get_string('createdon', 'lti');
686         $html = <<< EOD
687         <div id="{$id}_tool_proxies_container" style="margin-top: 0.5em; margin-bottom: 0.5em">
688             <table id="{$id}_tool_proxies">
689                 <thead>
690                     <tr>
691                         <th>{$typename}</th>
692                         <th>{$url}</th>
693                         <th>{$createdon}</th>
694                         <th>{$action}</th>
695                     </tr>
696                 </thead>
697 EOD;
698         foreach ($toolproxies as $toolproxy) {
699             $date = userdate($toolproxy->timecreated, get_string('strftimedatefullshort', 'core_langconfig'));
700             $accept = get_string('register', 'lti');
701             $update = get_string('update', 'lti');
702             $delete = get_string('delete', 'lti');
704             $baseurl = new \moodle_url('/mod/lti/registersettings.php', array(
705                     'action' => 'accept',
706                     'id' => $toolproxy->id,
707                     'sesskey' => sesskey(),
708                     'tab' => $id
709                 ));
711             $registerurl = new \moodle_url('/mod/lti/register.php', array(
712                     'id' => $toolproxy->id,
713                     'sesskey' => sesskey(),
714                     'tab' => 'tool_proxy'
715                 ));
717             $accepthtml = $OUTPUT->action_icon($registerurl,
718                     new \pix_icon('t/check', $accept, '', array('class' => 'iconsmall')), null,
719                     array('title' => $accept, 'class' => 'editing_accept'));
721             $deleteaction = 'delete';
723             if ($toolproxy->state != LTI_TOOL_PROXY_STATE_CONFIGURED) {
724                 $accepthtml = '';
725             }
727             if (($toolproxy->state == LTI_TOOL_PROXY_STATE_CONFIGURED) || ($toolproxy->state == LTI_TOOL_PROXY_STATE_PENDING)) {
728                 $delete = get_string('cancel', 'lti');
729             }
731             $updateurl = clone($baseurl);
732             $updateurl->param('action', 'update');
733             $updatehtml = $OUTPUT->action_icon($updateurl,
734                     new \pix_icon('t/edit', $update, '', array('class' => 'iconsmall')), null,
735                     array('title' => $update, 'class' => 'editing_update'));
737             $deleteurl = clone($baseurl);
738             $deleteurl->param('action', $deleteaction);
739             $deletehtml = $OUTPUT->action_icon($deleteurl,
740                     new \pix_icon('t/delete', $delete, '', array('class' => 'iconsmall')), null,
741                     array('title' => $delete, 'class' => 'editing_delete'));
742             $html .= <<< EOD
743             <tr>
744                 <td>
745                     {$toolproxy->name}
746                 </td>
747                 <td>
748                     {$toolproxy->regurl}
749                 </td>
750                 <td>
751                     {$date}
752                 </td>
753                 <td align="center">
754                     {$accepthtml}{$updatehtml}{$deletehtml}
755                 </td>
756             </tr>
757 EOD;
758         }
759         $html .= '</table></div>';
760     } else {
761         $html = get_string('no_' . $id, 'lti');
762     }
764     return $html;
767 /**
768  * Extracts the enabled capabilities into an array, including those implicitly declared in a parameter
769  *
770  * @param object    $tool           Tool instance object
771  *
772  * @return Array of enabled capabilities
773  */
774 function lti_get_enabled_capabilities($tool) {
775     if (!empty($tool->enabledcapability)) {
776         $enabledcapabilities = explode("\n", $tool->enabledcapability);
777     } else {
778         $enabledcapabilities = array();
779     }
780     $paramstr = str_replace("\r\n", "\n", $tool->parameter);
781     $paramstr = str_replace("\n\r", "\n", $paramstr);
782     $paramstr = str_replace("\r", "\n", $paramstr);
783     $params = explode("\n", $paramstr);
784     foreach ($params as $param) {
785         $pos = strpos($param, '=');
786         if (($pos === false) || ($pos < 1)) {
787             continue;
788         }
789         $value = trim(core_text::substr($param, $pos + 1, strlen($param)));
790         if (substr($value, 0, 1) == '$') {
791             $value = substr($value, 1);
792             if (!in_array($value, $enabledcapabilities)) {
793                 $enabledcapabilities[] = $value;
794             }
795         }
796     }
797     return $enabledcapabilities;
800 /**
801  * Splits the custom parameters field to the various parameters
802  *
803  * @param object    $toolproxy      Tool proxy instance object
804  * @param object    $tool           Tool instance object
805  * @param array     $params         LTI launch parameters
806  * @param string    $customstr      String containing the parameters
807  * @param boolean   $islti2         True if an LTI 2 tool is being launched
808  *
809  * @return Array of custom parameters
810  */
811 function lti_split_custom_parameters($toolproxy, $tool, $params, $customstr, $islti2 = false) {
812     $customstr = str_replace("\r\n", "\n", $customstr);
813     $customstr = str_replace("\n\r", "\n", $customstr);
814     $customstr = str_replace("\r", "\n", $customstr);
815     $lines = explode("\n", $customstr);  // Or should this split on "/[\n;]/"?
816     $retval = array();
817     foreach ($lines as $line) {
818         $pos = strpos($line, '=');
819         if ( $pos === false || $pos < 1 ) {
820             continue;
821         }
822         $key = trim(core_text::substr($line, 0, $pos));
823         $val = trim(core_text::substr($line, $pos + 1, strlen($line)));
824         $val = lti_parse_custom_parameter($toolproxy, $tool, $params, $val, $islti2);
825         $key2 = lti_map_keyname($key);
826         $retval['custom_'.$key2] = $val;
827         if ($islti2 && ($key != $key2)) {
828             $retval['custom_'.$key] = $val;
829         }
830     }
831     return $retval;
834 /**
835  * Adds the custom parameters to an array
836  *
837  * @param object    $toolproxy      Tool proxy instance object
838  * @param object    $tool           Tool instance object
839  * @param array     $params         LTI launch parameters
840  * @param array     $parameters     Array containing the parameters
841  *
842  * @return array    Array of custom parameters
843  */
844 function lti_get_custom_parameters($toolproxy, $tool, $params, $parameters) {
845     $retval = array();
846     foreach ($parameters as $key => $val) {
847         $key2 = lti_map_keyname($key);
848         $val = lti_parse_custom_parameter($toolproxy, $tool, $params, $val, true);
849         $retval['custom_'.$key2] = $val;
850         if ($key != $key2) {
851             $retval['custom_'.$key] = $val;
852         }
853     }
854     return $retval;
857 /**
858  * Parse a custom parameter to replace any substitution variables
859  *
860  * @param object    $toolproxy      Tool proxy instance object
861  * @param object    $tool           Tool instance object
862  * @param array     $params         LTI launch parameters
863  * @param string    $value          Custom parameter value
864  * @param boolean   $islti2         True if an LTI 2 tool is being launched
865  *
866  * @return Parsed value of custom parameter
867  */
868 function lti_parse_custom_parameter($toolproxy, $tool, $params, $value, $islti2) {
869     global $USER, $COURSE;
871     if ($value) {
872         if (substr($value, 0, 1) == '\\') {
873             $value = substr($value, 1);
874         } else if (substr($value, 0, 1) == '$') {
875             $value1 = substr($value, 1);
876             $enabledcapabilities = lti_get_enabled_capabilities($tool);
877             if (!$islti2 || in_array($value1, $enabledcapabilities)) {
878                 $capabilities = lti_get_capabilities();
879                 if (array_key_exists($value1, $capabilities)) {
880                     $val = $capabilities[$value1];
881                     if ($val) {
882                         if (substr($val, 0, 1) != '$') {
883                             $value = $params[$val];
884                         } else {
885                             $valarr = explode('->', substr($val, 1), 2);
886                             $value = "{${$valarr[0]}->{$valarr[1]}}";
887                             $value = str_replace('<br />' , ' ', $value);
888                             $value = str_replace('<br>' , ' ', $value);
889                             $value = format_string($value);
890                         }
891                     }
892                 } else if ($islti2) {
893                     $val = $value;
894                     $services = lti_get_services();
895                     foreach ($services as $service) {
896                         $service->set_tool_proxy($toolproxy);
897                         $value = $service->parse_value($val);
898                         if ($val != $value) {
899                             break;
900                         }
901                     }
902                 }
903             }
904         }
905     }
906     return $value;
909 /**
910  * Used for building the names of the different custom parameters
911  *
912  * @param string $key   Parameter name
913  *
914  * @return string       Processed name
915  */
916 function lti_map_keyname($key) {
917     $newkey = "";
918     $key = core_text::strtolower(trim($key));
919     foreach (str_split($key) as $ch) {
920         if ( ($ch >= 'a' && $ch <= 'z') || ($ch >= '0' && $ch <= '9') ) {
921             $newkey .= $ch;
922         } else {
923             $newkey .= '_';
924         }
925     }
926     return $newkey;
929 /**
930  * Gets the IMS role string for the specified user and LTI course module.
931  *
932  * @param mixed    $user      User object or user id
933  * @param int      $cmid      The course module id of the LTI activity
934  * @param int      $courseid  The course id of the LTI activity
935  * @param boolean  $islti2    True if an LTI 2 tool is being launched
936  *
937  * @return string A role string suitable for passing with an LTI launch
938  */
939 function lti_get_ims_role($user, $cmid, $courseid, $islti2) {
940     $roles = array();
942     if (empty($cmid)) {
943         // If no cmid is passed, check if the user is a teacher in the course
944         // This allows other modules to programmatically "fake" a launch without
945         // a real LTI instance.
946         $coursecontext = context_course::instance($courseid);
948         if (has_capability('moodle/course:manageactivities', $coursecontext, $user)) {
949             array_push($roles, 'Instructor');
950         } else {
951             array_push($roles, 'Learner');
952         }
953     } else {
954         $context = context_module::instance($cmid);
956         if (has_capability('mod/lti:manage', $context)) {
957             array_push($roles, 'Instructor');
958         } else {
959             array_push($roles, 'Learner');
960         }
961     }
963     if (is_siteadmin($user)) {
964         if (!$islti2) {
965             array_push($roles, 'urn:lti:sysrole:ims/lis/Administrator', 'urn:lti:instrole:ims/lis/Administrator');
966         } else {
967             array_push($roles, 'http://purl.imsglobal.org/vocab/lis/v2/person#Administrator');
968         }
969     }
971     return join(',', $roles);
974 /**
975  * Returns configuration details for the tool
976  *
977  * @param int $typeid   Basic LTI tool typeid
978  *
979  * @return array        Tool Configuration
980  */
981 function lti_get_type_config($typeid) {
982     global $DB;
984     $query = "SELECT name, value
985                 FROM {lti_types_config}
986                WHERE typeid = :typeid1
987            UNION ALL
988               SELECT 'toolurl' AS name, " . $DB->sql_compare_text('baseurl', 1333) . " AS value
989                 FROM {lti_types}
990                WHERE id = :typeid2
991            UNION ALL
992               SELECT 'icon' AS name, " . $DB->sql_compare_text('icon', 1333) . " AS value
993                 FROM {lti_types}
994                WHERE id = :typeid3
995            UNION ALL
996               SELECT 'secureicon' AS name, " . $DB->sql_compare_text('secureicon', 1333) . " AS value
997                 FROM {lti_types}
998                WHERE id = :typeid4";
1000     $typeconfig = array();
1001     $configs = $DB->get_records_sql($query,
1002         array('typeid1' => $typeid, 'typeid2' => $typeid, 'typeid3' => $typeid, 'typeid4' => $typeid));
1004     if (!empty($configs)) {
1005         foreach ($configs as $config) {
1006             $typeconfig[$config->name] = $config->value;
1007         }
1008     }
1010     return $typeconfig;
1013 function lti_get_tools_by_url($url, $state, $courseid = null) {
1014     $domain = lti_get_domain_from_url($url);
1016     return lti_get_tools_by_domain($domain, $state, $courseid);
1019 function lti_get_tools_by_domain($domain, $state = null, $courseid = null) {
1020     global $DB, $SITE;
1022     $filters = array('tooldomain' => $domain);
1024     $statefilter = '';
1025     $coursefilter = '';
1027     if ($state) {
1028         $statefilter = 'AND state = :state';
1029     }
1031     if ($courseid && $courseid != $SITE->id) {
1032         $coursefilter = 'OR course = :courseid';
1033     }
1035     $query = "SELECT *
1036                 FROM {lti_types}
1037                WHERE tooldomain = :tooldomain
1038                  AND (course = :siteid $coursefilter)
1039                  $statefilter";
1041     return $DB->get_records_sql($query, array(
1042         'courseid' => $courseid,
1043         'siteid' => $SITE->id,
1044         'tooldomain' => $domain,
1045         'state' => $state
1046     ));
1049 /**
1050  * Returns all basicLTI tools configured by the administrator
1051  *
1052  */
1053 function lti_filter_get_types($course) {
1054     global $DB;
1056     if (!empty($course)) {
1057         $where = "WHERE t.course = :course";
1058         $params = array('course' => $course);
1059     } else {
1060         $where = '';
1061         $params = array();
1062     }
1063     $query = "SELECT t.id, t.name, t.baseurl, t.state, t.toolproxyid, t.timecreated, tp.name tpname
1064                 FROM {lti_types} t LEFT OUTER JOIN {lti_tool_proxies} tp ON t.toolproxyid = tp.id
1065                 {$where}";
1066     return $DB->get_records_sql($query, $params);
1069 /**
1070  * Given an array of tools, filter them based on their state
1071  *
1072  * @param array $tools An array of lti_types records
1073  * @param int $state One of the LTI_TOOL_STATE_* constants
1074  * @return array
1075  */
1076 function lti_filter_tool_types(array $tools, $state) {
1077     $return = array();
1078     foreach ($tools as $key => $tool) {
1079         if ($tool->state == $state) {
1080             $return[$key] = $tool;
1081         }
1082     }
1083     return $return;
1086 /**
1087  * Returns all lti types visible in this course
1088  *
1089  * @param int $courseid The id of the course to retieve types for
1090  * @return stdClass[] All the lti types visible in the given course
1091  */
1092 function lti_get_lti_types_by_course($courseid) {
1093     global $DB, $SITE;
1095     $query = "SELECT *
1096                 FROM {lti_types}
1097                WHERE coursevisible = 1
1098                  AND (course = :siteid OR course = :courseid)
1099                  AND state = :active";
1101     return $DB->get_records_sql($query,
1102         array('siteid' => $SITE->id, 'courseid' => $courseid, 'active' => LTI_TOOL_STATE_CONFIGURED));
1105 /**
1106  * Returns tool types for lti add instance and edit page
1107  *
1108  * @return array Array of lti types
1109  */
1110 function lti_get_types_for_add_instance() {
1111     global $COURSE;
1112     $admintypes = lti_get_lti_types_by_course($COURSE->id);
1114     $types = array();
1115     $types[0] = (object)array('name' => get_string('automatic', 'lti'), 'course' => 0, 'toolproxyid' => null);
1117     foreach ($admintypes as $type) {
1118         $types[$type->id] = $type;
1119     }
1121     return $types;
1124 /**
1125  * Returns a list of configured types in the given course
1126  *
1127  * @param int $courseid The id of the course to retieve types for
1128  * @param int $sectionreturn section to return to for forming the URLs
1129  * @return array Array of lti types. Each element is object with properties: name, title, icon, help, link
1130  */
1131 function lti_get_configured_types($courseid, $sectionreturn = 0) {
1132     global $OUTPUT;
1133     $types = array();
1134     $admintypes = lti_get_lti_types_by_course($courseid);
1136     foreach ($admintypes as $ltitype) {
1137         $type           = new stdClass();
1138         $type->modclass = MOD_CLASS_ACTIVITY;
1139         $type->name     = 'lti_type_' . $ltitype->id;
1140         $type->title    = $ltitype->name;
1141         if (empty($ltitype->icon)) {
1142             $type->icon = $OUTPUT->pix_icon('icon', '', 'lti', array('class' => 'icon'));
1143         } else {
1144             $type->icon = html_writer::empty_tag('img', array('src' => $ltitype->icon, 'alt' => $ltitype->name, 'class' => 'icon'));
1145         }
1146         $type->link = new moodle_url('/course/modedit.php', array('add' => 'lti', 'return' => 0, 'course' => $courseid,
1147             'sr' => $sectionreturn, 'typeid' => $ltitype->id));
1148         $types[] = $type;
1149     }
1150     return $types;
1153 function lti_get_domain_from_url($url) {
1154     $matches = array();
1156     if (preg_match(LTI_URL_DOMAIN_REGEX, $url, $matches)) {
1157         return $matches[1];
1158     }
1161 function lti_get_tool_by_url_match($url, $courseid = null, $state = LTI_TOOL_STATE_CONFIGURED) {
1162     $possibletools = lti_get_tools_by_url($url, $state, $courseid);
1164     return lti_get_best_tool_by_url($url, $possibletools, $courseid);
1167 function lti_get_url_thumbprint($url) {
1168     // Parse URL requires a schema otherwise everything goes into 'path'.  Fixed 5.4.7 or later.
1169     if (preg_match('/https?:\/\//', $url) !== 1) {
1170         $url = 'http://'.$url;
1171     }
1172     $urlparts = parse_url(strtolower($url));
1173     if (!isset($urlparts['path'])) {
1174         $urlparts['path'] = '';
1175     }
1177     if (!isset($urlparts['host'])) {
1178         $urlparts['host'] = '';
1179     }
1181     if (substr($urlparts['host'], 0, 4) === 'www.') {
1182         $urlparts['host'] = substr($urlparts['host'], 4);
1183     }
1185     return $urllower = $urlparts['host'] . '/' . $urlparts['path'];
1188 function lti_get_best_tool_by_url($url, $tools, $courseid = null) {
1189     if (count($tools) === 0) {
1190         return null;
1191     }
1193     $urllower = lti_get_url_thumbprint($url);
1195     foreach ($tools as $tool) {
1196         $tool->_matchscore = 0;
1198         $toolbaseurllower = lti_get_url_thumbprint($tool->baseurl);
1200         if ($urllower === $toolbaseurllower) {
1201             // 100 points for exact thumbprint match.
1202             $tool->_matchscore += 100;
1203         } else if (substr($urllower, 0, strlen($toolbaseurllower)) === $toolbaseurllower) {
1204             // 50 points if tool thumbprint starts with the base URL thumbprint.
1205             $tool->_matchscore += 50;
1206         }
1208         // Prefer course tools over site tools.
1209         if (!empty($courseid)) {
1210             // Minus 10 points for not matching the course id (global tools).
1211             if ($tool->course != $courseid) {
1212                 $tool->_matchscore -= 10;
1213             }
1214         }
1215     }
1217     $bestmatch = array_reduce($tools, function($value, $tool) {
1218         if ($tool->_matchscore > $value->_matchscore) {
1219             return $tool;
1220         } else {
1221             return $value;
1222         }
1224     }, (object)array('_matchscore' => -1));
1226     // None of the tools are suitable for this URL.
1227     if ($bestmatch->_matchscore <= 0) {
1228         return null;
1229     }
1231     return $bestmatch;
1234 function lti_get_shared_secrets_by_key($key) {
1235     global $DB;
1237     // Look up the shared secret for the specified key in both the types_config table (for configured tools)
1238     // And in the lti resource table for ad-hoc tools.
1239     $query = "SELECT t2.value
1240                 FROM {lti_types_config} t1
1241                 JOIN {lti_types_config} t2 ON t1.typeid = t2.typeid
1242                 JOIN {lti_types} type ON t2.typeid = type.id
1243               WHERE t1.name = 'resourcekey'
1244                 AND t1.value = :key1
1245                 AND t2.name = 'password'
1246                 AND type.state = :configured1
1247                UNION
1248               SELECT tp.secret AS value
1249                 FROM {lti_tool_proxies} tp
1250                 JOIN {lti_types} t ON tp.id = t.toolproxyid
1251               WHERE tp.guid = :key2
1252                 AND t.state = :configured2
1253               UNION
1254              SELECT password AS value
1255                FROM {lti}
1256               WHERE resourcekey = :key3";
1258     $sharedsecrets = $DB->get_records_sql($query, array('configured1' => LTI_TOOL_STATE_CONFIGURED,
1259         'configured2' => LTI_TOOL_STATE_CONFIGURED, 'key1' => $key, 'key2' => $key, 'key3' => $key));
1261     $values = array_map(function($item) {
1262         return $item->value;
1263     }, $sharedsecrets);
1265     // There should really only be one shared secret per key. But, we can't prevent
1266     // more than one getting entered. For instance, if the same key is used for two tool providers.
1267     return $values;
1270 /**
1271  * Delete a Basic LTI configuration
1272  *
1273  * @param int $id   Configuration id
1274  */
1275 function lti_delete_type($id) {
1276     global $DB;
1278     // We should probably just copy the launch URL to the tool instances in this case... using a single query.
1279     /*
1280     $instances = $DB->get_records('lti', array('typeid' => $id));
1281     foreach ($instances as $instance) {
1282         $instance->typeid = 0;
1283         $DB->update_record('lti', $instance);
1284     }*/
1286     $DB->delete_records('lti_types', array('id' => $id));
1287     $DB->delete_records('lti_types_config', array('typeid' => $id));
1290 function lti_set_state_for_type($id, $state) {
1291     global $DB;
1293     $DB->update_record('lti_types', array('id' => $id, 'state' => $state));
1296 /**
1297  * Transforms a basic LTI object to an array
1298  *
1299  * @param object $ltiobject    Basic LTI object
1300  *
1301  * @return array Basic LTI configuration details
1302  */
1303 function lti_get_config($ltiobject) {
1304     $typeconfig = array();
1305     $typeconfig = (array)$ltiobject;
1306     $additionalconfig = lti_get_type_config($ltiobject->typeid);
1307     $typeconfig = array_merge($typeconfig, $additionalconfig);
1308     return $typeconfig;
1311 /**
1312  *
1313  * Generates some of the tool configuration based on the instance details
1314  *
1315  * @param int $id
1316  *
1317  * @return Instance configuration
1318  *
1319  */
1320 function lti_get_type_config_from_instance($id) {
1321     global $DB;
1323     $instance = $DB->get_record('lti', array('id' => $id));
1324     $config = lti_get_config($instance);
1326     $type = new \stdClass();
1327     $type->lti_fix = $id;
1328     if (isset($config['toolurl'])) {
1329         $type->lti_toolurl = $config['toolurl'];
1330     }
1331     if (isset($config['instructorchoicesendname'])) {
1332         $type->lti_sendname = $config['instructorchoicesendname'];
1333     }
1334     if (isset($config['instructorchoicesendemailaddr'])) {
1335         $type->lti_sendemailaddr = $config['instructorchoicesendemailaddr'];
1336     }
1337     if (isset($config['instructorchoiceacceptgrades'])) {
1338         $type->lti_acceptgrades = $config['instructorchoiceacceptgrades'];
1339     }
1340     if (isset($config['instructorchoiceallowroster'])) {
1341         $type->lti_allowroster = $config['instructorchoiceallowroster'];
1342     }
1344     if (isset($config['instructorcustomparameters'])) {
1345         $type->lti_allowsetting = $config['instructorcustomparameters'];
1346     }
1347     return $type;
1350 /**
1351  * Generates some of the tool configuration based on the admin configuration details
1352  *
1353  * @param int $id
1354  *
1355  * @return Configuration details
1356  */
1357 function lti_get_type_type_config($id) {
1358     global $DB;
1360     $basicltitype = $DB->get_record('lti_types', array('id' => $id));
1361     $config = lti_get_type_config($id);
1363     $type = new \stdClass();
1365     $type->lti_typename = $basicltitype->name;
1367     $type->typeid = $basicltitype->id;
1369     $type->toolproxyid = $basicltitype->toolproxyid;
1371     $type->lti_toolurl = $basicltitype->baseurl;
1373     $type->lti_description = $basicltitype->description;
1375     $type->lti_parameters = $basicltitype->parameter;
1377     $type->lti_icon = $basicltitype->icon;
1379     $type->lti_secureicon = $basicltitype->secureicon;
1381     if (isset($config['resourcekey'])) {
1382         $type->lti_resourcekey = $config['resourcekey'];
1383     }
1384     if (isset($config['password'])) {
1385         $type->lti_password = $config['password'];
1386     }
1388     if (isset($config['sendname'])) {
1389         $type->lti_sendname = $config['sendname'];
1390     }
1391     if (isset($config['instructorchoicesendname'])) {
1392         $type->lti_instructorchoicesendname = $config['instructorchoicesendname'];
1393     }
1394     if (isset($config['sendemailaddr'])) {
1395         $type->lti_sendemailaddr = $config['sendemailaddr'];
1396     }
1397     if (isset($config['instructorchoicesendemailaddr'])) {
1398         $type->lti_instructorchoicesendemailaddr = $config['instructorchoicesendemailaddr'];
1399     }
1400     if (isset($config['acceptgrades'])) {
1401         $type->lti_acceptgrades = $config['acceptgrades'];
1402     }
1403     if (isset($config['instructorchoiceacceptgrades'])) {
1404         $type->lti_instructorchoiceacceptgrades = $config['instructorchoiceacceptgrades'];
1405     }
1406     if (isset($config['allowroster'])) {
1407         $type->lti_allowroster = $config['allowroster'];
1408     }
1409     if (isset($config['instructorchoiceallowroster'])) {
1410         $type->lti_instructorchoiceallowroster = $config['instructorchoiceallowroster'];
1411     }
1413     if (isset($config['customparameters'])) {
1414         $type->lti_customparameters = $config['customparameters'];
1415     }
1417     if (isset($config['forcessl'])) {
1418         $type->lti_forcessl = $config['forcessl'];
1419     }
1421     if (isset($config['organizationid'])) {
1422         $type->lti_organizationid = $config['organizationid'];
1423     }
1424     if (isset($config['organizationurl'])) {
1425         $type->lti_organizationurl = $config['organizationurl'];
1426     }
1427     if (isset($config['organizationdescr'])) {
1428         $type->lti_organizationdescr = $config['organizationdescr'];
1429     }
1430     if (isset($config['launchcontainer'])) {
1431         $type->lti_launchcontainer = $config['launchcontainer'];
1432     }
1434     if (isset($config['coursevisible'])) {
1435         $type->lti_coursevisible = $config['coursevisible'];
1436     }
1438     if (isset($config['debuglaunch'])) {
1439         $type->lti_debuglaunch = $config['debuglaunch'];
1440     }
1442     if (isset($config['module_class_type'])) {
1443         $type->lti_module_class_type = $config['module_class_type'];
1444     }
1446     return $type;
1449 function lti_prepare_type_for_save($type, $config) {
1450     if (isset($config->lti_toolurl)) {
1451         $type->baseurl = $config->lti_toolurl;
1452         $type->tooldomain = lti_get_domain_from_url($config->lti_toolurl);
1453     }
1454     if (isset($config->lti_description)) {
1455         $type->description = $config->lti_description;
1456     }
1457     if (isset($config->lti_typename)) {
1458         $type->name = $config->lti_typename;
1459     }
1460     if (isset($config->lti_coursevisible)) {
1461         $type->coursevisible = !empty($config->lti_coursevisible) ? $config->lti_coursevisible : 0;
1462         $config->lti_coursevisible = $type->coursevisible;
1463     }
1465     if (isset($config->lti_icon)) {
1466         $type->icon = $config->lti_icon;
1467     }
1468     if (isset($config->lti_secureicon)) {
1469         $type->secureicon = $config->lti_secureicon;
1470     }
1472     $type->forcessl = !empty($config->lti_forcessl) ? $config->lti_forcessl : 0;
1473     $config->lti_forcessl = $type->forcessl;
1475     $type->timemodified = time();
1477     unset ($config->lti_typename);
1478     unset ($config->lti_toolurl);
1479     unset ($config->lti_description);
1480     unset ($config->lti_icon);
1481     unset ($config->lti_secureicon);
1484 function lti_update_type($type, $config) {
1485     global $DB, $CFG;
1487     lti_prepare_type_for_save($type, $config);
1489     $clearcache = false;
1490     if (lti_request_is_using_ssl() && !empty($type->secureicon)) {
1491         $clearcache = !isset($config->oldicon) || ($config->oldicon !== $type->secureicon);
1492     } else {
1493         $clearcache = isset($type->icon) && (!isset($config->oldicon) || ($config->oldicon !== $type->icon));
1494     }
1495     unset($config->oldicon);
1497     if ($DB->update_record('lti_types', $type)) {
1498         foreach ($config as $key => $value) {
1499             if (substr($key, 0, 4) == 'lti_' && !is_null($value)) {
1500                 $record = new \StdClass();
1501                 $record->typeid = $type->id;
1502                 $record->name = substr($key, 4);
1503                 $record->value = $value;
1504                 lti_update_config($record);
1505             }
1506         }
1507         require_once($CFG->libdir.'/modinfolib.php');
1508         if ($clearcache) {
1509             rebuild_course_cache();
1510         }
1511     }
1514 function lti_add_type($type, $config) {
1515     global $USER, $SITE, $DB;
1517     lti_prepare_type_for_save($type, $config);
1519     if (!isset($type->state)) {
1520         $type->state = LTI_TOOL_STATE_PENDING;
1521     }
1523     if (!isset($type->timecreated)) {
1524         $type->timecreated = time();
1525     }
1527     if (!isset($type->createdby)) {
1528         $type->createdby = $USER->id;
1529     }
1531     if (!isset($type->course)) {
1532         $type->course = $SITE->id;
1533     }
1535     // Create a salt value to be used for signing passed data to extension services
1536     // The outcome service uses the service salt on the instance. This can be used
1537     // for communication with services not related to a specific LTI instance.
1538     $config->lti_servicesalt = uniqid('', true);
1540     $id = $DB->insert_record('lti_types', $type);
1542     if ($id) {
1543         foreach ($config as $key => $value) {
1544             if (substr($key, 0, 4) == 'lti_' && !is_null($value)) {
1545                 $record = new \StdClass();
1546                 $record->typeid = $id;
1547                 $record->name = substr($key, 4);
1548                 $record->value = $value;
1550                 lti_add_config($record);
1551             }
1552         }
1553     }
1555     return $id;
1558 /**
1559  * Given an array of tool proxies, filter them based on their state
1560  *
1561  * @param array $toolproxies An array of lti_tool_proxies records
1562  * @param int $state One of the LTI_TOOL_PROXY_STATE_* constants
1563  *
1564  * @return array
1565  */
1566 function lti_filter_tool_proxy_types(array $toolproxies, $state) {
1567     $return = array();
1568     foreach ($toolproxies as $key => $toolproxy) {
1569         if ($toolproxy->state == $state) {
1570             $return[$key] = $toolproxy;
1571         }
1572     }
1573     return $return;
1576 /**
1577  * Get the tool proxy instance given its GUID
1578  *
1579  * @param string  $toolproxyguid   Tool proxy GUID value
1580  *
1581  * @return object
1582  */
1583 function lti_get_tool_proxy_from_guid($toolproxyguid) {
1584     global $DB;
1586     $toolproxy = $DB->get_record('lti_tool_proxies', array('guid' => $toolproxyguid));
1588     return $toolproxy;
1591 /**
1592  * Get the tool proxy instance given its registration URL
1593  *
1594  * @param string $regurl Tool proxy registration URL
1595  *
1596  * @return array The record of the tool proxy with this url
1597  */
1598 function lti_get_tool_proxies_from_registration_url($regurl) {
1599     global $DB;
1601     return $DB->get_records_sql(
1602         'SELECT * FROM {lti_tool_proxies}
1603         WHERE '.$DB->sql_compare_text('regurl', 256).' = :regurl',
1604         array('regurl' => $regurl)
1605     );
1608 /**
1609  * Generates some of the tool proxy configuration based on the admin configuration details
1610  *
1611  * @param int $id
1612  *
1613  * @return Tool Proxy details
1614  */
1615 function lti_get_tool_proxy($id) {
1616     global $DB;
1618     $toolproxy = $DB->get_record('lti_tool_proxies', array('id' => $id));
1619     return $toolproxy;
1622 /**
1623  * Generates some of the tool proxy configuration based on the admin configuration details
1624  *
1625  * @param int $id
1626  *
1627  * @return Tool Proxy details
1628  */
1629 function lti_get_tool_proxy_config($id) {
1630     $toolproxy = lti_get_tool_proxy($id);
1632     $tp = new \stdClass();
1633     $tp->lti_registrationname = $toolproxy->name;
1634     $tp->toolproxyid = $toolproxy->id;
1635     $tp->state = $toolproxy->state;
1636     $tp->lti_registrationurl = $toolproxy->regurl;
1637     $tp->lti_capabilities = explode("\n", $toolproxy->capabilityoffered);
1638     $tp->lti_services = explode("\n", $toolproxy->serviceoffered);
1640     return $tp;
1643 /**
1644  * Update the database with a tool proxy instance
1645  *
1646  * @param object   $config    Tool proxy definition
1647  *
1648  * @return int  Record id number
1649  */
1650 function lti_add_tool_proxy($config) {
1651     global $USER, $DB;
1653     $toolproxy = new \stdClass();
1654     if (isset($config->lti_registrationname)) {
1655         $toolproxy->name = trim($config->lti_registrationname);
1656     }
1657     if (isset($config->lti_registrationurl)) {
1658         $toolproxy->regurl = trim($config->lti_registrationurl);
1659     }
1660     if (isset($config->lti_capabilities)) {
1661         $toolproxy->capabilityoffered = implode("\n", $config->lti_capabilities);
1662     } else {
1663         $toolproxy->capabilityoffered = implode("\n", array_keys(lti_get_capabilities()));
1664     }
1665     if (isset($config->lti_services)) {
1666         $toolproxy->serviceoffered = implode("\n", $config->lti_services);
1667     } else {
1668         $func = function($s) {
1669             return $s->get_id();
1670         };
1671         $servicenames = array_map($func, lti_get_services());
1672         $toolproxy->serviceoffered = implode("\n", $servicenames);
1673     }
1674     if (isset($config->toolproxyid) && !empty($config->toolproxyid)) {
1675         $toolproxy->id = $config->toolproxyid;
1676         if (!isset($toolproxy->state) || ($toolproxy->state != LTI_TOOL_PROXY_STATE_ACCEPTED)) {
1677             $toolproxy->state = LTI_TOOL_PROXY_STATE_CONFIGURED;
1678             $toolproxy->guid = random_string();
1679             $toolproxy->secret = random_string();
1680         }
1681         $id = lti_update_tool_proxy($toolproxy);
1682     } else {
1683         $toolproxy->state = LTI_TOOL_PROXY_STATE_CONFIGURED;
1684         $toolproxy->timemodified = time();
1685         $toolproxy->timecreated = $toolproxy->timemodified;
1686         if (!isset($toolproxy->createdby)) {
1687             $toolproxy->createdby = $USER->id;
1688         }
1689         $toolproxy->guid = random_string();
1690         $toolproxy->secret = random_string();
1691         $id = $DB->insert_record('lti_tool_proxies', $toolproxy);
1692     }
1694     return $id;
1697 /**
1698  * Updates a tool proxy in the database
1699  *
1700  * @param object  $toolproxy   Tool proxy
1701  *
1702  * @return int    Record id number
1703  */
1704 function lti_update_tool_proxy($toolproxy) {
1705     global $DB;
1707     $toolproxy->timemodified = time();
1708     $id = $DB->update_record('lti_tool_proxies', $toolproxy);
1710     return $id;
1713 /**
1714  * Delete a Tool Proxy
1715  *
1716  * @param int $id   Tool Proxy id
1717  */
1718 function lti_delete_tool_proxy($id) {
1719     global $DB;
1720     $DB->delete_records('lti_tool_settings', array('toolproxyid' => $id));
1721     $tools = $DB->get_records('lti_types', array('toolproxyid' => $id));
1722     foreach ($tools as $tool) {
1723         lti_delete_type($tool->id);
1724     }
1725     $DB->delete_records('lti_tool_proxies', array('id' => $id));
1728 /**
1729  * Add a tool configuration in the database
1730  *
1731  * @param object $config   Tool configuration
1732  *
1733  * @return int Record id number
1734  */
1735 function lti_add_config($config) {
1736     global $DB;
1738     return $DB->insert_record('lti_types_config', $config);
1741 /**
1742  * Updates a tool configuration in the database
1743  *
1744  * @param object  $config   Tool configuration
1745  *
1746  * @return Record id number
1747  */
1748 function lti_update_config($config) {
1749     global $DB;
1751     $return = true;
1752     $old = $DB->get_record('lti_types_config', array('typeid' => $config->typeid, 'name' => $config->name));
1754     if ($old) {
1755         $config->id = $old->id;
1756         $return = $DB->update_record('lti_types_config', $config);
1757     } else {
1758         $return = $DB->insert_record('lti_types_config', $config);
1759     }
1760     return $return;
1763 /**
1764  * Gets the tool settings
1765  *
1766  * @param int  $toolproxyid   Id of tool proxy record
1767  * @param int  $courseid      Id of course (null if system settings)
1768  * @param int  $instanceid    Id of course module (null if system or context settings)
1769  *
1770  * @return array  Array settings
1771  */
1772 function lti_get_tool_settings($toolproxyid, $courseid = null, $instanceid = null) {
1773     global $DB;
1775     $settings = array();
1776     $settingsstr = $DB->get_field('lti_tool_settings', 'settings', array('toolproxyid' => $toolproxyid,
1777         'course' => $courseid, 'coursemoduleid' => $instanceid));
1778     if ($settingsstr !== false) {
1779         $settings = json_decode($settingsstr, true);
1780     }
1781     return $settings;
1784 /**
1785  * Sets the tool settings (
1786  *
1787  * @param array  $settings      Array of settings
1788  * @param int    $toolproxyid   Id of tool proxy record
1789  * @param int    $courseid      Id of course (null if system settings)
1790  * @param int    $instanceid    Id of course module (null if system or context settings)
1791  */
1792 function lti_set_tool_settings($settings, $toolproxyid, $courseid = null, $instanceid = null) {
1793     global $DB;
1795     $json = json_encode($settings);
1796     $record = $DB->get_record('lti_tool_settings', array('toolproxyid' => $toolproxyid,
1797         'course' => $courseid, 'coursemoduleid' => $instanceid));
1798     if ($record !== false) {
1799         $DB->update_record('lti_tool_settings', array('id' => $record->id, 'settings' => $json, 'timemodified' => time()));
1800     } else {
1801         $record = new \stdClass();
1802         $record->toolproxyid = $toolproxyid;
1803         $record->course = $courseid;
1804         $record->coursemoduleid = $instanceid;
1805         $record->settings = $json;
1806         $record->timecreated = time();
1807         $record->timemodified = $record->timecreated;
1808         $DB->insert_record('lti_tool_settings', $record);
1809     }
1812 /**
1813  * Signs the petition to launch the external tool using OAuth
1814  *
1815  * @param $oldparms     Parameters to be passed for signing
1816  * @param $endpoint     url of the external tool
1817  * @param $method       Method for sending the parameters (e.g. POST)
1818  * @param $oauth_consumoer_key          Key
1819  * @param $oauth_consumoer_secret       Secret
1820  */
1821 function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret) {
1823     $parms = $oldparms;
1825     $testtoken = '';
1827     // TODO: Switch to core oauthlib once implemented - MDL-30149.
1828     $hmacmethod = new lti\OAuthSignatureMethod_HMAC_SHA1();
1829     $testconsumer = new lti\OAuthConsumer($oauthconsumerkey, $oauthconsumersecret, null);
1830     $accreq = lti\OAuthRequest::from_consumer_and_token($testconsumer, $testtoken, $method, $endpoint, $parms);
1831     $accreq->sign_request($hmacmethod, $testconsumer, $testtoken);
1833     $newparms = $accreq->get_parameters();
1835     return $newparms;
1838 /**
1839  * Posts the launch petition HTML
1840  *
1841  * @param $newparms     Signed parameters
1842  * @param $endpoint     URL of the external tool
1843  * @param $debug        Debug (true/false)
1844  */
1845 function lti_post_launch_html($newparms, $endpoint, $debug=false) {
1846     $r = "<form action=\"" . $endpoint .
1847         "\" name=\"ltiLaunchForm\" id=\"ltiLaunchForm\" method=\"post\" encType=\"application/x-www-form-urlencoded\">\n";
1849     // Contruct html for the launch parameters.
1850     foreach ($newparms as $key => $value) {
1851         $key = htmlspecialchars($key);
1852         $value = htmlspecialchars($value);
1853         if ( $key == "ext_submit" ) {
1854             $r .= "<input type=\"submit\"";
1855         } else {
1856             $r .= "<input type=\"hidden\" name=\"{$key}\"";
1857         }
1858         $r .= " value=\"";
1859         $r .= $value;
1860         $r .= "\"/>\n";
1861     }
1863     if ( $debug ) {
1864         $r .= "<script language=\"javascript\"> \n";
1865         $r .= "  //<![CDATA[ \n";
1866         $r .= "function basicltiDebugToggle() {\n";
1867         $r .= "    var ele = document.getElementById(\"basicltiDebug\");\n";
1868         $r .= "    if (ele.style.display == \"block\") {\n";
1869         $r .= "        ele.style.display = \"none\";\n";
1870         $r .= "    }\n";
1871         $r .= "    else {\n";
1872         $r .= "        ele.style.display = \"block\";\n";
1873         $r .= "    }\n";
1874         $r .= "} \n";
1875         $r .= "  //]]> \n";
1876         $r .= "</script>\n";
1877         $r .= "<a id=\"displayText\" href=\"javascript:basicltiDebugToggle();\">";
1878         $r .= get_string("toggle_debug_data", "lti")."</a>\n";
1879         $r .= "<div id=\"basicltiDebug\" style=\"display:none\">\n";
1880         $r .= "<b>".get_string("basiclti_endpoint", "lti")."</b><br/>\n";
1881         $r .= $endpoint . "<br/>\n&nbsp;<br/>\n";
1882         $r .= "<b>".get_string("basiclti_parameters", "lti")."</b><br/>\n";
1883         foreach ($newparms as $key => $value) {
1884             $key = htmlspecialchars($key);
1885             $value = htmlspecialchars($value);
1886             $r .= "$key = $value<br/>\n";
1887         }
1888         $r .= "&nbsp;<br/>\n";
1889         $r .= "</div>\n";
1890     }
1891     $r .= "</form>\n";
1893     if ( ! $debug ) {
1894         $r .= " <script type=\"text/javascript\"> \n" .
1895             "  //<![CDATA[ \n" .
1896             "    document.ltiLaunchForm.submit(); \n" .
1897             "  //]]> \n" .
1898             " </script> \n";
1899     }
1900     return $r;
1903 function lti_get_type($typeid) {
1904     global $DB;
1906     return $DB->get_record('lti_types', array('id' => $typeid));
1909 function lti_get_launch_container($lti, $toolconfig) {
1910     if (empty($lti->launchcontainer)) {
1911         $lti->launchcontainer = LTI_LAUNCH_CONTAINER_DEFAULT;
1912     }
1914     if ($lti->launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1915         if (isset($toolconfig['launchcontainer'])) {
1916             $launchcontainer = $toolconfig['launchcontainer'];
1917         }
1918     } else {
1919         $launchcontainer = $lti->launchcontainer;
1920     }
1922     if (empty($launchcontainer) || $launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1923         $launchcontainer = LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS;
1924     }
1926     $devicetype = core_useragent::get_device_type();
1928     // Scrolling within the object element doesn't work on iOS or Android
1929     // Opening the popup window also had some issues in testing
1930     // For mobile devices, always take up the entire screen to ensure the best experience.
1931     if ($devicetype === core_useragent::DEVICETYPE_MOBILE || $devicetype === core_useragent::DEVICETYPE_TABLET ) {
1932         $launchcontainer = LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW;
1933     }
1935     return $launchcontainer;
1938 function lti_request_is_using_ssl() {
1939     global $CFG;
1940     return (stripos($CFG->httpswwwroot, 'https://') === 0);
1943 function lti_ensure_url_is_https($url) {
1944     if (!strstr($url, '://')) {
1945         $url = 'https://' . $url;
1946     } else {
1947         // If the URL starts with http, replace with https.
1948         if (stripos($url, 'http://') === 0) {
1949             $url = 'https://' . substr($url, 7);
1950         }
1951     }
1953     return $url;
1956 /**
1957  * Determines if we should try to log the request
1958  *
1959  * @param string $rawbody
1960  * @return bool
1961  */
1962 function lti_should_log_request($rawbody) {
1963     global $CFG;
1965     if (empty($CFG->mod_lti_log_users)) {
1966         return false;
1967     }
1969     $logusers = explode(',', $CFG->mod_lti_log_users);
1970     if (empty($logusers)) {
1971         return false;
1972     }
1974     try {
1975         $xml = new \SimpleXMLElement($rawbody);
1976         $ns  = $xml->getNamespaces();
1977         $ns  = array_shift($ns);
1978         $xml->registerXPathNamespace('lti', $ns);
1979         $requestuserid = '';
1980         if ($node = $xml->xpath('//lti:userId')) {
1981             $node = $node[0];
1982             $requestuserid = clean_param((string) $node, PARAM_INT);
1983         } else if ($node = $xml->xpath('//lti:sourcedId')) {
1984             $node = $node[0];
1985             $resultjson = json_decode((string) $node);
1986             $requestuserid = clean_param($resultjson->data->userid, PARAM_INT);
1987         }
1988     } catch (Exception $e) {
1989         return false;
1990     }
1992     if (empty($requestuserid) or !in_array($requestuserid, $logusers)) {
1993         return false;
1994     }
1996     return true;
1999 /**
2000  * Logs the request to a file in temp dir.
2001  *
2002  * @param string $rawbody
2003  */
2004 function lti_log_request($rawbody) {
2005     if ($tempdir = make_temp_directory('mod_lti', false)) {
2006         if ($tempfile = tempnam($tempdir, 'mod_lti_request'.date('YmdHis'))) {
2007             $content  = "Request Headers:\n";
2008             foreach (moodle\mod\lti\OAuthUtil::get_headers() as $header => $value) {
2009                 $content .= "$header: $value\n";
2010             }
2011             $content .= "Request Body:\n";
2012             $content .= $rawbody;
2014             file_put_contents($tempfile, $content);
2015             chmod($tempfile, 0644);
2016         }
2017     }
2020 /**
2021  * Log an LTI response.
2022  *
2023  * @param string $responsexml The response XML
2024  * @param Exception $e If there was an exception, pass that too
2025  */
2026 function lti_log_response($responsexml, $e = null) {
2027     if ($tempdir = make_temp_directory('mod_lti', false)) {
2028         if ($tempfile = tempnam($tempdir, 'mod_lti_response'.date('YmdHis'))) {
2029             $content = '';
2030             if ($e instanceof Exception) {
2031                 $info = get_exception_info($e);
2033                 $content .= "Exception:\n";
2034                 $content .= "Message: $info->message\n";
2035                 $content .= "Debug info: $info->debuginfo\n";
2036                 $content .= "Backtrace:\n";
2037                 $content .= format_backtrace($info->backtrace, true);
2038                 $content .= "\n";
2039             }
2040             $content .= "Response XML:\n";
2041             $content .= $responsexml;
2043             file_put_contents($tempfile, $content);
2044             chmod($tempfile, 0644);
2045         }
2046     }
2049 /**
2050  * Fetches LTI type configuration for an LTI instance
2051  *
2052  * @param stdClass $instance
2053  * @return array Can be empty if no type is found
2054  */
2055 function lti_get_type_config_by_instance($instance) {
2056     $typeid = null;
2057     if (empty($instance->typeid)) {
2058         $tool = lti_get_tool_by_url_match($instance->toolurl, $instance->course);
2059         if ($tool) {
2060             $typeid = $tool->id;
2061         }
2062     } else {
2063         $typeid = $instance->typeid;
2064     }
2065     if (!empty($typeid)) {
2066         return lti_get_type_config($typeid);
2067     }
2068     return array();
2071 /**
2072  * Enforce type config settings onto the LTI instance
2073  *
2074  * @param stdClass $instance
2075  * @param array $typeconfig
2076  */
2077 function lti_force_type_config_settings($instance, array $typeconfig) {
2078     $forced = array(
2079         'instructorchoicesendname'      => 'sendname',
2080         'instructorchoicesendemailaddr' => 'sendemailaddr',
2081         'instructorchoiceacceptgrades'  => 'acceptgrades',
2082     );
2084     foreach ($forced as $instanceparam => $typeconfigparam) {
2085         if (array_key_exists($typeconfigparam, $typeconfig) && $typeconfig[$typeconfigparam] != LTI_SETTING_DELEGATE) {
2086             $instance->$instanceparam = $typeconfig[$typeconfigparam];
2087         }
2088     }
2091 /**
2092  * Initializes an array with the capabilities supported by the LTI module
2093  *
2094  * @return array List of capability names (without a dollar sign prefix)
2095  */
2096 function lti_get_capabilities() {
2098     $capabilities = array(
2099        'basic-lti-launch-request' => '',
2100        'Context.id' => 'context_id',
2101        'CourseSection.title' => 'context_title',
2102        'CourseSection.label' => 'context_label',
2103        'CourseSection.sourcedId' => 'lis_course_section_sourcedid',
2104        'CourseSection.longDescription' => '$COURSE->summary',
2105        'CourseSection.timeFrame.begin' => '$COURSE->startdate',
2106        'ResourceLink.id' => 'resource_link_id',
2107        'ResourceLink.title' => 'resource_link_title',
2108        'ResourceLink.description' => 'resource_link_description',
2109        'User.id' => 'user_id',
2110        'User.username' => '$USER->username',
2111        'Person.name.full' => 'lis_person_name_full',
2112        'Person.name.given' => 'lis_person_name_given',
2113        'Person.name.family' => 'lis_person_name_family',
2114        'Person.email.primary' => 'lis_person_contact_email_primary',
2115        'Person.sourcedId' => 'lis_person_sourcedid',
2116        'Person.name.middle' => '$USER->middlename',
2117        'Person.address.street1' => '$USER->address',
2118        'Person.address.locality' => '$USER->city',
2119        'Person.address.country' => '$USER->country',
2120        'Person.address.timezone' => '$USER->timezone',
2121        'Person.phone.primary' => '$USER->phone1',
2122        'Person.phone.mobile' => '$USER->phone2',
2123        'Person.webaddress' => '$USER->url',
2124        'Membership.role' => 'roles',
2125        'Result.sourcedId' => 'lis_result_sourcedid',
2126        'Result.autocreate' => 'lis_outcome_service_url');
2128     return $capabilities;
2132 /**
2133  * Initializes an array with the services supported by the LTI module
2134  *
2135  * @return array List of services
2136  */
2137 function lti_get_services() {
2139     $services = array();
2140     $definedservices = core_component::get_plugin_list('ltiservice');
2141     foreach ($definedservices as $name => $location) {
2142         $classname = "\\ltiservice_{$name}\\local\\service\\{$name}";
2143         $services[] = new $classname();
2144     }
2146     return $services;
2150 /**
2151  * Initializes an instance of the named service
2152  *
2153  * @param string $servicename Name of service
2154  *
2155  * @return mod_lti\local\ltiservice\service_base Service
2156  */
2157 function lti_get_service_by_name($servicename) {
2159     $service = false;
2160     $classname = "\\ltiservice_{$servicename}\\local\\service\\{$servicename}";
2161     if (class_exists($classname)) {
2162         $service = new $classname();
2163     }
2165     return $service;
2169 /**
2170  * Finds a service by id
2171  *
2172  * @param array  $services    Array of services
2173  * @param string $resourceid  ID of resource
2174  *
2175  * @return mod_lti\local\ltiservice\service_base Service
2176  */
2177 function lti_get_service_by_resource_id($services, $resourceid) {
2179     $service = false;
2180     foreach ($services as $aservice) {
2181         foreach ($aservice->get_resources() as $resource) {
2182             if ($resource->get_id() === $resourceid) {
2183                 $service = $aservice;
2184                 break 2;
2185             }
2186         }
2187     }
2189     return $service;
2193 /**
2194  * Extracts the named contexts from a tool proxy
2195  *
2196  * @param object $json
2197  *
2198  * @return array Contexts
2199  */
2200 function lti_get_contexts($json) {
2202     $contexts = array();
2203     if (isset($json->{'@context'})) {
2204         foreach ($json->{'@context'} as $context) {
2205             if (is_object($context)) {
2206                 $contexts = array_merge(get_object_vars($context), $contexts);
2207             }
2208         }
2209     }
2211     return $contexts;
2215 /**
2216  * Converts an ID to a fully-qualified ID
2217  *
2218  * @param array $contexts
2219  * @param string $id
2220  *
2221  * @return string Fully-qualified ID
2222  */
2223 function lti_get_fqid($contexts, $id) {
2225     $parts = explode(':', $id, 2);
2226     if (count($parts) > 1) {
2227         if (array_key_exists($parts[0], $contexts)) {
2228             $id = $contexts[$parts[0]] . $parts[1];
2229         }
2230     }
2232     return $id;
2236 /**
2237  * Returns the icon for the given tool type
2238  *
2239  * @param stdClass $type The tool type
2240  *
2241  * @return string The url to the tool type's corresponding icon
2242  */
2243 function get_tool_type_icon_url(stdClass $type) {
2244     global $OUTPUT;
2246     $iconurl = $type->secureicon;
2248     if (empty($iconurl)) {
2249         $iconurl = $type->icon;
2250     }
2252     if (empty($iconurl)) {
2253         $iconurl = $OUTPUT->pix_url('icon', 'lti')->out();
2254     }
2256     return $iconurl;
2259 /**
2260  * Returns the edit url for the given tool type
2261  *
2262  * @param stdClass $type The tool type
2263  *
2264  * @return string The url to edit the tool type
2265  */
2266 function get_tool_type_edit_url(stdClass $type) {
2267     $url = new moodle_url('/mod/lti/typessettings.php',
2268                           array('action' => 'update', 'id' => $type->id, 'sesskey' => sesskey(), 'returnto' => 'toolconfigure'));
2269     return $url->out();
2272 /**
2273  * Returns the course url for the given tool type
2274  *
2275  * @param stdClass $type The tool type
2276  *
2277  * @return string|void The url to the course of the tool type, void if it is a site wide type
2278  */
2279 function get_tool_type_course_url(stdClass $type) {
2280     if ($type->course == 1) {
2281         return;
2282     } else {
2283         $url = new moodle_url('/course/view.php', array('id' => $type->course));
2284         return $url->out();
2285     }
2288 /**
2289  * Returns the icon and edit urls for the tool type and the course url if it is a course type.
2290  *
2291  * @param stdClass $type The tool type
2292  *
2293  * @return string The url to the course of the tool type
2294  */
2295 function get_tool_type_urls(stdClass $type) {
2296     $courseurl = get_tool_type_course_url($type);
2298     $urls = array(
2299         'icon' => get_tool_type_icon_url($type),
2300         'edit' => get_tool_type_edit_url($type),
2301     );
2303     if ($courseurl) {
2304         $urls['course'] = $courseurl;
2305     }
2307     return $urls;
2310 /**
2311  * Returns information on the current state of the tool type
2312  *
2313  * @param stdClass $type The tool type
2314  *
2315  * @return array An array with a text description of the state, and boolean for whether it is in each state:
2316  * pending, configured, rejected, unknown
2317  */
2318 function get_tool_type_state_info(stdClass $type) {
2319     $state = '';
2320     $isconfigured = false;
2321     $ispending = false;
2322     $isrejected = false;
2323     $isunknown = false;
2324     switch ($type->state) {
2325         case LTI_TOOL_STATE_CONFIGURED:
2326             $state = get_string('active', 'mod_lti');
2327             $isconfigured = true;
2328             break;
2329         case LTI_TOOL_STATE_PENDING:
2330             $state = get_string('pending', 'mod_lti');
2331             $ispending = true;
2332             break;
2333         case LTI_TOOL_STATE_REJECTED:
2334             $state = get_string('rejected', 'mod_lti');
2335             $isrejected = true;
2336             break;
2337         default:
2338             $state = get_string('unknownstate', 'mod_lti');
2339             $isunknown = true;
2340             break;
2341     }
2343     return array(
2344         'text' => $state,
2345         'pending' => $ispending,
2346         'configured' => $isconfigured,
2347         'rejected' => $isrejected,
2348         'unknown' => $isunknown
2349     );
2352 /**
2353  * Returns a summary of each LTI capability this tool type requires in plain language
2354  *
2355  * @param stdClass $type The tool type
2356  *
2357  * @return array An array of text descriptions of each of the capabilities this tool type requires
2358  */
2359 function get_tool_type_capability_groups($type) {
2360     $capabilities = lti_get_enabled_capabilities($type);
2361     $groups = array();
2362     $hascourse = false;
2363     $hasactivities = false;
2364     $hasuseraccount = false;
2365     $hasuserpersonal = false;
2367     foreach ($capabilities as $capability) {
2368         // Bail out early if we've already found all groups.
2369         if (count($groups) >= 4) {
2370             continue;
2371         }
2373         if (!$hascourse && preg_match('/^CourseSection/', $capability)) {
2374             $hascourse = true;
2375             $groups[] = get_string('courseinformation', 'mod_lti');
2376         } else if (!$hasactivities && preg_match('/^ResourceLink/', $capability)) {
2377             $hasactivities = true;
2378             $groups[] = get_string('courseactivitiesorresources', 'mod_lti');
2379         } else if (!$hasuseraccount && preg_match('/^User/', $capability) || preg_match('/^Membership/', $capability)) {
2380             $hasuseraccount = true;
2381             $groups[] = get_string('useraccountinformation', 'mod_lti');
2382         } else if (!$hasuserpersonal && preg_match('/^Person/', $capability)) {
2383             $hasuserpersonal = true;
2384             $groups[] = get_string('userpersonalinformation', 'mod_lti');
2385         }
2386     }
2388     return $groups;
2392 /**
2393  * Returns the ids of each instance of this tool type
2394  *
2395  * @param stdClass $type The tool type
2396  *
2397  * @return array An array of ids of the instances of this tool type
2398  */
2399 function get_tool_type_instance_ids($type) {
2400     global $DB;
2402     return array_keys($DB->get_fieldset_select('lti', 'id', 'typeid = ?', array($type->id)));
2405 /**
2406  * Serialises this tool type
2407  *
2408  * @param stdClass $type The tool type
2409  *
2410  * @return array An array of values representing this type
2411  */
2412 function serialise_tool_type(stdClass $type) {
2413     $capabilitygroups = get_tool_type_capability_groups($type);
2414     $instanceids = get_tool_type_instance_ids($type);
2416     return array(
2417         'id' => $type->id,
2418         'name' => $type->name,
2419         'description' => isset($type->description) ? $type->description : get_string('editdescription', 'mod_lti'),
2420         'urls' => get_tool_type_urls($type),
2421         'state' => get_tool_type_state_info($type),
2422         'hascapabilitygroups' => !empty($capabilitygroups),
2423         'capabilitygroups' => $capabilitygroups,
2424         // Course ID of 1 means it's not linked to a course.
2425         'courseid' => $type->course == 1 ? 0 : $type->course,
2426         'instanceids' => $instanceids,
2427         'instancecount' => count($instanceids)
2428     );
2431 /**
2432  * Loads the cartridge information into the tool type, if the launch url is for a cartridge file
2433  *
2434  * @param stdClass $type The tool type object to be filled in
2435  * @since Moodle 3.1
2436  */
2437 function lti_load_type_if_cartridge($type) {
2438     if (!empty($type->lti_toolurl) && lti_is_cartridge($type->lti_toolurl)) {
2439         lti_load_type_from_cartridge($type->lti_toolurl, $type);
2440     }
2443 /**
2444  * Loads the cartridge information into the new tool, if the launch url is for a cartridge file
2445  *
2446  * @param stdClass $lti The tools config
2447  * @since Moodle 3.1
2448  */
2449 function lti_load_tool_if_cartridge($lti) {
2450     if (!empty($lti->toolurl) && lti_is_cartridge($lti->toolurl)) {
2451         lti_load_tool_from_cartridge($lti->toolurl, $lti);
2452     }
2455 /**
2456  * Determines if the given url is for a IMS basic cartridge
2457  *
2458  * @param  string $url The url to be checked
2459  * @return True if the url is for a cartridge
2460  * @since Moodle 3.1
2461  */
2462 function lti_is_cartridge($url) {
2463     // If it is empty, it's not a cartridge.
2464     if (empty($url)) {
2465         return false;
2466     }
2467     // If it has xml at the end of the url, it's a cartridge.
2468     if (preg_match('/\.xml$/', $url)) {
2469         return true;
2470     }
2471     // Even if it doesn't have .xml, load the url to check if it's a cartridge..
2472     try {
2473         $toolinfo = lti_load_cartridge($url,
2474             array(
2475                 "launch_url" => "launchurl"
2476             )
2477         );
2478         if (!empty($toolinfo['launchurl'])) {
2479             return true;
2480         }
2481     } catch (moodle_exception $e) {
2482         return false; // Error loading the xml, so it's not a cartridge.
2483     }
2484     return false;
2487 /**
2488  * Allows you to load settings for an external tool type from an IMS cartridge.
2489  *
2490  * @param  string   $url     The URL to the cartridge
2491  * @param  stdClass $type    The tool type object to be filled in
2492  * @throws moodle_exception if the cartridge could not be loaded correctly
2493  * @since Moodle 3.1
2494  */
2495 function lti_load_type_from_cartridge($url, $type) {
2496     $toolinfo = lti_load_cartridge($url,
2497         array(
2498             "title" => "lti_typename",
2499             "launch_url" => "lti_toolurl",
2500             "description" => "lti_description"
2501         ),
2502         array(
2503             "icon_url" => "lti_icon",
2504             "secure_icon_url" => "lti_secureicon"
2505         )
2506     );
2507     foreach ($toolinfo as $property => $value) {
2508         $type->$property = $value;
2509     }
2512 /**
2513  * Allows you to load in the configuration for an external tool from an IMS cartridge.
2514  *
2515  * @param  string   $url    The URL to the cartridge
2516  * @param  stdClass $lti    LTI object
2517  * @throws moodle_exception if the cartridge could not be loaded correctly
2518  * @since Moodle 3.1
2519  */
2520 function lti_load_tool_from_cartridge($url, $lti) {
2521     $toolinfo = lti_load_cartridge($url,
2522         array(
2523             "title" => "name",
2524             "launch_url" => "toolurl",
2525             "secure_launch_url" => "securetoolurl",
2526             "description" => "intro"
2527         ),
2528         array(
2529             "icon_url" => "icon",
2530             "secure_icon_url" => "secureicon"
2531         )
2532     );
2533     foreach ($toolinfo as $property => $value) {
2534         $lti->$property = $value;
2535     }
2538 /**
2539  * Search for a tag within an XML DOMDocument
2540  *
2541  * @param  string $url The url of the cartridge to be loaded
2542  * @param  array  $map The map of tags to keys in the return array
2543  * @param  array  $propertiesmap The map of properties to keys in the return array
2544  * @return array An associative array with the given keys and their values from the cartridge
2545  * @throws moodle_exception if the cartridge could not be loaded correctly
2546  * @since Moodle 3.1
2547  */
2548 function lti_load_cartridge($url, $map, $propertiesmap = array()) {
2549     global $CFG;
2550     require_once($CFG->libdir. "/filelib.php");
2551     // TODO MDL-46023 Replace this code with a call to the new library.
2552     $origentity = libxml_disable_entity_loader(true);
2554     $curl = new curl();
2555     $response = $curl->get($url);
2557     $document = new DOMDocument();
2558     @$document->loadXML($response, LIBXML_DTDLOAD | LIBXML_DTDATTR);
2560     $cartridge = new DomXpath($document);
2562     $errors = libxml_get_errors();
2563     if (count($errors) > 0) {
2564         $message = 'Failed to load cartridge.';
2565         foreach ($errors as $error) {
2566             $message .= "\n" . trim($error->message, "\n\r\t .") . " at line " . $error->line;
2567         }
2568         throw new moodle_exception($message);
2569     }
2571     $toolinfo = array();
2572     foreach ($map as $tag => $key) {
2573         $value = get_tag($tag, $cartridge);
2574         if ($value) {
2575             $toolinfo[$key] = $value;
2576         }
2577     }
2578     if (!empty($propertiesmap)) {
2579         foreach ($propertiesmap as $property => $key) {
2580             $value = get_tag("property", $cartridge, $property);
2581             if ($value) {
2582                 $toolinfo[$key] = $value;
2583             }
2584         }
2585     }
2586     libxml_disable_entity_loader($origentity);
2587     return $toolinfo;
2590 /**
2591  * Search for a tag within an XML DOMDocument
2592  *
2593  * @param  stdClass $tagname The name of the tag to search for
2594  * @param  XPath    $xpath   The XML to find the tag in
2595  * @param  XPath    $attribute The attribute to search for (if we should search for a child node with the given
2596  * value for the name attribute
2597  * @since Moodle 3.1
2598  */
2599 function get_tag($tagname, $xpath, $attribute = null) {
2600     if ($attribute) {
2601         $result = $xpath->query('//*[local-name() = \'' . $tagname . '\'][@name="' . $attribute . '"]');
2602     } else {
2603         $result = $xpath->query('//*[local-name() = \'' . $tagname . '\']');
2604     }
2605     if ($result->length > 0) {
2606         return $result->item(0)->nodeValue;
2607     }
2608     return null;