--- loncom/interface/createaccount.pm	2010/12/01 21:38:29	1.43
+++ loncom/interface/createaccount.pm	2012/12/05 18:23:54	1.54
@@ -3,7 +3,7 @@
 # institutional log-in ID (institutional authentication required - localauth
 #  or kerberos) or an e-mail address.
 #
-# $Id: createaccount.pm,v 1.43 2010/12/01 21:38:29 raeburn Exp $
+# $Id: createaccount.pm,v 1.54 2012/12/05 18:23:54 bisitz Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -39,12 +39,13 @@ use Apache::lonhtmlcommon;
 use Apache::lonlocal;
 use Apache::lonauth;
 use Apache::resetpw;
-use Authen::Captcha;
 use DynaLoader; # for Crypt::DES version
 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 +66,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 +93,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 +120,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 +188,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 +275,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 +286,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;
@@ -401,8 +381,14 @@ sub print_username_form {
         }
         if (grep(/^email$/,@{$cancreate})) {
             $output .= '<div class="LC_left_float"><h3>'.&mt('Create account with an e-mail address as your username').'</h3>';
-            my $captchaform = &create_captcha();
-            if ($captchaform) {
+            my ($captchaform,$error) = &Apache::loncommon::captcha_display('usercreation',$lonhost);
+            if ($error) {
+                my $helpdesk = '/adm/helpdesk?origurl=%2fadm%2fcreateaccount';
+                if ($courseid ne '') {
+                    $helpdesk .= '&courseid='.$courseid;
+                }
+                $output .= '<span class="LC_error">'.&mt('An error occurred generating the validation code[_1] required for an e-mail address to be used as username.','<br />').'</span><br /><br />'.&mt('[_1]Contact the helpdesk[_2] or [_3]reload[_2] the page and try again.','<a href="'.$helpdesk.'">','</a>','<a href="javascript:window.location.reload()">');
+            } else {
                 my $submit_text = &mt('Request LON-CAPA account');
                 my $emailform = '<input type="text" name="useremail" size="25" value="" />';
                 if (grep(/^login$/,@{$cancreate})) {
@@ -410,15 +396,17 @@ 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".
-                            $emailform."\n".
-                            &Apache::lonhtmlcommon::row_closure(1).
-                            &Apache::lonhtmlcommon::row_title(&mt('Validation'),
-                                                             'LC_pick_box_title')."\n".
-                            $captchaform."\n".'<br /><br />';
+                                                              'LC_pick_box_title')."\n".
+                            $emailform."\n";
+                if ($captchaform) {
+                    $output .= &Apache::lonhtmlcommon::row_closure(1).
+                               &Apache::lonhtmlcommon::row_title(&mt('Validation'),
+                                                                 'LC_pick_box_title')."\n".
+                               $captchaform."\n".'<br /><br />';
+                }
                 if ($courseid ne '') {
                     $output .= '<input type="hidden" name="courseid" value="'.$courseid.'"/>'."\n"; 
                 }
@@ -432,12 +420,6 @@ sub print_username_form {
                     $output .= &Apache::lonhtmlcommon::echo_form_input(['courseid']);
                 }
                 $output .= '</form>';
-            } else {
-                my $helpdesk = '/adm/helpdesk?origurl=%2fadm%2fcreateaccount';
-                if ($courseid ne '') {
-                    $helpdesk .= '&courseid='.$courseid;
-                }
-                $output .= '<span class="LC_error">'.&mt('An error occurred generating the validation code[_1] required for an e-mail address to be used as username.','<br />').'</span><br /><br />'.&mt('[_1]Contact the helpdesk[_2] or [_3]reload[_2] the page and try again.','<a href="'.$helpdesk.'">','</a>','<a href="javascript:window.location.reload()">');
             }
             $output .= '</div>';
         }
@@ -464,7 +446,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".
@@ -522,23 +504,10 @@ sub process_email_request {
                                          $contact_name,$contact_email);
                 return $output;
             } else {
-                my $code = $env{'form.code'};
-                my $md5sum = $env{'form.crypt'};
-                my %captcha_params = &captcha_settings();
-                my $captcha = Authen::Captcha->new(
-                                  output_folder => $captcha_params{'output_dir'},
-                                  data_folder   => $captcha_params{'db_dir'},
-                                 );
-                my $captcha_chk = $captcha->check_code($code,$md5sum);
-                my %captcha_hash = (
-                                  0       => 'Code not checked (file error)',
-                                  -1      => 'Failed: code expired',
-                                  -2      => 'Failed: invalid code (not in database)',
-                                  -3      => 'Failed: invalid code (code does not match crypt)',
-                                   );
+                my ($captcha_chk,$captcha_error) = &Apache::loncommon::captcha_response('usercreation',$server);
                 if ($captcha_chk != 1) {
                     $output = &invalid_state('captcha',$domdesc,$contact_name,
-                                             $contact_email,$captcha_hash{$captcha_chk});
+                                             $contact_email,$captcha_error);
                     return $output;
                 }
                 my $uhome=&Apache::lonnet::homeserver($useremail,$domain);
@@ -638,8 +607,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 +621,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 +649,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 +715,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 +753,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 +764,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,17 +795,22 @@ 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 />';
-    my $rtnlink   = '<a href="javascript:history.back();" />'.
+    my $rtnlink   = '<a href="javascript:history.back();">'.
                     &mt('Return to previous page').'</a>'.
                     &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 +821,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 +861,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 +968,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 +994,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,11 +1015,11 @@ 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 />';
-    my $rtnlink   = '<a href="javascript:history.back();" />'.
+    my $rtnlink   = '<a href="javascript:history.back();">'.
                     &mt('Return to previous page').'</a>'.
                     &Apache::loncommon::end_page();
     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
@@ -1090,7 +1085,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 +1102,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}} = (
@@ -1152,55 +1151,28 @@ sub invalid_state {
     if ($msgtext) {
         $msg .= '<br />'.$msgtext;
     }
-    $msg .= &linkto_email_help($contact_email,$domdesc);
+    $msg .= &linkto_email_help($contact_email,$domdesc,$error);
     return $msg;
 }
 
 sub linkto_email_help {
-    my ($contact_email,$domdesc) = @_;
+    my ($contact_email,$domdesc,$error) = @_;
     my $msg;
+    my $href = '/adm/helpdesk';
     if ($contact_email ne '') {
         my $escuri = &HTML::Entities::encode('/adm/createaccount','&<>"');
-        $msg .= '<br />'.&mt('You may wish to contact the [_1]LON-CAPA helpdesk[_2] for [_3].','<a href="/adm/helpdesk?origurl='.$escuri.'">','</a>',$domdesc).'<br />';
+        $href .= '?origurl='.$escuri;
+        if ($error eq 'existinguser') {
+            my $escemail = &HTML::Entities::encode($env{'form.useremail'});
+            $href .= '&useremail='.$escemail.'&useraccount='.$escemail;
+        }
+        $msg .= '<br />'.&mt('You may wish to contact the [_1]LON-CAPA helpdesk[_2] for [_3].','<a href="'.$href.'">','</a>',$domdesc).'<br />';
     } else {
         $msg .= '<br />'.&mt('You may wish to send an e-mail to the server administrator: [_1] for [_2].',$Apache::lonnet::perlvar{'AdminEmail'},$domdesc).'<br />';
     }
     return $msg;
 }
 
-sub create_captcha {
-    my ($output_dir,$db_dir) = @_;
-    my %captcha_params = &captcha_settings();
-    my ($output,$maxtries,$tries) = ('',10,0);
-    while ($tries < $maxtries) {
-        $tries ++;
-        my $captcha = Authen::Captcha->new (
-                                           output_folder => $captcha_params{'output_dir'},
-                                           data_folder   => $captcha_params{'db_dir'},
-                                          );
-        my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
-
-        if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
-            $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
-                      &mt('Type in the letters/numbers shown below').'&nbsp;'.
-                     '<input type="text" size="5" name="code" value="" /><br />'.
-                     '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" />';
-            last;
-        }
-    }
-    return $output;
-}
-
-sub captcha_settings {
-    my %captcha_params = ( 
-                           output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
-                           www_output_dir => "/captchaspool",
-                           db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
-                           numchars       => '5',
-                         );
-    return %captcha_params;
-}
-
 sub getkeys {
     my ($lkey,$ukey) = @_;
     my $lextkey=hex($lkey);
@@ -1238,6 +1210,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);
@@ -1259,6 +1237,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);
 }