Updating LTI submission viewer
[moodle.git] / mod / lti / locallib.php
1 <?php
2 // This file is part of BasicLTI4Moodle
3 //
4 // BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
5 // consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
6 // based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
7 // specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
8 // are already supporting or going to support BasicLTI. This project Implements the consumer
9 // for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
10 // BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
11 // at the GESSI research group at UPC.
12 // SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
13 // by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
14 // Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
15 //
16 // BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
17 // of the Universitat Politecnica de Catalunya http://www.upc.edu
18 // Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu
19 //
20 // Moodle is free software: you can redistribute it and/or modify
21 // it under the terms of the GNU General Public License as published by
22 // the Free Software Foundation, either version 3 of the License, or
23 // (at your option) any later version.
24 //
25 // Moodle is distributed in the hope that it will be useful,
26 // but WITHOUT ANY WARRANTY; without even the implied warranty of
27 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 // GNU General Public License for more details.
29 //
30 // You should have received a copy of the GNU General Public License
31 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
33 /**
34  * This file contains the library of functions and constants for the basiclti module
35  *
36  * @package lti
37  * @copyright 2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
38  *  marc.alier@upc.edu
39  * @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu
40  *
41  * @author Marc Alier
42  * @author Jordi Piguillem
43  * @author Nikolas Galanis
44  *
45  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
46  */
48 defined('MOODLE_INTERNAL') || die;
50 use moodle\mod\lti as lti;
52 require_once($CFG->dirroot.'/mod/lti/OAuth.php');
54 define('LTI_URL_DOMAIN_REGEX', '/(?:https?:\/\/)?(?:www\.)?([^\/]+)(?:\/|$)/i');
56 define('LTI_LAUNCH_CONTAINER_DEFAULT', 1);
57 define('LTI_LAUNCH_CONTAINER_EMBED', 2);
58 define('LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS', 3);
59 define('LTI_LAUNCH_CONTAINER_WINDOW', 4);
61 define('LTI_TOOL_STATE_ANY', 0);
62 define('LTI_TOOL_STATE_CONFIGURED', 1);
63 define('LTI_TOOL_STATE_PENDING', 2);
64 define('LTI_TOOL_STATE_REJECTED', 3);
66 define('LTI_SETTING_NEVER', 0);
67 define('LTI_SETTING_ALWAYS', 1);
68 define('LTI_SETTING_DEFAULT', 2);
70 /**
71  * Prints a Basic LTI activity
72  *
73  * $param int $basicltiid       Basic LTI activity id
74  */
75 function lti_view($instance, $makeobject=false) {
76     global $PAGE, $CFG;
78     if(empty($instance->typeid)){
79         $tool = lti_get_tool_by_url_match($instance->toolurl, $instance->course);
80         if($tool){
81             $typeid = $tool->id;
82         } else {
83             $typeid = null;
84         }
85     } else {
86         $typeid = $instance->typeid;
87     }
88     
89     if($typeid){
90         $typeconfig = lti_get_type_config($typeid);
91     } else {
92         //There is no admin configuration for this tool. Use configuration in the lti instance record plus some defaults.
93         $typeconfig = (array)$instance;
94         
95         $typeconfig['sendname'] = $instance->instructorchoicesendname;
96         $typeconfig['sendemailaddr'] = $instance->instructorchoicesendemailaddr;
97         $typeconfig['customparameters'] = $instance->instructorcustomparameters;
98         $typeconfig['acceptgrades'] = $instance->instructorchoiceacceptgrades;
99         $typeconfig['allowroster'] = $instance->instructorchoiceallowroster;
100     }
101     
102     //Default the organizationid if not specified
103     if(empty($typeconfig['organizationid'])){
104         $urlparts = parse_url($CFG->wwwroot);
105         
106         $typeconfig['organizationid'] = $urlparts['host'];
107     }
108     
109     $endpoint = !empty($instance->toolurl) ? $instance->toolurl : $typeconfig['toolurl'];
110     $key = !empty($instance->resourcekey) ? $instance->resourcekey : $typeconfig['resourcekey'];
111     $secret = !empty($instance->password) ? $instance->password : $typeconfig['password'];
112     $orgid = $typeconfig['organizationid'];
113     /* Suppress this for now - Chuck
114     $orgdesc = $typeconfig['organizationdescr'];
115     */
117     $course = $PAGE->course;
118     $requestparams = lti_build_request($instance, $typeconfig, $course);
120     // Make sure we let the tool know what LMS they are being called from
121     $requestparams["ext_lms"] = "moodle-2";
123     // Add oauth_callback to be compliant with the 1.0A spec
124     $requestparams["oauth_callback"] = "about:blank";
126     $submittext = get_string('press_to_submit', 'lti');
127     $parms = lti_sign_parameters($requestparams, $endpoint, "POST", $key, $secret, $submittext, $orgid /*, $orgdesc*/);
129     $debuglaunch = ( $instance->debuglaunch == 1 );
130     
131     $content = lti_post_launch_html($parms, $endpoint, $debuglaunch);
132     
133     echo $content;
136 function lti_build_sourcedid($instanceid, $userid, $launchid = null, $servicesalt){
137     $data = new stdClass();
138         
139     $data->instanceid = $instanceid;
140     $data->userid = $userid;
141     if(!empty($launchid)){
142         $data->launchid = $launchid;
143     } else {
144         $data->launchid = mt_rand();
145     }
147     $json = json_encode($data);
149     $hash = hash('sha256', $json . $servicesalt, false);
151     $container = new stdClass();
152     $container->data = $data;
153     $container->hash = $hash;
155     return $container;
158 /**
159  * This function builds the request that must be sent to the tool producer
160  *
161  * @param object    $instance       Basic LTI instance object
162  * @param object    $typeconfig     Basic LTI tool configuration
163  * @param object    $course         Course object
164  *
165  * @return array    $request        Request details
166  */
167 function lti_build_request($instance, $typeconfig, $course) {
168     global $USER, $CFG;
170     $context = get_context_instance(CONTEXT_COURSE, $course->id);
171     $role = lti_get_ims_role($USER, $context);
173     $locale = $course->lang;
174     if ( strlen($locale) < 1 ) {
175          $locale = $CFG->lang;
176     }
178     $requestparams = array(
179         "resource_link_id" => $instance->id,
180         "resource_link_title" => $instance->name,
181         "resource_link_description" => $instance->intro,
182         "user_id" => $USER->id,
183         "roles" => $role,
184         "context_id" => $course->id,
185         "context_label" => $course->shortname,
186         "context_title" => $course->fullname,
187         "launch_presentation_locale" => $locale,
188     );
190     $placementsecret = $instance->servicesalt;
191         
192     if ( isset($placementsecret) ) {
193         $sourcedid = json_encode(lti_build_sourcedid($instance->id, $USER->id, null, $placementsecret));
194     }
196     if ( isset($placementsecret) &&
197          ( $typeconfig['acceptgrades'] == 1 ||
198          ( $typeconfig['acceptgrades'] == 2 && $instance->instructorchoiceacceptgrades == 1 ) ) ) {
199         $requestparams["lis_result_sourcedid"] = $sourcedid;
200         $requestparams["ext_ims_lis_basic_outcome_url"] = $CFG->wwwroot.'/mod/lti/service.php';
201     }
203     if ( isset($placementsecret) &&
204          ( $typeconfig['allowroster'] == 1 ||
205          ( $typeconfig['allowroster'] == 2 && $instance->instructorchoiceallowroster == 1 ) ) ) {
206         $requestparams["ext_ims_lis_memberships_id"] = $sourcedid;
207         $requestparams["ext_ims_lis_memberships_url"] = $CFG->wwwroot.'/mod/lti/service.php';
208     }
210     // Send user's name and email data if appropriate
211     if ( $typeconfig['sendname'] == 1 ||
212          ( $typeconfig['sendname'] == 2 && $instance->instructorchoicesendname == 1 ) ) {
213         $requestparams["lis_person_name_given"] =  $USER->firstname;
214         $requestparams["lis_person_name_family"] =  $USER->lastname;
215         $requestparams["lis_person_name_full"] =  $USER->firstname." ".$USER->lastname;
216     }
218     if ( $typeconfig['sendemailaddr'] == 1 ||
219          ( $typeconfig['sendemailaddr'] == 2 && $instance->instructorchoicesendemailaddr == 1 ) ) {
220         $requestparams["lis_person_contact_email_primary"] = $USER->email;
221     }
223     // Concatenate the custom parameters from the administrator and the instructor
224     // Instructor parameters are only taken into consideration if the administrator
225     // has giver permission
226     $customstr = $typeconfig['customparameters'];
227     $instructorcustomstr = $instance->instructorcustomparameters;
228     $custom = array();
229     $instructorcustom = array();
230     if ($customstr) {
231         $custom = lti_split_custom_parameters($customstr);
232     }
233     if (!isset($typeconfig['allowinstructorcustom']) || $typeconfig['allowinstructorcustom'] == 0) {
234         $requestparams = array_merge($custom, $requestparams);
235     } else {
236         if ($instructorcustomstr) {
237             $instructorcustom = lti_split_custom_parameters($instructorcustomstr);
238         }
239         foreach ($instructorcustom as $key => $val) {
240             if (array_key_exists($key, $custom)) {
241                 // Ignore the instructor's parameter
242             } else {
243                 $custom[$key] = $val;
244             }
245         }
246         $requestparams = array_merge($custom, $requestparams);
247     }
249     return $requestparams;
252 function lti_get_tool_table($tools, $id){
253     global $CFG, $USER;
254     $html = '';
255     
256     $typename = get_string('typename', 'lti');
257     $baseurl = get_string('baseurl', 'lti');
258     $action = get_string('action', 'lti');
259     $createdon = get_string('createdon', 'lti');
260     
261     if($id == 'lti_configured'){
262         $html .= '<div><a style="margin-top:.25em" href="'.$CFG->wwwroot.'/mod/lti/typessettings.php?action=add&amp;sesskey='.$USER->sesskey.'">'.get_string('addtype', 'lti').'</a></div>';
263     }
264     
265     if (!empty($tools)) {
266         $html .= <<<HTML
267         <div id="{$id}_container" style="margin-top:.5em;margin-bottom:.5em">
268             <table id="{$id}_tools">
269                 <thead>
270                     <tr>
271                         <th>$typename</th>
272                         <th>$baseurl</th>
273                         <th>$createdon</th>
274                         <th>$action</th>
275                     </tr>
276                 </thead>
277 HTML;
278         
279         foreach ($tools as $type) {
280             $date = userdate($type->timecreated);
281             $accept = get_string('accept', 'lti');
282             $update = get_string('update', 'lti');
283             $delete = get_string('delete', 'lti');
284             
285             $accepthtml = <<<HTML
286                 <a class="editing_accept" href="{$CFG->wwwroot}/mod/lti/typessettings.php?action=accept&amp;id={$type->id}&amp;sesskey={$USER->sesskey}&amp;tab={$id}" title="{$accept}">
287                     <img class="iconsmall" alt="{$accept}" src="{$CFG->wwwroot}/pix/t/clear.gif"/>
288                 </a>
289 HTML;
291             $deleteaction = 'delete';
292                     
293             if($type->state == LTI_TOOL_STATE_CONFIGURED){
294                 $accepthtml = '';
295             }
296             
297             if($type->state != LTI_TOOL_STATE_REJECTED) {
298                 $deleteaction = 'reject';
299                 $delete = get_string('reject', 'lti');
300             }
301                     
302             $html .= <<<HTML
303             <tr>
304                 <td>
305                     {$type->name}
306                 </td>
307                 <td>
308                     {$type->baseurl}
309                 </td>
310                 <td>
311                     {$date}
312                 </td>
313                 <td align="center">
314                     {$accepthtml}
315                     <a class="editing_update" href="{$CFG->wwwroot}/mod/lti/typessettings.php?action=update&amp;id={$type->id}&amp;sesskey={$USER->sesskey}&amp;tab={$id}" title="{$update}">
316                         <img class="iconsmall" alt="{$update}" src="{$CFG->wwwroot}/pix/t/edit.gif"/>
317                     </a>
318                     <a class="editing_delete" href="{$CFG->wwwroot}/mod/lti/typessettings.php?action={$deleteaction}&amp;id={$type->id}&amp;sesskey={$USER->sesskey}&amp;tab={$id}" title="{$delete}">
319                         <img class="iconsmall" alt="{$delete}" src="{$CFG->wwwroot}/pix/t/delete.gif"/>
320                     </a>
321                 </td>
322             </tr>
323 HTML;
324         }
325         $html .= '</table></div>';
326     } else {
327         $html .= get_string('no_' . $id, 'lti');
328     }
329     
330     return $html;
333 /**
334  * Splits the custom parameters field to the various parameters
335  *
336  * @param string $customstr     String containing the parameters
337  *
338  * @return Array of custom parameters
339  */
340 function lti_split_custom_parameters($customstr) {
341     $textlib = textlib_get_instance();
343     $lines = preg_split("/[\n;]/", $customstr);
344     $retval = array();
345     foreach ($lines as $line) {
346         $pos = strpos($line, "=");
347         if ( $pos === false || $pos < 1 ) {
348             continue;
349         }
350         $key = trim($textlib->substr($line, 0, $pos));
351         $val = trim($textlib->substr($line, $pos+1));
352         $key = lti_map_keyname($key);
353         $retval['custom_'.$key] = $val;
354     }
355     return $retval;
358 /**
359  * Used for building the names of the different custom parameters
360  *
361  * @param string $key   Parameter name
362  *
363  * @return string       Processed name
364  */
365 function lti_map_keyname($key) {
366     $textlib = textlib_get_instance();
368     $newkey = "";
369     $key = $textlib->strtolower(trim($key));
370     foreach (str_split($key) as $ch) {
371         if ( ($ch >= 'a' && $ch <= 'z') || ($ch >= '0' && $ch <= '9') ) {
372             $newkey .= $ch;
373         } else {
374             $newkey .= '_';
375         }
376     }
377     return $newkey;
380 /**
381  * Returns the IMS user role in a given context
382  *
383  * This function queries Moodle for an user role and
384  * returns the correspondant IMS role
385  *
386  * @param StdClass $user          Moodle user instance
387  * @param StdClass $context       Moodle context
388  *
389  * @return string                 IMS Role
390  *
391  */
392 function lti_get_ims_role($user, $context) {
394     $roles = get_user_roles($context, $user->id);
395     $rolesname = array();
396     foreach ($roles as $role) {
397         $rolesname[] = $role->shortname;
398     }
400     if (in_array('admin', $rolesname) || in_array('coursecreator', $rolesname)) {
401         return get_string('imsroleadmin', 'lti');
402     }
404     if (in_array('editingteacher', $rolesname) || in_array('teacher', $rolesname)) {
405         return get_string('imsroleinstructor', 'lti');
406     }
408     return get_string('imsrolelearner', 'lti');
411 /**
412  * Returns configuration details for the tool
413  *
414  * @param int $typeid   Basic LTI tool typeid
415  *
416  * @return array        Tool Configuration
417  */
418 function lti_get_type_config($typeid) {
419     global $DB;
421     $typeconfig = array();
422     $configs = $DB->get_records('lti_types_config', array('typeid' => $typeid));
423     if (!empty($configs)) {
424         foreach ($configs as $config) {
425             $typeconfig[$config->name] = $config->value;
426         }
427     }
428     return $typeconfig;
431 function lti_get_tools_by_url($url, $state, $courseid = null){
432     $domain = lti_get_domain_from_url($url);
433     
434     return lti_get_tools_by_domain($domain, $state, $courseid);
437 function lti_get_tools_by_domain($domain, $state = null, $courseid = null){
438     global $DB, $SITE;
439     
440     $filters = array('tooldomain' => $domain);
441     
442     $statefilter = '';
443     $coursefilter = '';
444     
445     if($state){
446         $statefilter = 'AND state = :state';
447     }
448   
449     if($courseid && $courseid != $SITE->id){
450         $coursefilter = 'OR course = :courseid';
451     }
452     
453     $query = <<<QUERY
454         SELECT * FROM {lti_types}
455         WHERE
456             tooldomain = :tooldomain
457         AND (course = :siteid $coursefilter)
458         $statefilter
459 QUERY;
460     
461     return $DB->get_records_sql($query, array(
462         'courseid' => $courseid, 
463         'siteid' => $SITE->id, 
464         'tooldomain' => $domain, 
465         'state' => $state
466     ));
469 /**
470  * Returns all basicLTI tools configured by the administrator
471  *
472  */
473 function lti_filter_get_types($course) {
474     global $DB;
476     if(!empty($course)){
477         $filter = array('course' => $course);
478     } else {
479         $filter = array();
480     }
481     
482     return $DB->get_records('lti_types', $filter);
485 function lti_get_types_for_add_instance(){
486     global $DB, $SITE, $COURSE;
487     
488     $query = <<<QUERY
489             SELECT *
490             FROM {lti_types}
491             WHERE
492                 coursevisible = 1
493             AND (course = :siteid OR course = :courseid)
494             AND state = :active
495 QUERY;
496     
497     $admintypes = $DB->get_records_sql($query, array('siteid' => $SITE->id, 'courseid' => $COURSE->id, 'active' => LTI_TOOL_STATE_CONFIGURED));
498     
499     $types = array();
500     $types[0] = (object)array('name' => get_string('automatic', 'lti'), 'course' => $SITE->id);
501     
502     foreach($admintypes as $type) {
503         $types[$type->id] = $type;
504     }
505     
506     return $types;
509 function lti_get_domain_from_url($url){
510     $matches = array();
511     
512     if(preg_match(LTI_URL_DOMAIN_REGEX, $url, $matches)){
513         return $matches[1];
514     }
517 function lti_get_tool_by_url_match($url, $courseid = null, $state = LTI_TOOL_STATE_CONFIGURED){
518     $possibletools = lti_get_tools_by_url($url, $state, $courseid);
519     
520     return lti_get_best_tool_by_url($url, $possibletools, $courseid);
523 function lti_get_url_thumbprint($url){
524     $urlparts = parse_url(strtolower($url));
525     if(!isset($urlparts['path'])){
526         $urlparts['path'] = '';
527     }
528     
529     if(substr($urlparts['host'], 0, 3) === 'www'){
530         $urllparts['host'] = substr(3);
531     }
532     
533     return $urllower = $urlparts['host'] . '/' . $urlparts['path'];
536 function lti_get_best_tool_by_url($url, $tools, $courseid = null){
537     if(count($tools) === 0){
538         return null;
539     }
540     
541     $urllower = lti_get_url_thumbprint($url);
542     
543     foreach($tools as $tool){
544         $tool->_matchscore = 0;
545          
546         $toolbaseurllower = lti_get_url_thumbprint($tool->baseurl);
547         
548         if($urllower === $toolbaseurllower){
549             //100 points for exact thumbprint match
550             $tool->_matchscore += 100;
551         } else if(substr($urllower, 0, strlen($toolbaseurllower)) === $toolbaseurllower){
552             //50 points if tool thumbprint starts with the base URL thumbprint
553             $tool->_matchscore += 50;
554         }
555         
556         //Prefer course tools over site tools
557         if(!empty($courseid)){
558             //Minus 25 points for not matching the course id (global tools)
559             if($tool->course != $courseid){
560                 $tool->_matchscore -= 10;
561             }
562         }
563     }
564     
565     $bestmatch = array_reduce($tools, function($value, $tool){
566         if($tool->_matchscore > $value->_matchscore){
567             return $tool;
568         } else {
569             return $value;
570         }
571         
572     }, (object)array('_matchscore' => -1));
573     
574     //None of the tools are suitable for this URL
575     if($bestmatch->_matchscore <= 0){
576         return null;
577     }
578     
579     return $bestmatch;
582 /**
583  * Prints the various configured tool types
584  *
585  */
586 function lti_filter_print_types() {
587     global $CFG;
589     $types = lti_filter_get_types();
590     if (!empty($types)) {
591         echo '<ul>';
592         foreach ($types as $type) {
593             echo '<li>'.
594             $type->name.
595             '<span class="commands">'.
596             '<a class="editing_update" href="typessettings.php?action=update&amp;id='.$type->id.'&amp;sesskey='.sesskey().'" title="Update">'.
597             '<img class="iconsmall" alt="Update" src="'.$CFG->wwwroot.'/pix/t/edit.gif"/>'.
598             '</a>'.
599             '<a class="editing_delete" href="typessettings.php?action=delete&amp;id='.$type->id.'&amp;sesskey='.sesskey().'" title="Delete">'.
600             '<img class="iconsmall" alt="Delete" src="'.$CFG->wwwroot.'/pix/t/delete.gif"/>'.
601             '</a>'.
602             '</span>'.
603             '</li>';
605         }
606         echo '</ul>';
607     } else {
608         echo '<div class="message">';
609         echo get_string('notypes', 'lti');
610         echo '</div>';
611     }
614 /**
615  * Delete a Basic LTI configuration
616  *
617  * @param int $id   Configuration id
618  */
619 function lti_delete_type($id) {
620     global $DB;
622     //We should probably just copy the launch URL to the tool instances in this case... using a single query
623     /*
624     $instances = $DB->get_records('lti', array('typeid' => $id));
625     foreach ($instances as $instance) {
626         $instance->typeid = 0;
627         $DB->update_record('lti', $instance);
628     }*/
630     $DB->delete_records('lti_types', array('id' => $id));
631     $DB->delete_records('lti_types_config', array('typeid' => $id));
634 function lti_set_state_for_type($id, $state){
635     global $DB;
636     
637     $DB->update_record('lti_types', array('id' => $id, 'state' => $state));
640 /**
641  * Transforms a basic LTI object to an array
642  *
643  * @param object $ltiobject    Basic LTI object
644  *
645  * @return array Basic LTI configuration details
646  */
647 function lti_get_config($ltiobject) {
648     $typeconfig = array();
649     $typeconfig = (array)$ltiobject;
650     $additionalconfig = lti_get_type_config($ltiobject->typeid);
651     $typeconfig = array_merge($typeconfig, $additionalconfig);
652     return $typeconfig;
655 /**
656  *
657  * Generates some of the tool configuration based on the instance details
658  *
659  * @param int $id
660  *
661  * @return Instance configuration
662  *
663  */
664 function lti_get_type_config_from_instance($id) {
665     global $DB;
667     $instance = $DB->get_record('lti', array('id' => $id));
668     $config = lti_get_config($instance);
670     $type = new stdClass();
671     $type->lti_fix = $id;
672     if (isset($config['toolurl'])) {
673         $type->lti_toolurl = $config['toolurl'];
674     }
675     if (isset($config['instructorchoicesendname'])) {
676         $type->lti_sendname = $config['instructorchoicesendname'];
677     }
678     if (isset($config['instructorchoicesendemailaddr'])) {
679         $type->lti_sendemailaddr = $config['instructorchoicesendemailaddr'];
680     }
681     if (isset($config['instructorchoiceacceptgrades'])) {
682         $type->lti_acceptgrades = $config['instructorchoiceacceptgrades'];
683     }
684     if (isset($config['instructorchoiceallowroster'])) {
685         $type->lti_allowroster = $config['instructorchoiceallowroster'];
686     }
688     if (isset($config['instructorcustomparameters'])) {
689         $type->lti_allowsetting = $config['instructorcustomparameters'];
690     }
691     return $type;
694 /**
695  * Generates some of the tool configuration based on the admin configuration details
696  *
697  * @param int $id
698  *
699  * @return Configuration details
700  */
701 function lti_get_type_type_config($id) {
702     global $DB;
704     $basicltitype = $DB->get_record('lti_types', array('id' => $id));
705     $config = lti_get_type_config($id);
707     $type->lti_typename = $basicltitype->name;
708     
709     $type->typeid = $basicltitype->id;
710     
711     $type->lti_toolurl = $basicltitype->baseurl;
712     
713     if (isset($config['resourcekey'])) {
714         $type->lti_resourcekey = $config['resourcekey'];
715     }
716     if (isset($config['password'])) {
717         $type->lti_password = $config['password'];
718     }
720     if (isset($config['sendname'])) {
721         $type->lti_sendname = $config['sendname'];
722     }
723     if (isset($config['instructorchoicesendname'])){
724         $type->lti_instructorchoicesendname = $config['instructorchoicesendname'];
725     }
726     if (isset($config['sendemailaddr'])){
727         $type->lti_sendemailaddr = $config['sendemailaddr'];
728     }
729     if (isset($config['instructorchoicesendemailaddr'])){
730         $type->lti_instructorchoicesendemailaddr = $config['instructorchoicesendemailaddr'];
731     }
732     if (isset($config['acceptgrades'])){
733         $type->lti_acceptgrades = $config['acceptgrades'];
734     }
735     if (isset($config['instructorchoiceacceptgrades'])){
736         $type->lti_instructorchoiceacceptgrades = $config['instructorchoiceacceptgrades'];
737     }
738     if (isset($config['allowroster'])){
739         $type->lti_allowroster = $config['allowroster'];
740     }
741     if (isset($config['instructorchoiceallowroster'])){
742         $type->lti_instructorchoiceallowroster = $config['instructorchoiceallowroster'];
743     }
745     if (isset($config['customparameters'])) {
746         $type->lti_customparameters = $config['customparameters'];
747     }
749     if (isset($config['organizationid'])) {
750         $type->lti_organizationid = $config['organizationid'];
751     }
752     if (isset($config['organizationurl'])) {
753         $type->lti_organizationurl = $config['organizationurl'];
754     }
755     if (isset($config['organizationdescr'])) {
756         $type->lti_organizationdescr = $config['organizationdescr'];
757     }
758     if (isset($config['launchcontainer'])) {
759         $type->lti_launchcontainer = $config['launchcontainer'];
760     }
761     
762     if (isset($config['coursevisible'])) {
763         $type->lti_coursevisible = $config['coursevisible'];
764     }
765     
766     if (isset($config['debuglaunch'])) {
767         $type->lti_debuglaunch = $config['debuglaunch'];
768     }
769     
770     if (isset($config['module_class_type'])) {
771             $type->lti_module_class_type = $config['module_class_type'];
772     }
774     return $type;
777 function lti_prepare_type_for_save($type, $config){
778     $type->baseurl = $config->lti_toolurl;
779     $type->tooldomain = lti_get_domain_from_url($config->lti_toolurl);
780     $type->name = $config->lti_typename;
781     
782     $type->coursevisible = !empty($config->lti_coursevisible) ? $config->lti_coursevisible : 0;
783     $config->lti_coursevisible = $type->coursevisible;
784     
785     $type->timemodified = time();
786     
787     unset ($config->lti_typename);
788     unset ($config->lti_toolurl);
791 function lti_update_type($type, $config){
792     global $DB;
793     
794     lti_prepare_type_for_save($type, $config);
795     
796     if ($DB->update_record('lti_types', $type)) {
797         foreach ($config as $key => $value) {
798             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
799                 $record = new StdClass();
800                 $record->typeid = $type->id;
801                 $record->name = substr($key, 4);
802                 $record->value = $value;
803                 
804                 lti_update_config($record);
805             }
806         }
807     }
810 function lti_add_type($type, $config){
811     global $USER, $SITE, $DB;
812     
813     lti_prepare_type_for_save($type, $config);
814     
815     if(!isset($type->state)){
816         $type->state = LTI_TOOL_STATE_PENDING;
817     }
818     
819     if(!isset($type->timecreated)){
820         $type->timecreated = time();
821     }
822     
823     if(!isset($type->createdby)){
824         $type->createdby = $USER->id;
825     }
826     
827     if(!isset($type->course)){
828         $type->course = $SITE->id;
829     }
830     
831     //Create a salt value to be used for signing passed data to extension services
832     //The outcome service uses the service salt on the instance. This can be used
833     //for communication with services not related to a specific LTI instance.
834     $config->lti_servicesalt = uniqid('', true);
836     $id = $DB->insert_record('lti_types', $type);
838     if ($id) {
839         foreach ($config as $key => $value) {
840             if (substr($key, 0, 4)=='lti_' && !is_null($value)) {
841                 $record = new StdClass();
842                 $record->typeid = $id;
843                 $record->name = substr($key, 4);
844                 $record->value = $value;
846                 lti_add_config($record);
847             }
848         }
849     }
850     
851     return $id;
854 /**
855  * Add a tool configuration in the database
856  *
857  * @param $config   Tool configuration
858  *
859  * @return int Record id number
860  */
861 function lti_add_config($config) {
862     global $DB;
864     return $DB->insert_record('lti_types_config', $config);
867 /**
868  * Updates a tool configuration in the database
869  *
870  * @param $config   Tool configuration
871  *
872  * @return Record id number
873  */
874 function lti_update_config($config) {
875     global $DB;
877     $return = true;
878     $old = $DB->get_record('lti_types_config', array('typeid' => $config->typeid, 'name' => $config->name));
879     
880     if ($old) {
881         $config->id = $old->id;
882         $return = $DB->update_record('lti_types_config', $config);
883     } else {
884         $return = $DB->insert_record('lti_types_config', $config);
885     }
886     return $return;
889 /**
890  * Signs the petition to launch the external tool using OAuth
891  *
892  * @param $oldparms     Parameters to be passed for signing
893  * @param $endpoint     url of the external tool
894  * @param $method       Method for sending the parameters (e.g. POST)
895  * @param $oauth_consumoer_key          Key
896  * @param $oauth_consumoer_secret       Secret
897  * @param $submittext  The text for the submit button
898  * @param $orgid       LMS name
899  * @param $orgdesc     LMS key
900  */
901 function lti_sign_parameters($oldparms, $endpoint, $method, $oauthconsumerkey, $oauthconsumersecret, $submittext, $orgid /*, $orgdesc*/) {
902     global $lastbasestring;
903     $parms = $oldparms;
904     $parms["lti_version"] = "LTI-1p0";
905     $parms["lti_message_type"] = "basic-lti-launch-request";
906     if ( $orgid ) {
907         $parms["tool_consumer_instance_guid"] = $orgid;
908     }
909     /* Suppress this for now - Chuck
910     if ( $orgdesc ) $parms["tool_consumer_instance_description"] = $orgdesc;
911     */
912     $parms["ext_submit"] = $submittext;
914     $testtoken = '';
916     $hmacmethod = new lti\OAuthSignatureMethod_HMAC_SHA1();
917     $testconsumer = new lti\OAuthConsumer($oauthconsumerkey, $oauthconsumersecret, null);
919     $accreq = lti\OAuthRequest::from_consumer_and_token($testconsumer, $testtoken, $method, $endpoint, $parms);
920     $accreq->sign_request($hmacmethod, $testconsumer, $testtoken);
922     // Pass this back up "out of band" for debugging
923     $lastbasestring = $accreq->get_signature_base_string();
925     $newparms = $accreq->get_parameters();
927     return $newparms;
930 /**
931  * Posts the launch petition HTML
932  *
933  * @param $newparms     Signed parameters
934  * @param $endpoint     URL of the external tool
935  * @param $debug        Debug (true/false)
936  */
937 function lti_post_launch_html($newparms, $endpoint, $debug=false) {
938     global $lastbasestring;
939     
940     $r = "<form action=\"".$endpoint."\" name=\"ltiLaunchForm\" id=\"ltiLaunchForm\" method=\"post\" encType=\"application/x-www-form-urlencoded\">\n";
941     
942     $submittext = $newparms['ext_submit'];
944     // Contruct html for the launch parameters
945     foreach ($newparms as $key => $value) {
946         $key = htmlspecialchars($key);
947         $value = htmlspecialchars($value);
948         if ( $key == "ext_submit" ) {
949             $r .= "<input type=\"submit\" name=\"";
950         } else {
951             $r .= "<input type=\"hidden\" name=\"";
952         }
953         $r .= $key;
954         $r .= "\" value=\"";
955         $r .= $value;
956         $r .= "\"/>\n";
957     }
959     if ( $debug ) {
960         $r .= "<script language=\"javascript\"> \n";
961         $r .= "  //<![CDATA[ \n";
962         $r .= "function basicltiDebugToggle() {\n";
963         $r .= "    var ele = document.getElementById(\"basicltiDebug\");\n";
964         $r .= "    if(ele.style.display == \"block\") {\n";
965         $r .= "        ele.style.display = \"none\";\n";
966         $r .= "    }\n";
967         $r .= "    else {\n";
968         $r .= "        ele.style.display = \"block\";\n";
969         $r .= "    }\n";
970         $r .= "} \n";
971         $r .= "  //]]> \n";
972         $r .= "</script>\n";
973         $r .= "<a id=\"displayText\" href=\"javascript:basicltiDebugToggle();\">";
974         $r .= get_string("toggle_debug_data", "lti")."</a>\n";
975         $r .= "<div id=\"basicltiDebug\" style=\"display:none\">\n";
976         $r .=  "<b>".get_string("basiclti_endpoint", "lti")."</b><br/>\n";
977         $r .= $endpoint . "<br/>\n&nbsp;<br/>\n";
978         $r .=  "<b>".get_string("basiclti_parameters", "lti")."</b><br/>\n";
979         foreach ($newparms as $key => $value) {
980             $key = htmlspecialchars($key);
981             $value = htmlspecialchars($value);
982             $r .= "$key = $value<br/>\n";
983         }
984         $r .= "&nbsp;<br/>\n";
985         $r .= "<p><b>".get_string("basiclti_base_string", "lti")."</b><br/>\n".$lastbasestring."</p>\n";
986         $r .= "</div>\n";
987     }
988     $r .= "</form>\n";
990     if ( ! $debug ) {
991         $ext_submit = "ext_submit";
992         $ext_submit_text = $submittext;
993         $r .= " <script type=\"text/javascript\"> \n" .
994             "  //<![CDATA[ \n" .
995             "    document.getElementById(\"ltiLaunchForm\").style.display = \"none\";\n" .
996             "    nei = document.createElement('input');\n" .
997             "    nei.setAttribute('type', 'hidden');\n" .
998             "    nei.setAttribute('name', '".$ext_submit."');\n" .
999             "    nei.setAttribute('value', '".$ext_submit_text."');\n" .
1000             "    document.getElementById(\"ltiLaunchForm\").appendChild(nei);\n" .
1001             "    document.ltiLaunchForm.submit(); \n" .
1002             "  //]]> \n" .
1003             " </script> \n";
1004     }
1005     return $r;
1008 function lti_get_type($typeid){
1009     global $DB;
1010     
1011     return $DB->get_record('lti_types', array('id' => $typeid));