MDL-51624 mod_lti: New Web Service mod_lti_view_lti
[moodle.git] / mod / lti / lib.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 a 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 /**
52  * Returns all other caps used in module.
53  *
54  * @return array
55  */
56 function lti_get_extra_capabilities() {
57     return array('moodle/site:accessallgroups');
58 }
60 /**
61  * List of features supported in URL module
62  * @param string $feature FEATURE_xx constant for requested feature
63  * @return mixed True if module supports feature, false if not, null if doesn't know
64  */
65 function lti_supports($feature) {
66     switch ($feature) {
67         case FEATURE_GROUPS:
68         case FEATURE_GROUPINGS:
69             return false;
70         case FEATURE_MOD_INTRO:
71         case FEATURE_COMPLETION_TRACKS_VIEWS:
72         case FEATURE_GRADE_HAS_GRADE:
73         case FEATURE_GRADE_OUTCOMES:
74         case FEATURE_BACKUP_MOODLE2:
75         case FEATURE_SHOW_DESCRIPTION:
76             return true;
78         default:
79             return null;
80     }
81 }
83 /**
84  * Given an object containing all the necessary data,
85  * (defined by the form in mod.html) this function
86  * will create a new instance and return the id number
87  * of the new instance.
88  *
89  * @param object $instance An object from the form in mod.html
90  * @return int The id of the newly inserted basiclti record
91  **/
92 function lti_add_instance($lti, $mform) {
93     global $DB, $CFG;
94     require_once($CFG->dirroot.'/mod/lti/locallib.php');
96     if (!isset($lti->toolurl)) {
97         $lti->toolurl = '';
98     }
100     $lti->timecreated = time();
101     $lti->timemodified = $lti->timecreated;
102     $lti->servicesalt = uniqid('', true);
104     lti_force_type_config_settings($lti, lti_get_type_config_by_instance($lti));
106     if (empty($lti->typeid) && isset($lti->urlmatchedtypeid)) {
107         $lti->typeid = $lti->urlmatchedtypeid;
108     }
110     if (!isset($lti->instructorchoiceacceptgrades) || $lti->instructorchoiceacceptgrades != LTI_SETTING_ALWAYS) {
111         // The instance does not accept grades back from the provider, so set to "No grade" value 0.
112         $lti->grade = 0;
113     }
115     $lti->id = $DB->insert_record('lti', $lti);
117     if (isset($lti->instructorchoiceacceptgrades) && $lti->instructorchoiceacceptgrades == LTI_SETTING_ALWAYS) {
118         if (!isset($lti->cmidnumber)) {
119             $lti->cmidnumber = '';
120         }
122         lti_grade_item_update($lti);
123     }
125     return $lti->id;
128 /**
129  * Given an object containing all the necessary data,
130  * (defined by the form in mod.html) this function
131  * will update an existing instance with new data.
132  *
133  * @param object $instance An object from the form in mod.html
134  * @return boolean Success/Fail
135  **/
136 function lti_update_instance($lti, $mform) {
137     global $DB, $CFG;
138     require_once($CFG->dirroot.'/mod/lti/locallib.php');
140     $lti->timemodified = time();
141     $lti->id = $lti->instance;
143     if (!isset($lti->showtitlelaunch)) {
144         $lti->showtitlelaunch = 0;
145     }
147     if (!isset($lti->showdescriptionlaunch)) {
148         $lti->showdescriptionlaunch = 0;
149     }
151     lti_force_type_config_settings($lti, lti_get_type_config_by_instance($lti));
153     if (isset($lti->instructorchoiceacceptgrades) && $lti->instructorchoiceacceptgrades == LTI_SETTING_ALWAYS) {
154         lti_grade_item_update($lti);
155     } else {
156         // Instance is no longer accepting grades from Provider, set grade to "No grade" value 0.
157         $lti->grade = 0;
158         $lti->instructorchoiceacceptgrades = 0;
160         lti_grade_item_delete($lti);
161     }
163     if ($lti->typeid == 0 && isset($lti->urlmatchedtypeid)) {
164         $lti->typeid = $lti->urlmatchedtypeid;
165     }
167     return $DB->update_record('lti', $lti);
170 /**
171  * Given an ID of an instance of this module,
172  * this function will permanently delete the instance
173  * and any data that depends on it.
174  *
175  * @param int $id Id of the module instance
176  * @return boolean Success/Failure
177  **/
178 function lti_delete_instance($id) {
179     global $DB;
181     if (! $basiclti = $DB->get_record("lti", array("id" => $id))) {
182         return false;
183     }
185     $result = true;
187     // Delete any dependent records here.
188     lti_grade_item_delete($basiclti);
190     $ltitype = $DB->get_record('lti_types', array('id' => $basiclti->typeid));
191     $DB->delete_records('lti_tool_settings',
192         array('toolproxyid' => $ltitype->toolproxyid, 'course' => $basiclti->course, 'coursemoduleid' => $id));
194     return $DB->delete_records("lti", array("id" => $basiclti->id));
197 function lti_get_types() {
198     global $OUTPUT;
200     $subtypes = array();
201     foreach (get_plugin_list('ltisource') as $name => $dir) {
202         if ($moretypes = component_callback("ltisource_$name", 'get_types')) {
203             $subtypes = array_merge($subtypes, $moretypes);
204         }
205     }
206     if (empty($subtypes)) {
207         return MOD_SUBTYPE_NO_CHILDREN;
208     }
210     $types = array();
212     $type           = new stdClass();
213     $type->modclass = MOD_CLASS_ACTIVITY;
214     $type->type     = 'lti_group_start';
215     $type->typestr  = '--'.get_string('modulenameplural', 'mod_lti');
216     $types[]        = $type;
218     $link     = get_string('modulename_link', 'mod_lti');
219     $linktext = get_string('morehelp');
220     $help     = get_string('modulename_help', 'mod_lti');
221     $help    .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
223     $type           = new stdClass();
224     $type->modclass = MOD_CLASS_ACTIVITY;
225     $type->type     = '';
226     $type->typestr  = get_string('generaltool', 'mod_lti');
227     $type->help     = $help;
228     $types[]        = $type;
230     $types = array_merge($types, $subtypes);
232     $type           = new stdClass();
233     $type->modclass = MOD_CLASS_ACTIVITY;
234     $type->type     = 'lti_group_end';
235     $type->typestr  = '--';
236     $types[]        = $type;
238     return $types;
241 /**
242  * Given a coursemodule object, this function returns the extra
243  * information needed to print this activity in various places.
244  * For this module we just need to support external urls as
245  * activity icons
246  *
247  * @param stdClass $coursemodule
248  * @return cached_cm_info info
249  */
250 function lti_get_coursemodule_info($coursemodule) {
251     global $DB, $CFG;
252     require_once($CFG->dirroot.'/mod/lti/locallib.php');
254     if (!$lti = $DB->get_record('lti', array('id' => $coursemodule->instance),
255             'icon, secureicon, intro, introformat, name, typeid, toolurl, launchcontainer')) {
256         return null;
257     }
259     $info = new cached_cm_info();
261     if ($coursemodule->showdescription) {
262         // Convert intro to html. Do not filter cached version, filters run at display time.
263         $info->content = format_module_intro('lti', $lti, $coursemodule->id, false);
264     }
266     if (!empty($lti->typeid)) {
267         $toolconfig = lti_get_type_config($lti->typeid);
268     } else if ($tool = lti_get_tool_by_url_match($lti->toolurl)) {
269         $toolconfig = lti_get_type_config($tool->id);
270     } else {
271         $toolconfig = array();
272     }
274     // We want to use the right icon based on whether the
275     // current page is being requested over http or https.
276     if (lti_request_is_using_ssl() &&
277         (!empty($lti->secureicon) || (isset($toolconfig['secureicon']) && !empty($toolconfig['secureicon'])))) {
278         if (!empty($lti->secureicon)) {
279             $info->iconurl = new moodle_url($lti->secureicon);
280         } else {
281             $info->iconurl = new moodle_url($toolconfig['secureicon']);
282         }
283     } else if (!empty($lti->icon)) {
284         $info->iconurl = new moodle_url($lti->icon);
285     } else if (isset($toolconfig['icon']) && !empty($toolconfig['icon'])) {
286         $info->iconurl = new moodle_url($toolconfig['icon']);
287     }
289     // Does the link open in a new window?
290     $launchcontainer = lti_get_launch_container($lti, $toolconfig);
291     if ($launchcontainer == LTI_LAUNCH_CONTAINER_WINDOW) {
292         $launchurl = new moodle_url('/mod/lti/launch.php', array('id' => $coursemodule->id));
293         $info->onclick = "window.open('" . $launchurl->out(false) . "', 'lti'); return false;";
294     }
296     $info->name = $lti->name;
298     return $info;
301 /**
302  * Return a small object with summary information about what a
303  * user has done with a given particular instance of this module
304  * Used for user activity reports.
305  * $return->time = the time they did it
306  * $return->info = a short text description
307  *
308  * @return null
309  * @TODO: implement this moodle function (if needed)
310  **/
311 function lti_user_outline($course, $user, $mod, $basiclti) {
312     return null;
315 /**
316  * Print a detailed representation of what a user has done with
317  * a given particular instance of this module, for user activity reports.
318  *
319  * @return boolean
320  * @TODO: implement this moodle function (if needed)
321  **/
322 function lti_user_complete($course, $user, $mod, $basiclti) {
323     return true;
326 /**
327  * Given a course and a time, this module should find recent activity
328  * that has occurred in basiclti activities and print it out.
329  * Return true if there was output, or false is there was none.
330  *
331  * @uses $CFG
332  * @return boolean
333  * @TODO: implement this moodle function
334  **/
335 function lti_print_recent_activity($course, $isteacher, $timestart) {
336     return false;  //  True if anything was printed, otherwise false.
339 /**
340  * Function to be run periodically according to the moodle cron
341  * This function searches for things that need to be done, such
342  * as sending out mail, toggling flags etc ...
343  *
344  * @uses $CFG
345  * @return boolean
346  **/
347 function lti_cron () {
348     return true;
351 /**
352  * Must return an array of grades for a given instance of this module,
353  * indexed by user.  It also returns a maximum allowed grade.
354  *
355  * Example:
356  *    $return->grades = array of grades;
357  *    $return->maxgrade = maximum allowed grade;
358  *
359  *    return $return;
360  *
361  * @param int $basicltiid ID of an instance of this module
362  * @return mixed Null or object with an array of grades and with the maximum grade
363  *
364  * @TODO: implement this moodle function (if needed)
365  **/
366 function lti_grades($basicltiid) {
367     return null;
370 /**
371  * This function returns if a scale is being used by one basiclti
372  * it it has support for grading and scales. Commented code should be
373  * modified if necessary. See forum, glossary or journal modules
374  * as reference.
375  *
376  * @param int $basicltiid ID of an instance of this module
377  * @return mixed
378  *
379  * @TODO: implement this moodle function (if needed)
380  **/
381 function lti_scale_used ($basicltiid, $scaleid) {
382     $return = false;
384     // $rec = get_record("basiclti","id","$basicltiid","scale","-$scaleid");
385     //
386     // if (!empty($rec)  && !empty($scaleid)) {
387     //     $return = true;
388     // }
390     return $return;
393 /**
394  * Checks if scale is being used by any instance of basiclti.
395  * This function was added in 1.9
396  *
397  * This is used to find out if scale used anywhere
398  * @param $scaleid int
399  * @return boolean True if the scale is used by any basiclti
400  *
401  */
402 function lti_scale_used_anywhere($scaleid) {
403     global $DB;
405     if ($scaleid and $DB->record_exists('lti', array('grade' => -$scaleid))) {
406         return true;
407     } else {
408         return false;
409     }
412 /**
413  * Execute post-install custom actions for the module
414  * This function was added in 1.9
415  *
416  * @return boolean true if success, false on error
417  */
418 function lti_install() {
419      return true;
422 /**
423  * Execute post-uninstall custom actions for the module
424  * This function was added in 1.9
425  *
426  * @return boolean true if success, false on error
427  */
428 function lti_uninstall() {
429     return true;
432 /**
433  * Returns available Basic LTI types
434  *
435  * @return array of basicLTI types
436  */
437 function lti_get_lti_types() {
438     global $DB;
440     return $DB->get_records('lti_types');
443 /**
444  * Create grade item for given basiclti
445  *
446  * @category grade
447  * @param object $basiclti object with extra cmidnumber
448  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
449  * @return int 0 if ok, error code otherwise
450  */
451 function lti_grade_item_update($basiclti, $grades = null) {
452     global $CFG;
453     require_once($CFG->libdir.'/gradelib.php');
455     $params = array('itemname' => $basiclti->name, 'idnumber' => $basiclti->cmidnumber);
457     if ($basiclti->grade > 0) {
458         $params['gradetype'] = GRADE_TYPE_VALUE;
459         $params['grademax']  = $basiclti->grade;
460         $params['grademin']  = 0;
462     } else if ($basiclti->grade < 0) {
463         $params['gradetype'] = GRADE_TYPE_SCALE;
464         $params['scaleid']   = -$basiclti->grade;
466     } else {
467         $params['gradetype'] = GRADE_TYPE_TEXT; // Allow text comments only.
468     }
470     if ($grades === 'reset') {
471         $params['reset'] = true;
472         $grades = null;
473     }
475     return grade_update('mod/lti', $basiclti->course, 'mod', 'lti', $basiclti->id, 0, $grades, $params);
478 /**
479  * Delete grade item for given basiclti
480  *
481  * @category grade
482  * @param object $basiclti object
483  * @return object basiclti
484  */
485 function lti_grade_item_delete($basiclti) {
486     global $CFG;
487     require_once($CFG->libdir.'/gradelib.php');
489     return grade_update('mod/lti', $basiclti->course, 'mod', 'lti', $basiclti->id, 0, null, array('deleted' => 1));
492 /**
493  * Log post actions
494  *
495  * @return array
496  */
497 function lti_get_post_actions() {
498     return array();
501 /**
502  * Log view actions
503  *
504  * @return array
505  */
506 function lti_get_view_actions() {
507     return array('view all', 'view');
510 /**
511  * Mark the activity completed (if required) and trigger the course_module_viewed event.
512  *
513  * @param  stdClass $lti        lti object
514  * @param  stdClass $course     course object
515  * @param  stdClass $cm         course module object
516  * @param  stdClass $context    context object
517  * @since Moodle 3.0
518  */
519 function lti_view($lti, $course, $cm, $context) {
521     // Trigger course_module_viewed event.
522     $params = array(
523         'context' => $context,
524         'objectid' => $lti->id
525     );
527     $event = \mod_lti\event\course_module_viewed::create($params);
528     $event->add_record_snapshot('course_modules', $cm);
529     $event->add_record_snapshot('course', $course);
530     $event->add_record_snapshot('lti', $lti);
531     $event->trigger();
533     // Completion.
534     $completion = new completion_info($course);
535     $completion->set_module_viewed($cm);