dirname() is a slow function compared with __DIR__ and using
'/../'. Moodle has a large number of legacy files that are included
each time a page loads and is not able to use an autoloader as it is
functional code. This allows those required includes to perform as
best as possible in this situation.
This commit introduces support to the LTI module for LTI 2.0.
As well as the initial commit the following changes were made
and then squashed into the single commit for integration:
* Fixed bug in services
Fixed bug which limited characters allowed in values of template
variables (e.g. vendor ID) in service endpoints.
Changed language file to refer to tool registrations rather than
tool proxies.
* Refactored service classes
Moved classes relating to services into areas where Moodle will
autoload them
* Ran code through code checker
Removed all errors reported by the Code checker module
excluding third-party OAuth.php file.
* UI improvements
Mainly when adding an external tool to a course - fields which
should not be changed for a selected tool are either hidden or
disabled. Admin settings page now shows the Tool Registration
name against a tool rather than the launch URL, and the
registration URL replaces the GUID on the tool registrations
page.
* Updated tool proxy registration
Added check of tool proxy to ensure only offered capabilities
and services are included. Also check tool proxy when processing
a service request.
* Code review changes
Some fixes based on code review by Mark Nielsen and addition of
some PHPDocs comments.
* Updates from code/PHPdocs checks
Removed use of eval and corrected invalid PHPdocs for new
functions/classes
* Corrected namespace error and incorrect string terminator
* Updates based on forum feedback
Added dependencies and backup, restore and uninstall methods for
ltiservice subplugins.
Changed most uses of is_null to empty
* Updated custom parameters test
Updated test_split_custom_parameters to include new function
parameters.
Corrected PHPdoc entry for lti_split_custom_parameters
Fixed incorrect line separators in ltiservice.php
* Added require_capability to registrationreturn.php
* SQL and EOL updates
Moved PHP variable in SQL into a named parameter
Improved checks for end-of-line characters to include CR and LF
on their own or together
* Check for semicolon separators
Semicolon separators in custom parameters are changed to EOL
characters when upgrading to the 2014100100 version.
* Remove unused file
basiclti.js file not being used so removed.
* Adjust line lengths
Split long lines in upgrade.php
* Added savepoint to upgrade.php
savepoint omitted from earlier update to upgrade.php
* Updated namespaces and upgrade
Service and resource classes moved into .../local/...
Upgrade SQL moved into a function and unit test created
* Updated lti_tool_proxies table
Added indices and foreign keys to lti_tool_proxies table
* Fixed formatting and documentation issues
* ltiservice class moved into local
* Replaced lti_scale_used comments
Put back commented out code for lti_scale_used
* Removed redundant sesskey code
* Fixed namespace and path check
Updated ltiservice namespace for move into local
Added check for existence of $_SERVER['PATH_INFO']
* Updated upgrade code
Added indices and keys to lti_tool_settings table when upgrading
Fixed errors in upgradelib_test.php (thanks to jleyva)
Update SQL to use Moodle functions
* Use of empty with class method
PHP 5.4 does not like the use of empty with a class method so saved the
value to a variable first. PHP 5.5 seems to accept the use of a method
with empty.
* Removed redundant indices
Removed creation of indices for foreign keys on lti_tool_settings table
from install.xml and upgrade.php
* Fixes based on feedback
Minor changes and corrections based on review in JIRA
* Fixed bug in toolproxy service
Corrected bug which failed to respond properly to an invalid request
Also updated upgrade.txt file
* Improved admin navigation
Added the manage tool registrations page as a separate entry on the
admin menu (within a folder named LTI). Made this entry the current
position for the related pages.
* Updated PHPdocs with class names
Added class names with namespaces to PHPdocs to replace generic
references to "object"
* Changed object to iframe
Use of object tag in register.php changed to use an iframe tag in line
with the similar update made to view.php.
* Improved registration process
A message is now displayed if the registration page has not been loaded
in the iframe within 20 seconds. If a user is returned to Moodle
without a tool proxy being sent, the registration is moved back from
pending to configured.
* Fixes for integration
Removed comment - the template is the default path unless overridden, so
get_path and get_template should both be defined.
Added comment and intval to fix the issue with obtaining an error
reason.
* LTI service related changes:
** Fixing exceptions in OAuth library.
** Added new launch option, Existing window: replaces entire page with the LTI object.
** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests.
** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches.
** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name.
** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners.
** Fix the grade deletion service. Was deleting the grade item instead of just the grade.
** Send error response when LTI instance does not accept grades and grades are being sent.
** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default.
* Changes for ltisource plugins:
** Can now to plug into backup/restore.
** Can now have settings.php files.
** Can now hook into the LTI launch and edit parameters.
* Several grade changes:
** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade.
** No longer assumes that grade is out of 100.
** Replaced modl/lti:grade capability with mod/lti:view.
* JS on mod/lti/view.php for resizing the content object has been converted to YUI3.
* Fixed misspellings in language file.
* Added hooks for log post and view actions.
* Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
I ran the software through the certification and caught a few nits:
The error return is 'failure' not 'error'
The spec says that it needs to return 'failure' for out of range or non-numeric grades
The result score needs a language tag, hard-coded as 'en'
Setting a grade multiplied by 100 but reading the grade did not divide by 100
All those are now fixed with this patch as well as this bit of cruft:
I removed the "extension service url" as it is not implemented in service.php
Feel free to review and adjust - probably the one place you might want to refactor
is that I put code to catch out-of-range-and non-numeric in
lti_parse_grade_replace_message and threw an exception on error and then caught
it in service.php and sent back the 'failure' message. Feel free to refactor a
bit if you see this done in a cleaner manner.
