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

Diff for /loncom/enrollment/localenroll.pm between versions 1.12 and 1.26

version 1.12, 2006/02/07 05:08:21 version 1.26, 2007/09/12 19:50:47
Line 31  use strict; Line 31  use strict;
 ################################  ################################
 # sub run  # sub run
 # set this to return 1 if you want the auto enrollment to run  # set this to return 1 if you want the auto enrollment to run
   #
   # Beginning with LON-CAPA version 2.4, use of this routine is
   # deprecated.  Whether or not Autoenroll.pl should run is set
   # by the Domain Coordinator via "Set domain configuration",
   # provided in the Domain Management section of the Main menu. 
 ################################  ################################
   
 sub run() {  sub run() {
Line 204  sub get_sections { Line 209  sub get_sections {
 # (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).
 # (b) the course owner. This is the LON-CAPA username of the course coordinator   # (b) the course owner. This is the LON-CAPA username and domain of the course 
 # assigned to the course when it is first created.  # coordinator assigned to the course when it is first created, in the form
   # username:domain
 # (c) the LON-CAPA domain that contains the course  # (c) the LON-CAPA domain that contains the course
 #  #
 #################################  #################################
Line 256  sub validate_courseID { Line 262  sub validate_courseID {
 # (a) $authparam - the value of <autharg> from the classlist.xml files,  # (a) $authparam - the value of <autharg> from the classlist.xml files,
 # or if this blank, the default autharg, set by the domain coordinator when   # or if this blank, the default autharg, set by the domain coordinator when 
 # creating the course with loncreatecourse.pm  # creating the course with loncreatecourse.pm
 # (b) $username - the username of the new user  
 # (b) $dom - the domain of the new user.  # (b) $dom - the domain of the new user.
   # (c) $username - the username of the new user (currently not actually used)
 #  #
 # Four values are returned:  # Four values are returned:
 # (a) the value of $authparam - which might have been changed  # (a) the value of $authparam - which might have been changed
Line 286  sub validate_courseID { Line 292  sub validate_courseID {
 ###############################  ###############################
   
 sub create_password {  sub create_password {
     my ($authparam,$username,$dom) = @_;      my ($authparam,$dom,$username) = @_;
     my $authchk = 'ok';      my $authchk = 'ok';
     my $newpasswd = '';      my $newpasswd = '';
     my $create_passwd = 0;      my $create_passwd = 0;
Line 303  sub create_password { Line 309  sub create_password {
 #  #
 # Incoming data:  # Incoming data:
 # $dom (domain)  # $dom (domain)
 # $$instcodes{'43551dedcd43febmsul1'} = 'Title of course' (hash of courseIDs)  # $$instcodes{'43551dedcd43febmsul1'} = 'fs03nop590' (hash of courseIDs)
 #   # 
 # fs03nop590 would be split as follows  # fs03nop590 would be split as follows
 # @{$codetitles} = ("year","semester","department","number")  # @{$codetitles} = ("year","semester","department","number")
Line 416  sub manager_photo_update { Line 422  sub manager_photo_update {
     return ($update,$comment);      return ($update,$comment);
 }  }
   
   ###############################
   # sub check_section
   #
   # Incoming data: three arguments (+ fourth optional argument)
   # (a) $class - institutional class id (coursecode concatanated with section) 
   # (b) $owner - course owner (2.2 and later username:domain; pre-2.2 username)
   # (c) $dom 0 domain of course
   # (d) $dbh - optional database handle  
   #
   # returns 1 parameter - $sectioncheck ('ok' or other value). 
   # Verifies that course owner has access to classlist for specific class
   # according to institution's SIS. 'ok' if access available  
   ###############################
   
   sub check_section {
       my ($class,$owner,$dom,$dbh) = @_;
       my $sectioncheck = 'ok';
       return $sectioncheck;
   }
   
   ###############################
   # sub instcode_defaults
   #
   # Incoming data: three arguments
   # (a) $dom - domain
   # (b) $defaults - reference to hash which will contain default regular
   #                 expression matches for different components of an 
   #                 institutional course code 
   # (c) $code_order - reference to array which will contain order of 
   #                   component parts used in institutional code.  
   #
   # returns 1 parameter - ('ok' or other value).
   # Used to construct a regular expression to be used when searching for
   # courses based on fragments of an institutional code.
   # $defaults contains defaults to use for each component, and code_order
   # contains keys of hash in order in which they are to be concatenated.
   #
   # e.g., INSTITUTIONALCODE = fs03nop590
   # (MSU's course naming scheme - fs  = semester, 03 = year, nop =
   # department name, 590 = course number)
   #
   #     %{$defaults} = (
   #        'Year' => '\d{2}',
   #        'Semester' => '^[sfu]s', 
   #        'Department' => '\w{2,3}',
   #        'Number' => '\d{3,4}\w?',
   #     );
   #
   #     @{$code_order} = ('Semester','Year','Department','Number');
   #
   ###############################
   
   sub instcode_defaults {
       my ($dom,$defaults,$code_order) = @_;
       return 'ok';
   }
   
   ###############################
   # sub allusers_info
   #
   # Incoming data: three arguments
   # (a) $dom - domain
   # (b) $instusers - reference to hash which will contain hashes, 
   #                 where keys will be usernames and value will be a 
   #                 hash of user information. Keys in the inner hash 
   #                 will be some 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.
   # (c) $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 all users from all available 
   #                institutional datafeeds.
   #
   ###############################
   
   sub allusers_info {
       my ($dom,$instusers,$instids) = @_;
       my $outcome = 'ok';
       return $outcome; 
   }
   
   ###############################
   # sub get_userinfo
   #
   # Incoming data: four required arguments and additional optional arguments
   # Two modes of operation:
   # (1) Retrieves institutional data for a single user either by username
   #     if $uname is included as second argument, or by ID if $id is 
   #     included as a third argument.  Either (b) or (c) must be provided.
   #     (g), (h) and (i) will be undefined.
   # (2) Retrieves institutional user data from search of an institutional
   #     directory based on a search. (g) and (h) are required.
   #     (i) is optional. (b) and (c) will be undefined. 
   #
   # (a) $dom - domain
   # (b) $uname - username of user
   # (c) $id - student/faculty ID of user
   # (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.
   # (f) $types - optional reference to array which contains 
   #              institutional types to check.
   # (g) $srchby - optional if $uname or $id defined, otherwise required.
   #               Allowed values include: 1. lastfirst, 2. last, 3. uname
   #               corresponding to searches by 1. lastname,firstname;
   #               2. lastname; 3. username
   # (h) $srchterm - optional if $uname or $id defined, otherwise required
   #                String to search for.
   # (i) $srchtype - optional. Allowed values: contains, begins (defaults
   #                to exact match otherwise).
   #
   # 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 institutional directory 
   #          searches will always be reported as being unavailable
   #          in domain $dom.
   #
   ###############################
   
   sub get_userinfo {
       my ($dom,$uname,$id,$instusers,$instids,$types,
           $srchby,$srchterm,$srchtype) = @_;
       my $outcome = 'unavailable';
       return $outcome;
   }
   
   ###############################
   # sub inst_usertypes 
   #
   # Incoming data: three arguments
   # (a) $dom - domain
   # (b) $usertypes - reference to hash which will contain 
   #                 key = value, where keys are institution 
   #                 affiliation types (e.g., Faculty, Student etc.)
   #                 and values are titles (e.g., Faculty/Academic Staff)
   # (c) $order - reference to array which will contain the order in
   #              which institutional types should be shown
   #              when displaying data tables (e.g., default quotas    
   #              or updateable user fields (see domainprefs.pm) 
   # returns 1 parameter - 'ok' if no processing error, or other value 
   #                        if an error occurred.
   #
   ###############################
   
   sub inst_usertypes {
       my ($dom,$usertypes,$order) = @_;
       @{$order} = ();
       %{$usertypes} = ();
       my $outcome = 'ok';
       return $outcome;
   }
   
   ###############################
   # sub username_rules
   #
   # Incoming data: three arguments 
   # (a) $dom - domain
   # (b) $ruleshash - reference to hash containing rules
   #                  (a hash of a hash)
   #                  keys of top level hash are short names  
   #                   (e.g., netid, noncredit) 
   #                  for each key, value is a hash
   #                      desc => long name for rule  
   #                      rule => description of rule
   #                      authtype => (krb5,krb4,int, or loc)
   #                                 authentication type for rule 
   #                      authparm => authentication parameter for rule
   #                      authparmfixed => 1 if authparm used when
   #                          creating user for rule must be authparm  
   #                      authmsg => Message to display describing 
   #                                 authentication to use for this rule
   #
   # (c) $rulesorder - reference to array containing rule names 
   #                   in order to be displayed
   
   #
   #  returns 'ok' if no processing error.
   #
   ############################### 
   
   sub username_rules {
       my ($dom,$ruleshash,$rulesorder) = @_;
       my $outcome;
       return $outcome;
   }
   
   ###############################
   # sub username_check 
   #
   # Incoming data: four arguments
   # (a) $dom - domain (scalar) 
   # (b) $uname - username to compare against rules (scalar)
   # (c) $to_check (reference to array of rule names to check)
   # (d) $resultshash (reference to hash of results)
   #                    hash of results for rule checked
   #                   - keys are rule names
   #                   - values are: 1 or 0 (for matched or unmatched) 
   #
   # returns 'ok' if no processing error.
   #
   ###############################
   
   sub username_check {
       my ($dom,$uname,$to_check,$resultshash) = @_;
       my $outcome;
       return $outcome; 
   }
   
   ###############################
   # sub AUTOLOAD
   #
   # Incoming data: none
   # Returns ''
   #
   # Prevents errors when undefined subroutines are called in this package
   # Will allow new routines added in the future to be called from lond etc.
   # without the need for customized versions of local*.pm packages to be
   # modified to include the new subroutines immediately.
   #
   # See "Programming Perl" 3rd ed. pp 296-298.   
   ###############################
   
   sub AUTOLOAD {
       our $AUTOLOAD;
       return '';
   }
   
 1;  1;
Removed from v.1.12  
changed lines
  Added in v.1.26

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