Merge branch 'wip-MDL-47629-master' of https://github.com/kwiliarty/moodle
[moodle.git] / mod / lti / locallib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 //
17 // This file is part of BasicLTI4Moodle
18 //
19 // BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
20 // consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
21 // based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
22 // specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
23 // are already supporting or going to support BasicLTI. This project Implements the consumer
24 // for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
25 // BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
26 // at the GESSI research group at UPC.
27 // SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
28 // by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
29 // Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
30 //
31 // BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
32 // of the Universitat Politecnica de Catalunya http://www.upc.edu
33 // Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu.
35 /**
36  * This file contains the library of functions and constants for the lti module
37  *
38  * @package mod_lti
39  * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
40  *  marc.alier@upc.edu
41  * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
42  * @author     Marc Alier
43  * @author     Jordi Piguillem
44  * @author     Nikolas Galanis
45  * @author     Chris Scribner
46  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
47  */
49 defined('MOODLE_INTERNAL') || die;
51 // TODO: Switch to core oauthlib once implemented - MDL-30149.
52 use moodle\mod\lti as lti;
54 require_once($CFG->dirroot.'/mod/lti/OAuth.php');
56 define('LTI_URL_DOMAIN_REGEX', '/(?:https?:\/\/)?(?:www\.)?([^\/]+)(?:\/|$)/i');
58 define('LTI_LAUNCH_CONTAINER_DEFAULT', 1);
59 define('LTI_LAUNCH_CONTAINER_EMBED', 2);
60 define('LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS', 3);
61 define('LTI_LAUNCH_CONTAINER_WINDOW', 4);
62 define('LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW', 5);
64 define('LTI_TOOL_STATE_ANY', 0);
65 define('LTI_TOOL_STATE_CONFIGURED', 1);
66 define('LTI_TOOL_STATE_PENDING', 2);
67 define('LTI_TOOL_STATE_REJECTED', 3);
68 define('LTI_TOOL_PROXY_TAB', 4);
70 define('LTI_TOOL_PROXY_STATE_CONFIGURED', 1);
71 define('LTI_TOOL_PROXY_STATE_PENDING', 2);
72 define('LTI_TOOL_PROXY_STATE_ACCEPTED', 3);
73 define('LTI_TOOL_PROXY_STATE_REJECTED', 4);
75 define('LTI_SETTING_NEVER', 0);
76 define('LTI_SETTING_ALWAYS', 1);
77 define('LTI_SETTING_DELEGATE', 2);
79 /**
80  * Prints a Basic LTI activity
81  *
82  * $param int $basicltiid       Basic LTI activity id
83  */
84 function lti_view($instance) {
85     global $PAGE, $CFG;
87     if (empty($instance->typeid)) {
88         $tool = lti_get_tool_by_url_match($instance->toolurl, $instance->course);
89         if ($tool) {
90             $typeid = $tool->id;
91         } else {
92             $typeid = null;
93         }
94     } else {
95         $typeid = $instance->typeid;
96         $tool = lti_get_type($typeid);
97     }
99     if ($typeid) {
100         $typeconfig = lti_get_type_config($typeid);
101     } else {
102         // There is no admin configuration for this tool. Use configuration in the lti instance record plus some defaults.
103         $typeconfig = (array)$instance;
105         $typeconfig['sendname'] = $instance->instructorchoicesendname;
106         $typeconfig['sendemailaddr'] = $instance->instructorchoicesendemailaddr;
107         $typeconfig['customparameters'] = $instance->instructorcustomparameters;
108         $typeconfig['acceptgrades'] = $instance->instructorchoiceacceptgrades;
109         $typeconfig['allowroster'] = $instance->instructorchoiceallowroster;
110         $typeconfig['forcessl'] = '0';
111     }
113     // Default the organizationid if not specified.
114     if (empty($typeconfig['organizationid'])) {
115         $urlparts = parse_url($CFG->wwwroot);
117         $typeconfig['organizationid'] = $urlparts['host'];
118     }
120     if (isset($tool->toolproxyid)) {
121         $toolproxy = lti_get_tool_proxy($tool->toolproxyid);
122         $key = $toolproxy->guid;
123         $secret = $toolproxy->secret;
124     } else {
125         $toolproxy = null;
126         if (!empty($instance->resourcekey)) {
127             $key = $instance->resourcekey;
128         } else if (!empty($typeconfig['resourcekey'])) {
129             $key = $typeconfig['resourcekey'];
130         } else {
131             $key = '';
132         }
133         if (!empty($instance->password)) {
134             $secret = $instance->password;
135         } else if (!empty($typeconfig['password'])) {
136             $secret = $typeconfig['password'];
137         } else {
138             $secret = '';
139         }
140     }
142     $endpoint = !empty($instance->toolurl) ? $instance->toolurl : $typeconfig['toolurl'];
143     $endpoint = trim($endpoint);
145     // If the current request is using SSL and a secure tool URL is specified, use it.
146     if (lti_request_is_using_ssl() && !empty($instance->securetoolurl)) {
147         $endpoint = trim($instance->securetoolurl);
148     }
150     // If SSL is forced, use the secure tool url if specified. Otherwise, make sure https is on the normal launch URL.
151     if (isset($typeconfig['forcessl']) && ($typeconfig['forcessl'] == '1')) {
152         if (!empty($instance->securetoolurl)) {
153             $endpoint = trim($instance->securetoolurl);
154         }
156         $endpoint = lti_ensure_url_is_https($endpoint);
157     } else {
158         if (!strstr($endpoint, '://')) {
159             $endpoint = 'http://' . $endpoint;
160         }
161     }
163     $orgid = $typeconfig['organizationid'];
165     $course = $PAGE->course;
166     $islti2 = isset($tool->toolproxyid);
167     $allparams = lti_build_request($instance, $typeconfig, $course, $typeid, $islti2);
168     if ($islti2) {
169         $requestparams = lti_build_request_lti2($tool, $allparams);
170     } else {
171         $requestparams = $allparams;
172     }
173     $requestparams = array_merge($requestparams, lti_build_standard_request($instance, $orgid, $islti2));
174     $customstr = '';
175     if (isset($typeconfig['customparameters'])) {
176         $customstr = $typeconfig['customparameters'];
177     }
178     $requestparams = array_merge($requestparams, lti_build_custom_parameters($toolproxy, $tool, $instance, $allparams, $customstr,
179         $instance->instructorcustomparameters, $islti2));
181     $launchcontainer = lti_get_launch_container($instance, $typeconfig);
182     $returnurlparams = array('course' => $course->id, 'launch_container' => $launchcontainer, 'instanceid' => $instance->id);
184     // Add the return URL. We send the launch container along to help us avoid frames-within-frames when the user returns.
185     $url = new \moodle_url('/mod/lti/return.php', $returnurlparams);
186     $returnurl = $url->out(false);
188     if (isset($typeconfig['forcessl']) && ($typeconfig['forcessl'] == '1')) {
189         $returnurl = lti_ensure_url_is_https($returnurl);
190     }
192     $target = '';
193     switch($launchcontainer) {
194         case LTI_LAUNCH_CONTAINER_EMBED:
195         case LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS:
196             $target = 'iframe';
197             break;
198         case LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW:
199             $target = 'frame';
200             break;
201         case LTI_LAUNCH_CONTAINER_WINDOW:
202             $target = 'window';
203             break;
204     }
205     if (!empty($target)) {
206         $requestparams['launch_presentation_document_target'] = $target;
207     }
209     $requestparams['launch_presentation_return_url'] = $returnurl;
211     // Allow request params to be updated by sub-plugins.
212     $plugins = core_component::get_plugin_list('ltisource');
213     foreach (array_keys($plugins) as $plugin) {
214         $pluginparams = component_callback('ltisource_'.$plugin, 'before_launch',
215             array($instance, $endpoint, $requestparams), array());
217         if (!empty($pluginparams) && is_array($pluginparams)) {
218             $requestparams = array_merge($requestparams, $pluginparams);
219         }
220     }
222     if (!empty($key) && !empty($secret)) {
223         $parms = lti_sign_parameters($requestparams, $endpoint, "POST", $key, $secret);
225         $endpointurl = new \moodle_url($endpoint);
226         $endpointparams = $endpointurl->params();
228         // Strip querystring params in endpoint url from $parms to avoid duplication.
229         if (!empty($endpointparams) && !empty($parms)) {
230             foreach (array_keys($endpointparams) as $paramname) {
231                 if (isset($parms[$paramname])) {
232                     unset($parms[$paramname]);
233                 }
234             }
235         }
237     } else {
238         // If no key and secret, do the launch unsigned.
239         $returnurlparams['unsigned'] = '1';
240         $parms = $requestparams;
241     }
243     $debuglaunch = ( $instance->debuglaunch == 1 );
245     $content = lti_post_launch_html($parms, $endpoint, $debuglaunch);
247     echo $content;
250 /**
251  * Prepares an LTI registration request message
252  *
253  * $param object $instance       Tool Proxy instance object
254  */
255 function lti_register($toolproxy) {
256     global $PAGE, $CFG;
258     $key = $toolproxy->guid;
259     $secret = $toolproxy->secret;
260     $endpoint = $toolproxy->regurl;
262     $requestparams = array();
263     $requestparams['lti_message_type'] = 'ToolProxyRegistrationRequest';
264     $requestparams['lti_version'] = 'LTI-2p0';
265     $requestparams['reg_key'] = $key;
266     $requestparams['reg_password'] = $secret;
268     // Change the status to pending.
269     $toolproxy->state = LTI_TOOL_PROXY_STATE_PENDING;
270     lti_update_tool_proxy($toolproxy);
272     // Add the profile URL.
273     $profileservice = lti_get_service_by_name('profile');
274     $profileservice->set_tool_proxy($toolproxy);
275     $requestparams['tc_profile_url'] = $profileservice->parse_value('$ToolConsumerProfile.url');
277     // Add the return URL.
278     $returnurlparams = array('id' => $toolproxy->id);
279     $url = new \moodle_url('/mod/lti/registrationreturn.php', $returnurlparams);
280     $returnurl = $url->out(false);
282     $requestparams['launch_presentation_return_url'] = $returnurl;
283     $content = lti_post_launch_html($requestparams, $endpoint, false);
285     echo $content;
288 /**
289  * Build source ID
290  *
291  * @param int $instanceid
292  * @param int $userid
293  * @param string $servicesalt
294  * @param null|int $typeid
295  * @param null|int $launchid
296  * @return stdClass
297  */
298 function lti_build_sourcedid($instanceid, $userid, $servicesalt, $typeid = null, $launchid = null) {
299     $data = new \stdClass();
301     $data->instanceid = $instanceid;
302     $data->userid = $userid;
303     $data->typeid = $typeid;
304     if (!empty($launchid)) {
305         $data->launchid = $launchid;
306     } else {
307         $data->launchid = mt_rand();
308     }
310     $json = json_encode($data);
312     $hash = hash('sha256', $json . $servicesalt, false);
314     $container = new \stdClass();
315     $container->data = $data;
316     $container->hash = $hash;
318     return $container;
321 /**
322  * This function builds the request that must be sent to the tool producer
323  *
324  * @param object    $instance       Basic LTI instance object
325  * @param array     $typeconfig     Basic LTI tool configuration
326  * @param object    $course         Course object
327  * @param int|null  $typeid         Basic LTI tool ID
328  * @param boolean   $islti2         True if an LTI 2 tool is being launched
329  *
330  * @return array                    Request details
331  */
332 function lti_build_request($instance, $typeconfig, $course, $typeid = null, $islti2 = false) {
333     global $USER, $CFG;
335     if (empty($instance->cmid)) {
336         $instance->cmid = 0;
337     }
339     $role = lti_get_ims_role($USER, $instance->cmid, $instance->course, $islti2);
341     $intro = '';
342     if (!empty($instance->cmid)) {
343         $intro = format_module_intro('lti', $instance, $instance->cmid);
344         $intro = html_to_text($intro, 0, false);
346         // This may look weird, but this is required for new lines
347         // so we generate the same OAuth signature as the tool provider.
348         $intro = str_replace("\n", "\r\n", $intro);
349     }
350     $requestparams = array(
351         'resource_link_title' => $instance->name,
352         'resource_link_description' => $intro,
353         'user_id' => $USER->id,
354         'lis_person_sourcedid' => $USER->idnumber,
355         'roles' => $role,
356         'context_id' => $course->id,
357         'context_label' => $course->shortname,
358         'context_title' => $course->fullname,
359     );
360     if ($course->format == 'site') {
361         $requestparams['context_type'] = 'Group';
362     } else {
363         $requestparams['context_type'] = 'CourseSection';
364         $requestparams['lis_course_section_sourcedid'] = $course->idnumber;
365     }
366     $placementsecret = $instance->servicesalt;
368     if ( isset($placementsecret) ) {
369         $sourcedid = json_encode(lti_build_sourcedid($instance->id, $USER->id, $placementsecret, $typeid));
370         $requestparams['lis_result_sourcedid'] = $sourcedid;
371     }
373     if ( isset($placementsecret) && ($islti2 ||
374          $typeconfig['acceptgrades'] == LTI_SETTING_ALWAYS ||
375          ($typeconfig['acceptgrades'] == LTI_SETTING_DELEGATE && $instance->instructorchoiceacceptgrades == LTI_SETTING_ALWAYS))) {
377         // Add outcome service URL.
378         $serviceurl = new \moodle_url('/mod/lti/service.php');
379         $serviceurl = $serviceurl->out();
381         $forcessl = false;
382         if (!empty($CFG->mod_lti_forcessl)) {
383             $forcessl = true;
384         }
386         if ((isset($typeconfig['forcessl']) && ($typeconfig['forcessl'] == '1')) or $forcessl) {
387             $serviceurl = lti_ensure_url_is_https($serviceurl);
388         }
390         $requestparams['lis_outcome_service_url'] = $serviceurl;
391     }
393     // Send user's name and email data if appropriate.
394     if ($islti2 || $typeconfig['sendname'] == LTI_SETTING_ALWAYS ||
395          ( $typeconfig['sendname'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendname == LTI_SETTING_ALWAYS ) ) {
396         $requestparams['lis_person_name_given'] = $USER->firstname;
397         $requestparams['lis_person_name_family'] = $USER->lastname;
398         $requestparams['lis_person_name_full'] = $USER->firstname . ' ' . $USER->lastname;
399         $requestparams['ext_user_username'] = $USER->username;
400     }
402     if ($islti2 || $typeconfig['sendemailaddr'] == LTI_SETTING_ALWAYS ||
403          ($typeconfig['sendemailaddr'] == LTI_SETTING_DELEGATE && $instance->instructorchoicesendemailaddr == LTI_SETTING_ALWAYS)) {
404         $requestparams['lis_person_contact_email_primary'] = $USER->email;
405     }
407     return $requestparams;
410 /**
411  * This function builds the request that must be sent to an LTI 2 tool provider
412  *
413  * @param object    $tool           Basic LTI tool object
414  * @param array     $params         Custom launch parameters
415  *
416  * @return array                    Request details
417  */
418 function lti_build_request_lti2($tool, $params) {
420     $requestparams = array();
422     $capabilities = lti_get_capabilities();
423     $enabledcapabilities = explode("\n", $tool->enabledcapability);
424     foreach ($enabledcapabilities as $capability) {
425         if (array_key_exists($capability, $capabilities)) {
426             $val = $capabilities[$capability];
427             if ($val && (substr($val, 0, 1) != '$')) {
428                 if (isset($params[$val])) {
429                     $requestparams[$capabilities[$capability]] = $params[$capabilities[$capability]];
430                 }
431             }
432         }
433     }
435     return $requestparams;
439 /**
440  * This function builds the standard parameters for an LTI 1 or 2 request that must be sent to the tool producer
441  *
442  * @param object    $instance       Basic LTI instance object
443  * @param string    $orgid          Organisation ID
444  * @param boolean   $islti2         True if an LTI 2 tool is being launched
445  *
446  * @return array                    Request details
447  */
448 function lti_build_standard_request($instance, $orgid, $islti2) {
449     global $CFG;
451     $requestparams = array();
453     $requestparams['resource_link_id'] = $instance->id;
454     if (property_exists($instance, 'resource_link_id') and !empty($instance->resource_link_id)) {
455         $requestparams['resource_link_id'] = $instance->resource_link_id;
456     }
458     $requestparams['launch_presentation_locale'] = current_language();
460     // Make sure we let the tool know what LMS they are being called from.
461     $requestparams['ext_lms'] = 'moodle-2';
462     $requestparams['tool_consumer_info_product_family_code'] = 'moodle';
463     $requestparams['tool_consumer_info_version'] = strval($CFG->version);
465     // Add oauth_callback to be compliant with the 1.0A spec.
466     $requestparams['oauth_callback'] = 'about:blank';
468     if (!$islti2) {
469         $requestparams['lti_version'] = 'LTI-1p0';
470     } else {
471         $requestparams['lti_version'] = 'LTI-2p0';
472     }
473     $requestparams['lti_message_type'] = 'basic-lti-launch-request';
475     if ($orgid) {
476         $requestparams["tool_consumer_instance_guid"] = $orgid;
477     }
478     if (!empty($CFG->mod_lti_institution_name)) {
479         $requestparams['tool_consumer_instance_name'] = $CFG->mod_lti_institution_name;
480     } else {
481         $requestparams['tool_consumer_instance_name'] = get_site()->fullname;
482     }
484     return $requestparams;
487 /**
488  * This function builds the custom parameters
489  *
490  * @param object    $toolproxy      Tool proxy instance object
491  * @param object    $tool           Tool instance object
492  * @param object    $instance       Tool placement instance object
493  * @param array     $params         LTI launch parameters
494  * @param string    $customstr      Custom parameters defined for tool
495  * @param string    $instructorcustomstr      Custom parameters defined for this placement
496  * @param boolean   $islti2         True if an LTI 2 tool is being launched
497  *
498  * @return array                    Custom parameters
499  */
500 function lti_build_custom_parameters($toolproxy, $tool, $instance, $params, $customstr, $instructorcustomstr, $islti2) {
502     // Concatenate the custom parameters from the administrator and the instructor
503     // Instructor parameters are only taken into consideration if the administrator
504     // has given permission.
505     $custom = array();
506     if ($customstr) {
507         $custom = lti_split_custom_parameters($toolproxy, $tool, $params, $customstr, $islti2);
508     }
509     if (!isset($typeconfig['allowinstructorcustom']) || $typeconfig['allowinstructorcustom'] != LTI_SETTING_NEVER) {
510         if ($instructorcustomstr) {
511             $custom = array_merge(lti_split_custom_parameters($toolproxy, $tool, $params, $instructorcustomstr, $islti2), $custom);
512         }
513     }
514     if ($islti2) {
515         $custom = array_merge(lti_split_custom_parameters($toolproxy, $tool, $params, $tool->parameter, true), $custom);
516         $settings = lti_get_tool_settings($tool->toolproxyid);
517         $custom = array_merge($custom, lti_get_custom_parameters($toolproxy, $tool, $params, $settings));
518         $settings = lti_get_tool_settings($tool->toolproxyid, $instance->course);
519         $custom = array_merge($custom, lti_get_custom_parameters($toolproxy, $tool, $params, $settings));
520         $settings = lti_get_tool_settings($tool->toolproxyid, $instance->course, $instance->id);
521         $custom = array_merge($custom, lti_get_custom_parameters($toolproxy, $tool, $params, $settings));
522     }
524     return $custom;
527 function lti_get_tool_table($tools, $id) {
528     global $CFG, $OUTPUT, $USER;
529     $html = '';
531     $typename = get_string('typename', 'lti');
532     $baseurl = get_string('baseurl', 'lti');
533     $action = get_string('action', 'lti');
534     $createdon = get_string('createdon', 'lti');
536     if (!empty($tools)) {
537         $html .= "
538         <div id=\"{$id}_tools_container\" style=\"margin-top:.5em;margin-bottom:.5em\">
539             <table id=\"{$id}_tools\">
540                 <thead>
541                     <tr>
542                         <th>$typename</th>
543                         <th>$baseurl</th>
544                         <th>$createdon</th>
545                         <th>$action</th>
546                     </tr>
547                 </thead>
548         ";
550         foreach ($tools as $type) {
551             $date = userdate($type->timecreated, get_string('strftimedatefullshort', 'core_langconfig'));
552             $accept = get_string('accept', 'lti');
553             $update = get_string('update', 'lti');
554             $delete = get_string('delete', 'lti');
556             if (empty($type->toolproxyid)) {
557                 $baseurl = new \moodle_url('/mod/lti/typessettings.php', array(
558                         'action' => 'accept',
559                         'id' => $type->id,
560                         'sesskey' => sesskey(),
561                         'tab' => $id
562                     ));
563                 $ref = $type->baseurl;
564             } else {
565                 $baseurl = new \moodle_url('/mod/lti/toolssettings.php', array(
566                         'action' => 'accept',
567                         'id' => $type->id,
568                         'sesskey' => sesskey(),
569                         'tab' => $id
570                     ));
571                 $ref = $type->tpname;
572             }
574             $accepthtml = $OUTPUT->action_icon($baseurl,
575                     new \pix_icon('t/check', $accept, '', array('class' => 'iconsmall')), null,
576                     array('title' => $accept, 'class' => 'editing_accept'));
578             $deleteaction = 'delete';
580             if ($type->state == LTI_TOOL_STATE_CONFIGURED) {
581                 $accepthtml = '';
582             }
584             if ($type->state != LTI_TOOL_STATE_REJECTED) {
585                 $deleteaction = 'reject';
586                 $delete = get_string('reject', 'lti');
587             }
589             $updateurl = clone($baseurl);
590             $updateurl->param('action', 'update');
591             $updatehtml = $OUTPUT->action_icon($updateurl,
592                     new \pix_icon('t/edit', $update, '', array('class' => 'iconsmall')), null,
593                     array('title' => $update, 'class' => 'editing_update'));
595             if (($type->state != LTI_TOOL_STATE_REJECTED) || empty($type->toolproxyid)) {
596                 $deleteurl = clone($baseurl);
597                 $deleteurl->param('action', $deleteaction);
598                 $deletehtml = $OUTPUT->action_icon($deleteurl,
599                         new \pix_icon('t/delete', $delete, '', array('class' => 'iconsmall')), null,
600                         array('title' => $delete, 'class' => 'editing_delete'));
601             } else {
602                 $deletehtml = '';
603             }
604             $html .= "
605             <tr>
606                 <td>
607                     {$type->name}
608                 </td>
609                 <td>
610                     {$ref}
611                 </td>
612                 <td>
613                     {$date}
614                 </td>
615                 <td align=\"center\">
616                     {$accepthtml}{$updatehtml}{$deletehtml}
617                 </td>
618             </tr>
619             ";
620         }
621         $html .= '</table></div>';
622     } else {
623         $html .= get_string('no_' . $id, 'lti');
624     }
626     return $html;
629 /**
630  * This function builds the tab for a category of tool proxies
631  *
632  * @param object    $toolproxies    Tool proxy instance objects
633  * @param string    $id             Category ID
634  *
635  * @return string                   HTML for tab
636  */
637 function lti_get_tool_proxy_table($toolproxies, $id) {
638     global $OUTPUT;
640     if (!empty($toolproxies)) {
641         $typename = get_string('typename', 'lti');
642         $url = get_string('registrationurl', 'lti');
643         $action = get_string('action', 'lti');
644         $createdon = get_string('createdon', 'lti');
646         $html = <<< EOD
647         <div id="{$id}_tool_proxies_container" style="margin-top: 0.5em; margin-bottom: 0.5em">
648             <table id="{$id}_tool_proxies">
649                 <thead>
650                     <tr>
651                         <th>{$typename}</th>
652                         <th>{$url}</th>
653                         <th>{$createdon}</th>
654                         <th>{$action}</th>
655                     </tr>
656                 </thead>
657 EOD;
658         foreach ($toolproxies as $toolproxy) {
659             $date = userdate($toolproxy->timecreated, get_string('strftimedatefullshort', 'core_langconfig'));
660             $accept = get_string('register', 'lti');
661             $update = get_string('update', 'lti');
662             $delete = get_string('delete', 'lti');
664             $baseurl = new \moodle_url('/mod/lti/registersettings.php', array(
665                     'action' => 'accept',
666                     'id' => $toolproxy->id,
667                     'sesskey' => sesskey(),
668                     'tab' => $id
669                 ));
671             $registerurl = new \moodle_url('/mod/lti/register.php', array(
672                     'id' => $toolproxy->id,
673                     'sesskey' => sesskey(),
674                     'tab' => 'tool_proxy'
675                 ));
677             $accepthtml = $OUTPUT->action_icon($registerurl,
678                     new \pix_icon('t/check', $accept, '', array('class' => 'iconsmall')), null,
679                     array('title' => $accept, 'class' => 'editing_accept'));
681             $deleteaction = 'delete';
683             if ($toolproxy->state != LTI_TOOL_PROXY_STATE_CONFIGURED) {
684                 $accepthtml = '';
685             }
687             if (($toolproxy->state == LTI_TOOL_PROXY_STATE_CONFIGURED) || ($toolproxy->state == LTI_TOOL_PROXY_STATE_PENDING)) {
688                 $delete = get_string('cancel', 'lti');
689             }
691             $updateurl = clone($baseurl);
692             $updateurl->param('action', 'update');
693             $updatehtml = $OUTPUT->action_icon($updateurl,
694                     new \pix_icon('t/edit', $update, '', array('class' => 'iconsmall')), null,
695                     array('title' => $update, 'class' => 'editing_update'));
697             $deleteurl = clone($baseurl);
698             $deleteurl->param('action', $deleteaction);
699             $deletehtml = $OUTPUT->action_icon($deleteurl,
700                     new \pix_icon('t/delete', $delete, '', array('class' => 'iconsmall')), null,
701                     array('title' => $delete, 'class' => 'editing_delete'));
702             $html .= <<< EOD
703             <tr>
704                 <td>
705                     {$toolproxy->name}
706                 </td>
707                 <td>
708                     {$toolproxy->regurl}
709                 </td>
710                 <td>
711                     {$date}
712                 </td>
713                 <td align="center">
714                     {$accepthtml}{$updatehtml}{$deletehtml}
715                 </td>
716             </tr>
717 EOD;
718         }
719         $html .= '</table></div>';
720     } else {
721         $html = get_string('no_' . $id, 'lti');
722     }
724     return $html;
727 /**
728  * Splits the custom parameters field to the various parameters
729  *
730  * @param object    $toolproxy      Tool proxy instance object
731  * @param object    $tool           Tool instance object
732  * @param array     $params         LTI launch parameters
733  * @param string    $customstr      String containing the parameters
734  * @param boolean   $islti2         True if an LTI 2 tool is being launched
735  *
736  * @return Array of custom parameters
737  */
738 function lti_split_custom_parameters($toolproxy, $tool, $params, $customstr, $islti2 = false) {
739     $customstr = str_replace("\r\n", "\n", $customstr);
740     $customstr = str_replace("\n\r", "\n", $customstr);
741     $customstr = str_replace("\r", "\n", $customstr);
742     $lines = explode("\n", $customstr);  // Or should this split on "/[\n;]/"?
743     $retval = array();
744     foreach ($lines as $line) {
745         $pos = strpos($line, "=");
746         if ( $pos === false || $pos < 1 ) {
747             continue;
748         }
749         $key = trim(core_text::substr($line, 0, $pos));
750         $val = trim(core_text::substr($line, $pos + 1, strlen($line)));
751         $val = lti_parse_custom_parameter($toolproxy, $tool, $params, $val, $islti2);
752         $key2 = lti_map_keyname($key);
753         $retval['custom_'.$key2] = $val;
754         if ($islti2 && ($key != $key2)) {
755             $retval['custom_'.$key] = $val;
756         }
757     }
758     return $retval;
761 /**
762  * Adds the custom parameters to an array
763  *
764  * @param object    $toolproxy      Tool proxy instance object
765  * @param object    $tool           Tool instance object
766  * @param array     $params         LTI launch parameters
767  * @param array     $parameters     Array containing the parameters
768  *
769  * @return array    Array of custom parameters
770  */
771 function lti_get_custom_parameters($toolproxy, $tool, $params, $parameters) {
772     $retval = array();
773     foreach ($parameters as $key => $val) {
774         $key2 = lti_map_keyname($key);
775         $val = lti_parse_custom_parameter($toolproxy, $tool, $params, $val, true);
776         $retval['custom_'.$key2] = $val;
777         if ($key != $key2) {
778             $retval['custom_'.$key] = $val;
779         }
780     }
781     return $retval;
784 /**
785  * Parse a custom parameter to replace any substitution variables
786  *
787  * @param object    $toolproxy      Tool proxy instance object
788  * @param object    $tool           Tool instance object
789  * @param array     $params         LTI launch parameters
790  * @param string    $value          Custom parameter value
791  * @param boolean   $islti2         True if an LTI 2 tool is being launched
792  *
793  * @return Parsed value of custom parameter
794  */
795 function lti_parse_custom_parameter($toolproxy, $tool, $params, $value, $islti2) {
796     global $USER, $COURSE;
798     if ($value) {
799         if (substr($value, 0, 1) == '\\') {
800             $value = substr($value, 1);
801         } else if (substr($value, 0, 1) == '$') {
802             $value1 = substr($value, 1);
803             $enabledcapabilities = explode("\n", $tool->enabledcapability);
804             if (!$islti2 || in_array($value1, $enabledcapabilities)) {
805                 $capabilities = lti_get_capabilities();
806                 if (array_key_exists($value1, $capabilities)) {
807                     $val = $capabilities[$value1];
808                     if ($val) {
809                         if (substr($val, 0, 1) != '$') {
810                             $value = $params[$val];
811                         } else {
812                             $valarr = explode('->', substr($val, 1), 2);
813                             $value = "{${$valarr[0]}->$valarr[1]}";
814                             $value = str_replace('<br />' , ' ', $value);
815                             $value = str_replace('<br>' , ' ', $value);
816                             $value = format_string($value);
817                         }
818                     }
819                 } else if ($islti2) {
820                     $val = $value;
821                     $services = lti_get_services();
822                     foreach ($services as $service) {
823                         $service->set_tool_proxy($toolproxy);
824                         $value = $service->parse_value($val);
825                         if ($val != $value) {
826                             break;
827                         }
828                     }
829                 }
830             }
831         }
832     }
833     return $value;
836 /**
837  * Used for building the names of the different custom parameters
838  *
839  * @param string $key   Parameter name
840  *
841  * @return string       Processed name
842  */
843 function lti_map_keyname($key) {
844     $newkey = "";
845     $key = core_text::strtolower(trim($key));
846     foreach (str_split($key) as $ch) {
847         if ( ($ch >= 'a' && $ch <= 'z') || ($ch >= '0' && $ch <= '9') ) {
848             $newkey .= $ch;
849         } else {
850             $newkey .= '_';
851         }
852     }
853     return $newkey;
856 /**
857  * Gets the IMS role string for the specified user and LTI course module.
858  *
859  * @param mixed    $user      User object or user id
860  * @param int      $cmid      The course module id of the LTI activity
861  * @param int      $courseid  The course id of the LTI activity
862  * @param boolean  $islti2    True if an LTI 2 tool is being launched
863  *
864  * @return string A role string suitable for passing with an LTI launch
865  */
866 function lti_get_ims_role($user, $cmid, $courseid, $islti2) {
867     $roles = array();
869     if (empty($cmid)) {
870         // If no cmid is passed, check if the user is a teacher in the course
871         // This allows other modules to programmatically "fake" a launch without
872         // a real LTI instance.
873         $coursecontext = context_course::instance($courseid);
875         if (has_capability('moodle/course:manageactivities', $coursecontext)) {
876             array_push($roles, 'Instructor');
877         } else {
878             array_push($roles, 'Learner');
879         }
880     } else {
881         $context = context_module::instance($cmid);
883         if (has_capability('mod/lti:manage', $context)) {
884             array_push($roles, 'Instructor');
885         } else {
886             array_push($roles, 'Learner');
887         }
888     }
890     if (is_siteadmin($user)) {
891         if (!$islti2) {
892             array_push($roles, 'urn:lti:sysrole:ims/lis/Administrator', 'urn:lti:instrole:ims/lis/Administrator');
893         } else {
894             array_push($roles, 'http://purl.imsglobal.org/vocab/lis/v2/person#Administrator');
895         }
896     }
898     return join(',', $roles);
901 /**
902  * Returns configuration details for the tool
903  *
904  * @param int $typeid   Basic LTI tool typeid
905  *
906  * @return array        Tool Configuration
907  */
908 function lti_get_type_config($typeid) {
909     global $DB;
911     $query = "SELECT name, value
912                 FROM {lti_types_config}
913                WHERE typeid = :typeid1
914            UNION ALL
915               SELECT 'toolurl' AS name, " . $DB->sql_compare_text('baseurl', 1333) . " AS value
916                 FROM {lti_types}
917                WHERE id = :typeid2";
919     $typeconfig = array();
920     $configs = $DB->get_records_sql($query, array('typeid1' => $typeid, 'typeid2' => $typeid));
922     if (!empty($configs)) {
923         foreach ($configs as $config) {
924             $typeconfig[$config->name] = $config->value;
925         }
926     }
928     return $typeconfig;
931 function lti_get_tools_by_url($url, $state, $courseid = null) {
932     $domain = lti_get_domain_from_url($url);
934     return lti_get_tools_by_domain($domain, $state, $courseid);
937 function lti_get_tools_by_domain($domain, $state = null, $courseid = null) {
938     global $DB, $SITE;
940     $filters = array('tooldomain' => $domain);
942     $statefilter = '';
943     $coursefilter = '';
945     if ($state) {
946         $statefilter = 'AND state = :state';
947     }
949     if ($courseid && $courseid != $SITE->id) {
950         $coursefilter = 'OR course = :courseid';
951     }
953     $query = "SELECT *
954                 FROM {lti_types}
955                WHERE tooldomain = :tooldomain
956                  AND (course = :siteid $coursefilter)
957                  $statefilter";
959     return $DB->get_records_sql($query, array(
960         'courseid' => $courseid,
961         'siteid' => $SITE->id,
962         'tooldomain' => $domain,
963         'state' => $state
964     ));
967 /**
968  * Returns all basicLTI tools configured by the administrator
969  *
970  */
971 function lti_filter_get_types($course) {
972     global $DB;
974     if (!empty($course)) {
975         $where = "WHERE t.course = :course";
976         $params = array('course' => $course);
977     } else {
978         $where = '';
979         $params = array();
980     }
981     $query = "SELECT t.id, t.name, t.baseurl, t.state, t.toolproxyid, t.timecreated, tp.name tpname
982                 FROM {lti_types} t LEFT OUTER JOIN {lti_tool_proxies} tp ON t.toolproxyid = tp.id
983                 {$where}";
984     return $DB->get_records_sql($query, $params);
987 /**
988  * Given an array of tools, filter them based on their state
989  *
990  * @param array $tools An array of lti_types records
991  * @param int $state One of the LTI_TOOL_STATE_* constants
992  * @return array
993  */
994 function lti_filter_tool_types(array $tools, $state) {
995     $return = array();
996     foreach ($tools as $key => $tool) {
997         if ($tool->state == $state) {
998             $return[$key] = $tool;
999         }
1000     }
1001     return $return;
1004 function lti_get_types_for_add_instance() {
1005     global $DB, $SITE, $COURSE;
1007     $query = "SELECT *
1008                 FROM {lti_types}
1009                WHERE coursevisible = 1
1010                  AND (course = :siteid OR course = :courseid)
1011                  AND state = :active";
1013     $admintypes = $DB->get_records_sql($query,
1014         array('siteid' => $SITE->id, 'courseid' => $COURSE->id, 'active' => LTI_TOOL_STATE_CONFIGURED));
1016     $types = array();
1017     $types[0] = (object)array('name' => get_string('automatic', 'lti'), 'course' => 0, 'toolproxyid' => null);
1019     foreach ($admintypes as $type) {
1020         $types[$type->id] = $type;
1021     }
1023     return $types;
1026 function lti_get_domain_from_url($url) {
1027     $matches = array();
1029     if (preg_match(LTI_URL_DOMAIN_REGEX, $url, $matches)) {
1030         return $matches[1];
1031     }
1034 function lti_get_tool_by_url_match($url, $courseid = null, $state = LTI_TOOL_STATE_CONFIGURED) {
1035     $possibletools = lti_get_tools_by_url($url, $state, $courseid);
1037     return lti_get_best_tool_by_url($url, $possibletools, $courseid);
1040 function lti_get_url_thumbprint($url) {
1041     // Parse URL requires a schema otherwise everything goes into 'path'.  Fixed 5.4.7 or later.
1042     if (preg_match('/https?:\/\//', $url) !== 1) {
1043         $url = 'http://'.$url;
1044     }
1045     $urlparts = parse_url(strtolower($url));
1046     if (!isset($urlparts['path'])) {
1047         $urlparts['path'] = '';
1048     }
1050     if (!isset($urlparts['host'])) {
1051         $urlparts['host'] = '';
1052     }
1054     if (substr($urlparts['host'], 0, 4) === 'www.') {
1055         $urlparts['host'] = substr($urlparts['host'], 4);
1056     }
1058     return $urllower = $urlparts['host'] . '/' . $urlparts['path'];
1061 function lti_get_best_tool_by_url($url, $tools, $courseid = null) {
1062     if (count($tools) === 0) {
1063         return null;
1064     }
1066     $urllower = lti_get_url_thumbprint($url);
1068     foreach ($tools as $tool) {
1069         $tool->_matchscore = 0;
1071         $toolbaseurllower = lti_get_url_thumbprint($tool->baseurl);
1073         if ($urllower === $toolbaseurllower) {
1074             // 100 points for exact thumbprint match.
1075             $tool->_matchscore += 100;
1076         } else if (substr($urllower, 0, strlen($toolbaseurllower)) === $toolbaseurllower) {
1077             // 50 points if tool thumbprint starts with the base URL thumbprint.
1078             $tool->_matchscore += 50;
1079         }
1081         // Prefer course tools over site tools.
1082         if (!empty($courseid)) {
1083             // Minus 10 points for not matching the course id (global tools).
1084             if ($tool->course != $courseid) {
1085                 $tool->_matchscore -= 10;
1086             }
1087         }
1088     }
1090     $bestmatch = array_reduce($tools, function($value, $tool) {
1091         if ($tool->_matchscore > $value->_matchscore) {
1092             return $tool;
1093         } else {
1094             return $value;
1095         }
1097     }, (object)array('_matchscore' => -1));
1099     // None of the tools are suitable for this URL.
1100     if ($bestmatch->_matchscore <= 0) {
1101         return null;
1102     }
1104     return $bestmatch;
1107 function lti_get_shared_secrets_by_key($key) {
1108     global $DB;
1110     // Look up the shared secret for the specified key in both the types_config table (for configured tools)
1111     // And in the lti resource table for ad-hoc tools.
1112     $query = "SELECT t2.value
1113                 FROM {lti_types_config} t1
1114                 JOIN {lti_types_config} t2 ON t1.typeid = t2.typeid
1115                 JOIN {lti_types} type ON t2.typeid = type.id
1116               WHERE t1.name = 'resourcekey'
1117                 AND t1.value = :key1
1118                 AND t2.name = 'password'
1119                 AND type.state = :configured1
1120                UNION
1121               SELECT tp.secret AS value
1122                 FROM {lti_tool_proxies} tp
1123                 JOIN {lti_types} t ON tp.id = t.toolproxyid
1124               WHERE tp.guid = :key2
1125                 AND t.state = :configured2
1126               UNION
1127              SELECT password AS value
1128                FROM {lti}
1129               WHERE resourcekey = :key3";
1131     $sharedsecrets = $DB->get_records_sql($query, array('configured1' => LTI_TOOL_STATE_CONFIGURED,
1132         'configured2' => LTI_TOOL_STATE_CONFIGURED, 'key1' => $key, 'key2' => $key, 'key3' => $key));
1134     $values = array_map(function($item) {
1135         return $item->value;
1136     }, $sharedsecrets);
1138     // There should really only be one shared secret per key. But, we can't prevent
1139     // more than one getting entered. For instance, if the same key is used for two tool providers.
1140     return $values;
1143 /**
1144  * Delete a Basic LTI configuration
1145  *
1146  * @param int $id   Configuration id
1147  */
1148 function lti_delete_type($id) {
1149     global $DB;
1151     // We should probably just copy the launch URL to the tool instances in this case... using a single query.
1152     /*
1153     $instances = $DB->get_records('lti', array('typeid' => $id));
1154     foreach ($instances as $instance) {
1155         $instance->typeid = 0;
1156         $DB->update_record('lti', $instance);
1157     }*/
1159     $DB->delete_records('lti_types', array('id' => $id));
1160     $DB->delete_records('lti_types_config', array('typeid' => $id));
1163 function lti_set_state_for_type($id, $state) {
1164     global $DB;
1166     $DB->update_record('lti_types', array('id' => $id, 'state' => $state));
1169 /**
1170  * Transforms a basic LTI object to an array
1171  *
1172  * @param object $ltiobject    Basic LTI object
1173  *
1174  * @return array Basic LTI configuration details
1175  */
1176 function lti_get_config($ltiobject) {
1177     $typeconfig = array();
1178     $typeconfig = (array)$ltiobject;
1179     $additionalconfig = lti_get_type_config($ltiobject->typeid);
1180     $typeconfig = array_merge($typeconfig, $additionalconfig);
1181     return $typeconfig;
1184 /**
1185  *
1186  * Generates some of the tool configuration based on the instance details
1187  *
1188  * @param int $id
1189  *
1190  * @return Instance configuration
1191  *
1192  */
1193 function lti_get_type_config_from_instance($id) {
1194     global $DB;
1196     $instance = $DB->get_record('lti', array('id' => $id));
1197     $config = lti_get_config($instance);
1199     $type = new \stdClass();
1200     $type->lti_fix = $id;
1201     if (isset($config['toolurl'])) {
1202         $type->lti_toolurl = $config['toolurl'];
1203     }
1204     if (isset($config['instructorchoicesendname'])) {
1205         $type->lti_sendname = $config['instructorchoicesendname'];
1206     }
1207     if (isset($config['instructorchoicesendemailaddr'])) {
1208         $type->lti_sendemailaddr = $config['instructorchoicesendemailaddr'];
1209     }
1210     if (isset($config['instructorchoiceacceptgrades'])) {
1211         $type->lti_acceptgrades = $config['instructorchoiceacceptgrades'];
1212     }
1213     if (isset($config['instructorchoiceallowroster'])) {
1214         $type->lti_allowroster = $config['instructorchoiceallowroster'];
1215     }
1217     if (isset($config['instructorcustomparameters'])) {
1218         $type->lti_allowsetting = $config['instructorcustomparameters'];
1219     }
1220     return $type;
1223 /**
1224  * Generates some of the tool configuration based on the admin configuration details
1225  *
1226  * @param int $id
1227  *
1228  * @return Configuration details
1229  */
1230 function lti_get_type_type_config($id) {
1231     global $DB;
1233     $basicltitype = $DB->get_record('lti_types', array('id' => $id));
1234     $config = lti_get_type_config($id);
1236     $type = new \stdClass();
1238     $type->lti_typename = $basicltitype->name;
1240     $type->typeid = $basicltitype->id;
1242     $type->toolproxyid = $basicltitype->toolproxyid;
1244     $type->lti_toolurl = $basicltitype->baseurl;
1246     $type->lti_parameters = $basicltitype->parameter;
1248     if (isset($config['resourcekey'])) {
1249         $type->lti_resourcekey = $config['resourcekey'];
1250     }
1251     if (isset($config['password'])) {
1252         $type->lti_password = $config['password'];
1253     }
1255     if (isset($config['sendname'])) {
1256         $type->lti_sendname = $config['sendname'];
1257     }
1258     if (isset($config['instructorchoicesendname'])) {
1259         $type->lti_instructorchoicesendname = $config['instructorchoicesendname'];
1260     }
1261     if (isset($config['sendemailaddr'])) {
1262         $type->lti_sendemailaddr = $config['sendemailaddr'];
1263     }
1264     if (isset($config['instructorchoicesendemailaddr'])) {
1265         $type->lti_instructorchoicesendemailaddr = $config['instructorchoicesendemailaddr'];
1266     }
1267     if (isset($config['acceptgrades'])) {
1268         $type->lti_acceptgrades = $config['acceptgrades'];
1269     }
1270     if (isset($config['instructorchoiceacceptgrades'])) {
1271         $type->lti_instructorchoiceacceptgrades = $config['instructorchoiceacceptgrades'];
1272     }
1273     if (isset($config['allowroster'])) {
1274         $type->lti_allowroster = $config['allowroster'];
1275     }
1276     if (isset($config['instructorchoiceallowroster'])) {
1277         $type->lti_instructorchoiceallowroster = $config['instructorchoiceallowroster'];
1278     }
1280     if (isset($config['customparameters'])) {
1281         $type->lti_customparameters = $config['customparameters'];
1282     }
1284     if (isset($config['forcessl'])) {
1285         $type->lti_forcessl = $config['forcessl'];
1286     }
1288     if (isset($config['organizationid'])) {
1289         $type->lti_organizationid = $config['organizationid'];
1290     }
1291     if (isset($config['organizationurl'])) {
1292         $type->lti_organizationurl = $config['organizationurl'];
1293     }
1294     if (isset($config['organizationdescr'])) {
1295         $type->lti_organizationdescr = $config['organizationdescr'];
1296     }
1297     if (isset($config['launchcontainer'])) {
1298         $type->lti_launchcontainer = $config['launchcontainer'];
1299     }
1301     if (isset($config['coursevisible'])) {
1302         $type->lti_coursevisible = $config['coursevisible'];
1303     }
1305     if (isset($config['debuglaunch'])) {
1306         $type->lti_debuglaunch = $config['debuglaunch'];
1307     }
1309     if (isset($config['module_class_type'])) {
1310         $type->lti_module_class_type = $config['module_class_type'];
1311     }
1313     return $type;
1316 function lti_prepare_type_for_save($type, $config) {
1317     if (isset($config->lti_toolurl)) {
1318         $type->baseurl = $config->lti_toolurl;
1319         $type->tooldomain = lti_get_domain_from_url($config->lti_toolurl);
1320     }
1321     if (isset($config->lti_typename)) {
1322         $type->name = $config->lti_typename;
1323     }
1324     $type->coursevisible = !empty($config->lti_coursevisible) ? $config->lti_coursevisible : 0;
1325     $config->lti_coursevisible = $type->coursevisible;
1327     if (isset($config->lti_forcessl)) {
1328         $type->forcessl = !empty($config->lti_forcessl) ? $config->lti_forcessl : 0;
1329         $config->lti_forcessl = $type->forcessl;
1330     }
1332     $type->timemodified = time();
1334     unset ($config->lti_typename);
1335     unset ($config->lti_toolurl);
1338 function lti_update_type($type, $config) {
1339     global $DB;
1341     lti_prepare_type_for_save($type, $config);
1343     if ($DB->update_record('lti_types', $type)) {
1344         foreach ($config as $key => $value) {
1345             if (substr($key, 0, 4) == 'lti_' && !is_null($value)) {
1346                 $record = new \StdClass();
1347                 $record->typeid = $type->id;
1348                 $record->name = substr($key, 4);
1349                 $record->value = $value;
1350                 lti_update_config($record);
1351             }
1352         }
1353     }
1356 function lti_add_type($type, $config) {
1357     global $USER, $SITE, $DB;
1359     lti_prepare_type_for_save($type, $config);
1361     if (!isset($type->state)) {
1362         $type->state = LTI_TOOL_STATE_PENDING;
1363     }
1365     if (!isset($type->timecreated)) {
1366         $type->timecreated = time();
1367     }
1369     if (!isset($type->createdby)) {
1370         $type->createdby = $USER->id;
1371     }
1373     if (!isset($type->course)) {
1374         $type->course = $SITE->id;
1375     }
1377     // Create a salt value to be used for signing passed data to extension services
1378     // The outcome service uses the service salt on the instance. This can be used
1379     // for communication with services not related to a specific LTI instance.
1380     $config->lti_servicesalt = uniqid('', true);
1382     $id = $DB->insert_record('lti_types', $type);
1384     if ($id) {
1385         foreach ($config as $key => $value) {
1386             if (substr($key, 0, 4) == 'lti_' && !is_null($value)) {
1387                 $record = new \StdClass();
1388                 $record->typeid = $id;
1389                 $record->name = substr($key, 4);
1390                 $record->value = $value;
1392                 lti_add_config($record);
1393             }
1394         }
1395     }
1397     return $id;
1400 /**
1401  * Given an array of tool proxies, filter them based on their state
1402  *
1403  * @param array $toolproxies An array of lti_tool_proxies records
1404  * @param int $state One of the LTI_TOOL_PROXY_STATE_* constants
1405  *
1406  * @return array
1407  */
1408 function lti_filter_tool_proxy_types(array $toolproxies, $state) {
1409     $return = array();
1410     foreach ($toolproxies as $key => $toolproxy) {
1411         if ($toolproxy->state == $state) {
1412             $return[$key] = $toolproxy;
1413         }
1414     }
1415     return $return;
1418 /**
1419  * Get the tool proxy instance given its GUID
1420  *
1421  * @param string  $toolproxyguid   Tool proxy GUID value
1422  *
1423  * @return object
1424  */
1425 function lti_get_tool_proxy_from_guid($toolproxyguid) {
1426     global $DB;
1428     $toolproxy = $DB->get_record('lti_tool_proxies', array('guid' => $toolproxyguid));
1430     return $toolproxy;
1433 /**
1434  * Generates some of the tool proxy configuration based on the admin configuration details
1435  *
1436  * @param int $id
1437  *
1438  * @return Tool Proxy details
1439  */
1440 function lti_get_tool_proxy($id) {
1441     global $DB;
1443     $toolproxy = $DB->get_record('lti_tool_proxies', array('id' => $id));
1444     return $toolproxy;
1447 /**
1448  * Generates some of the tool proxy configuration based on the admin configuration details
1449  *
1450  * @param int $id
1451  *
1452  * @return Tool Proxy details
1453  */
1454 function lti_get_tool_proxy_config($id) {
1455     $toolproxy = lti_get_tool_proxy($id);
1457     $tp = new \stdClass();
1458     $tp->lti_registrationname = $toolproxy->name;
1459     $tp->toolproxyid = $toolproxy->id;
1460     $tp->state = $toolproxy->state;
1461     $tp->lti_registrationurl = $toolproxy->regurl;
1462     $tp->lti_capabilities = explode("\n", $toolproxy->capabilityoffered);
1463     $tp->lti_services = explode("\n", $toolproxy->serviceoffered);
1465     return $tp;
1468 /**
1469  * Update the database with a tool proxy instance
1470  *
1471  * @param object   $config    Tool proxy definition
1472  *
1473  * @return int  Record id number
1474  */
1475 function lti_add_tool_proxy($config) {
1476     global $USER, $DB;
1478     $toolproxy = new \stdClass();
1479     if (isset($config->lti_registrationname)) {
1480         $toolproxy->name = trim($config->lti_registrationname);
1481     }
1482     if (isset($config->lti_registrationurl)) {
1483         $toolproxy->regurl = trim($config->lti_registrationurl);
1484     }
1485     if (isset($config->lti_capabilities)) {
1486         $toolproxy->capabilityoffered = implode("\n", $config->lti_capabilities);
1487     }
1488     if (isset($config->lti_services)) {
1489         $toolproxy->serviceoffered = implode("\n", $config->lti_services);
1490     }
1491     if (isset($config->toolproxyid) && !empty($config->toolproxyid)) {
1492         $toolproxy->id = $config->toolproxyid;
1493         if (!isset($toolproxy->state) || ($toolproxy->state != LTI_TOOL_PROXY_STATE_ACCEPTED)) {
1494             $toolproxy->state = LTI_TOOL_PROXY_STATE_CONFIGURED;
1495             $toolproxy->guid = random_string();
1496             $toolproxy->secret = random_string();
1497         }
1498         $id = lti_update_tool_proxy($toolproxy);
1499     } else {
1500         $toolproxy->state = LTI_TOOL_PROXY_STATE_CONFIGURED;
1501         $toolproxy->timemodified = time();
1502         $toolproxy->timecreated = $toolproxy->timemodified;
1503         if (!isset($toolproxy->createdby)) {
1504             $toolproxy->createdby = $USER->id;
1505         }
1506         $toolproxy->guid = random_string();
1507         $toolproxy->secret = random_string();
1508         $id = $DB->insert_record('lti_tool_proxies', $toolproxy);
1509     }
1511     return $id;
1514 /**
1515  * Updates a tool proxy in the database
1516  *
1517  * @param object  $toolproxy   Tool proxy
1518  *
1519  * @return int    Record id number
1520  */
1521 function lti_update_tool_proxy($toolproxy) {
1522     global $DB;
1524     $toolproxy->timemodified = time();
1525     $id = $DB->update_record('lti_tool_proxies', $toolproxy);
1527     return $id;
1530 /**
1531  * Delete a Tool Proxy
1532  *
1533  * @param int $id   Tool Proxy id
1534  */
1535 function lti_delete_tool_proxy($id) {
1536     global $DB;
1537     $DB->delete_records('lti_tool_settings', array('toolproxyid' => $id));
1538     $tools = $DB->get_records('lti_types', array('toolproxyid' => $id));
1539     foreach ($tools as $tool) {
1540         lti_delete_type($tool->id);
1541     }
1542     $DB->delete_records('lti_tool_proxies', array('id' => $id));
1545 /**
1546  * Add a tool configuration in the database
1547  *
1548  * @param object $config   Tool configuration
1549  *
1550  * @return int Record id number
1551  */
1552 function lti_add_config($config) {
1553     global $DB;
1555     return $DB->insert_record('lti_types_config', $config);
1558 /**
1559  * Updates a tool configuration in the database
1560  *
1561  * @param object  $config   Tool configuration
1562  *
1563  * @return Record id number
1564  */
1565 function lti_update_config($config) {
1566     global $DB;
1568     $return = true;
1569     $old = $DB->get_record('lti_types_config', array('typeid' => $config->typeid, 'name' => $config->name));
1571     if ($old) {
1572         $config->id = $old->id;
1573         $return = $DB->update_record('lti_types_config', $config);
1574     } else {
1575         $return = $DB->insert_record('lti_types_config', $config);
1576     }
1577     return $return;
1580 /**
1581  * Gets the tool settings
1582  *
1583  * @param int  $toolproxyid   Id of tool proxy record
1584  * @param int  $courseid      Id of course (null if system settings)
1585  * @param int  $instanceid    Id of course module (null if system or context settings)
1586  *
1587  * @return array  Array settings
1588  */
1589 function lti_get_tool_settings($toolproxyid, $courseid = null, $instanceid = null) {
1590     global $DB;
1592     $settings = array();
1593     $settingsstr = $DB->get_field('lti_tool_settings', 'settings', array('toolproxyid' => $toolproxyid,
1594         'course' => $courseid, 'coursemoduleid' => $instanceid));
1595     if ($settingsstr !== false) {
1596         $settings = json_decode($settingsstr, true);
1597     }
1598     return $settings;
1601 /**
1602  * Sets the tool settings (
1603  *
1604  * @param array  $settings      Array of settings
1605  * @param int    $toolproxyid   Id of tool proxy record
1606  * @param int    $courseid      Id of course (null if system settings)
1607  * @param int    $instanceid    Id of course module (null if system or context settings)
1608  */
1609 function lti_set_tool_settings($settings, $toolproxyid, $courseid = null, $instanceid = null) {
1610     global $DB;
1612     $json = json_encode($settings);
1613     $record = $DB->get_record('lti_tool_settings', array('toolproxyid' => $toolproxyid,
1614         'course' => $courseid, 'coursemoduleid' => $instanceid));
1615     if ($record !== false) {
1616         $DB->update_record('lti_tool_settings', array('id' => $record->id, 'settings' => $json, 'timemodified' => time()));
1617     } else {
1618         $record = new \stdClass();
1619         $record->toolproxyid = $toolproxyid;
1620         $record->course = $courseid;
1621         $record->coursemoduleid = $instanceid;
1622         $record->settings = $json;
1623         $record->timecreated = time();
1624         $record->timemodified = $record->timecreated;
1625         $DB->insert_record('lti_tool_settings', $record);
1626     }
1629 /**
1630  * Signs the petition to launch the external tool using OAuth
1631  *
1632  * @param $oldparms     Parameters to be passed for signing
1633  * @param $endpoint     url of the external tool
1634  * @param $method       Method for sending the parameters (e.g. POST)
1635  * @param $oauth_consumoer_key          Key
1636  * @param $oauth_consumoer_secret       Secret
1637  */
1638 function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret) {
1640     $parms = $oldparms;
1642     $testtoken = '';
1644     // TODO: Switch to core oauthlib once implemented - MDL-30149.
1645     $hmacmethod = new lti\OAuthSignatureMethod_HMAC_SHA1();
1646     $testconsumer = new lti\OAuthConsumer($oauthconsumerkey, $oauthconsumersecret, null);
1647     $accreq = lti\OAuthRequest::from_consumer_and_token($testconsumer, $testtoken, $method, $endpoint, $parms);
1648     $accreq->sign_request($hmacmethod, $testconsumer, $testtoken);
1650     $newparms = $accreq->get_parameters();
1652     return $newparms;
1655 /**
1656  * Posts the launch petition HTML
1657  *
1658  * @param $newparms     Signed parameters
1659  * @param $endpoint     URL of the external tool
1660  * @param $debug        Debug (true/false)
1661  */
1662 function lti_post_launch_html($newparms, $endpoint, $debug=false) {
1663     $r = "<form action=\"" . $endpoint .
1664         "\" name=\"ltiLaunchForm\" id=\"ltiLaunchForm\" method=\"post\" encType=\"application/x-www-form-urlencoded\">\n";
1666     // Contruct html for the launch parameters.
1667     foreach ($newparms as $key => $value) {
1668         $key = htmlspecialchars($key);
1669         $value = htmlspecialchars($value);
1670         if ( $key == "ext_submit" ) {
1671             $r .= "<input type=\"submit\"";
1672         } else {
1673             $r .= "<input type=\"hidden\" name=\"{$key}\"";
1674         }
1675         $r .= " value=\"";
1676         $r .= $value;
1677         $r .= "\"/>\n";
1678     }
1680     if ( $debug ) {
1681         $r .= "<script language=\"javascript\"> \n";
1682         $r .= "  //<![CDATA[ \n";
1683         $r .= "function basicltiDebugToggle() {\n";
1684         $r .= "    var ele = document.getElementById(\"basicltiDebug\");\n";
1685         $r .= "    if (ele.style.display == \"block\") {\n";
1686         $r .= "        ele.style.display = \"none\";\n";
1687         $r .= "    }\n";
1688         $r .= "    else {\n";
1689         $r .= "        ele.style.display = \"block\";\n";
1690         $r .= "    }\n";
1691         $r .= "} \n";
1692         $r .= "  //]]> \n";
1693         $r .= "</script>\n";
1694         $r .= "<a id=\"displayText\" href=\"javascript:basicltiDebugToggle();\">";
1695         $r .= get_string("toggle_debug_data", "lti")."</a>\n";
1696         $r .= "<div id=\"basicltiDebug\" style=\"display:none\">\n";
1697         $r .= "<b>".get_string("basiclti_endpoint", "lti")."</b><br/>\n";
1698         $r .= $endpoint . "<br/>\n&nbsp;<br/>\n";
1699         $r .= "<b>".get_string("basiclti_parameters", "lti")."</b><br/>\n";
1700         foreach ($newparms as $key => $value) {
1701             $key = htmlspecialchars($key);
1702             $value = htmlspecialchars($value);
1703             $r .= "$key = $value<br/>\n";
1704         }
1705         $r .= "&nbsp;<br/>\n";
1706         $r .= "</div>\n";
1707     }
1708     $r .= "</form>\n";
1710     if ( ! $debug ) {
1711         $r .= " <script type=\"text/javascript\"> \n" .
1712             "  //<![CDATA[ \n" .
1713             "    document.ltiLaunchForm.submit(); \n" .
1714             "  //]]> \n" .
1715             " </script> \n";
1716     }
1717     return $r;
1720 function lti_get_type($typeid) {
1721     global $DB;
1723     return $DB->get_record('lti_types', array('id' => $typeid));
1726 function lti_get_launch_container($lti, $toolconfig) {
1727     if (empty($lti->launchcontainer)) {
1728         $lti->launchcontainer = LTI_LAUNCH_CONTAINER_DEFAULT;
1729     }
1731     if ($lti->launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1732         if (isset($toolconfig['launchcontainer'])) {
1733             $launchcontainer = $toolconfig['launchcontainer'];
1734         }
1735     } else {
1736         $launchcontainer = $lti->launchcontainer;
1737     }
1739     if (empty($launchcontainer) || $launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT) {
1740         $launchcontainer = LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS;
1741     }
1743     $devicetype = core_useragent::get_device_type();
1745     // Scrolling within the object element doesn't work on iOS or Android
1746     // Opening the popup window also had some issues in testing
1747     // For mobile devices, always take up the entire screen to ensure the best experience.
1748     if ($devicetype === core_useragent::DEVICETYPE_MOBILE || $devicetype === core_useragent::DEVICETYPE_TABLET ) {
1749         $launchcontainer = LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW;
1750     }
1752     return $launchcontainer;
1755 function lti_request_is_using_ssl() {
1756     global $CFG;
1757     return (stripos($CFG->httpswwwroot, 'https://') === 0);
1760 function lti_ensure_url_is_https($url) {
1761     if (!strstr($url, '://')) {
1762         $url = 'https://' . $url;
1763     } else {
1764         // If the URL starts with http, replace with https.
1765         if (stripos($url, 'http://') === 0) {
1766             $url = 'https://' . substr($url, 7);
1767         }
1768     }
1770     return $url;
1773 /**
1774  * Determines if we should try to log the request
1775  *
1776  * @param string $rawbody
1777  * @return bool
1778  */
1779 function lti_should_log_request($rawbody) {
1780     global $CFG;
1782     if (empty($CFG->mod_lti_log_users)) {
1783         return false;
1784     }
1786     $logusers = explode(',', $CFG->mod_lti_log_users);
1787     if (empty($logusers)) {
1788         return false;
1789     }
1791     try {
1792         $xml = new \SimpleXMLElement($rawbody);
1793         $ns  = $xml->getNamespaces();
1794         $ns  = array_shift($ns);
1795         $xml->registerXPathNamespace('lti', $ns);
1796         $requestuserid = '';
1797         if ($node = $xml->xpath('//lti:userId')) {
1798             $node = $node[0];
1799             $requestuserid = clean_param((string) $node, PARAM_INT);
1800         } else if ($node = $xml->xpath('//lti:sourcedId')) {
1801             $node = $node[0];
1802             $resultjson = json_decode((string) $node);
1803             $requestuserid = clean_param($resultjson->data->userid, PARAM_INT);
1804         }
1805     } catch (Exception $e) {
1806         return false;
1807     }
1809     if (empty($requestuserid) or !in_array($requestuserid, $logusers)) {
1810         return false;
1811     }
1813     return true;
1816 /**
1817  * Logs the request to a file in temp dir
1818  *
1819  * @param string $rawbody
1820  */
1821 function lti_log_request($rawbody) {
1822     if ($tempdir = make_temp_directory('mod_lti', false)) {
1823         if ($tempfile = tempnam($tempdir, 'mod_lti_request'.date('YmdHis'))) {
1824             file_put_contents($tempfile, $rawbody);
1825             chmod($tempfile, 0644);
1826         }
1827     }
1830 /**
1831  * Fetches LTI type configuration for an LTI instance
1832  *
1833  * @param stdClass $instance
1834  * @return array Can be empty if no type is found
1835  */
1836 function lti_get_type_config_by_instance($instance) {
1837     $typeid = null;
1838     if (empty($instance->typeid)) {
1839         $tool = lti_get_tool_by_url_match($instance->toolurl, $instance->course);
1840         if ($tool) {
1841             $typeid = $tool->id;
1842         }
1843     } else {
1844         $typeid = $instance->typeid;
1845     }
1846     if (!empty($typeid)) {
1847         return lti_get_type_config($typeid);
1848     }
1849     return array();
1852 /**
1853  * Enforce type config settings onto the LTI instance
1854  *
1855  * @param stdClass $instance
1856  * @param array $typeconfig
1857  */
1858 function lti_force_type_config_settings($instance, array $typeconfig) {
1859     $forced = array(
1860         'instructorchoicesendname'      => 'sendname',
1861         'instructorchoicesendemailaddr' => 'sendemailaddr',
1862         'instructorchoiceacceptgrades'  => 'acceptgrades',
1863     );
1865     foreach ($forced as $instanceparam => $typeconfigparam) {
1866         if (array_key_exists($typeconfigparam, $typeconfig) && $typeconfig[$typeconfigparam] != LTI_SETTING_DELEGATE) {
1867             $instance->$instanceparam = $typeconfig[$typeconfigparam];
1868         }
1869     }
1872 /**
1873  * Initializes an array with the capabilities supported by the LTI module
1874  *
1875  * @return array List of capability names (without a dollar sign prefix)
1876  */
1877 function lti_get_capabilities() {
1879     $capabilities = array(
1880        'basic-lti-launch-request' => '',
1881        'Context.id' => 'context_id',
1882        'CourseSection.title' => 'context_title',
1883        'CourseSection.label' => 'context_label',
1884        'CourseSection.sourcedId' => 'lis_course_section_sourcedid',
1885        'CourseSection.longDescription' => '$COURSE->summary',
1886        'CourseSection.timeFrame.begin' => '$COURSE->startdate',
1887        'ResourceLink.id' => 'resource_link_id',
1888        'ResourceLink.title' => 'resource_link_title',
1889        'ResourceLink.description' => 'resource_link_description',
1890        'User.id' => 'user_id',
1891        'User.username' => '$USER->username',
1892        'Person.name.full' => 'lis_person_name_full',
1893        'Person.name.given' => 'lis_person_name_given',
1894        'Person.name.family' => 'lis_person_name_family',
1895        'Person.email.primary' => 'lis_person_contact_email_primary',
1896        'Person.sourcedId' => 'lis_person_sourcedid',
1897        'Person.name.middle' => '$USER->middlename',
1898        'Person.address.street1' => '$USER->address',
1899        'Person.address.locality' => '$USER->city',
1900        'Person.address.country' => '$USER->country',
1901        'Person.address.timezone' => '$USER->timezone',
1902        'Person.phone.primary' => '$USER->phone1',
1903        'Person.phone.mobile' => '$USER->phone2',
1904        'Person.webaddress' => '$USER->url',
1905        'Membership.role' => 'roles',
1906        'Result.sourcedId' => 'lis_result_sourcedid',
1907        'Result.autocreate' => 'lis_outcome_service_url');
1909     return $capabilities;
1913 /**
1914  * Initializes an array with the services supported by the LTI module
1915  *
1916  * @return array List of services
1917  */
1918 function lti_get_services() {
1920     $services = array();
1921     $definedservices = core_component::get_plugin_list('ltiservice');
1922     foreach ($definedservices as $name => $location) {
1923         $classname = "\\ltiservice_{$name}\\local\\service\\{$name}";
1924         $services[] = new $classname();
1925     }
1927     return $services;
1931 /**
1932  * Initializes an instance of the named service
1933  *
1934  * @param string $servicename Name of service
1935  *
1936  * @return mod_lti\local\ltiservice\service_base Service
1937  */
1938 function lti_get_service_by_name($servicename) {
1940     $service = false;
1941     $classname = "\\ltiservice_{$servicename}\\local\\service\\{$servicename}";
1942     if (class_exists($classname)) {
1943         $service = new $classname();
1944     }
1946     return $service;
1950 /**
1951  * Finds a service by id
1952  *
1953  * @param array  $services    Array of services
1954  * @param string $resourceid  ID of resource
1955  *
1956  * @return mod_lti\local\ltiservice\service_base Service
1957  */
1958 function lti_get_service_by_resource_id($services, $resourceid) {
1960     $service = false;
1961     foreach ($services as $aservice) {
1962         foreach ($aservice->get_resources() as $resource) {
1963             if ($resource->get_id() === $resourceid) {
1964                 $service = $aservice;
1965                 break 2;
1966             }
1967         }
1968     }
1970     return $service;
1974 /**
1975  * Extracts the named contexts from a tool proxy
1976  *
1977  * @param object $json
1978  *
1979  * @return array Contexts
1980  */
1981 function lti_get_contexts($json) {
1983     $contexts = array();
1984     if (isset($json->{'@context'})) {
1985         foreach ($json->{'@context'} as $context) {
1986             if (is_object($context)) {
1987                 $contexts = array_merge(get_object_vars($context), $contexts);
1988             }
1989         }
1990     }
1992     return $contexts;
1996 /**
1997  * Converts an ID to a fully-qualified ID
1998  *
1999  * @param array $contexts
2000  * @param string $id
2001  *
2002  * @return string Fully-qualified ID
2003  */
2004 function lti_get_fqid($contexts, $id) {
2006     $parts = explode(':', $id, 2);
2007     if (count($parts) > 1) {
2008         if (array_key_exists($parts[0], $contexts)) {
2009             $id = $contexts[$parts[0]] . $parts[1];
2010         }
2011     }
2013     return $id;