[LON-CAPA-cvs] cvs: loncom /interface createaccount.pm

[www]

www		Thu May 17 17:41:48 2012 EDT

  Modified files:              
    /loncom/interface	createaccount.pm 
  Log:
  Documentation
  
  
Index: loncom/interface/createaccount.pm
diff -u loncom/interface/createaccount.pm:1.48 loncom/interface/createaccount.pm:1.49
--- loncom/interface/createaccount.pm:1.48	Wed May 16 21:19:39 2012
+++ loncom/interface/createaccount.pm	Thu May 17 17:41:48 2012
@@ -3,7 +3,7 @@
 # institutional log-in ID (institutional authentication required - localauth
 #  or kerberos) or an e-mail address.
 #
-# $Id: createaccount.pm,v 1.48 2012/05/16 21:19:39 droeschl Exp $
+# $Id: createaccount.pm,v 1.49 2012/05/17 17:41:48 www Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -838,6 +838,12 @@
 sub username_validation {
     my ($r,$username,$domain,$domdesc,$contact_name,$contact_email,$courseid,
         $lonhost,$statustocreate) = @_;
+# $username,$domain: for the user who needs to be validated
+# $domdesc: full name of the domain (for error messages)
+# $contact_name, $contact_email: name and email for user assistance (for error messages in &username_check
+# $courseid: ID of the course that the user should be validated for, goes into start_session
+# $statustocreate: -> inststatus in username_check ('faculty', 'staff', 'student', ...)
+ 
     my ($retrieved,$output,$upass);
 
     $username= &LONCAPA::clean_username($username);
@@ -1230,6 +1236,12 @@
 }
 
 sub process_credentials {
+#
+# Fetches the information from the logtoken via tmpget
+# Token contains the DES-key and the stage of the process (would only be "createaccount")
+# $lonhost in this routine is *not* necessarily the machine that this runs on,
+# but $env{'form.serverid'}, the machine that issued the token. 
+#
     my ($logtoken,$lonhost) = @_;
     my $tmpinfo=Apache::lonnet::reply('tmpget:'.$logtoken,$lonhost);
     my ($retrieved,$output,$upass);
@@ -1251,6 +1263,10 @@
     } else {
         $output = &mt('Unable to retrieve your log-in information - unexpected context');
     }
+# $retrieved is 'ok' if retrieved okay
+# $output is screen output for the user
+# $upass is $env{'form.upass'}, decrypted with the DES-key, if stage was 'createaccount'
+
     return ($retrieved,$output,$upass);
 }