CVS log for loncom/lti/ltiutils.pm

Up to [LON-CAPA] / loncom / lti

Request diff between arbitrary revisions

Keyword substitution: kv
Default branch: MAIN

- Where session launch was via LTI-mediated deep-linking from another CMS
  and launch payload included URL and uniqueID for return of score:
  (a) successful score transfer
     - logged in course's activity log (action = EXPORT)
     - passback information stored in student's $cdom_$cnum_lp_passback.db
  (b) unsuccessful score transfer
     - logged in student's activity log and lonnet.log
     - passback information stored in course's linkprot_passback_pending.db

- For 2.11.4 (modified)
  Include changes in 1.20

- Remove trailing white space
- Indenting -- replace tab with spsces

- When scoretype is decimal, send value with 4 decimal places, i.e., a
  number between 0.0000 and 1.0000

- For 2.11.4 (modified)
  - Reverse changes in 1.17.2.1. Include changes in 1.19.
  - Replace use of LONCAPA::LWPReq (in 2.12) with LWP::UserAgent (in 2.11).

- Bugs 6754 and 6907
  - Return of grades to launcher CMS supported for resources or folders
    accessed via LTI-mediated deep link.
  - Support option: "Encrypt stored consumer secrets defined in domain"
  - Signing of LTI payloads for roster retrieval, passback of grades,
    and callback to logput launcher CMS session all now occur on
    primary library server for course's domain.

- For 2.11.4 (modified)
  Include changes in 1.18

- Bug 6754
  Documentation says to use Encode::decode('UTF-8',$string) instead of
  Encode::decode_utf8($string) for data exchange.

- For 2.11.4 (modified)
  - Reverse one change in 1.17.2.1 to support call to md5_hex().
  - Replace use of LONCAPA::LWPReq (in 2.12) with LWP::UserAgent (in 2.11).

- For 2.11.4 (modified)
  Retain only those routines needed for LTI Consumer without grade passback
  or roster enrollment and LTI Provider without username (re-authentication
  needed).

- For 2.11.2 (modified)
  Retain only those routines used to support LON-CAPA as LTI Consumer.
  Remove passback and roster options, and related routines.

- Bug 6754. LON-CAPA as LTI Provider.
  Domain configuration to support session expiration in LON-CAPA,
  after user logs out of LTI Consumer which originally launched session,
  (if Consumer supports logoutServiceUrl; e.g. custom_logout_url in Canvas).

- Bug 6754 LON-CAPA as LTI Provider
  - Support LTI Basic Outcomes Service (1.1) in which grade (a decimal) is
    included in XML in the request body (with oauth_body_hash in the header).

- Bug 6754 LON-CAPA as LTI Provider
  - Support requests to /adm/service/passback and /adm/service/roster in
    which OAuth data in request header.
  - Support LTI Basic Outcomes Service (1.1) in which grade (a decimal) is
    included in XML in the request body (with oauth_body_hash in the header).
  - LTI Provider domain configuration to set grade passback using either
    Outcomes Service (1.1) -- the default -- or Outcomes extension (1.0).

- Bug 6754 LON-CAPA as LTI Provider
  - Checking if gradesecret has expired.
    - config in days; convert to seconds
    - config items are gradesecret & gradesecretdate

- Bug 6754 LON-CAPA as LTI Provider
  - create a real symb from the launch URL.
  - calls to &sign_params() need to include 4 args before the fifth one
    (params hashref).

- Bug 6754 LON-CAPA as LTI Provider
  - Add documentation.
  - Seed rand() in create_passwd routine.

- Bug 6754 LON-CAPA as LTI Provider
  - Support LTI Extension: Context Memberships Service, whereby launch of
    Consumer can trigger Provider to request course roster.
  - Code moved from ltiauth.pm to routines in ltiutils.pm:
    &get_lc_roles(), &create_user() and &enrolluser(); &create_passwd() routine
    also moved.
  - Code moved from &parse_roster() to &get_roster() in ltiutils.pm.
  - New routines: &batchaddroster(), &datechange_check(), &store_passbackurl()
    added to support roster updates, (including saving user-specific values
    for: lis_result_sourcedid, used for passback of grades to Consumer.

- Bug 6754 LON-CAPA as LTI Provider
  - Pass grades back to the LTI Consumer which launched the LTI session.
  - Any problemstatus settings of "No" are ignored.

- Seed rand before generating nonce.

- Bug 6754 LON-CAPA as LTI Provider
  - LTI launch can be for a published .sequence or .page
  - LTI launch can be for a composite page.

- Bug 6754 LON-CAPA as LTI Provider
  - No page flip arrows in inline menu if LTI launch was or a resource
  - No forward arrow if LTI launch was for map and this is last resource.
  - No reverse arrow if LTI launch was for map and this is first resource.
  - No Contents in inline breadcrumbs if LTI launch was for resource or map.

- Bug 6754 LON-CAPA as LTI Provider
  - Original LTI launch of LON-CAPA is for a resource, a map, or an entire
    course, and display is for iframe, tab or window; retain this in %env.

- Extract signature from string returned by &get_service_id() for comparison
  with signature in the sourcedid received from an LTI provider.

- Fix typos in comments

- Bug 6754 LON-CAPA as LTI Consumer
  - Signature method can be HMAC-SHA1 (default), or HMAC-SHA256, if LTI
    Provider supports it.

- Sequential numbering of errors when requesting service from LTI Consumer
  to store grades or retrieve roster.

Bug 6754 LTI Integration
- ltiutils.pm contains common LTI routines (to facilitate re-use).
  - &check_nonce() moved from ltiauth.pm to ltiutils.pm.
  - &set_callback_secret() moved from lonexttool.pm to ltiutils.pm, and
    renamed &set_service_secret().
  - &sign_params(), &get_tool_lock(), and &release_tool_lock() moved from
    lonexttool.pm to ltiutils.pm
- ltiroster.pm will service requests for course membership information
  from an LTI Provider, where domain configuration for Tool permits this
  service, and launch (by Instructor( included ext_ims_lis_memberships_id.