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

Diff for /loncom/enrollment/localenroll.pm between versions 1.21 and 1.30

version 1.21, 2007/07/25 20:43:48 version 1.30, 2008/02/24 22:59:20
Line 427  sub manager_photo_update { Line 427  sub manager_photo_update {
 #  #
 # Incoming data: three arguments (+ fourth optional argument)  # Incoming data: three arguments (+ fourth optional argument)
 # (a) $class - institutional class id (coursecode concatanated with section)   # (a) $class - institutional class id (coursecode concatanated with section) 
 # (b) $owner - course owner (2.2 and later username:domain; pre-2.2 username)  # (b) $owner - course owner (2.2 and later username:domain; pre-2.2 username;
 # (c) $dom 0 domain of course  #                            2.6 and later - comma-separated list of 
 # (d) $dbh - optional database handle    #                            username:domain for course owner and co-owners.)
   # (c) $dom - domain of course
   # (d) $dbh - optional database handle
 #  #
 # returns 1 parameter - $sectioncheck ('ok' or other value).   # returns 1 parameter - $sectioncheck ('ok' or other value). 
 # Verifies that course owner has access to classlist for specific class  # Verifies that at least one of the course owner (or co-owners) have access 
 # according to institution's SIS. 'ok' if access available    # to classlist for specific class according to institution's SIS
   # 'ok' if access available  
 ###############################  ###############################
   
 sub check_section {  sub check_section {
Line 496  sub instcode_defaults { Line 499  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.
 # returns 1 parameter - ('ok' or other value).  # 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.  # side effects - populates the $instusers and $instids refs to hashes.
 #                with information for all users from all available   #                with information for all users from all available 
 #                institutional datafeeds.  #                institutional datafeeds.
Line 512  sub allusers_info { Line 516  sub allusers_info {
 ###############################  ###############################
 # sub get_userinfo  # sub get_userinfo
 #  #
 # Incoming data: four required arguments and t optional arguments  # Incoming data: four required arguments and additional optional arguments
 # Retrieves institutional data for a single user either by username  # Two modes of operation:
 # if $uname is included as second argument, or by ID if $id is   # (1) Retrieves institutional data for a single user either by username
 # included as a third argument.  Either (b) or (c) must be provided.   #     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  # (a) $dom - domain
 # (b) $uname - username of user  # (b) $uname - username of user
 # (c) $id - student/faculty ID of user  # (c) $id - student/faculty ID of user
Line 537  sub allusers_info { Line 547  sub allusers_info {
 #               2. lastname; 3. username  #               2. lastname; 3. username
 # (h) $srchterm - optional if $uname or $id defined, otherwise required  # (h) $srchterm - optional if $uname or $id defined, otherwise required
 #                String to search for.  #                String to search for.
 # (i) $srchtype - optional. Allowed value: contains  # (i) $srchtype - optional. Allowed values: contains, begins (defaults
   #                to exact match otherwise).
 #  #
 # returns 1 parameter - ('ok' or other value).  # 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.  # side effects - populates the $instusers and $instids refs to hashes.
 #                with information for specified username, or specified  #                with information for specified username, or specified
 #                id, if fifth argument provided, from all available, or   #                id, if fifth argument provided, from all available, or 
 #                specified (e.g., faculty only) institutional datafeeds,  #                specified (e.g., faculty only) institutional datafeeds,
 #                if sixth argument provided.  #                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 {  sub get_userinfo {
     my ($dom,$uname,$id,$instusers,$instids,$types,      my ($dom,$uname,$id,$instusers,$instids,$types,
         $srchby,$srchterm,$srchtype) = @_;          $srchby,$srchterm,$srchtype) = @_;
     my $outcome = 'ok';      my $outcome = 'unavailable';
     return $outcome;      return $outcome;
 }  }
   
Line 567  sub get_userinfo { Line 586  sub get_userinfo {
 #              which institutional types should be shown  #              which institutional types should be shown
 #              when displaying data tables (e.g., default quotas      #              when displaying data tables (e.g., default quotas    
 #              or updateable user fields (see domainprefs.pm)   #              or updateable user fields (see domainprefs.pm) 
 # returns 1 parameter - ('ok' or other value).  # returns 1 parameter - 'ok' if no processing error, or other value 
   #                        if an error occurred.
 #  #
 ###############################  ###############################
   
Line 579  sub inst_usertypes { Line 599  sub inst_usertypes {
     return $outcome;      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 id_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
   #
   # (c) $rulesorder - reference to array containing rule names
   #                   in order to be displayed
   #
   #  returns 'ok' if no processing error.
   #
   ###############################
   
   sub id_rules {
       my ($dom,$ruleshash,$rulesorder) = @_;
       my $outcome;
       return $outcome;
   }
   
   ###############################
   # sub selfenroll_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)
   #                  for each key, value is a hash
   #                      desc => long name for rule
   #                      rule => description of rule
   #
   # (c) $rulesorder - reference to array containing rule names
   #                   in order to be displayed
   #
   #  returns 'ok' if no processing error.
   #
   ###############################
   
   
   sub selfenroll_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 id_check
   #
   # Incoming data: four arguments
   # (a) $dom - domain (scalar)
   # (b) $id - ID 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 id_check {
       my ($dom,$id,$to_check,$resultshash) = @_;
       my $outcome;
       return $outcome;
   }
   
   ###############################
   # sub selfenroll_check
   #
   # Incoming data: four arguments
   # (a) $dom - domain (scalar)
   # (b) $selfenrollname - e-mail proposed as username (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 selfenroll_check {
       my ($dom,$selfenrollname,$to_check,$resultshash) = @_;
       my $outcome;
       return $outcome;
   }
   
 ###############################  ###############################
 # sub AUTOLOAD  # sub AUTOLOAD
 #  #
Removed from v.1.21  
changed lines
  Added in v.1.30

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