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

Diff for /loncom/enrollment/localenroll.pm between versions 1.63 and 1.64

version 1.63, 2022/01/14 16:27:20 version 1.64, 2022/02/27 01:43:14
Line 1157  sub get_userinfo { Line 1157  sub get_userinfo {
   
 =pod  =pod
   
 =item get_multusersinfo  =item get_multusersinfo()
   
  (a) $dom - domain   (a) $dom - domain
  (b) $type - username or id   (b) $type - username or id
Line 1250  sub inst_usertypes { Line 1250  sub inst_usertypes {
                   keys of top level hash are short names                      keys of top level hash are short names  
                    (e.g., netid, noncredit)                      (e.g., netid, noncredit) 
                   for each key, value is a hash                    for each key, value is a hash
                       desc => long name for rule                          name => long name for rule  
                       rule => description of rule                        desc => description of rule
                       authtype => (krb5,krb4,int, or loc)                        authtype => (krb5,krb4,int, or loc)
                                  authentication type for rule                                    authentication type for rule 
                       authparm => authentication parameter for rule                        authparm => authentication parameter for rule
Line 1285  sub username_rules { Line 1285  sub username_rules {
                   keys of top level hash are short names                    keys of top level hash are short names
                    (e.g., netid, noncredit)                     (e.g., netid, noncredit)
                   for each key, value is a hash                    for each key, value is a hash
                       desc => long name for rule                        name => long name for rule
                       rule => description of rule                        desc => description of rule
   
  (c) $rulesorder - reference to array containing rule names   (c) $rulesorder - reference to array containing rule names
                    in order to be displayed                     in order to be displayed
Line 1312  sub id_rules { Line 1312  sub id_rules {
                   keys of top level hash are short names                    keys of top level hash are short names
                    (e.g., netid)                     (e.g., netid)
                   for each key, value is a hash                    for each key, value is a hash
                       desc => long name for rule                        name => long name for rule
                       rule => description of rule                        desc => description of rule
   
  (c) $rulesorder - reference to array containing rule names   (c) $rulesorder - reference to array containing rule names
                    in order to be displayed                     in order to be displayed
Line 1331  sub selfcreate_rules { Line 1331  sub selfcreate_rules {
   
 =pod  =pod
   
   =item unamemap_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
                         name => long name for rule
                         desc => description of rule
   
    For example: 
   
           %{$ruleshash} = (
               emailaddress  => {
                                  name     => 'Email address to UserID',
                                  desc     => 'Extract userID from userID@example.tld',
                                },
                           );
     would enable display of a checkbox for: 'Email address to UserID' in the
     "Available conversions" item in the "Mapping for missing usernames via standard log-in"
     panel available to a Domain Coordinator via:
     Main Menu > Set domain configuration > Display ("Default authentication/language/timezone/portal/types" checked)
   
    (c) $rulesorder - reference to array containing rule names
                      in order to be displayed
   
     returns 'ok' if no processing error.
   
   =cut
   
   sub unamemap_rules {
       my ($dom,$ruleshash,$rulesorder) = @_;
       my $outcome;
       return $outcome;
   }
   
   =pod
   
 =item username_check()   =item username_check() 
   
  Incoming data: four arguments   Incoming data: four arguments
Line 1338  sub selfcreate_rules { Line 1378  sub selfcreate_rules {
  (b) $uname - username to compare against rules (scalar)   (b) $uname - username to compare against rules (scalar)
  (c) $to_check (reference to array of rule names to check)   (c) $to_check (reference to array of rule names to check)
  (d) $resultshash (reference to hash of results)   (d) $resultshash (reference to hash of results)
                     hash of results for rule checked                      hash of results for rules checked
                    - keys are rule names                     - keys are rule names
                    - values are: 1 or 0 (for matched or unmatched)                      - values are: 1 or 0 (for matched or unmatched) 
   
Line 1362  sub username_check { Line 1402  sub username_check {
  (b) $id - ID to compare against rules (scalar)   (b) $id - ID to compare against rules (scalar)
  (c) $to_check (reference to array of rule names to check)   (c) $to_check (reference to array of rule names to check)
  (d) $resultshash (reference to hash of results)   (d) $resultshash (reference to hash of results)
                     hash of results for rule checked                      hash of results for rules checked
                    - keys are rule names                     - keys are rule names
                    - values are: 1 or 0 (for matched or unmatched)                     - values are: 1 or 0 (for matched or unmatched)
   
Line 1386  sub id_check { Line 1426  sub id_check {
  (b) $selfcreatename - e-mail proposed as username (compare against rules - scalar)   (b) $selfcreatename - e-mail proposed as username (compare against rules - scalar)
  (c) $to_check (reference to array of rule names to check)   (c) $to_check (reference to array of rule names to check)
  (d) $resultshash (reference to hash of results)   (d) $resultshash (reference to hash of results)
                    hash of results for rule checked                     hash of results for rules checked
                    - keys are rule names                     - keys are rule names
                    - values are: 1 or 0 (for matched or unmatched)                     - values are: 1 or 0 (for matched or unmatched)
   
Line 1400  sub selfcreate_check { Line 1440  sub selfcreate_check {
     my $outcome;      my $outcome;
     return $outcome;      return $outcome;
 }  }
   
   =pod
   
   =item unamemap_check()
   
    Incoming data: four arguments
    (a) $dom - domain (scalar)
    (b) $uname - username entered on log-in page (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 rules checked
                      - keys are rule names
                      - values are derived username from substitution operation
                        applied to $uname.
   
     For example, in the msu domain the rule "msuemail" will replace an MSU
     email address submitted as a username, with the part before the @msu.edu,
     (known as the MSUNetID), which is what is used in LON-CAPA as a username.
   
     if ($dom eq 'msu') {
         foreach my $item (@{$to_check}) {
             if ($item eq 'msuemail') {
                 if ($uname =~ /^(\w{2,8})\@msu\.edu$/) {
                     $resultshash->{$item} = $1;
                 }
             }
         }
      }
   
    returns 'ok' if no processing error.
   
   =cut
   
   sub unamemap_check {
       my ($dom,$uname,$to_check,$resultshash) = @_;
       my $outcome;
       return $outcome;
   }
   
 =pod  =pod
   
Removed from v.1.63  
changed lines
  Added in v.1.64

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