[BACK]Return to localenroll.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / enrollment

Diff for /loncom/enrollment/localenroll.pm between versions 1.33 and 1.56

version 1.33, 2009/02/20 13:59:20 version 1.56, 2016/08/25 18:01:34
Line 41  described at http://www.lon-capa.org. Line 41  described at http://www.lon-capa.org.
   
 =over  =over
   
 =back  
   
 =cut  =cut
   
 package localenroll;  package localenroll;
Line 125  sub run() { Line 123  sub run() {
   <middlename>D</middlename>    <middlename>D</middlename>
   <startdate></startdate>    <startdate></startdate>
   <studentID>A12345678</studentID>    <studentID>A12345678</studentID>
     <credits></credits>
     <inststatus></inststatus>
  </student>   </student>
     
  with the following at the top of the file   with the following at the top of the file
Line 149  sub run() { Line 149  sub run() {
  If dates are to included in the XML file, they should be in the format   If dates are to included in the XML file, they should be in the format
  YYYY:MM:DD:HH:MM:SS (: separators required).   YYYY:MM:DD:HH:MM:SS (: separators required).
   
    The <credits> tag need only be used if the credits earned by the students will 
    be different from the default for the course. The course default is set when the
    course is created and can be modifed by a Domain Coordinator via "View or
    modify a course or community" on the DC's Main Menu screen.
   
    A value for <inststatus> should be the institutional status used for students,
    and should be one of the types defined in the "Institutional user types"
    section in the domain config screen for:
    "Default authentication/language/timezone/portal/types" 
   
    If no status types are defined for the domain this tag can be omitted.
    If Autoupdate.pl is enabled in your domain, updates to the institutional 
    status set here will be updated by Autoupdate.pl, should changes occur.
   
  If there were 10 students in fs03nop590001, 5 students in fs03nop59o601,    If there were 10 students in fs03nop590001, 5 students in fs03nop59o601, 
  8 students in fs03nop590602, and 2 students in fs03ost580002,   8 students in fs03nop590602, and 2 students in fs03ost580002,
  then $$reply{'43551dedcd43febmsul1'} = 25   then $$reply{'43551dedcd43febmsul1'} = 25
Line 235  sub get_sections { Line 249  sub get_sections {
  The course section or crosslisted course will only be added to the list of   The course section or crosslisted course will only be added to the list of
  affiliates if 'ok' is returned.   affiliates if 'ok' is returned.
   
  new_course takes three arguments -   new_course takes three required arguments -
  (a) the institutional courseID (in the MSU case this is a concatenation of    (a) the institutional courseID (in the MSU case this is a concatenation of 
  semester code, department code, course number, and section number   semester code, department code, course number, and section number
  e.g., fs03nop590001).   e.g., fs03nop590001).
Line 244  sub get_sections { Line 258  sub get_sections {
  username:domain   username:domain
  (c) the LON-CAPA domain that contains the course   (c) the LON-CAPA domain that contains the course
   
    new_course also takes a fourth (optional) argument -
    (d) the course co-owners, as a comma-separated list of username:domain for
    any co-owners. 
   
 =cut  =cut
   
 sub new_course  {  sub new_course  {
     my ($course_id,$owner,$dom) = @_;      my ($course_id,$owner,$dom,$coowners) = @_;
     my $outcome = 'ok';      my $outcome = 'ok';
     return $outcome;      return $outcome;
 }  }
Line 281  sub validate_courseID { Line 299  sub validate_courseID {
   
 =pod  =pod
   
   =item validate_instcode()
   
   This is called when a request is being made for an official course.
   A check is made that the institutional code for which a course is
   is being requested is valid according to the institutional
   schedule of official classes.
   
   If the username of the course owner is provided, a more restrictive
   test is used, namely that the requestor is listed as instructor of
   record for the course in the institution's course schedule/database.
   
   validate_instcode takes three arguments -
    (a) the LON-CAPA domain that will contain the course
    (b) the institutional code (in the MSU case this is a concatenation of
    semester code, department code, and course number, e.g., fs03nop590.
    (c) an optional institutional username for the course owner.
   
   An array is returned containing (a) the result of the check for a valid 
   instcode, (b) an (optional) course description, and (c) the default credits
   earned by students when completing this course. If no institutional credits
   value is available, the default credits for the course can be set via the
   course request form, or via XML in a batch file, of via the web form used
   by the Domain Coordinator to create new courses one at a time.
   
   A valid instcode is confirmed by returning 'valid'.
   
   If no course description is available, '' should be set as
   the value of the second item in the returned array.
   
   =cut
   
   sub validate_instcode {
       my ($dom,$instcode,$owner) = @_;
       my $outcome = '';
       my $description = '';
       my $credits = '';
       return ($outcome,$description,$credits);
   }
   
   =pod
   
   =item validate_crsreq()
   
   This is used to check whether a course request should be processed
   automatically, or held in a queue pending administrative action at
   the institution.
   
   Course requests will trigger this check if the process type has been set 
   to 'validate' for the course type (official, unofficial, textbook, 
   placement or community) and the requestor's affiliation.  Whether
   "validate" is an available option in the Domain Configuration menu 
   is controlled by auto_courserequest_checks(). 
   One scenario is where the request is for an official course, in which case
   a check could be made that the requestor is listed as instructor of 
   record for the course in the institution's course schedule/database.
   
   Other scenarios are possible, and the routine can be customized according
   to whatever rules a domain wishes to implement to run validations against
   given the data passed in to the routine.
   
   validate_crsreq takes seven arguments -
    (a) the LON-CAPA domain that will contain the course.
    (b) the username:domain for the course owner.
    (c) the course type (official, unofficial,textbook, placement or community)
    (d) a comma-separated list of institutional affiliations of 
        the course owner.
    (e) the institutional code (in the MSU case this is a concatenation of
    semester code, department code, and course number, e.g., fs03nop590).
    (f) a comma-separated list of institutional sections included in
        the course request (only applicable to official courses).
    (g) an optional reference to a hash of custom form data.
        The custom form data will come from crsreq_updates(), with one
        additional item: $custominfo->{'_LC_clonefrom'}, provided internally
        (the courseID of the LON-CAPA course being cloned).
   
   A valid courserequest is confirmed by returning 'process'.
   The following can be returned: process, rejected, pending, approval or 
   error (with error condition - no :), followed by a : and then an optional message. 
   
   (a) process  - the requestor is the recorded instructor - create the course
   
   (b) rejected - the requestor should never be requesting this course, reject the
       request permanently
   
   (c) pending - the requestor is not the recorded instructor, but could
       become so after administrative action at the institution. Put the
       request in a queue and, if an official course, check 
       localenroll:validate_instcode() periodically until the status changes to 
       "valid".
   
   (d) approval - the request will be held pending review by a Domain Coordinator.
   
   (e) error (followed by the error condition).
   
   =cut
   
   sub validate_crsreq {
       my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
       my $outcome = 'approval';
       return $outcome;
   }
   
   =pod 
   
   =item crsreq_checks()
   
   This is used to determine whether the "validate" option should appear in the
   possible choices for course request processing in the Domain Configuration 
   menu for Course Requests. Ultimately it is called by domainprefs.pm (via: 
   lonnet -> lond -> localenroll.pm) The domain configuration menu includes 
   a table where columns are course type (official, unofficial, textbook,
   placement or community) and rows are institutional affiliations 
   (e.g., Faculty, Staff, Student etc.).
   
   crsreq_checks() takes three arguments: $dom, $reqtypes, $validations.
   $dom - the domain for which validation options are needed.
   $reqtypes - ref to an ARRAY of course types (i.e., official, unofficial and community.
   $validations - ref to a hash of a hash which will determine whether "validate"
   will be one of the possible choices for each course type (outer hash key),
   and institutional type (inner hash key).
   
   For example to allow validate to be a choice for official classes for Faculty,
   req_checks would include:
   
   $validations{'official'}{'Faculty'} = 1;
   
   This routine is closely tied to validate_crsreq(). "Validate" should not be
   a possible choice in the domain configuration menu for a particular course
   type/institutional affiliation, unless a corresponding validation code has
   been implemented in validate_crsreq().
   
   For example at MSU, official courses requested by Faculty will be validated
   against the official schedule of classes to check that the requestor is one
   of the instructors of record for the course.  In this case validate_crsreq()
   includes a call to validate_instcode().
   
   =cut
   
   sub crsreq_checks {
       my ($dom,$reqtypes,$validations) = @_;
       if ((ref($reqtypes) eq 'ARRAY') && (ref($validations) eq 'HASH')) {
           my (%usertypes,@order);
           if (&inst_usertypes($dom,\%usertypes,\@order) eq 'ok') {
               foreach my $type (@{$reqtypes}) {
                   foreach my $inst_type (@order) {
                       $validations->{$type}{$inst_type} = 0;
                   }
               }
           }
       }
       return 'ok';
   }
   
   =pod
   
   =item crsreq_updates()
   
   This is used to customize the LON-CAPA course request process.
   There are two hash references: $incoming, and $outgoing; $incoming can
   contain additional information collected from the requester, whereas $outgoing
   can contain custom items to send back to lonrequestcourse.pm, which creates the
   HTML displayed to the user during a course request.
   
   Different key-value pairs may be returned to lonrequestcourse.pm in the $outgoing
   hashref depending on the current action.  The available actions are:
   review, prevalidate, process, created and queued.
   
   One scenario would be to return HTML markup in: $outgoing->{'reviewweb'},
   i.e., where the action is 'review', to prompt the user to provide additional
   information as part of the course request, at the request review stage, 
   (i.e,, the page which contains the button used to submit a completed course request).
   
   The HTML could contain form elements (e.g., radio buttons etc.). The value(s)
   selected by the requester in those form elements will be available in the incoming
   hashref, for a subsequent action, if the corresponding keys have been included
   in $outgoing->{'formitems'}, i.e., $outgoing will be hash of a hash.  If a
   particular form item will the single valued, the value set for the key in the 
   inner hash in $outgoing should be 1, otherwise, if it will be multi-valued,
   the value should be multiple.
   
   The $outgoing hashref can contain a 'formitems' key for both the prevalidate
   and process actions, as calls to localenroll::crsreq_update() can originate
   in lonrequestcourse::process_request() for both of those actions.
   
   The retrieved form values are passed to localenroll::validate_crsreq() as the
   optional seventh arg (a hashref) -- $custominfo.
   
   =cut
   
   sub crsreq_updates {
       my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
           $code,$accessstart,$accessend,$incoming,$outgoing) = @_;
       unless (ref($outgoing) eq 'HASH') {
           return 'fail';
       }
       my %extrainfo;
       if (ref($incoming) eq 'HASH') {
           %extrainfo = %{$incoming};
       }
       if ($action eq 'review') {
           $outgoing->{'reviewweb'} = '';
       } elsif ($action eq 'prevalidate') {
           $outgoing->{'formitems'} = {}; # key=>value, where key is form element name
                                          #             and value is multiple, if there
                                          #             are multiple form elements with
                                          #             the same name.
       } elsif ($action eq 'process') {
           $outgoing->{'formitems'} = {}; # key=>value, where key is form element name
                                          #             and value is multiple, if there
                                          #             are multiple form elements with
                                          #             the same name.
       } elsif ($action eq 'created') {
           $outgoing->{'createdweb'} = '';
           $outgoing->{'createdmsg'} = [{
                                        mt => '',
                                        args => [],
                                       }];
           $outgoing->{'createdactions'} = {
                                               environment => {},
                                           };
                                           # environment can contain key=>value for
                                           # items to set in the course environment.
                                           # These would be items which are NOT included
                                           # in the items set via options in the course
                                           # request form. Currently self-enrollment
                                           # settings are the only ones allowed, i.e.,
                                           # internal.selfenroll_types internal.selfenroll_registered
                                           # internal.selfenroll_section internal.selfenroll_start_access 
                                           # internal.selfenroll_end_access internal.selfenroll_limit
                                           # internal.selfenroll_cap internal.selfenroll_approval
                                           # internal.selfenroll_notifylist
       } elsif ($action eq 'queued') {
           $outgoing->{'queuedmsg'} = [{
                                        mt   => '',
                                        args => [],
                                       }];
           $outgoing->{'queuedweb'} = '';
       }
       return 'ok'
   }
   
   =pod
   
   =item export_grades()
    
   This routine can be customized to push grade information to some other gradebook,
   LCMS, or administrative system external to LON-CAPA.
   
   export_grades() takes five arguments -
   (a) the LON-CAPA course ID
   (b) the LON-CAPA course domain
   (c) a hash reference containing the following: 
       scope    => scope of the grades (e.g., course, map or resource).
       instcode => institutional course code (if an official course)
       crstype  => course type -- Course, Community or Placement
       context  => calling context, e.g., "completion" when a student completes a placement test.
   (d) a perl data structure (hash of a hash) containing the grade data.
       in the outer hash, the keys are student's username:domain
       in the inner hash, keys are:  
       id        => student/employee ID
       lastname  => student's last name
       firstname => student's first name
       email     => student's "permannent" e-mail address
       section   => student's LON-CAPA course section
       total     => total points earned
       bytitle   => reference to a hash (keys are question titles, values are points
       bysymb    => reference to a hash (keys are symbs, i.e., unique resource identifiers).
   (e) reference to a hash which will contain information to return.
       keys will be the student's username:domain. Value of 1 to show grades pushed 
       successfully. 
   
   =cut
   
   sub export_grades {
       my ($cnum,$cdom,$hashref,$dataref,$outgoing) = @_;
       my %info;
       if (ref($hashref) eq 'HASH') {
           %info = %{$hashref};
       }
       if ((ref($dataref) eq 'HASH') && (ref($outgoing) eq 'HASH')) {
           foreach my $key (keys(%{$dataref})) {
               $outgoing->{$key} = 1;
           }
           return 'ok';
       } else {
           return 'error';
       }
   }
   
   =pod
   
 =item create_password()  =item create_password()
   
  This is called when the authentication method set for the automated    This is called when the authentication method set for the automated 
Line 381  sub instcode_format () { Line 690  sub instcode_format () {
     return $outcome;      return $outcome;
 }  }
   
   =pod
   
   =item possible_instcodes()
   
   Gather acceptable values for institutional categories to use in course creation request form for official courses.
   
    requires five arguments:
   
    domain ($dom)
    reference to array of titles ($codetitles)
    reference to hash of abbreviations used in categories ($cat_titles).
    reference to hash of arrays specifying sort order used in 
              category titles ($cat_order).
    reference to array which will contain order of component parts used 
              in institutional code ($code_order).
   
    e.g., 
    @{$codetitles} = ('Year','Semester',"Department','Number');
   
    %{$$cat_titles{'Semester'}} = (
                      fs => 'Fall',
                      ss => 'Spring',
                      us => 'Summer');
   
    @{$$cat_order{'Semester'}} = ('ss','us','fs');
    @{$code_order} = ('Semester','Year','Department','Number');
   
    returns 1 parameter: 'ok' if no processing errors.
   
   =cut
   
   sub possible_instcodes {
       my ($dom,$codetitles,$cat_titles,$cat_order,$code_order) = @_;
       @{$codetitles} = ();
       %{$$cat_titles{'Semester'}} = ();
       @{$$cat_order{'Semester'}} = ('ss','us','fs');
       @{$code_order} = ();
       return 'ok';
   }
   
   
 =pod  =pod
   
Line 401  sub instcode_format () { Line 750  sub instcode_format () {
      existing photo, photo was found to be missing from institution's       existing photo, photo was found to be missing from institution's
      data store, photo used is same as before, or photo was        data store, photo used is same as before, or photo was 
      deleted from storage on LON-CAPA server housing student's       deleted from storage on LON-CAPA server housing student's
      information, no student ID was available.        information, no student/employee ID was available. 
                                 
  (e) $action: the type of action needed. (e.g., update, delete);   (e) $action: the type of action needed. (e.g., update, delete);
  (f) $students: a reference to a hash with the keys set to student    (f) $students: a reference to a hash with the keys set to student 
Line 557  sub instcode_defaults { Line 906  sub instcode_defaults {
                 keys will be unique IDs (student or faculty/staff ID)                  keys will be unique IDs (student or faculty/staff ID)
                 values will be either: scalar (username) or an array                   values will be either: scalar (username) or an array 
                 if a single ID matches multiple usernames.                  if a single ID matches multiple usernames.
    (d) $lc_users - reference to hash containing LON-CAPA usernames in 
                    in domain $dom, as keys. Needed if institutional
                    data source only allows query by username.
  returns 1 parameter - 'ok' if no processing error, or other value    returns 1 parameter - 'ok' if no processing error, or other value 
                        if an error occurred.                         if an error occurred.
  side effects - populates the $instusers and $instids refs to hashes.   side effects - populates the $instusers and $instids refs to hashes.
Line 567  sub instcode_defaults { Line 919  sub instcode_defaults {
 =cut  =cut
   
 sub allusers_info {  sub allusers_info {
     my ($dom,$instusers,$instids) = @_;      my ($dom,$instusers,$instids,$lc_users) = @_;
     my $outcome = 'ok';      my $outcome = 'ok';
     return $outcome;       return $outcome; 
 }  }
Line 635  sub get_userinfo { Line 987  sub get_userinfo {
   
 =pod  =pod
   
   =item get_multusersinfo
   
    (a) $dom - domain
    (b) $type - username or id
    (c) $unamenames - reference to hash containing usernames of users
    (d) $instusers - reference to hash which will contain info for user
                    as key = value; keys will be one or all of:
                    lastname,firstname,middlename,generation,id,inststatus -
                    institutional status (e.g., faculty,staff,student)
                    Values are all scalars except inststatus,
                    which is an array.
    (e) $instids - reference to hash which will contain ID numbers -
                    keys will be unique IDs (student or faculty/staff ID)
                    values will be either: scalar (username) or an array
                    if a single ID matches multiple usernames.
   
    returns 1 parameter - 'ok' if no processing error, or other value
                          if an error occurred.
   
    side effects - populates the $instusers and $instids refs to hashes.
                   with information for specified username, or specified
                   id, if fifth argument provided, from all available, or
                   specified (e.g., faculty only) institutional datafeeds,
                   if sixth argument provided.
   
    WARNING: You need to set $outcome to 'ok' once you have customized
             this routine to communicate with an instititional
             directory data source, otherwise retrieval of institutional
             user information will always be reported as being unavailable
             in domain $dom.
   
   =cut
   
   sub get_multusersinfo {
       my ($dom,$type,$usernames,$instusers,$instids) = @_;
       my $outcome = 'unavailable'; 
       return $outcome;
   }
   
   =pod
   
 =item inst_usertypes()   =item inst_usertypes() 
   
    Starting with LON-CAPA 2.11.0 use of this subroutine
    is deprecated. The domain configuration web GUI
    accessible to Domain Coordinators will be used to
    manage institutional types.  If you have previously
    customized this routine, then values set there will
    be used when displaying the "Institutional user types"
    section in the domain config screen for:
    "Default authentication/language/timezone/portal/types".
   
    Once you have visited that screen and saved the settings,
    configuration thereafter will be via the web GUI of
    values stored in the domain's configuration.db file on
    the primary library server in the domain, and values in
    inst_usertypes() will no longer be consulted.
    
  Incoming data: three arguments   Incoming data: three arguments
  (a) $dom - domain   (a) $dom - domain
  (b) $usertypes - reference to hash which will contain    (b) $usertypes - reference to hash which will contain 
Removed from v.1.33  
changed lines
  Added in v.1.56

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>