[LON-CAPA-cvs] cvs: loncom /interface createaccount.pm
raeburn
lon-capa-cvs-allow@mail.lon-capa.org
Thu, 17 Jul 2008 12:10:09 -0000
This is a MIME encoded message
--raeburn1216296609
Content-Type: text/plain
raeburn Thu Jul 17 08:10:09 2008 EDT
Modified files:
/loncom/interface createaccount.pm
Log:
- Breadcrumbs added to facilitate retreat to earlier pages during account creation process.
- &catreturn_js() added to provide javascript functions used in breadcrumb trail to jump back to
course catalog or first self-enrollment screen, when account creation occuring in context of self-rnrollment
- &print_footer() added to provide backupcrumbs form where coursecatalog search terms are stored so breadcrumb links can jump back to entry point from course catalog in self-enroll context.
- &selfenroll_crumbs() added to provide additional breadcrumbs in selfe-ennroll context.
- &login_failure_msg() added to put messages displayed when authentication fails in one place, with a link back to try again.
- form element cid renamed courseid (and $cid renamed $courseid) to avoid confusing this with the cid form element used for entering a studentID in loncreateuser:personal_data_display().
--raeburn1216296609
Content-Type: text/plain
Content-Disposition: attachment; filename="raeburn-20080717081009.txt"
Index: loncom/interface/createaccount.pm
diff -u loncom/interface/createaccount.pm:1.21 loncom/interface/createaccount.pm:1.22
--- loncom/interface/createaccount.pm:1.21 Mon Jul 14 06:17:42 2008
+++ loncom/interface/createaccount.pm Thu Jul 17 08:10:05 2008
@@ -3,7 +3,7 @@
# institutional log-in ID (institutional authentication required - localauth
# or kerberos) or an e-mail address.
#
-# $Id: createaccount.pm,v 1.21 2008/07/14 10:17:42 raeburn Exp $
+# $Id: createaccount.pm,v 1.22 2008/07/17 12:10:05 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -52,7 +52,7 @@
if ($r->header_only) {
return OK;
}
-
+
my $domain;
my $sso_username = $r->subprocess_env->get('REDIRECT_SSOUserUnknown');
@@ -90,35 +90,41 @@
return OK;
}
- my $courseid;
+ my ($js,$courseid,$title);
if (defined($env{'form.courseid'})) {
$courseid = &validate_course($env{'form.courseid'});
}
+ if ($courseid ne '') {
+ $js = &catreturn_js();
+ $title = 'Self-enroll in a LON-CAPA course';
+ } else {
+ $title = 'Create a user account in LON-CAPA';
+ }
if ($env{'form.phase'} eq 'selfenroll_login') {
+ $title = 'Self-enroll in a LON-CAPA course';
if ($env{'form.udom'} ne '') {
$domain = $env{'form.udom'};
}
my ($result,$output) =
&username_validation($r,$env{'form.uname'},$domain,$domdesc,
-
$contact_name,$contact_email,$courseid,
$lonhost);
if ($result eq 'existingaccount') {
$r->print($output);
- $r->print(&Apache::loncommon::end_page());
+ &print_footer($r);
return OK;
} else {
$start_page =
- &Apache::loncommon::start_page('Self-enroll in a LON-CAPA course','',
+ &Apache::loncommon::start_page($title,$js,
{'no_inline_link' => 1,});
- &print_header($r,$start_page);
- $r->print($output.&Apache::loncommon::end_page());
+ &print_header($r,$start_page,$courseid);
+ $r->print($output);
+ &print_footer($r);
return OK;
}
}
-
$start_page =
- &Apache::loncommon::start_page('Create a user account in LON-CAPA','',
+ &Apache::loncommon::start_page($title,$js,
{'no_inline_link' => 1,});
my @cancreate;
my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$domain);
@@ -134,17 +140,17 @@
}
if (@cancreate == 0) {
- &print_header($r,$start_page);
+ &print_header($r,$start_page,$courseid);
my $output = '<h3>'.&mt('Account creation unavailable').'</h3>'.
'<span class="LC_warning">'.
&mt('Creation of a new user account using an e-mail address or an institutional log-in ID as username is not permitted at this institution ([_1]).',$domdesc).'</span><br /><br />';
$r->print($output);
- $r->print(&Apache::loncommon::end_page());
+ &print_footer($r);
return OK;
}
if ($sso_username ne '') {
- &print_header($r,$start_page);
+ &print_header($r,$start_page,$courseid);
my ($msg,$sso_logout);
$sso_logout = &sso_logout_frag($r,$domain);
if (grep(/^sso$/,@cancreate)) {
@@ -159,7 +165,7 @@
$sso_logout;
}
$r->print($msg);
- $r->print(&Apache::loncommon::end_page());
+ &print_footer($r);
return OK;
}
@@ -174,13 +180,13 @@
return OK;
} else {
$r->print($output);
- $r->print(&Apache::loncommon::end_page());
+ &print_footer($r);
return OK;
}
} else {
- &print_header($r,$start_page);
+ &print_header($r,$start_page,$courseid);
$r->print($output);
- $r->print(&Apache::loncommon::end_page());
+ &print_footer($r);
return OK;
}
}
@@ -194,9 +200,9 @@
return OK;
}
}
- &print_header($r,$start_page);
+ &print_header($r,$start_page,$courseid);
$r->print($output);
- $r->print(&Apache::loncommon::end_page());
+ &print_footer($r);
return OK;
} elsif ($env{'form.phase'} eq 'username_validation') {
(my $result,$output) =
@@ -205,19 +211,19 @@
$lonhost);
if ($result eq 'existingaccount') {
$r->print($output);
- $r->print(&Apache::loncommon::end_page());
+ &print_footer($r);
return OK;
} else {
- &print_header($r,$start_page);
+ &print_header($r,$start_page,$courseid);
}
} elsif ($env{'form.create_with_email'}) {
- &print_header($r,$start_page);
+ &print_header($r,$start_page,$courseid);
$output = &process_email_request($env{'form.useremail'},$domain,$domdesc,
$contact_name,$contact_email,\@cancreate,
$lonhost,$domconfig{'usercreation'},
$courseid);
} elsif (!$token) {
- &print_header($r,$start_page);
+ &print_header($r,$start_page,$courseid);
my $now=time;
if (grep(/^login$/,@cancreate)) {
my $jsh=Apache::File->new($include."/londes.js");
@@ -228,17 +234,21 @@
$r->print(&javascript_validmail());
}
$output = &print_username_form($domain,$domdesc,\@cancreate,$now,$lonhost,
- $courseid);
+ $courseid);
}
$r->print($output);
- $r->print(&Apache::loncommon::end_page());
+ &print_footer($r);
return OK;
}
sub print_header {
- my ($r,$start_page) = @_;
+ my ($r,$start_page,$courseid) = @_;
$r->print($start_page);
&Apache::lonhtmlcommon::clear_breadcrumbs();
+ if ($courseid ne '') {
+ my %coursehash = &Apache::lonnet::coursedescription($courseid);
+ &selfenroll_crumbs($r,$courseid,$coursehash{'description'});
+ }
&Apache::lonhtmlcommon::add_breadcrumb
({href=>"/adm/createuser",
text=>"New username"});
@@ -246,6 +256,42 @@
return;
}
+sub print_footer {
+ my ($r) = @_;
+ if ($env{'form.courseid'} ne '') {
+ $r->print('<form name="backupcrumbs" method="post" action="">'.
+ &Apache::lonhtmlcommon::echo_form_input(['backto','logtoken',
+ 'token','serverid','uname','upass','phase','create_with_email',
+ 'code','useremail','crypt','cfirstname','clastname',
+ 'cmiddlename','cgeneration','cpermanentemail','cid]).
+ '</form>');
+ }
+ $r->print(&Apache::loncommon::end_page());
+}
+
+sub selfenroll_crumbs {
+ my ($r,$courseid,$desc) = @_;
+ &Apache::lonhtmlcommon::add_breadcrumb
+ ({href=>"javascript:ToCatalog('backupcrumbs','')",
+ text=>"Course Catalog"});
+ if ($env{'form.coursenum'} ne '') {
+ &Apache::lonhtmlcommon::add_breadcrumb
+ ({href=>"javascript:ToCatalog('backupcrumbs','details')",
+ text=>"Course details"});
+ }
+ my $last_crumb;
+ if ($desc ne '') {
+ $last_crumb = &mt('Self-enroll in [_1]','<span class="LC_cusr_emph">'.$desc.'</span>');
+ } else {
+ $last_crumb = &mt('Self-enroll');
+ }
+ &Apache::lonhtmlcommon::add_breadcrumb
+ ({href=>"javascript:ToSelfenroll('backupcrumbs')",
+ text=>$last_crumb,
+ no_mt=>"1"});
+ return;
+}
+
sub validate_course {
my ($courseid) = @_;
my ($cdom,$cnum) = ($courseid =~ /^($match_domain)_($match_courseid)$/);
@@ -346,7 +392,7 @@
my $submit_text = &mt('Create LON-CAPA account');
$output .= &mt('If you already have a log-in ID at this institution,[_1] you may be able to use it for LON-CAPA.','<br />').'<br /><br />'.&mt('Type in your log-in ID and password to find out.').'<br /><br />';
$output .= &login_box($now,$lonhost,$courseid,$submit_text,
- $domain,'createaccount');
+ $domain,'createaccount').'</div>';
}
}
if (grep(/^email$/,@{$cancreate})) {
@@ -374,8 +420,11 @@
$output .= '<input type="submit" name="create_with_email" value="'.
$submit_text.'" />'.
&Apache::lonhtmlcommon::row_closure(1).
- &Apache::lonhtmlcommon::end_pick_box().'<br /><br /></form>'.
- '</div>';
+ &Apache::lonhtmlcommon::end_pick_box().'<br /><br />';
+ if ($courseid ne '') {
+ $output .= &Apache::lonhtmlcommon::echo_form_input(['courseid']);
+ }
+ $output .= '</form></div>';
}
}
if ($output eq '') {
@@ -424,7 +473,7 @@
&Apache::lonhtmlcommon::end_pick_box().'<br /><br />'."\n".
'<input type="hidden" name="lextkey" value="'.$lextkey.'">'."\n".
'<input type="hidden" name="uextkey" value="'.$uextkey.'">'."\n".
- '</form></div>';
+ '</form>';
return $output;
}
@@ -608,7 +657,7 @@
$courseid = &validate_course($courseid);
if ($courseid ne '') {
$form{'courseid'} = $courseid;
- $firsturl = '/adm/selfenroll?cid='.$courseid;
+ $firsturl = '/adm/selfenroll?courseid='.$courseid;
}
}
if ($r->dir_config('lonBalancer') eq 'yes') {
@@ -730,7 +779,7 @@
&mt('Return to previous page').'</a>'.
&Apache::loncommon::end_page();
if ($retrieved eq 'ok') {
- if ($env{'form.cid'} ne '') {
+ if ($env{'form.courseid'} ne '') {
my ($result,$userchkmsg) = &check_id($username,$domain,$domdesc);
if ($result eq 'fail') {
$output = $error.&mt('Invalid ID format').$end.
@@ -775,10 +824,7 @@
$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 {
- $output = '<div class="LC_warning">'.
- &mt('Username and/or password could not be authenticated.').
- '</div>'.
- &mt('Please check the username and password.');
+ $output = &login_failure_msg($courseid);
}
} else {
my $primlibserv = &Apache::lonnet::domain($domain,'primary');
@@ -795,15 +841,28 @@
$output = &username_check($username,$domain,$domdesc,$courseid,$lonhost,
$contact_email,$contact_name);
} else {
- $output = '<div class="LC_warning">'.
- &mt('Username and/or password could not be authenticated.').
- '</div>'.
- &mt('Please check the username and password.');
+ $output = &login_failure_msg($courseid);
}
}
return ('ok',$output);
}
+sub login_failure_msg {
+ my ($courseid) = @_;
+ my $url;
+ if ($courseid ne '') {
+ $url = "/adm/selfenroll?courseid=".$courseid;
+ } else {
+ $url = "/adm/createaccount";
+ }
+ my $output = '<h4>'.&mt('Authentication failed').'</h4><div class="LC_warning">'.
+ &mt('Username and/or password could not be authenticated.').
+ '</div>'.
+ &mt('Please check the username and password.').'<br /><br />';
+ '<a href="'.$url.'">'.&mt('Try again').'</a>';
+ return $output;
+}
+
sub username_check {
my ($username,$domain,$domdesc,$courseid,$lonhost,$contact_email,$contact_name,
$sso_logout) = @_;
@@ -877,12 +936,21 @@
&mt('Create LON-CAPA account').'" /></form>';
if ($rowcount) {
if ($editable) {
- $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 />';
+ if ($courseid ne '') {
+ $msg = '<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 {
- $msg = &mt('A user account will be created with information displayed in the table below, when you click the [_1]Create LON-CAPA account[_2] button.','<span class="LC_cusr_emph">','</span>').'<br />';
+ if ($courseid ne '') {
+ $msg = '<h4>'.&mt('Review user information').'</h4>';
+ }
+ $msg .= &mt('A user account will be created with information displayed in the table below, when you click the [_1]Create LON-CAPA account[_2] button.','<span class="LC_cusr_emph">','</span>').'<br />';
}
} else {
- $msg = '<br />'.&mt('Confirm that you wish to create an account.');
+ if ($courseid ne '') {
+ $msg = '<h4>'.&mt('Confirmation').'</h4>';
+ }
+ $msg .= &mt('Confirm that you wish to create an account.');
}
$msg .= $output;
}
@@ -922,7 +990,7 @@
if ((($domdefaults{'auth_def'} =~/^krb(4|5)$/) &&
($domdefaults{'auth_arg_def'} ne '')) ||
($domdefaults{'auth_def'} eq 'localauth')) {
- if ($env{'form.cid'} ne '') {
+ if ($env{'form.courseid'} ne '') {
my ($result,$userchkmsg) = &check_id($username,$domain,$domdesc);
if ($result eq 'fail') {
$output = $error.&mt('Invalid ID format').$end.
@@ -932,7 +1000,7 @@
}
# Call modifyuser
my $result =
- &Apache::lonnet::modifyuser($domain,$username,$env{'form.cid'},
+ &Apache::lonnet::modifyuser($domain,$username,$env{'form.courseid'},
$domdefaults{'auth_def'},
$domdefaults{'auth_arg_def'},$env{'form.cfirstname'},
$env{'form.cmiddlename'},$env{'form.clastname'},
@@ -1056,11 +1124,15 @@
sub serverform {
my ($logtoken,$lonhost,$mailtoken,$courseid,$context) = @_;
- my $phase = 'username_validation"';
+ my $phase = 'username_validation';
+ my $catalog_elements;
if ($context eq 'selfenroll') {
$phase = 'selfenroll_login';
}
- my $output .= <<ENDSERVERFORM;
+ if ($courseid ne '') {
+ $catalog_elements = &Apache::lonhtmlcommon::echo_form_input(['courseid','phase']);
+ }
+ my $output = <<ENDSERVERFORM;
<form name="server" method="post" action="/adm/createaccount">
<input type="hidden" name="logtoken" value="$logtoken" />
<input type="hidden" name="token" value="$mailtoken" />
@@ -1069,6 +1141,7 @@
<input type="hidden" name="upass" value="" />
<input type="hidden" name="phase" value="$phase" />
<input type="hidden" name="courseid" value="$courseid" />
+ $catalog_elements
</form>
ENDSERVERFORM
return $output;
@@ -1153,4 +1226,61 @@
return $endsessionmsg;
}
+sub catreturn_js {
+ return <<"ENDSCRIPT";
+<script type="text/javascript">
+
+function ToSelfenroll(formname) {
+ var formidx = getFormByName(formname);
+ if (formidx > -1) {
+ document.forms[formidx].action = '/adm/selfenroll';
+ numidx = getIndexByName(formidx,'phase');
+ if (numidx > -1) {
+ document.forms[formidx].elements[numidx].value = '';
+ }
+ numidx = getIndexByName(formidx,'context');
+ if (numidx > -1) {
+ document.forms[formidx].elements[numidx].value = '';
+ }
+ }
+ document.forms[formidx].submit();
+}
+
+function ToCatalog(formname,caller) {
+ var formidx = getFormByName(formname);
+ if (formidx > -1) {
+ document.forms[formidx].action = '/adm/coursecatalog';
+ numidx = getIndexByName(formidx,'coursenum');
+ if (numidx > -1) {
+ if (caller != 'details') {
+ document.forms[formidx].elements[numidx].value = '';
+ }
+ }
+ }
+ document.forms[formidx].submit();
+}
+
+function getIndexByName(formidx,item) {
+ for (var i=0;i<document.forms[formidx].elements.length;i++) {
+ if (document.forms[formidx].elements[i].name == item) {
+ return i;
+ }
+ }
+ return -1;
+}
+
+function getFormByName(item) {
+ for (var i=0; i<document.forms.length; i++) {
+ if (document.forms[i].name == item) {
+ return i;
+ }
+ }
+ return -1;
+}
+
+</script>
+ENDSCRIPT
+
+}
+
1;
--raeburn1216296609--