Merge branch 'MDL-62815_mod_lti' of git://github.com/davosmith/moodle
[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  * List of features supported in URL module
53  * @param string $feature FEATURE_xx constant for requested feature
54  * @return mixed True if module supports feature, false if not, null if doesn't know
55  */
56 function lti_supports($feature) {
57     switch ($feature) {
58         case FEATURE_GROUPS:
59         case FEATURE_GROUPINGS:
60             return false;
61         case FEATURE_MOD_INTRO:
62         case FEATURE_COMPLETION_TRACKS_VIEWS:
63         case FEATURE_GRADE_HAS_GRADE:
64         case FEATURE_GRADE_OUTCOMES:
65         case FEATURE_BACKUP_MOODLE2:
66         case FEATURE_SHOW_DESCRIPTION:
67             return true;
69         default:
70             return null;
71     }
72 }
74 /**
75  * Given an object containing all the necessary data,
76  * (defined by the form in mod.html) this function
77  * will create a new instance and return the id number
78  * of the new instance.
79  *
80  * @param object $instance An object from the form in mod.html
81  * @return int The id of the newly inserted basiclti record
82  **/
83 function lti_add_instance($lti, $mform) {
84     global $DB, $CFG;
85     require_once($CFG->dirroot.'/mod/lti/locallib.php');
87     if (!isset($lti->toolurl)) {
88         $lti->toolurl = '';
89     }
91     lti_load_tool_if_cartridge($lti);
93     $lti->timecreated = time();
94     $lti->timemodified = $lti->timecreated;
95     $lti->servicesalt = uniqid('', true);
96     if (!isset($lti->typeid)) {
97         $lti->typeid = null;
98     }
100     lti_force_type_config_settings($lti, lti_get_type_config_by_instance($lti));
102     if (empty($lti->typeid) && isset($lti->urlmatchedtypeid)) {
103         $lti->typeid = $lti->urlmatchedtypeid;
104     }
106     if (!isset($lti->instructorchoiceacceptgrades) || $lti->instructorchoiceacceptgrades != LTI_SETTING_ALWAYS) {
107         // The instance does not accept grades back from the provider, so set to "No grade" value 0.
108         $lti->grade = 0;
109     }
111     $lti->id = $DB->insert_record('lti', $lti);
113     if (isset($lti->instructorchoiceacceptgrades) && $lti->instructorchoiceacceptgrades == LTI_SETTING_ALWAYS) {
114         if (!isset($lti->cmidnumber)) {
115             $lti->cmidnumber = '';
116         }
118         lti_grade_item_update($lti);
119     }
121     $completiontimeexpected = !empty($lti->completionexpected) ? $lti->completionexpected : null;
122     \core_completion\api::update_completion_date_event($lti->coursemodule, 'lti', $lti->id, $completiontimeexpected);
124     return $lti->id;
127 /**
128  * Given an object containing all the necessary data,
129  * (defined by the form in mod.html) this function
130  * will update an existing instance with new data.
131  *
132  * @param object $instance An object from the form in mod.html
133  * @return boolean Success/Fail
134  **/
135 function lti_update_instance($lti, $mform) {
136     global $DB, $CFG;
137     require_once($CFG->dirroot.'/mod/lti/locallib.php');
139     lti_load_tool_if_cartridge($lti);
141     $lti->timemodified = time();
142     $lti->id = $lti->instance;
144     if (!isset($lti->showtitlelaunch)) {
145         $lti->showtitlelaunch = 0;
146     }
148     if (!isset($lti->showdescriptionlaunch)) {
149         $lti->showdescriptionlaunch = 0;
150     }
152     lti_force_type_config_settings($lti, lti_get_type_config_by_instance($lti));
154     if (isset($lti->instructorchoiceacceptgrades) && $lti->instructorchoiceacceptgrades == LTI_SETTING_ALWAYS) {
155         lti_grade_item_update($lti);
156     } else {
157         // Instance is no longer accepting grades from Provider, set grade to "No grade" value 0.
158         $lti->grade = 0;
159         $lti->instructorchoiceacceptgrades = 0;
161         lti_grade_item_delete($lti);
162     }
164     if ($lti->typeid == 0 && isset($lti->urlmatchedtypeid)) {
165         $lti->typeid = $lti->urlmatchedtypeid;
166     }
168     $completiontimeexpected = !empty($lti->completionexpected) ? $lti->completionexpected : null;
169     \core_completion\api::update_completion_date_event($lti->coursemodule, 'lti', $lti->id, $completiontimeexpected);
171     return $DB->update_record('lti', $lti);
174 /**
175  * Given an ID of an instance of this module,
176  * this function will permanently delete the instance
177  * and any data that depends on it.
178  *
179  * @param int $id Id of the module instance
180  * @return boolean Success/Failure
181  **/
182 function lti_delete_instance($id) {
183     global $DB;
185     if (! $basiclti = $DB->get_record("lti", array("id" => $id))) {
186         return false;
187     }
189     $result = true;
191     // Delete any dependent records here.
192     lti_grade_item_delete($basiclti);
194     $ltitype = $DB->get_record('lti_types', array('id' => $basiclti->typeid));
195     if ($ltitype) {
196         $DB->delete_records('lti_tool_settings',
197             array('toolproxyid' => $ltitype->toolproxyid, 'course' => $basiclti->course, 'coursemoduleid' => $id));
198     }
200     $cm = get_coursemodule_from_instance('lti', $id);
201     \core_completion\api::update_completion_date_event($cm->id, 'lti', $id, null);
203     // We must delete the module record after we delete the grade item.
204     return $DB->delete_records("lti", array("id" => $basiclti->id));
207 /**
208  * Return aliases of this activity. LTI should have an alias for each configured tool type
209  * This is so you can add an external tool types directly to the activity chooser
210  *
211  * @param stdClass $defaultitem default item that would be added to the activity chooser if this callback was not present.
212  *     It has properties: archetype, name, title, help, icon, link
213  * @return array An array of aliases for this activity. Each element is an object with same list of properties as $defaultitem,
214  *     plus an additional property, helplink.
215  *     Properties title and link are required
216  **/
217 function lti_get_shortcuts($defaultitem) {
218     global $CFG, $COURSE;
219     require_once($CFG->dirroot.'/mod/lti/locallib.php');
221     $types = lti_get_configured_types($COURSE->id, $defaultitem->link->param('sr'));
222     if (has_capability('mod/lti:addmanualinstance', context_course::instance($COURSE->id))) {
223         $types[] = $defaultitem;
224     }
226     // Add items defined in ltisource plugins.
227     foreach (core_component::get_plugin_list('ltisource') as $pluginname => $dir) {
228         // LTISOURCE plugins can also implement callback get_shortcuts() to add items to the activity chooser.
229         // The return values are the same as of the 'mod' callbacks except that $defaultitem is only passed for reference and
230         // should not be added to the return value.
231         if ($moretypes = component_callback("ltisource_$pluginname", 'get_shortcuts', array($defaultitem))) {
232             $types = array_merge($types, $moretypes);
233         }
234     }
235     return $types;
238 /**
239  * Given a coursemodule object, this function returns the extra
240  * information needed to print this activity in various places.
241  * For this module we just need to support external urls as
242  * activity icons
243  *
244  * @param stdClass $coursemodule
245  * @return cached_cm_info info
246  */
247 function lti_get_coursemodule_info($coursemodule) {
248     global $DB, $CFG;
249     require_once($CFG->dirroot.'/mod/lti/locallib.php');
251     if (!$lti = $DB->get_record('lti', array('id' => $coursemodule->instance),
252             'icon, secureicon, intro, introformat, name, typeid, toolurl, launchcontainer')) {
253         return null;
254     }
256     $info = new cached_cm_info();
258     if ($coursemodule->showdescription) {
259         // Convert intro to html. Do not filter cached version, filters run at display time.
260         $info->content = format_module_intro('lti', $lti, $coursemodule->id, false);
261     }
263     if (!empty($lti->typeid)) {
264         $toolconfig = lti_get_type_config($lti->typeid);
265     } else if ($tool = lti_get_tool_by_url_match($lti->toolurl)) {
266         $toolconfig = lti_get_type_config($tool->id);
267     } else {
268         $toolconfig = array();
269     }
271     // We want to use the right icon based on whether the
272     // current page is being requested over http or https.
273     if (lti_request_is_using_ssl() &&
274         (!empty($lti->secureicon) || (isset($toolconfig['secureicon']) && !empty($toolconfig['secureicon'])))) {
275         if (!empty($lti->secureicon)) {
276             $info->iconurl = new moodle_url($lti->secureicon);
277         } else {
278             $info->iconurl = new moodle_url($toolconfig['secureicon']);
279         }
280     } else if (!empty($lti->icon)) {
281         $info->iconurl = new moodle_url($lti->icon);
282     } else if (isset($toolconfig['icon']) && !empty($toolconfig['icon'])) {
283         $info->iconurl = new moodle_url($toolconfig['icon']);
284     }
286     // Does the link open in a new window?
287     $launchcontainer = lti_get_launch_container($lti, $toolconfig);
288     if ($launchcontainer == LTI_LAUNCH_CONTAINER_WINDOW) {
289         $launchurl = new moodle_url('/mod/lti/launch.php', array('id' => $coursemodule->id));
290         $info->onclick = "window.open('" . $launchurl->out(false) . "', 'lti-".$coursemodule->id."'); return false;";
291     }
293     $info->name = $lti->name;
295     return $info;
298 /**
299  * Return a small object with summary information about what a
300  * user has done with a given particular instance of this module
301  * Used for user activity reports.
302  * $return->time = the time they did it
303  * $return->info = a short text description
304  *
305  * @return null
306  * @TODO: implement this moodle function (if needed)
307  **/
308 function lti_user_outline($course, $user, $mod, $basiclti) {
309     return null;
312 /**
313  * Print a detailed representation of what a user has done with
314  * a given particular instance of this module, for user activity reports.
315  *
316  * @return boolean
317  * @TODO: implement this moodle function (if needed)
318  **/
319 function lti_user_complete($course, $user, $mod, $basiclti) {
320     return true;
323 /**
324  * Given a course and a time, this module should find recent activity
325  * that has occurred in basiclti activities and print it out.
326  * Return true if there was output, or false is there was none.
327  *
328  * @uses $CFG
329  * @return boolean
330  * @TODO: implement this moodle function
331  **/
332 function lti_print_recent_activity($course, $isteacher, $timestart) {
333     return false;  //  True if anything was printed, otherwise false.
336 /**
337  * Function to be run periodically according to the moodle cron
338  * This function searches for things that need to be done, such
339  * as sending out mail, toggling flags etc ...
340  *
341  * @uses $CFG
342  * @return boolean
343  **/
344 function lti_cron () {
345     return true;
348 /**
349  * Must return an array of grades for a given instance of this module,
350  * indexed by user.  It also returns a maximum allowed grade.
351  *
352  * Example:
353  *    $return->grades = array of grades;
354  *    $return->maxgrade = maximum allowed grade;
355  *
356  *    return $return;
357  *
358  * @param int $basicltiid ID of an instance of this module
359  * @return mixed Null or object with an array of grades and with the maximum grade
360  *
361  * @TODO: implement this moodle function (if needed)
362  **/
363 function lti_grades($basicltiid) {
364     return null;
367 /**
368  * @deprecated since Moodle 3.8
369  */
370 function lti_scale_used() {
371     throw new coding_exception('lti_scale_used() can not be used anymore. Plugins can implement ' .
372         '<modname>_scale_used_anywhere, all implementations of <modname>_scale_used are now ignored');
375 /**
376  * Checks if scale is being used by any instance of basiclti.
377  * This function was added in 1.9
378  *
379  * This is used to find out if scale used anywhere
380  * @param $scaleid int
381  * @return boolean True if the scale is used by any basiclti
382  *
383  */
384 function lti_scale_used_anywhere($scaleid) {
385     global $DB;
387     if ($scaleid and $DB->record_exists('lti', array('grade' => -$scaleid))) {
388         return true;
389     } else {
390         return false;
391     }
394 /**
395  * Execute post-install custom actions for the module
396  * This function was added in 1.9
397  *
398  * @return boolean true if success, false on error
399  */
400 function lti_install() {
401      return true;
404 /**
405  * Execute post-uninstall custom actions for the module
406  * This function was added in 1.9
407  *
408  * @return boolean true if success, false on error
409  */
410 function lti_uninstall() {
411     return true;
414 /**
415  * Returns available Basic LTI types
416  *
417  * @return array of basicLTI types
418  */
419 function lti_get_lti_types() {
420     global $DB;
422     return $DB->get_records('lti_types', null, 'state DESC, timemodified DESC');
425 /**
426  * Returns available Basic LTI types that match the given
427  * tool proxy id
428  *
429  * @param int $toolproxyid Tool proxy id
430  * @return array of basicLTI types
431  */
432 function lti_get_lti_types_from_proxy_id($toolproxyid) {
433     global $DB;
435     return $DB->get_records('lti_types', array('toolproxyid' => $toolproxyid), 'state DESC, timemodified DESC');
438 /**
439  * Create grade item for given basiclti
440  *
441  * @category grade
442  * @param object $basiclti object with extra cmidnumber
443  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
444  * @return int 0 if ok, error code otherwise
445  */
446 function lti_grade_item_update($basiclti, $grades = null) {
447     global $CFG;
448     require_once($CFG->libdir.'/gradelib.php');
449     require_once($CFG->dirroot.'/mod/lti/servicelib.php');
451     if (!lti_accepts_grades($basiclti)) {
452         return 0;
453     }
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  * Update activity grades
480  *
481  * @param stdClass $basiclti The LTI instance
482  * @param int      $userid Specific user only, 0 means all.
483  * @param bool     $nullifnone Not used
484  */
485 function lti_update_grades($basiclti, $userid=0, $nullifnone=true) {
486     global $CFG;
487     require_once($CFG->dirroot.'/mod/lti/servicelib.php');
488     // LTI doesn't have its own grade table so the only thing to do is update the grade item.
489     if (lti_accepts_grades($basiclti)) {
490         lti_grade_item_update($basiclti);
491     }
494 /**
495  * Delete grade item for given basiclti
496  *
497  * @category grade
498  * @param object $basiclti object
499  * @return object basiclti
500  */
501 function lti_grade_item_delete($basiclti) {
502     global $CFG;
503     require_once($CFG->libdir.'/gradelib.php');
505     return grade_update('mod/lti', $basiclti->course, 'mod', 'lti', $basiclti->id, 0, null, array('deleted' => 1));
508 /**
509  * Log post actions
510  *
511  * @return array
512  */
513 function lti_get_post_actions() {
514     return array();
517 /**
518  * Log view actions
519  *
520  * @return array
521  */
522 function lti_get_view_actions() {
523     return array('view all', 'view');
526 /**
527  * Mark the activity completed (if required) and trigger the course_module_viewed event.
528  *
529  * @param  stdClass $lti        lti object
530  * @param  stdClass $course     course object
531  * @param  stdClass $cm         course module object
532  * @param  stdClass $context    context object
533  * @since Moodle 3.0
534  */
535 function lti_view($lti, $course, $cm, $context) {
537     // Trigger course_module_viewed event.
538     $params = array(
539         'context' => $context,
540         'objectid' => $lti->id
541     );
543     $event = \mod_lti\event\course_module_viewed::create($params);
544     $event->add_record_snapshot('course_modules', $cm);
545     $event->add_record_snapshot('course', $course);
546     $event->add_record_snapshot('lti', $lti);
547     $event->trigger();
549     // Completion.
550     $completion = new completion_info($course);
551     $completion->set_module_viewed($cm);
554 /**
555  * Check if the module has any update that affects the current user since a given time.
556  *
557  * @param  cm_info $cm course module data
558  * @param  int $from the time to check updates from
559  * @param  array $filter  if we need to check only specific updates
560  * @return stdClass an object with the different type of areas indicating if they were updated or not
561  * @since Moodle 3.2
562  */
563 function lti_check_updates_since(cm_info $cm, $from, $filter = array()) {
564     global $DB, $USER;
566     $updates = course_check_module_updates_since($cm, $from, array(), $filter);
568     // Check if there is a new submission.
569     $updates->submissions = (object) array('updated' => false);
570     $select = 'ltiid = :id AND userid = :userid AND (datesubmitted > :since1 OR dateupdated > :since2)';
571     $params = array('id' => $cm->instance, 'userid' => $USER->id, 'since1' => $from, 'since2' => $from);
572     $submissions = $DB->get_records_select('lti_submission', $select, $params, '', 'id');
573     if (!empty($submissions)) {
574         $updates->submissions->updated = true;
575         $updates->submissions->itemids = array_keys($submissions);
576     }
578     // Now, teachers should see other students updates.
579     if (has_capability('mod/lti:manage', $cm->context)) {
580         $select = 'ltiid = :id AND (datesubmitted > :since1 OR dateupdated > :since2)';
581         $params = array('id' => $cm->instance, 'since1' => $from, 'since2' => $from);
583         if (groups_get_activity_groupmode($cm) == SEPARATEGROUPS) {
584             $groupusers = array_keys(groups_get_activity_shared_group_members($cm));
585             if (empty($groupusers)) {
586                 return $updates;
587             }
588             list($insql, $inparams) = $DB->get_in_or_equal($groupusers, SQL_PARAMS_NAMED);
589             $select .= ' AND userid ' . $insql;
590             $params = array_merge($params, $inparams);
591         }
593         $updates->usersubmissions = (object) array('updated' => false);
594         $submissions = $DB->get_records_select('lti_submission', $select, $params, '', 'id');
595         if (!empty($submissions)) {
596             $updates->usersubmissions->updated = true;
597             $updates->usersubmissions->itemids = array_keys($submissions);
598         }
599     }
601     return $updates;
604 /**
605  * Get icon mapping for font-awesome.
606  */
607 function mod_lti_get_fontawesome_icon_map() {
608     return [
609         'mod_lti:warning' => 'fa-exclamation text-warning',
610     ];
613 /**
614  * This function receives a calendar event and returns the action associated with it, or null if there is none.
615  *
616  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
617  * is not displayed on the block.
618  *
619  * @param calendar_event $event
620  * @param \core_calendar\action_factory $factory
621  * @param int $userid User id to use for all capability checks, etc. Set to 0 for current user (default).
622  * @return \core_calendar\local\event\entities\action_interface|null
623  */
624 function mod_lti_core_calendar_provide_event_action(calendar_event $event,
625                                                       \core_calendar\action_factory $factory,
626                                                       int $userid = 0) {
627     global $USER;
629     if (empty($userid)) {
630         $userid = $USER->id;
631     }
633     $cm = get_fast_modinfo($event->courseid, $userid)->instances['lti'][$event->instance];
635     if (!$cm->uservisible) {
636         // The module is not visible to the user for any reason.
637         return null;
638     }
640     $completion = new \completion_info($cm->get_course());
642     $completiondata = $completion->get_data($cm, false, $userid);
644     if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {
645         return null;
646     }
648     return $factory->create_instance(
649         get_string('view'),
650         new \moodle_url('/mod/lti/view.php', ['id' => $cm->id]),
651         1,
652         true
653     );