--- loncom/interface/createaccount.pm	2010/08/16 14:39:20	1.40.2.1
+++ loncom/interface/createaccount.pm	2012/05/17 17:41:48	1.49
@@ -3,7 +3,7 @@
 # institutional log-in ID (institutional authentication required - localauth
 #  or kerberos) or an e-mail address.
 #
-# $Id: createaccount.pm,v 1.40.2.1 2010/08/16 14:39:20 raeburn Exp $
+# $Id: createaccount.pm,v 1.49 2012/05/17 17:41:48 www 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';
@@ -128,8 +122,7 @@ sub handler {
             return OK;
         } else {
             $start_page = 
-                &Apache::loncommon::start_page($title,$js,
-                                               {'no_inline_link'   => 1,});
+                &Apache::loncommon::start_page($title,$js);
             &print_header($r,$start_page,$courseid);
             $r->print($output);
             &print_footer($r);    
@@ -137,8 +130,8 @@ sub handler {
         }
     }
     $start_page =
-        &Apache::loncommon::start_page($title,$js,
-                                       {'no_inline_link'   => 1,});
+        &Apache::loncommon::start_page($title,$js);
+
     my %domconfig = 
         &Apache::lonnet::get_dom('configuration',['usercreation'],$domain);
     my ($cancreate,$statustocreate) = &get_creation_controls($domain,$domconfig{'usercreation'});
@@ -285,7 +278,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');
     }
@@ -296,17 +289,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;
@@ -411,7 +393,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".
@@ -460,12 +442,12 @@ sub login_box {
                                             );
     my ($lkey,$ukey) = &Apache::lonpreferences::des_keys();
     my ($lextkey,$uextkey) = &getkeys($lkey,$ukey);
-    my $logtoken=Apache::lonnet::reply('tmpput:'.$ukey.$lkey.'&createaccount',
+    my $logtoken=Apache::lonnet::reply('tmpput:'.$ukey.$lkey.'&createaccount:createaccount',
                                        $lonhost);
     $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".
@@ -598,7 +580,7 @@ sub send_token {
                 'domain'     => $domain,
                 'username'   => $email,
                 'courseid'   => $courseid);
-    my $token = &Apache::lonnet::tmpput(\%info,$server);
+    my $token = &Apache::lonnet::tmpput(\%info,$server,'createaccount');
     if ($token !~ /^error/ && $token ne 'no_such_host') {
         my $esc_token = &escape($token);
         my $showtime = localtime(time);
@@ -653,9 +635,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, $lonhost,
+                        $data{'courseid'}, $token);
                     $nostart = 1;
                     $noend = 1;
                 } else {
@@ -682,31 +663,24 @@ 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, $lonhost, $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, $lonhost,
+            '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, $lonhost,
+            ($courseid ? "/adm/selfenroll?courseid=$courseid" : '/adm/roles'),
+            undef, {}); 
     }
-    return %form;
+
+    return;
 }
 
 
@@ -722,7 +696,7 @@ sub print_dataentry_form {
         $output .= &javascript_setforms($now)."\n".&javascript_checkpass($now);
         my ($lkey,$ukey) = &Apache::lonpreferences::des_keys();
         my ($lextkey,$uextkey) = &getkeys($lkey,$ukey);
-        my $logtoken=Apache::lonnet::reply('tmpput:'.$ukey.$lkey.'&createaccount',
+        my $logtoken=Apache::lonnet::reply('tmpput:'.$ukey.$lkey.'&createaccount:createaccount',
                                            $lonhost);
         my $formtag = '<form name="server" method="post" target="_top" action="/adm/createaccount">';
         my ($datatable,$rowcount) =
@@ -751,7 +725,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'),
@@ -796,6 +770,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) =
@@ -853,6 +838,12 @@ sub create_account {
 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);
@@ -867,7 +858,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, $lonhost, $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 {
@@ -963,7 +954,7 @@ sub username_check {
                     'time'       => $now,
                     'domain'     => $domain,
                     'username'   => $username);
-        my $authtoken = &Apache::lonnet::tmpput(\%info,$lonhost);
+        my $authtoken = &Apache::lonnet::tmpput(\%info,$lonhost,'createaccount');
         if ($authtoken !~ /^error/ && $authtoken ne 'no_such_host') {
             $output .= '<input type="hidden" name="authtoken" value="'.&HTML::Entities::encode($authtoken,'&<>"').'" />';
         } else {
@@ -974,7 +965,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.').
@@ -1000,7 +991,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 {
@@ -1091,7 +1082,7 @@ 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);
+            &start_session($r, $username, $domain, $lonhost, $courseid);
             my $nostart = 1;
             return ('ok',$output,$nostart);
         } else {
@@ -1137,32 +1128,38 @@ sub invalid_state {
     my ($error,$domdesc,$contact_name,$contact_email,$msgtext) = @_;
     my $msg = '<h3>'.&mt('Account creation unavailable').'</h3><span class="LC_error">';
     if ($error eq 'baduseremail') {
-        $msg = &mt('The e-mail address you provided does not appear to be a valid address.');
+        $msg .= &mt('The e-mail address you provided does not appear to be a valid address.');
     } elsif ($error eq 'existinguser') {
-        $msg = &mt('The e-mail address you provided is already in use as a username in LON-CAPA at this institution.');
+        $msg .= &mt('The e-mail address you provided is already in use as a username in LON-CAPA at this institution.');
     } elsif ($error eq 'userrules') {
-        $msg = &mt('Username rules at this institution do not allow the e-mail address you provided to be used as a username.');
+        $msg .= &mt('Username rules at this institution do not allow the e-mail address you provided to be used as a username.');
     } elsif ($error eq 'userformat') {
-        $msg = &mt('The e-mail address you provided may not be used as a username at this LON-CAPA institution.');
+        $msg .= &mt('The e-mail address you provided may not be used as a username at this LON-CAPA institution.');
     } elsif ($error eq 'captcha') {
-        $msg = &mt('Validation of the code your entered failed.');
+        $msg .= &mt('Validation of the code you entered failed.');
     } elsif ($error eq 'noemails') {
-        $msg = &mt('Creation of a new user account using an e-mail address as username is not permitted at this LON-CAPA institution.');
+        $msg .= &mt('Creation of a new user account using an e-mail address as username is not permitted at this LON-CAPA institution.');
     }
     $msg .= '</span>';
     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 />';
     }
@@ -1239,6 +1236,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);
@@ -1260,6 +1263,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);
 }