--- loncom/interface/createaccount.pm	2010/12/02 22:05:17	1.44
+++ loncom/interface/createaccount.pm	2012/05/18 04:31:05	1.51
@@ -3,7 +3,7 @@
 # institutional log-in ID (institutional authentication required - localauth
 #  or kerberos) or an e-mail address.
 #
-# $Id: createaccount.pm,v 1.44 2010/12/02 22:05:17 raeburn Exp $
+# $Id: createaccount.pm,v 1.51 2012/05/18 04:31:05 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -45,6 +45,8 @@ use Crypt::DES;
 use LONCAPA qw(:DEFAULT :match);
 use HTML::Entities;
 
+#TODO this module needs documentation
+
 sub handler {
     my $r = shift;
     &Apache::loncommon::content_type($r,'text/html');
@@ -65,14 +67,8 @@ sub handler {
     if ($sso_username ne '' && $sso_domain ne '') {
         $domain = $sso_domain; 
     } else {
-        $domain = &Apache::lonnet::default_login_domain();
-        if (defined($env{'form.courseid'})) {
-            if (&validate_course($env{'form.courseid'})) {
-                if ($env{'form.courseid'} =~ /^($match_domain)_($match_courseid)$/) {
-                    $domain = $1; 
-                }
-            }
-        }
+        ($domain, undef) = Apache::lonnet::is_course($env{'form.courseid'}); 
+        $domain ||= &Apache::lonnet::default_login_domain();
     }
     my $domdesc = &Apache::lonnet::domain($domain,'description');
     my $contact_name = &mt('LON-CAPA helpdesk');
@@ -98,9 +94,7 @@ sub handler {
     }
 
     my ($js,$courseid,$title);
-    if (defined($env{'form.courseid'})) {
-        $courseid = &validate_course($env{'form.courseid'});
-    }
+    $courseid = Apache::lonnet::is_course($env{'form.courseid'});
     if ($courseid ne '') {
         $js = &catreturn_js();
         $title = 'Self-enroll in a LON-CAPA course';
@@ -127,16 +121,14 @@ sub handler {
             &print_footer($r);
             return OK;
         } else {
-            $start_page = 
-                &Apache::loncommon::start_page($title,$js);
+            $start_page = &Apache::loncommon::start_page($title,$js); 
             &print_header($r,$start_page,$courseid);
             $r->print($output);
             &print_footer($r);    
             return OK;
         }
     }
-    $start_page =
-        &Apache::loncommon::start_page($title,$js);
+    $start_page = &Apache::loncommon::start_page($title,$js);
 
     my %domconfig = 
         &Apache::lonnet::get_dom('configuration',['usercreation'],$domain);
@@ -197,7 +189,7 @@ sub handler {
     if ($env{'form.phase'} eq 'username_activation') {
         (my $result,$output,$nostart) = 
             &username_activation($r,$env{'form.uname'},$domain,$domdesc,
-                                 $lonhost,$courseid);
+                                 $courseid);
         if ($result eq 'ok') {
             if ($nostart) {
                 return OK;
@@ -284,7 +276,7 @@ sub selfenroll_crumbs {
     }
     my $last_crumb;
     if ($desc ne '') {
-        $last_crumb = &mt('Self-enroll in [_1]','<span class="LC_cusr_emph">'.$desc.'</span>');
+        $last_crumb = &mt('Self-enroll in [_1]',"<span class='LC_cusr_emph'>$desc</span>");
     } else {
         $last_crumb = &mt('Self-enroll');
     }
@@ -295,17 +287,6 @@ sub selfenroll_crumbs {
     return;
 }
 
-sub validate_course {
-    my ($courseid) = @_;
-    my ($cdom,$cnum) = ($courseid =~ /^($match_domain)_($match_courseid)$/);
-    if (($cdom ne '') && ($cnum ne '')) {
-        if (&Apache::lonnet::is_course($cdom,$cnum)) {
-            return ($courseid);
-        }
-    }
-    return;
-}
-
 sub javascript_setforms {
     my ($now) =  @_;
     my $js = <<ENDSCRIPT;
@@ -410,7 +391,7 @@ sub print_username_form {
                 } else {
                     $output .= '<br />';
                 }
-                $output .=  '<form name="createaccount" method="post" onSubmit="return validate_email()" action="/adm/createaccount">'.
+                $output .=  '<form name="createaccount" method="post" onsubmit="return validate_email()" action="/adm/createaccount">'.
                             &Apache::lonhtmlcommon::start_pick_box()."\n".
                             &Apache::lonhtmlcommon::row_title(&mt('E-mail address'),
                                                              'LC_pick_box_title')."\n".
@@ -464,7 +445,7 @@ sub login_box {
     $output = &serverform($logtoken,$lonhost,undef,$courseid,$context);
     my $unameform = '<input type="text" name="uname" size="20" value="" />';
     my $upassform = '<input type="password" name="upass'.$now.'" size="20" />';
-    $output .= '<form name="client" method="post" onsubmit="return(send());">'."\n".
+    $output .= '<form name="client" method="post" action="" onsubmit="return(send());">'."\n".
                &Apache::lonhtmlcommon::start_pick_box()."\n".
                &Apache::lonhtmlcommon::row_title($titles{$context},
                                                  'LC_pick_box_title')."\n".
@@ -638,8 +619,8 @@ sub process_mailtoken {
         ($data{'username'}  =~ /^[^\@]+\@[^\@]+\.[^\@\.]+$/)) {
         if ($now - $data{'time'} < 7200) {
             if ($env{'form.phase'} eq 'createaccount') {
-                my ($result,$output) = &create_account($r,$domain,$lonhost,
-                                                       $data{'username'},$domdesc);
+                my ($result,$output,$uhome) = 
+                    &create_account($r,$domain,$data{'username'},$domdesc);
                 if ($result eq 'ok') {
                     $msg = $output; 
                     my $shownow = &Apache::lonlocal::locallocaltime($now);
@@ -652,9 +633,8 @@ sub process_mailtoken {
                     } else {
                         $msg .= &mt('An error occurred when sending e-mail to [_1] confirming creation of your LON-CAPA account.',$data{'username'});
                     }
-                    my %form = &start_session($r,$data{'username'},$domain, 
-                                              $lonhost,$data{'courseid'},
-                                              $token);
+                    &start_session($r,$data{'username'},$domain,$uhome,
+                                   $data{'courseid'},$token);
                     $nostart = 1;
                     $noend = 1;
                 } else {
@@ -681,34 +661,31 @@ sub process_mailtoken {
 }
 
 sub start_session {
-    my ($r,$username,$domain,$lonhost,$courseid,$token) = @_;
-    my %form = (
-                uname => $username,
-                udom  => $domain,
-               );
-    my $firsturl = '/adm/roles';
-    if (defined($courseid)) {
-        $courseid = &validate_course($courseid);
-        if ($courseid ne '') {
-            $form{'courseid'} = $courseid;
-            $firsturl = '/adm/selfenroll?courseid='.$courseid;
-        }
-    }
+    my ($r,$username,$domain,$uhome,$courseid,$token) = @_;
+
     if ($r->dir_config('lonBalancer') eq 'yes') {
-        &Apache::lonauth::success($r,$form{'uname'},$form{'udom'},
-                                  $lonhost,'noredirect',undef,\%form);
-        if ($token ne '') { 
-            my $delete = &Apache::lonnet::tmpdel($token);
-        }
+        Apache::lonauth::success($r, $username, $domain, $uhome,
+            'noredirect', undef, {});
+
+        Apache::lonnet::tmpdel($token) if $token;
+
         $r->internal_redirect('/adm/switchserver');
     } else {
-        &Apache::lonauth::success($r,$form{'uname'},$form{'udom'},
-                                  $lonhost,$firsturl,undef,\%form);
+        $courseid = Apache::lonnet::is_course($courseid); 
+
+        Apache::lonauth::success($r, $username, $domain, $uhome,
+            ($courseid ? "/adm/selfenroll?courseid=$courseid" : '/adm/roles'),
+            undef, {}); 
     }
-    return %form;
-}
 
+    return;
+}
 
+#
+# The screen that the user gets to create his or her account
+# Desired username, desired password, etc
+# Stores token to store DES-key and stage during creation session
+#
 sub print_dataentry_form {
     my ($r,$domain,$lonhost,$include,$mailtoken,$now,$username,$start_page) = @_;
     my ($error,$output);
@@ -750,7 +727,7 @@ ENDSERVERFORM
         my $upasstwo = '<input type="password" name="upasscheck'.$now.'" size="10" />';
         my $submit_text = &mt('Create LON-CAPA account');
         $output .= '<h3>'.&mt('Login Data').'</h3>'."\n".
-                   '<form name="client" method="post" '.
+                   '<form name="client" method="post" action="" '.
                    'onsubmit="return checkpass();">'."\n".
                    &Apache::lonhtmlcommon::start_pick_box()."\n".
                    &Apache::lonhtmlcommon::row_title(&mt('Username'),
@@ -788,6 +765,10 @@ ENDSERVERFORM
     return $output;
 }
 
+#
+# Retrieve rules for generating accounts from domain configuration
+# Can the user make a new account or just self-enroll?
+
 sub get_creation_controls {
     my ($domain,$usercreation) = @_;
     my (@cancreate,@statustocreate);
@@ -795,6 +776,17 @@ sub get_creation_controls {
         if (ref($usercreation->{'cancreate'}) eq 'HASH') {
             if (ref($usercreation->{'cancreate'}{'statustocreate'}) eq 'ARRAY') {
                 @statustocreate = @{$usercreation->{'cancreate'}{'statustocreate'}};
+                if (@statustocreate == 0) {
+                    my ($othertitle,$usertypes,$types) =
+                        &Apache::loncommon::sorted_inst_types($domain);
+                    if (ref($types) eq 'ARRAY') {
+                        if (@{$types} == 0) {
+                            @statustocreate = ('default');
+                        }
+                    } else {
+                        @statustocreate = ('default');
+                    }
+                }
             } else {
                 @statustocreate = ('default');
                 my ($othertitle,$usertypes,$types) =
@@ -815,9 +807,13 @@ sub get_creation_controls {
 }
 
 sub create_account {
-    my ($r,$domain,$lonhost,$username,$domdesc) = @_;
+    my ($r,$domain,$username,$domdesc) = @_;
+# Get the token info
     my ($retrieved,$output,$upass) = &process_credentials($env{'form.logtoken'},
                                                           $env{'form.serverid'}); 
+# $retrieved is 'ok' if things worked
+# $output is user error output
+# $upass is the decrypted password
     # Error messages
     my $error     = '<span class="LC_error">'.&mt('Error:').' ';
     my $end       = '</span><br /><br />';
@@ -826,6 +822,7 @@ sub create_account {
                     &Apache::loncommon::end_page();
     if ($retrieved eq 'ok') {
         if ($env{'form.courseid'} ne '') {
+# See if we are allowed to use this username per domain rules (number of characters, etc)
             my ($result,$userchkmsg) = &check_id($username,$domain,$domdesc);
             if ($result eq 'fail') {
                 $output = $error.&mt('Invalid ID format').$end.
@@ -836,22 +833,32 @@ sub create_account {
     } else {
         return ('fail',$error.$output.$end.$rtnlink);
     }
-    # Call modifyuser
+    # Yes! We can do this. Valid token, valid username format
+    # Create an internally authenticated account with password $upass 
+    # if the account does not exist yet
+    # Assign student/staff number $env{'form.cid'}, first name, last name, etc
     my $result = 
         &Apache::lonnet::modifyuser($domain,$username,$env{'form.cid'},
                                     'internal',$upass,$env{'form.cfirstname'},
                                     $env{'form.cmiddlename'},$env{'form.clastname'},
                                     $env{'form.cgeneration'},undef,undef,$username);
     $output = &mt('Generating user: [_1]',$result);
+    # Now that the user exists, we can have a homeserver
     my $uhome = &Apache::lonnet::homeserver($username,$domain);
     $output .= '<br />'.&mt('Home server: [_1]',$uhome).' '.
               &Apache::lonnet::hostname($uhome).'<br /><br />';
-    return ('ok',$output);
+    return ('ok',$output,$uhome);
 }
 
 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);
@@ -866,7 +873,7 @@ sub username_validation {
     if ($uhome ne 'no_host') {
         my $result = &Apache::lonnet::authenticate($username,$upass,$domain);
         if ($result ne 'no_host') { 
-            my %form = &start_session($r,$username,$domain,$lonhost,$courseid);
+            &start_session($r,$username,$domain,$uhome,$courseid);
             $output = '<br /><br />'.&mt('A LON-CAPA account already exists for username [_1] at this institution ([_2]).','<tt>'.$username.'</tt>',$domdesc).'<br />'.&mt('The password entered was also correct so you have been logged in.');
             return ('existingaccount',$output);
         } else {
@@ -973,7 +980,7 @@ sub username_check {
         }
     }
     if ($checkfail) { 
-        $msg = '<h4>'.&mt('Account creation unavailable').'</h4>';
+        $msg = '<br /><h4>'.&mt('Account creation unavailable').'</h4>';
         if ($checkfail eq 'username') {
             $msg .= '<span class="LC_warning">'.
                      &mt('A LON-CAPA account may not be created with the username you use.').
@@ -999,7 +1006,7 @@ sub username_check {
         if ($rowcount) {
             if ($editable) {
                 if ($courseid ne '') { 
-                    $msg = '<h4>'.&mt('User information').'</h4>';
+                    $msg = '<br /><h4>'.&mt('User information').'</h4>';
                 }
                 $msg .= &mt('To create one, use the table below to provide information about yourself, then click the [_1]Create LON-CAPA account[_2] button.','<span class="LC_cusr_emph">','</span>').'<br />';
             } else {
@@ -1020,7 +1027,7 @@ sub username_check {
 }
 
 sub username_activation {
-    my ($r,$username,$domain,$domdesc,$lonhost,$courseid) = @_;
+    my ($r,$username,$domain,$domdesc,$courseid) = @_;
     my $output;
     my $error     = '<span class="LC_error">'.&mt('Error:').' ';
     my $end       = '</span><br /><br />';
@@ -1090,7 +1097,8 @@ sub username_activation {
         if ($result eq 'ok') {
             my $delete = &Apache::lonnet::tmpdel($env{'form.authtoken'});
             $output = &mt('A LON-CAPA account has been created for username: [_1] in domain: [_2].',$username,$domain);
-            my %form = &start_session($r,$username,$domain,$lonhost,$courseid);
+            my $uhome=&Apache::lonnet::homeserver($username,$domain,'true');
+            &start_session($r,$username,$domain,$uhome,$courseid);
             my $nostart = 1;
             return ('ok',$output,$nostart);
         } else {
@@ -1106,6 +1114,9 @@ sub username_activation {
 sub check_id {
     my ($username,$domain,$domdesc) = @_;
     # Check ID format
+    # Is $username in an okay format for $domain 
+    # (right number of characters, special characters, etc - follow domain rules)?
+    # $domdesc is just used for user error messages
     my (%alerts,%rulematch,%inst_results,%curr_rules,%checkhash);
     my %checks = ('id' => 1);
     %{$checkhash{$username.':'.$domain}} = (
@@ -1244,6 +1255,12 @@ ENDSERVERFORM
 }
 
 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);
@@ -1265,6 +1282,10 @@ sub process_credentials {
     } 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);
 }