Merge branch 'MDL-67372-master' of git://github.com/rezaies/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     $types[] = $defaultitem;
224     // Add items defined in ltisource plugins.
225     foreach (core_component::get_plugin_list('ltisource') as $pluginname => $dir) {
226         // LTISOURCE plugins can also implement callback get_shortcuts() to add items to the activity chooser.
227         // The return values are the same as of the 'mod' callbacks except that $defaultitem is only passed for reference and
228         // should not be added to the return value.
229         if ($moretypes = component_callback("ltisource_$pluginname", 'get_shortcuts', array($defaultitem))) {
230             $types = array_merge($types, $moretypes);
231         }
232     }
233     return $types;
236 /**
237  * Given a coursemodule object, this function returns the extra
238  * information needed to print this activity in various places.
239  * For this module we just need to support external urls as
240  * activity icons
241  *
242  * @param stdClass $coursemodule
243  * @return cached_cm_info info
244  */
245 function lti_get_coursemodule_info($coursemodule) {
246     global $DB, $CFG;
247     require_once($CFG->dirroot.'/mod/lti/locallib.php');
249     if (!$lti = $DB->get_record('lti', array('id' => $coursemodule->instance),
250             'icon, secureicon, intro, introformat, name, typeid, toolurl, launchcontainer')) {
251         return null;
252     }
254     $info = new cached_cm_info();
256     if ($coursemodule->showdescription) {
257         // Convert intro to html. Do not filter cached version, filters run at display time.
258         $info->content = format_module_intro('lti', $lti, $coursemodule->id, false);
259     }
261     if (!empty($lti->typeid)) {
262         $toolconfig = lti_get_type_config($lti->typeid);
263     } else if ($tool = lti_get_tool_by_url_match($lti->toolurl)) {
264         $toolconfig = lti_get_type_config($tool->id);
265     } else {
266         $toolconfig = array();
267     }
269     // We want to use the right icon based on whether the
270     // current page is being requested over http or https.
271     if (lti_request_is_using_ssl() &&
272         (!empty($lti->secureicon) || (isset($toolconfig['secureicon']) && !empty($toolconfig['secureicon'])))) {
273         if (!empty($lti->secureicon)) {
274             $info->iconurl = new moodle_url($lti->secureicon);
275         } else {
276             $info->iconurl = new moodle_url($toolconfig['secureicon']);
277         }
278     } else if (!empty($lti->icon)) {
279         $info->iconurl = new moodle_url($lti->icon);
280     } else if (isset($toolconfig['icon']) && !empty($toolconfig['icon'])) {
281         $info->iconurl = new moodle_url($toolconfig['icon']);
282     }
284     // Does the link open in a new window?
285     $launchcontainer = lti_get_launch_container($lti, $toolconfig);
286     if ($launchcontainer == LTI_LAUNCH_CONTAINER_WINDOW) {
287         $launchurl = new moodle_url('/mod/lti/launch.php', array('id' => $coursemodule->id));
288         $info->onclick = "window.open('" . $launchurl->out(false) . "', 'lti-".$coursemodule->id."'); return false;";
289     }
291     $info->name = $lti->name;
293     return $info;
296 /**
297  * Return a small object with summary information about what a
298  * user has done with a given particular instance of this module
299  * Used for user activity reports.
300  * $return->time = the time they did it
301  * $return->info = a short text description
302  *
303  * @return null
304  * @TODO: implement this moodle function (if needed)
305  **/
306 function lti_user_outline($course, $user, $mod, $basiclti) {
307     return null;
310 /**
311  * Print a detailed representation of what a user has done with
312  * a given particular instance of this module, for user activity reports.
313  *
314  * @return boolean
315  * @TODO: implement this moodle function (if needed)
316  **/
317 function lti_user_complete($course, $user, $mod, $basiclti) {
318     return true;
321 /**
322  * Given a course and a time, this module should find recent activity
323  * that has occurred in basiclti activities and print it out.
324  * Return true if there was output, or false is there was none.
325  *
326  * @uses $CFG
327  * @return boolean
328  * @TODO: implement this moodle function
329  **/
330 function lti_print_recent_activity($course, $isteacher, $timestart) {
331     return false;  //  True if anything was printed, otherwise false.
334 /**
335  * Function to be run periodically according to the moodle cron
336  * This function searches for things that need to be done, such
337  * as sending out mail, toggling flags etc ...
338  *
339  * @uses $CFG
340  * @return boolean
341  **/
342 function lti_cron () {
343     return true;
346 /**
347  * Must return an array of grades for a given instance of this module,
348  * indexed by user.  It also returns a maximum allowed grade.
349  *
350  * Example:
351  *    $return->grades = array of grades;
352  *    $return->maxgrade = maximum allowed grade;
353  *
354  *    return $return;
355  *
356  * @param int $basicltiid ID of an instance of this module
357  * @return mixed Null or object with an array of grades and with the maximum grade
358  *
359  * @TODO: implement this moodle function (if needed)
360  **/
361 function lti_grades($basicltiid) {
362     return null;
365 /**
366  * @deprecated since Moodle 3.8
367  */
368 function lti_scale_used() {
369     throw new coding_exception('lti_scale_used() can not be used anymore. Plugins can implement ' .
370         '<modname>_scale_used_anywhere, all implementations of <modname>_scale_used are now ignored');
373 /**
374  * Checks if scale is being used by any instance of basiclti.
375  * This function was added in 1.9
376  *
377  * This is used to find out if scale used anywhere
378  * @param $scaleid int
379  * @return boolean True if the scale is used by any basiclti
380  *
381  */
382 function lti_scale_used_anywhere($scaleid) {
383     global $DB;
385     if ($scaleid and $DB->record_exists('lti', array('grade' => -$scaleid))) {
386         return true;
387     } else {
388         return false;
389     }
392 /**
393  * Execute post-install custom actions for the module
394  * This function was added in 1.9
395  *
396  * @return boolean true if success, false on error
397  */
398 function lti_install() {
399      return true;
402 /**
403  * Execute post-uninstall custom actions for the module
404  * This function was added in 1.9
405  *
406  * @return boolean true if success, false on error
407  */
408 function lti_uninstall() {
409     return true;
412 /**
413  * Returns available Basic LTI types
414  *
415  * @return array of basicLTI types
416  */
417 function lti_get_lti_types() {
418     global $DB;
420     return $DB->get_records('lti_types', null, 'state DESC, timemodified DESC');
423 /**
424  * Returns available Basic LTI types that match the given
425  * tool proxy id
426  *
427  * @param int $toolproxyid Tool proxy id
428  * @return array of basicLTI types
429  */
430 function lti_get_lti_types_from_proxy_id($toolproxyid) {
431     global $DB;
433     return $DB->get_records('lti_types', array('toolproxyid' => $toolproxyid), 'state DESC, timemodified DESC');
436 /**
437  * Create grade item for given basiclti
438  *
439  * @category grade
440  * @param object $basiclti object with extra cmidnumber
441  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
442  * @return int 0 if ok, error code otherwise
443  */
444 function lti_grade_item_update($basiclti, $grades = null) {
445     global $CFG;
446     require_once($CFG->libdir.'/gradelib.php');
447     require_once($CFG->dirroot.'/mod/lti/servicelib.php');
449     if (!lti_accepts_grades($basiclti)) {
450         return 0;
451     }
453     $params = array('itemname' => $basiclti->name, 'idnumber' => $basiclti->cmidnumber);
455     if ($basiclti->grade > 0) {
456         $params['gradetype'] = GRADE_TYPE_VALUE;
457         $params['grademax']  = $basiclti->grade;
458         $params['grademin']  = 0;
460     } else if ($basiclti->grade < 0) {
461         $params['gradetype'] = GRADE_TYPE_SCALE;
462         $params['scaleid']   = -$basiclti->grade;
464     } else {
465         $params['gradetype'] = GRADE_TYPE_TEXT; // Allow text comments only.
466     }
468     if ($grades === 'reset') {
469         $params['reset'] = true;
470         $grades = null;
471     }
473     return grade_update('mod/lti', $basiclti->course, 'mod', 'lti', $basiclti->id, 0, $grades, $params);
476 /**
477  * Update activity grades
478  *
479  * @param stdClass $basiclti The LTI instance
480  * @param int      $userid Specific user only, 0 means all.
481  * @param bool     $nullifnone Not used
482  */
483 function lti_update_grades($basiclti, $userid=0, $nullifnone=true) {
484     global $CFG;
485     require_once($CFG->dirroot.'/mod/lti/servicelib.php');
486     // LTI doesn't have its own grade table so the only thing to do is update the grade item.
487     if (lti_accepts_grades($basiclti)) {
488         lti_grade_item_update($basiclti);
489     }
492 /**
493  * Delete grade item for given basiclti
494  *
495  * @category grade
496  * @param object $basiclti object
497  * @return object basiclti
498  */
499 function lti_grade_item_delete($basiclti) {
500     global $CFG;
501     require_once($CFG->libdir.'/gradelib.php');
503     return grade_update('mod/lti', $basiclti->course, 'mod', 'lti', $basiclti->id, 0, null, array('deleted' => 1));
506 /**
507  * Log post actions
508  *
509  * @return array
510  */
511 function lti_get_post_actions() {
512     return array();
515 /**
516  * Log view actions
517  *
518  * @return array
519  */
520 function lti_get_view_actions() {
521     return array('view all', 'view');
524 /**
525  * Mark the activity completed (if required) and trigger the course_module_viewed event.
526  *
527  * @param  stdClass $lti        lti object
528  * @param  stdClass $course     course object
529  * @param  stdClass $cm         course module object
530  * @param  stdClass $context    context object
531  * @since Moodle 3.0
532  */
533 function lti_view($lti, $course, $cm, $context) {
535     // Trigger course_module_viewed event.
536     $params = array(
537         'context' => $context,
538         'objectid' => $lti->id
539     );
541     $event = \mod_lti\event\course_module_viewed::create($params);
542     $event->add_record_snapshot('course_modules', $cm);
543     $event->add_record_snapshot('course', $course);
544     $event->add_record_snapshot('lti', $lti);
545     $event->trigger();
547     // Completion.
548     $completion = new completion_info($course);
549     $completion->set_module_viewed($cm);
552 /**
553  * Check if the module has any update that affects the current user since a given time.
554  *
555  * @param  cm_info $cm course module data
556  * @param  int $from the time to check updates from
557  * @param  array $filter  if we need to check only specific updates
558  * @return stdClass an object with the different type of areas indicating if they were updated or not
559  * @since Moodle 3.2
560  */
561 function lti_check_updates_since(cm_info $cm, $from, $filter = array()) {
562     global $DB, $USER;
564     $updates = course_check_module_updates_since($cm, $from, array(), $filter);
566     // Check if there is a new submission.
567     $updates->submissions = (object) array('updated' => false);
568     $select = 'ltiid = :id AND userid = :userid AND (datesubmitted > :since1 OR dateupdated > :since2)';
569     $params = array('id' => $cm->instance, 'userid' => $USER->id, 'since1' => $from, 'since2' => $from);
570     $submissions = $DB->get_records_select('lti_submission', $select, $params, '', 'id');
571     if (!empty($submissions)) {
572         $updates->submissions->updated = true;
573         $updates->submissions->itemids = array_keys($submissions);
574     }
576     // Now, teachers should see other students updates.
577     if (has_capability('mod/lti:manage', $cm->context)) {
578         $select = 'ltiid = :id AND (datesubmitted > :since1 OR dateupdated > :since2)';
579         $params = array('id' => $cm->instance, 'since1' => $from, 'since2' => $from);
581         if (groups_get_activity_groupmode($cm) == SEPARATEGROUPS) {
582             $groupusers = array_keys(groups_get_activity_shared_group_members($cm));
583             if (empty($groupusers)) {
584                 return $updates;
585             }
586             list($insql, $inparams) = $DB->get_in_or_equal($groupusers, SQL_PARAMS_NAMED);
587             $select .= ' AND userid ' . $insql;
588             $params = array_merge($params, $inparams);
589         }
591         $updates->usersubmissions = (object) array('updated' => false);
592         $submissions = $DB->get_records_select('lti_submission', $select, $params, '', 'id');
593         if (!empty($submissions)) {
594             $updates->usersubmissions->updated = true;
595             $updates->usersubmissions->itemids = array_keys($submissions);
596         }
597     }
599     return $updates;
602 /**
603  * Get icon mapping for font-awesome.
604  */
605 function mod_lti_get_fontawesome_icon_map() {
606     return [
607         'mod_lti:warning' => 'fa-exclamation text-warning',
608     ];
611 /**
612  * This function receives a calendar event and returns the action associated with it, or null if there is none.
613  *
614  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
615  * is not displayed on the block.
616  *
617  * @param calendar_event $event
618  * @param \core_calendar\action_factory $factory
619  * @param int $userid User id to use for all capability checks, etc. Set to 0 for current user (default).
620  * @return \core_calendar\local\event\entities\action_interface|null
621  */
622 function mod_lti_core_calendar_provide_event_action(calendar_event $event,
623                                                       \core_calendar\action_factory $factory,
624                                                       int $userid = 0) {
625     global $USER;
627     if (empty($userid)) {
628         $userid = $USER->id;
629     }
631     $cm = get_fast_modinfo($event->courseid, $userid)->instances['lti'][$event->instance];
633     if (!$cm->uservisible) {
634         // The module is not visible to the user for any reason.
635         return null;
636     }
638     $completion = new \completion_info($cm->get_course());
640     $completiondata = $completion->get_data($cm, false, $userid);
642     if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {
643         return null;
644     }
646     return $factory->create_instance(
647         get_string('view'),
648         new \moodle_url('/mod/lti/view.php', ['id' => $cm->id]),
649         1,
650         true
651     );