--- loncom/interface/createaccount.pm 2013/06/05 12:46:39 1.56
+++ loncom/interface/createaccount.pm 2017/07/26 19:45:45 1.73
@@ -1,9 +1,10 @@
# The LearningOnline Network
# Allow visitors to create a user account with the username being either an
-# institutional log-in ID (institutional authentication required - localauth
-# or kerberos) or an e-mail address.
+# institutional log-in ID (institutional authentication required - localauth,
+# kerberos, or SSO) or an e-mail address. Requests to use an e-mail address as
+# username may be processed automatically, or may be queued for approval.
#
-# $Id: createaccount.pm,v 1.56 2013/06/05 12:46:39 raeburn Exp $
+# $Id: createaccount.pm,v 1.73 2017/07/26 19:45:45 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -44,8 +45,6 @@ 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');
@@ -56,11 +55,11 @@ sub handler {
my $domain;
- my $sso_username = $r->subprocess_env->get('REDIRECT_SSOUserUnknown');
- my $sso_domain = $r->subprocess_env->get('REDIRECT_SSOUserDomain');
+ my $sso_username = $r->subprocess_env->get('SSOUserUnknown');
+ my $sso_domain = $r->subprocess_env->get('SSOUserDomain');
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
- ['token','courseid','domain']);
+ ['token','courseid','domain','type']);
&Apache::lonacc::get_posted_cgi($r);
&Apache::lonlocal::get_language_handle($r);
@@ -103,7 +102,8 @@ sub handler {
my $end_page =
&Apache::loncommon::end_page();
$r->print($start_page."\n".'
'.&mt('You are already logged in').'
'.
- '
'.&mt('Please either [_1]continue the current session[_2] or [_3]log out[_4].','','','','').
+ '
'.&mt('Please either [_1]continue the current session[_2] or [_3]log out[_4].',
+ '','','','').
'
'.
''.
- &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).'
';
+ &mt('Creation of a new user account using an institutional log-in ID or e-mail verification is not permitted for: [_1].',$domdesc).
+ '
';
$r->print($output);
&print_footer($r);
return OK;
@@ -165,10 +189,37 @@ sub handler {
if (grep(/^sso$/,@{$cancreate})) {
$msg = '
'.&mt('Account creation').'
'.
&mt("Although your username and password were authenticated by your institution's Single Sign On system, you do not currently have a LON-CAPA account at this institution.").' ';
-
+ my $shibenv;
+ if (($r->dir_config('lonOtherAuthen') eq 'yes') &&
+ ($r->dir_config('lonOtherAuthenType') eq 'Shibboleth')) {
+ if (ref($domconfig{'usercreation'}) eq 'HASH') {
+ if (ref($domconfig{'usercreation'}{'cancreate'}) eq 'HASH') {
+ if (ref($domconfig{'usercreation'}{'cancreate'}{'shibenv'}) eq 'HASH') {
+ my @possfields = ('firstname','middlename','lastname','generation',
+ 'permanentemail','id');
+ $shibenv= {};
+ foreach my $key (keys(%{$domconfig{'usercreation'}{'cancreate'}{'shibenv'}})) {
+ if ($key eq 'inststatus') {
+ if (ref($usertypes) eq 'HASH') {
+ if ($domconfig{'usercreation'}{'cancreate'}{'shibenv'}{$key} ne '') {
+ if (exists($usertypes->{$domconfig{'usercreation'}{'cancreate'}{'shibenv'}{$key}})) {
+ $shibenv->{$key} = $domconfig{'usercreation'}{'cancreate'}{'shibenv'}{$key};
+ }
+ }
+ }
+ } elsif (grep(/^\Q$key\E/,@possfields)) {
+ if ($domconfig{'usercreation'}{'cancreate'}{'shibenv'}{$key} ne '') {
+ $shibenv->{$key} = $domconfig{'usercreation'}{'cancreate'}{'shibenv'}{$key};
+ }
+ }
+ }
+ }
+ }
+ }
+ }
$msg .= &username_check($sso_username,$domain,$domdesc,$courseid,
$lonhost,$contact_email,$contact_name,
- $sso_logout,$statustocreate);
+ $sso_logout,$statustocreate,$shibenv);
} else {
$msg = '
'.&mt('Account creation unavailable').'
'.
''.&mt("Although your username and password were authenticated by your institution's Single Sign On system, you do not currently have a LON-CAPA account at this institution, and you are not permitted to create one.").'
'.&mt('Please contact the [_1] ([_2]) for assistance.',$contact_name,$contact_email).''.
@@ -179,13 +230,17 @@ sub handler {
return OK;
}
- my ($output,$nostart,$noend);
+ my ($output,$nostart,$noend,$redirect);
my $token = $env{'form.token'};
if ($token) {
- ($output,$nostart,$noend) =
+ ($output,$nostart,$noend,$redirect) =
&process_mailtoken($r,$token,$contact_name,$contact_email,$domain,
- $domdesc,$lonhost,$include,$start_page);
- if ($nostart) {
+ $domdesc,$lonhost,$include,$start_page,$cancreate,
+ $domconfig{'usercreation'},$types);
+ if ($redirect) {
+ $r->internal_redirect('/adm/switchserver');
+ return OK;
+ } elsif ($nostart) {
if ($noend) {
return OK;
} else {
@@ -200,12 +255,29 @@ sub handler {
return OK;
}
}
-
+ my ($usernameset,$condition);
+ if ((grep(/^email$/,@{$cancreate})) && (($env{'form.create_with_email'}) ||
+ ((!$token) && ($env{'form.phase'} eq '')))) {
+ my $usertype = &get_usertype($domain);
+ if (ref($verification) eq 'HASH') {
+ if ($verification->{$usertype} eq 'other') {
+ $usernameset = 1;
+ if (ref($emaildomain) eq 'HASH') {
+ if ($emaildomain->{$usertype} ne '') {
+ $condition = $emaildomain->{$usertype};
+ }
+ }
+ }
+ }
+ }
if ($env{'form.phase'} eq 'username_activation') {
(my $result,$output,$nostart) =
&username_activation($r,$env{'form.uname'},$domain,$domdesc,
$courseid);
- if ($result eq 'ok') {
+ if ($result eq 'redirect') {
+ $r->internal_redirect('/adm/switchserver');
+ return OK;
+ } elsif ($result eq 'ok') {
if ($nostart) {
return OK;
}
@@ -228,23 +300,32 @@ sub handler {
}
} elsif ($env{'form.create_with_email'}) {
&print_header($r,$start_page,$courseid);
- $output = &process_email_request($env{'form.useremail'},$domain,$domdesc,
+ my $usertype = &get_usertype($domain);
+ $output = &process_email_request($env{'form.uname'},$domain,$domdesc,
$contact_name,$contact_email,$cancreate,
$lonhost,$domconfig{'usercreation'},
- $courseid);
+ $emailusername,$courseid,$usertype,
+ $usernameset,$condition);
} elsif (!$token) {
- &print_header($r,$start_page,$courseid);
+ &print_header($r,$start_page,$courseid,$pagetitle);
my $now=time;
- if (grep(/^login$/,@{$cancreate})) {
- my $jsh=Apache::File->new($include."/londes.js");
- $r->print(<$jsh>);
- $r->print(&javascript_setforms($now));
+ if ((grep(/^login$/,@{$cancreate})) && (!grep(/^email$/,@{$cancreate}))) {
+ if (open(my $jsh,"<$include/londes.js")) {
+ while(my $line = <$jsh>) {
+ $r->print($line);
+ }
+ close($jsh);
+ $r->print(&javascript_setforms($now));
+ }
}
if (grep(/^email$/,@{$cancreate})) {
$r->print(&javascript_validmail());
}
- $output = &print_username_form($domain,$domdesc,$cancreate,$now,$lonhost,
- $courseid);
+ my $usertype = &get_usertype($domain);
+ $output = &print_username_form($r,$domain,$domdesc,$cancreate,$now,$lonhost,
+ $include,$courseid,$emailusername,
+ $statusforemail,$usernameset,$condition,
+ $usertype,$types,$usertypes,$othertitle);
}
$r->print($output);
&print_footer($r);
@@ -252,16 +333,25 @@ sub handler {
}
sub print_header {
- my ($r,$start_page,$courseid) = @_;
+ my ($r,$start_page,$courseid,$pagetitle) = @_;
$r->print($start_page);
&Apache::lonhtmlcommon::clear_breadcrumbs();
+ my $url = '/adm/createaccount';
+ if ($pagetitle eq '') {
+ $pagetitle = 'New username';
+ }
if ($courseid ne '') {
my %coursehash = &Apache::lonnet::coursedescription($courseid);
&selfenroll_crumbs($r,$courseid,$coursehash{'description'});
}
+ if ($env{'form.reportedtype'}) {
+ &Apache::lonhtmlcommon::add_breadcrumb
+ ({href=>$url,
+ text=>"Select affiliation"});
+ }
&Apache::lonhtmlcommon::add_breadcrumb
- ({href=>"/adm/createuser",
- text=>"New username"});
+ ({href=>$url,
+ text=>$pagetitle});
$r->print(&Apache::lonhtmlcommon::breadcrumbs('Create account'));
return;
}
@@ -272,13 +362,29 @@ sub print_footer {
$r->print('');
}
$r->print(&Apache::loncommon::end_page());
}
+sub get_usertype {
+ my ($domain) = @_;
+ my $usertype;
+ my ($othertitle,$usertypes,$types) = &Apache::loncommon::sorted_inst_types($domain);
+ if (ref($types) eq 'ARRAY') {
+ push(@{$types},'default');
+ my $posstype = $env{'form.type'};
+ $posstype =~ s/^\s+|\s$//g;
+ if (grep(/^\Q$posstype\E$/,@{$types})) {
+ $usertype = $posstype;
+ }
+ }
+ return $usertype;
+}
+
sub selfenroll_crumbs {
my ($r,$courseid,$desc) = @_;
&Apache::lonhtmlcommon::add_breadcrumb
@@ -291,7 +397,7 @@ sub selfenroll_crumbs {
}
my $last_crumb;
if ($desc ne '') {
- $last_crumb = &mt('Self-enroll in [_1]',"$desc");
+ $last_crumb = &mt("Self-enroll in [_1]","'$desc'");
} else {
$last_crumb = &mt('Self-enroll');
}
@@ -303,145 +409,266 @@ sub selfenroll_crumbs {
}
sub javascript_setforms {
- my ($now) = @_;
- my $js = <
- function send() {
- this.document.server.elements.uname.value = this.document.client.elements.uname.value;
- this.document.server.elements.udom.value = this.document.client.elements.udom.value;
- uextkey=this.document.client.elements.uextkey.value;
- lextkey=this.document.client.elements.lextkey.value;
- initkeys();
-
- this.document.server.elements.upass.value
- = crypted(this.document.client.elements.upass$now.value);
-
- this.document.client.elements.uname.value='';
- this.document.client.elements.upass$now.value='';
+ my ($now,$emailusername,$captcha,$usertype,$recaptchaversion,$usernameset,$condition) = @_;
+ my ($setuserinfo,@required,$requiredchk);
+ if (ref($emailusername) eq 'HASH') {
+ if (ref($emailusername->{$usertype}) eq 'HASH') {
+ foreach my $key (sort(keys(%{$emailusername->{$usertype}}))) {
+ if ($emailusername->{$usertype}{$key} eq 'required') {
+ push(@required,$key);
+ }
+ $setuserinfo .= ' server.elements.'.$key.'.value=client.elements.'.$key.'.value;'."\n";
+ }
+ $setuserinfo .= ' server.elements.type.value=client.elements.type.value;'."\n";
+ }
+ if ($captcha eq 'original') {
+ $setuserinfo .= ' server.elements.code.value=client.elements.code.value;'."\n".
+ ' server.elements.crypt.value=client.elements.crypt.value;'."\n";
+ } elsif ($captcha eq 'recaptcha') {
+ if ($recaptchaversion ne '2') {
+ $setuserinfo .=
+ ' server.elements.recaptcha_challenge_field.value=client.elements.recaptcha_challenge_field.value;'."\n".
+ ' server.elements.recaptcha_response_field.value=client.elements.recaptcha_response_field.value;'."\n";
+ }
+ }
+ if ($usernameset) {
+ $setuserinfo .=
+ ' server.elements.username.value=client.elements.username.value;'."\n";
+ }
+ }
+ if (@required) {
+ my $missprompt = &mt('One or more required fields are currently blank.');
+ &js_escape(\$missprompt);
+ my $reqstr = join("','",@required);
+ $requiredchk = <<"ENDCHK";
+ var requiredfields = new Array('$reqstr');
+ missing = 0;
+ for (var i=0; i 0) {
+ alert("$missprompt");
+ return false;
+ }
- this.document.server.submit();
+ENDCHK
+ }
+ my $js = <
+//
+
+// ]]>
+
ENDSCRIPT
+ if (($captcha eq 'recaptcha') && ($recaptchaversion eq '2')) {
+ $js .= "\n".''."\n";
+ }
return $js;
}
sub javascript_checkpass {
- my ($now) = @_;
+ my ($now,$context) = @_;
my $nopass = &mt('You must enter a password.');
- my $mismatchpass = &mt('The passwords you entered did not match.').'\\n'.
+ my $mismatchpass = &mt('The passwords you entered did not match.')."\n".
&mt('Please try again.');
+ &js_escape(\$nopass);
+ &js_escape(\$mismatchpass);
my $js = <<"ENDSCRIPT";
-
ENDSCRIPT
return $js;
}
sub javascript_validmail {
- my %lt = &Apache::lonlocal::texthash (
+ my %js_lt = &Apache::lonlocal::texthash (
email => 'The e-mail address you entered',
notv => 'is not a valid e-mail address',
);
my $output = "\n".''."\n";
+ $output .= "\n".'// ]]>'."\n".''."\n";
return $output;
}
sub print_username_form {
- my ($domain,$domdesc,$cancreate,$now,$lonhost,$courseid) = @_;
- my %lt = &Apache::lonlocal::texthash(
- unam => 'username',
- udom => 'domain',
- uemail => 'E-mail address in LON-CAPA',
- proc => 'Proceed');
+ my ($r,$domain,$domdesc,$cancreate,$now,$lonhost,$include,$courseid,$emailusername,
+ $statusforemail,$usernameset,$condition,$usertype,$types,$usertypes,
+ $othertitle) = @_;
+ my %lt = &Apache::lonlocal::texthash (
+ crac => 'Create account with a username provided by this institution',
+ clca => 'Create LON-CAPA account',
+ type => 'Type in your log-in ID and password to find out.',
+ plse => 'Please provide a password for your new account.',
+ info => 'Please provide user information and a password for your new account.',
+ yopw => 'Your password will be encrypted when sent (and stored).',
+ crae => 'Create account using e-mail address verification',
+ );
my $output;
if (ref($cancreate) eq 'ARRAY') {
if (grep(/^login$/,@{$cancreate})) {
my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
if ((($domdefaults{'auth_def'} =~/^krb/) && ($domdefaults{'auth_arg_def'} ne '')) || ($domdefaults{'auth_def'} eq 'localauth')) {
- $output = '
'.&mt('Create account with a username provided by this institution').'
';
- 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.',' ').'
'.&mt('Type in your log-in ID and password to find out.').'
'.&mt('Choose your affiliation at [_1]',$domdesc).'
'."\n".
+ '';
} else {
- my $submit_text = &mt('Request LON-CAPA account');
- my $emailform = '';
- if (grep(/^login$/,@{$cancreate})) {
- $output .= &mt('Provide your e-mail address to request a LON-CAPA account,[_1] if you do not have a log-in ID at your institution.',' ').'
';
+ my ($captchaform,$error,$captcha,$recaptchaversion) =
+ &Apache::loncommon::captcha_display('usercreation',$lonhost);
+ if ($error) {
+ my $helpdesk = '/adm/helpdesk?origurl=%2fadm%2fcreateaccount';
+ if ($courseid ne '') {
+ $helpdesk .= '&courseid='.$courseid;
+ }
+ $output .= ''.
+ &mt('An error occurred generating the validation code[_1] required for use of an e-mail address to request a LON-CAPA account.',' ').
+ '
';
}
}
if ($output eq '') {
- $output = &mt('Creation of a new LON-CAPA user account using an e-mail address or an institutional log-in ID as your username is not permitted at [_1].',$domdesc);
+ $output = &mt('Creation of a new LON-CAPA user account using an institutional log-in ID or verification by e-mail is not permitted at [_1].',$domdesc);
} else {
$output .= '';
}
@@ -455,14 +682,14 @@ sub login_box {
createaccount => 'Log-in ID',
selfenroll => 'Username',
);
- my ($lkey,$ukey) = &Apache::lonpreferences::des_keys();
+ my ($lkey,$ukey) = &Apache::loncommon::des_keys();
my ($lextkey,$uextkey) = &getkeys($lkey,$ukey);
my $logtoken=Apache::lonnet::reply('tmpput:'.$ukey.$lkey.'&createaccount:createaccount',
$lonhost);
$output = &serverform($logtoken,$lonhost,undef,$courseid,$context);
- my $unameform = '';
- my $upassform = '';
- $output .= '