CVS log for loncom/enrollment/localenroll.pm

Up to [LON-CAPA] / loncom / enrollment

Request diff between arbitrary revisions

Keyword substitution: kv
Default branch: MAIN

- Domain configuration to allow authentication of an alternate username, if
  username entered differs from real username in a predictable way,
  e.g., username entered in log-in page was email address (userid@example.tld)
  instead of just userid.

- Provide mechanism to (optionally) log counts to autoupdate.log when running
  Autoupdate.pl to update user information for users in a domain.

- Typo in rev. 1.61

- Support customization in localenroll.pm to eliminate ambiguity in extraction
  of institutional section from institutional course section for automated
  enrollment.

- Support institutional policies which allow a Course Coordinator affiliated
  with a cross-listed course to be automatically listed as a co-owner in a
  course.

- Typo.

- Checking if enrollment data can be accessed for a course uses a single
  call to localenroll::check_instclasses(), mediated via lonnet/lond.

- Domain configuration to override domain's helpdesk settings for e-mail
  recipients, and optionally added text, based on requester's affiliation
  (e.g., faculty, staff or student).

- Typo.

- Bug 6808. New course container -- "Placement" for Placement Tests.
  - Student's score on a placement test can be exported by customizing
    localenroll.pm in /home/httpd/lib/perl on domain's library server.
  - When a placement test is completed by the student, the chain:
    lonnet::auto_export_grades() > lond::auto_export_grades_handler()
    > localenroll::export_grades() is used to export grades (e.g. to
    a CMS).

- Bug 6808. New course container -- "Placement" for Placement Tests.
  Work in progress.

- Bug 5596.
  Add a routine to lonnet.pm -- get_multiple_instusers() which makes one call
  to lond > lonsql > localenroll.pm to retrieve institutional data
  for multiple users when adding users via file upload, to minimize number
  of sleep() commands needed. Supports up to 1s per query, on localenroll.pm
  side if adding more than 100 new users.

- Add new routine to localenroll.pm -- &get_multusersinfo() -- to retrieve
    institutional data for users being added via user file upload.

  Note: if this routine does not exist in localenroll.pm, will fall-back
  to retrieving institutional data using a separate call to &get_userinfo()
  for each user.

- Update perldoc for validate_crsreq() and crsreq_updates().

- Update documentation for validate_crsreq()

- Update documentation for fetch_enrollment() to reflect change in mechanism
  for defining institutional status types in a domain.

- Update documentation for deprecated inst_usertypes() routine (DC domain
  configuration web GUI used instead in 2.11.0).

- Post-processing for course requests.
  - localenroll::crsreq_updates() can populate hash ref:
    $outgoing->{'createdactions'}->{'environment'} with a course's
    self-enrollment settings when processing course request.

- Pass default start access date and default end access dates to
  localenroll::crsreq_updates() so they are available to course request
  validator.

- Course requests for unofficial courses, textbook courses and communities
  can include validation.
  - lonrequestcourse.pm
    - New subroutine: pending_validation_form() generates web form used to
      proceed to validation (can be local script, or script on remote server)
    - Prepended new arg to args passed to: &print_request_outcome() and
      &process_request()  -- $lonhost (lonHostID of current server).
 - localenroll.pm
   - &validate_crsreq() accepts additional (optional) arg -- ref to hash of
     custominfo.
   - &crsreq_updates() supports additional action type ('prevalidate') which
     is used to generate form elements needed for validation of request.
 - lond
   - &validate_crsreq_handler() accepts additional -- $customdata
     which is a frozen hash of custominfo passed in from lonnet.pm
 - lonnet.pm
   - &auto_courserequest_validation() accepts additional arg -- ref to hash of
     custominfo (contains key => value for custm form elements retrieved from
     course request review page.

- New routine in localenroll.pm -- &crsreq_updates() -- to support
  domain-specific operations during course request process.
- Tabbed interface used for textbook-type course requests, one tab
  for course creation, one for request logs.
- Column for unique codes included in user's request log display, if
  domain has enabled use of unique codes.
- Correction to LON-CAPA messaging of unique code -- recipient should
  be requestor.

- Course credits for a particular institutional code can be provided as a
  third item returned by localenroll::validate_instcode()
- Course credits can be specified for an official course (or retrieved from
  localenroll::validate_instcode) or an unofficial course as part of a course
  request
- Credits earned for a course can also be different for a specific student
  (e.g., retrieved from institutional classlist data), or specified when
  CC adds a student to a course via the web GUI.

- Make Autoupdate.pl suitable for institutions which only allow a LON-CAPA
  server to retrieve institutional user information when the user's
  username is included in the query.

- Typo in documentation.

- Update stub for &new_course() to include new arg: co-owners.

- Update stub and documentation for possible_instcode()
  - requires a fifth argument - $code_order (ref to an array) which
    specifies the order in which the components of an institutional code need to
    be combined.  (Note: this order may differ from the order in which the
    components are presented in select boxes (in $codetitles array ref).
    e.g., at MSU:
    @{$codetitles} = ("Year","Semester","Department","Number");
    @{$code_order} = ("Semester","Year","Department","Number");

- &Apache::lonnet::auto_validate_instcode() now returns an array containing:
  - the outcome ('valid' - or some other message) and
  - an (optional) brief description for the course retrieved from
     localenroll::validate_instcode() which likewise returns an array of 2 items.
- Used to set cdescr form element in the course request form for official courses when the instcode has been validated.

- lond
  - update documentation in lond for validate_instcode_handler().
  - &crsreq_checks_handler()
     - include ref to reqtypes array
        - official, unofficial, community
     as arg in call to &localenroll::crsreq_checks_handler().

- enrollment::localenroll.pm
  - update &validate_instcode() to accept three args, and modify documentation.
  - add &crsreq_checks() to determine which types/affiliations should have 'validate'
    choice for processing course requests.
  - add validate_crsreq() to determine next action for a course request for which
    process type is 'validate'.

- msu::localenroll.pm
  - Add &crsreq_checks() and &validate_crsreq().
  - Update &validate_instcode()
    - owner is $username:$domain
    - outcome for valid course is 'valid' instead of 'ok'.
    - correct text of a couple of $outcome messages were course was not validated.

- lonnet::auto_validate_instcode() used to check if requestor's status permits automatic processing of the course request.
- Additional arguments now passed (besides $instcode and $owner) include comma-separated list of requestor's institutional affiliations (e.g., Faculty, Staff etc.) and comma-separated list of sections.

lond:validate_instcode_handler()
- Passes additional arguments on to corresponding routine in localenroll.pm.

localenroll.pm - update stub args and documentation for validate_instcode().

- &localenroll:possible_instcodes() takes an addition arg: $code_order which indicates the order in which components of the course code should be recombined.
  - e.g., At MSU, select boxes in the course request form are in the order:
          Year Semester Department
    but the order used to create the institutional code is:
          Semester Year Department

- &lonnet::auto_get_sections()
  - $cnum arg is undefined when checking for institutional sections during the course request process.  In the is case the homeserver used to retrieve the sections is the primary library server for the domain.

- &lonnet::auto_validate_instcode() - new routine used to validate an institutional course code during course requests.
  - Note: this differs from the institutional courseID (which in the institutional code with appended institutional section).

- Request creation of official courses.
    - retrieve possible values for institutional categories.
    - used by lond::get_possible_instcodes_handler().

consistent wording:
changed "student number" to "student/employee ID"
changed "student ID" to "student/employee ID"
changed "student and eyployee IDs" to "student/employee IDs"

instcode_format() and instcode_defaults():
  - Added link to detailed help file
  - Typo

POD documentation changes

- Replace "selfenroll" with "selfcreate" in various subroutine names, and modify text which refers to self-enrollment to refer to user creation of accounts.
- Intended to clarify that these procedures relate to a user creating his/her own account in a LON-CAPA domain as opposed to self-enrolling in a course, once the user has an account.

lond::validate_user() - optional fourth and fifth arguments added in lond 1.395, replaced with a single optional argument ($checkdefauth). If true, default auth type and args retrieved using lonnet::get_domain_defaults().
- Default authentication type and argument, and language in a domain can be retrieved from lonnet::get_domain_defaults().
- lonnet::inst_rulecheck() can check format rules for e-mail addresses proposed as usernames for self-enrollment
- lonnet::inst_userrules() can retrieve rule definitions for e-mail addresses used as usernames
- loncommon::get_auth_defaults() eliminated. lonnet::get_domain_defaults() used instead
- loncommon::preferred_languages() streamlined.
- localenroll::selfenroll_rules() and localenroll::selfenroll_check() added to define rules for e-mail addresses which may not be used as usernames, and to check a proposed self-enrollment username (i.e., e-mail address) against the rules in force.

- # needed for comments.

&validate_class_access_handler() - pass the comma-separated owner list to localenroll::check_section() instead of splitting into an array. (For backward compatibility with existing localenroll::check_section() implementations.

- update the documentation for the check_section() stub in enrollment/localenroll.pm to indicate that $owner can be comma-separated list owner and co-owners.

Adding stubs for  &id_rules() and &id_check() to default localenroll.pm for
"namespacing" of user IDs.
-  &id_rules() defines rules for format of official IDs.
-  &id_check() checks if the proposed ID for a user matches these formats.

Make subroutine name in comments consistent with name in stub.

Functionality for namespacing of usernames.
- &username_rules() defines rules for formats reserved for different
- &username_check() is a routine to be used to check if the format of a username
matches one or more rules (which rules should be checked included in the args passed in).

Institutional directory search now reported as unavailable in the case where a DC has enabled directory searching via "Modify domain configuration" but either:
 (a) localenroll::get_userinfo() has not been customized, or
 (b) an error ioccurred when querying the institutional directory.

lonsql
- &do_inst_dir_search() returns 'unavailable' if the response from localenroll::get_userinfo() is not 'ok'

lonnet.pm
- &inst_directory_query() now returns a scalar and a hash.
  - scalar is the outcome of the query: 'unavailable', 'ok' or ''.
  - hash contains the search results (if any matches)

loncreateuser.pm
- Report to user that institutional directory search is unavailable if response from &lonnet::inst_directory_query() is not 'ok'.

localenroll.pm
- documentation updated
- &get_userinfo() returns 'unavailable' by default

- comment typo

Update documentation for &get_userinfo()
- begins added as a searchtype (look for matches which begin with the
  searchterm).

- Additional arguments accepted by get_userinfo() - $searchby, $searchterm, $searchtype. to allow searching of institutional directory by username, last name, or last name, first name for $srchterm.

- This search functionality to be available in loncreateuser (if permitted by domain settings).

- Documentation updated

Apparently values being set in the subroutine were not in scope back in the calling block.

Running of Autoenroll.pl and display of "Automated Enrollment Manager" link on ENRL menu now controlled by domain configuration setting.

Support automated update of instiutional users in a domain, based on domain preferences.
Autoupdate.pl --
- Institutional data now gathered for all users in a single call to localenroll.
- Correction to check to see if Autoupdate should run
- Accumulate updateable fields for all institutional types with which user is affiliated
- Use modifyuser() in lonnet to store updated user information
- affiliations_check() checks for changes in institutional status

localenroll.pm --
- correct documentation for instcodes hash reference
- allusers_info() - retrieve institutional user data for all users.
- get_userinfo() - retrieve institutional data for a single username or ID
- inst_usertypes() - provide institutional types (short and long titles).

Get regular expression fragments and order of concatenation when creating regular expressions used in course catalog search by institutional code (or parts thereof) - used by coursecatalog.pm

&check_section used to validate that a course owner has rights to access classlist data for a specific institutional class ID (including section).  Used to verify individual sections of the requested class, or crosslisted classes (and sections).

Bug 4813.  Retain backwards compatibility with legacy courses in which only a course owner's username is stored in environment.internal.courseowner, and in the course's record in nohist_courseids.db.  New courses will include username:domain (escaped) in nohist_courseids.db.  MCRS can be used to update legacy course owner information (just click "Modify Settings" button, it will be necessary to select the correct course owner where the course domain is different from the owner's domain.

Allow for the addition of new subroutines to local*.pm packages in the future, in a way that will prevent errors if undefined subroutines are called in customized versions.

- for backwards compatability username moved to last in the ist of args

Add support for student photo import from an institutional repository. Availability of photos of registered students in a course controlled by course environment parameter: 'internal.studentphoto'.  This may be configured to require initial acceptance of conditions of use by course owner.  View classlist in ENRL, and Automated Enrollment Manager now includes option to display thumbnails of student photos.  Nightly enrollment update can import student photos for students added to a course.  Student photos can be updated via the Automated Enrollment Manager.

Update documentation, now that most routines take domain as an argument to supppport use on single library servers hosting multiple domains.

Add stub for instcode_format to retrieve institutional code format information.

Calls to functions in localenroll.pm mediated by lonc/lond now include domain
in the set of passed parameters to support domain-specific variants in a single
localenroll.pm file housed on a multi-domain library server.

Automated enrollment now sets first access and last access dates for student
roles based on defaults set on course creation, and modifiable via a number
of mechanisms in the Enrollment Manager, and Automated Enrollment Manager.

The Automated Enrollment Manager now provides a utility to allow enrollment type
to be toggled between 'auto' and 'manual', so that students added via CSV file
or singly can become liable for automated update (dropping, section switching
etc.).

Fixed some typos, and updated explanation of activation and expiration dates for student roles.Replaced reference to local authentication as 'local' with correct term: 'localauth'.

Clean up extra '}'.

- setting things up so the nightly script has no effect

- putting GPL header back in

Created stub subroutines.  Included documentation to explain how each should
work.  Added an additional create_password subroutine that is called by
Enrollment.pm when a new user is to be added to the domain, and the
authentication method is set to "local". Not required at MSU.

- adding GPL headers

Modified to support enrollment from crosslisted classes.

Module to fetch institutional class list data. Each LON-CAPA domain should create its own customized version.  This version is specific to MSU data sources maintained by the Registrar's office.
Retrieves enrollment data from LONCAPA_ClassList view in RO_ClassList database.  Writes enrollment for a LON-CAPA course in XML to a file in /home/httpd/perl/tmp.  Data is retrieved and processed by routines in LONCAPA::Enrollment.