[LON-CAPA-cvs] cvs: loncom /enrollment localenroll.pm

raeburn lon-capa-cvs-allow@mail.lon-capa.org
Wed, 12 Sep 2007 19:49:37 -0000


raeburn		Wed Sep 12 15:49:37 2007 EDT

  Modified files:              
    /loncom/enrollment	localenroll.pm 
  Log:
  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).     
  
  
Index: loncom/enrollment/localenroll.pm
diff -u loncom/enrollment/localenroll.pm:1.24 loncom/enrollment/localenroll.pm:1.25
--- loncom/enrollment/localenroll.pm:1.24	Fri Aug 31 08:33:35 2007
+++ loncom/enrollment/localenroll.pm	Wed Sep 12 15:49:37 2007
@@ -1,6 +1,6 @@
 # functions to glue school database system into Lon-CAPA for 
 # automated enrollment
-# $Id: localenroll.pm,v 1.24 2007/08/31 12:33:35 raeburn Exp $
+# $Id: localenroll.pm,v 1.25 2007/09/12 19:49:37 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -597,6 +597,62 @@
 }
 
 ###############################
+# 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 check_username 
+#
+# 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