--- loncom/interface/lonuserutils.pm 2014/04/04 23:06:31 1.166
+++ loncom/interface/lonuserutils.pm 2016/10/14 23:26:21 1.177
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Utility functions for managing LON-CAPA user accounts
#
-# $Id: lonuserutils.pm,v 1.166 2014/04/04 23:06:31 raeburn Exp $
+# $Id: lonuserutils.pm,v 1.177 2016/10/14 23:26:21 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -30,12 +30,29 @@
package Apache::lonuserutils;
+=pod
+
+=head1 NAME
+
+Apache::lonuserutils.pm
+
+=head1 SYNOPSIS
+
+ Utilities for management of users and custom roles
+
+ Provides subroutines called by loncreateuser.pm
+
+=head1 OVERVIEW
+
+=cut
+
use strict;
use Apache::lonnet;
use Apache::loncommon();
use Apache::lonhtmlcommon;
use Apache::lonlocal;
use Apache::longroup;
+use HTML::Entities;
use LONCAPA qw(:DEFAULT :match);
###############################################################
@@ -450,6 +467,7 @@ sub javascript_validations {
if (($mode eq 'upload') && ($context eq 'domain')) {
$alert{'inststatus'} = &mt('The optional affiliation field was not specified');
}
+ &js_escape(\%alert);
my $function_name = <<"END";
$setsections_js
@@ -642,8 +660,9 @@ sub upload_manager_javascript_forward_as
$numbuttons ++;
}
if (!$can_assign->{'int'}) {
- my $warning = &mt('You may not specify an initial password for each user, as this is only available when new users use LON-CAPA internal authentication.').'\n'.
+ my $warning = &mt('You may not specify an initial password for each user, as this is only available when new users use LON-CAPA internal authentication.')."\n".
&mt('Your current role does not have rights to create users with that authentication type.');
+ &js_escape(\$warning);
$auth_update = <<"END";
// Currently the initial password field is only supported for internal auth
// (see bug 6368).
@@ -781,6 +800,7 @@ sub upload_manager_javascript_reverse_as
if (!$can_assign->{'int'}) {
my $warning = &mt('You may not specify an initial password, as this is only available when new users use LON-CAPA internal authentication.\n').
&mt('Your current role does not have rights to create users with that authentication type.');
+ &js_escape(\$warning);
$auth_update = <<"END";
// Currently the initial password field is only supported for internal auth
// (see bug 6368).
@@ -1527,10 +1547,10 @@ sub curr_role_permissions {
# ======================================================= Existing Custom Roles
sub my_custom_roles {
- my ($crstype) = @_;
+ my ($crstype,$udom,$uname) = @_;
my %returnhash=();
my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1});
- my %rolehash=&Apache::lonnet::dump('roles');
+ my %rolehash=&Apache::lonnet::dump('roles',$udom,$uname);
foreach my $key (keys(%rolehash)) {
if ($key=~/^rolesdef\_(\w+)$/) {
if ($crstype eq 'Community') {
@@ -2410,6 +2430,7 @@ sub make_keylist_array {
$index->{'photo'} = &Apache::loncoursedata::CL_PHOTO();
$index->{'thumbnail'} = &Apache::loncoursedata::CL_THUMBNAIL();
$index->{'credits'} = &Apache::loncoursedata::CL_CREDITS();
+ $index->{'instsec'} = &Apache::loncoursedata::CL_INSTSEC();
$index->{'authorquota'} = &Apache::loncoursedata::CL_AUTHORQUOTA();
$index->{'authorusage'} = &Apache::loncoursedata::CL_AUTHORUSAGE();
foreach my $key (keys(%{$index})) {
@@ -2542,9 +2563,13 @@ $verify_action_js
function username_display_launch(username,domain) {
var target;
- for (var i=0; i');
+ 'actionlist" value="'.&HTML::Entities::encode($checkval,'&<>"').'" />');
} else {
$r->print(' ');
}
@@ -3074,7 +3100,7 @@ END
if ($item eq 'username') {
$r->print(''.&print_username_link($mode,\%in).' ');
} elsif (($item eq 'start' || $item eq 'end') && ($actionselect)) {
- $r->print(''.$in{$item}.' '."\n");
+ $r->print(''.$in{$item}.' '."\n");
} elsif ($item eq 'status') {
my $showitem = $in{$item};
if (defined($ltstatus{$in{$item}})) {
@@ -3173,6 +3199,10 @@ sub bulkaction_javascript {
my $noaction = &mt("You need to select an action to take for the user(s) you have selected");
my $singconfirm = &mt(' for a single user?');
my $multconfirm = &mt(' for multiple users?');
+ &js_escape(\$alert);
+ &js_escape(\$noaction);
+ &js_escape(\$singconfirm);
+ &js_escape(\$multconfirm);
my $output = <<"ENDJS";
function verify_action (field) {
var numchecked = 0;
@@ -4290,7 +4320,10 @@ sub upfile_drop_add {
my $newuserdom = $env{'request.role.domain'};
map { $cancreate{$_} = &can_create_user($newuserdom,$context,$_); } keys(%longtypes);
# Get new users list
+ my (%existinguser,%userinfo,%disallow,%rulematch,%inst_results,%alerts,%checkuname);
+ my $counter = -1;
foreach my $line (@userdata) {
+ $counter ++;
my @secs;
my %entries=&Apache::loncommon::record_sep($line);
# Determine user name
@@ -4322,23 +4355,20 @@ sub upfile_drop_add {
if ($entries{$fields{'username'}} =~ /\s/) {
$nowhitespace = ' - '.&mt('usernames may not contain spaces.');
}
- $r->print(
- '
'.
+ $disallow{$counter} =
&mt('Unacceptable username [_1] for user [_2] [_3] [_4] [_5]',
- '"'.$entries{$fields{'username'}}.'"',
- $fname,$mname,$lname,$gen).
- $nowhitespace);
+ '"'.$entries{$fields{'username'}}.'"',
+ $fname,$mname,$lname,$gen).$nowhitespace;
next;
} else {
$entries{$fields{'domain'}} =~ s/^\s+|\s+$//g;
if ($entries{$fields{'domain'}}
ne &LONCAPA::clean_domain($entries{$fields{'domain'}})) {
- $r->print(
- '
'.
+ $disallow{$counter} =
&mt('Unacceptable domain [_1] for user [_2] [_3] [_4] [_5]',
- '"'.$entries{$fields{'domain'}}.'"',
- $fname,$mname,$lname,$gen));
- next;
+ '"'.$entries{$fields{'domain'}}.'"',
+ $fname,$mname,$lname,$gen);
+ next;
}
my $username = $entries{$fields{'username'}};
my $userdomain = $entries{$fields{'domain'}};
@@ -4350,10 +4380,15 @@ sub upfile_drop_add {
$entries{$fields{'sec'}} =~ s/\W//g;
my $item = $entries{$fields{'sec'}};
if ($item eq "none" || $item eq 'all') {
- $r->print('
'.&mt('[_1]: Unable to enroll user [_2] [_3] [_4] [_5] in a section named "[_6]" - this is a reserved word.',''.$username.'',$fname,$mname,$lname,$gen,$item));
+ $disallow{$counter} =
+ &mt('[_1]: Unable to enroll user [_2] [_3] [_4] [_5] in a section named "[_6]" - this is a reserved word.',
+ ''.$username.'',$fname,$mname,$lname,$gen,$item);
next;
} elsif (exists($curr_groups{$item})) {
- $r->print('
'.&mt('[_1]: Unable to enroll user [_2] [_3] [_4] [_5] in a section named "[_6]" - this is a course group.',''.$username.'',$fname,$mname,$lname,$gen,$item).' '.&mt('Section names and group names must be distinct.'));
+ $disallow{$counter} =
+ &mt('[_1]: Unable to enroll user [_2] [_3] [_4] [_5] in a section named "[_6]" - this is a course group.',
+ ''.$username.'',$fname,$mname,$lname,$gen,$item).' '.
+ &mt('Section names and group names must be distinct.');
next;
} else {
push(@secs,$item);
@@ -4365,14 +4400,21 @@ sub upfile_drop_add {
if (ref($userlist{$username.':'.$userdomain}) eq 'ARRAY') {
my $currsec = $userlist{$username.':'.$userdomain}[$secidx];
if ($currsec ne $env{'request.course.sec'}) {
- $r->print('
'.&mt('[_1]: Unable to enroll user [_2] [_3] [_4] [_5] in a section named "[_6]".',''.$username.'',$fname,$mname,$lname,$gen,$secs[0]).'
');
+ $disallow{$counter} =
+ &mt('[_1]: Unable to enroll user [_2] [_3] [_4] [_5] in a section named "[_6]".',
+ ''.$username.'',$fname,$mname,$lname,$gen,$secs[0]);
if ($currsec eq '') {
- $r->print(&mt('This user already has an active/future student role in the course, unaffiliated to any section.'));
+ $disallow{$counter} .=
+ &mt('This user already has an active/future student role in the course, unaffiliated to any section.');
} else {
- $r->print(&mt('This user already has an active/future role in section "[_1]" of the course.',$currsec));
+ $disallow{$counter} .=
+ &mt('This user already has an active/future role in section "[_1]" of the course.',$currsec);
}
- $r->print('
'.&mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$secs[0]).'
');
+ $disallow{$counter} .=
+ '
'.
+ &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',
+ $secs[0]);
next;
}
}
@@ -4424,13 +4466,12 @@ sub upfile_drop_add {
}
if ($role eq '') {
my $rolestr = join(', ',@permitted_roles);
- $r->print('
'
- .&mt('[_1]: You do not have permission to add the requested role [_2] for the user.'
- ,''.$entries{$fields{'username'}}.''
- ,$entries{$fields{'role'}})
- .'
'
- .&mt('Allowable role(s) is/are: [_1].',$rolestr)."\n"
- );
+ $disallow{$counter} =
+ &mt('[_1]: You do not have permission to add the requested role [_2] for the user.'
+ ,''.$entries{$fields{'username'}}.''
+ ,$entries{$fields{'role'}})
+ .'
'
+ .&mt('Allowable role(s) is/are: [_1].',$rolestr);
next;
}
}
@@ -4460,55 +4501,36 @@ sub upfile_drop_add {
# check against rules
my $checkid = 0;
my $newuser = 0;
- my (%rulematch,%inst_results,%idinst_results);
my $uhome=&Apache::lonnet::homeserver($username,$userdomain);
if ($uhome eq 'no_host') {
if ($userdomain ne $newuserdom) {
if ($context eq 'course') {
- $r->print('
'.
- &mt('[_1]: The domain specified ([_2]) is different to that of the course.',
- ''.$username.'',$userdomain).'
');
+ $disallow{$counter} =
+ &mt('[_1]: The domain specified ([_2]) is different to that of the course.',
+ ''.$username.'',$userdomain);
} elsif ($context eq 'author') {
- $r->print(&mt('[_1]: The domain specified ([_2]) is different to that of the author.',
- ''.$username.'',$userdomain).'
');
+ $disallow{$counter} =
+ &mt('[_1]: The domain specified ([_2]) is different to that of the author.',
+ ''.$username.'',$userdomain);
} else {
- $r->print(&mt('[_1]: The domain specified ([_2]) is different to that of your current role.',
- ''.$username.'',$userdomain).'
');
+ $disallow{$counter} =
+ &mt('[_1]: The domain specified ([_2]) is different to that of your current role.',
+ ''.$username.'',$userdomain);
}
- $r->print(&mt('The user does not already exist, and you may not create a new user in a different domain.'));
+ $disallow{$counter} .=
+ &mt('The user does not already exist, and you may not create a new user in a different domain.');
next;
+ } else {
+ unless ($password || $env{'form.login'} eq 'loc') {
+ $disallow{$counter} =
+ &mt('[_1]: This is a new user but no default password was provided, and the authentication type requires one.',
+ ''.$username.'');
+ next;
+ }
}
$checkid = 1;
$newuser = 1;
- my $user = $username.':'.$newuserdom;
- my $checkhash;
- my $checks = { 'username' => 1 };
- $checkhash->{$username.':'.$newuserdom} = { 'newuser' => 1, };
- &Apache::loncommon::user_rule_check($checkhash,$checks,
- \%alerts,\%rulematch,\%inst_results,\%curr_rules,
- \%got_rules);
- if (ref($alerts{'username'}) eq 'HASH') {
- if (ref($alerts{'username'}{$newuserdom}) eq 'HASH') {
- if ($alerts{'username'}{$newuserdom}{$username}) {
- $r->print('
'.
- &mt('[_1]: matches the username format at your institution, but is not known to your directory service.',''.$username.'').'
'.
- &mt('Consequently, the user was not created.'));
- next;
- }
- }
- }
- my $usertype = 'unofficial';
- if (ref($rulematch{$user}) eq 'HASH') {
- if ($rulematch{$user}{'username'}) {
- $usertype = 'official';
- }
- }
- unless ($cancreate{$usertype}) {
- my $showtype = $longtypes{$usertype};
- $r->print('
'.
- &mt('[_1]: The user does not exist, and you are not permitted to create users of type: [_2].',''.$username.'',$showtype));
- next;
- }
+ $checkuname{$username.':'.$newuserdom} = { 'newuser' => $newuser, 'id' => $id };
} else {
if ($context eq 'course' || $context eq 'author') {
if ($userdomain eq $domain ) {
@@ -4541,77 +4563,205 @@ sub upfile_drop_add {
}
}
}
+ if ($id) {
+ $existinguser{$userdomain}{$username} = $id;
+ }
+ }
+ $userinfo{$counter} = {
+ username => $username,
+ domain => $userdomain,
+ fname => $fname,
+ mname => $mname,
+ lname => $lname,
+ gen => $gen,
+ email => $email,
+ id => $id,
+ password => $password,
+ inststatus => $inststatus,
+ role => $role,
+ sections => \@secs,
+ credits => $credits,
+ newuser => $newuser,
+ checkid => $checkid,
+ };
+ }
+ }
+ } # end of foreach (@userdata)
+ if ($counter > -1) {
+ my $total = $counter + 1;
+ my %checkids;
+ if ((keys(%existinguser)) || (keys(%checkuname))) {
+ $r->print(&mt('Please be patient -- checking for institutional data ...'));
+ $r->rflush();
+ if (keys(%existinguser)) {
+ foreach my $dom (keys(%existinguser)) {
+ if (ref($existinguser{$dom}) eq 'HASH') {
+ my %idhash = &Apache::lonnet::idrget($dom,keys(%{$existinguser{$dom}}));
+ foreach my $username (keys(%{$existinguser{$dom}})) {
+ if ($idhash{$username} ne $existinguser{$dom}{$username}) {
+ $checkids{$username.':'.$dom} = {
+ 'id' => $existinguser{$dom}{$username},
+ };
+ }
+ }
+ if (keys(%checkids)) {
+ &Apache::loncommon::user_rule_check(\%checkids,{ 'id' => 1 },
+ \%alerts,\%rulematch,
+ \%inst_results,\%curr_rules,
+ \%got_rules);
+ }
+ }
}
- if ($id ne '') {
- if (!$newuser) {
- my %idhash = &Apache::lonnet::idrget($userdomain,($username));
- if ($idhash{$username} ne $id) {
- $checkid = 1;
+ }
+ if (keys(%checkuname)) {
+ &Apache::loncommon::user_rule_check(\%checkuname,{ 'username' => 1, 'id' => 1, },
+ \%alerts,\%rulematch,\%inst_results,
+ \%curr_rules,\%got_rules);
+ }
+ $r->print(' '.&mt('done').'
');
+ $r->rflush();
+ }
+ my %prog_state = &Apache::lonhtmlcommon::Create_PrgWin($r,$total);
+ $r->print('');
+ for (my $i=0; $i<=$counter; $i++) {
+ if ($disallow{$i}) {
+ $r->print('
');
+ &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
+ }
# Flush the course logs so reverse user roles immediately updated
$r->register_cleanup(\&Apache::lonnet::flushcourselogs);
$r->print("
'.
+ &mt('Consequently, the user was not created.').'
'.
- &mt('Consequently, the user was not created.'));
+ &mt('Consequently, the user was not created.').'
'.
+ &mt('Consequently, the ID was not changed.').'
'.
- &mt('[_1]: Unable to enroll. No password specified.',''.$username.'')
- );
- } elsif ($context eq 'author') {
- $r->print('
'.
- &mt('[_1]: Unable to add co-author. No password specified.',''.$username.'')
- );
- } else {
- $r->print('
'.
- &mt('[_1]: Unable to add user. No password specified.',''.$username.'')
- );
- }
+ $flushc =
+ &user_change_result($r,$userresult,$authresult,
+ $roleresult,$idresult,\%counts,$flushc,
+ $username,$userdomain,\%userchg);
}
}
- }
- } # end of foreach (@userdata)
+ &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last user');
+ } # end of loop
+ $r->print('
\n".&mt('Processed [quant,_1,user].',$counts{'user'}).
@@ -4750,11 +4889,12 @@ sub user_change_result {
my ($r,$userresult,$authresult,$roleresult,$idresult,$counts,$flushc,
$username,$userdomain,$userchg) = @_;
my $okresult = 0;
+ my @status;
if ($userresult ne 'ok') {
if ($userresult =~ /^error:(.+)$/) {
my $error = $1;
- $r->print('
'.
- &mt('[_1]: Unable to add/modify: [_2]',''.$username.':'.$userdomain.'',$error));
+ push(@status,
+ &mt('[_1]: Unable to add/modify: [_2]',''.$username.':'.$userdomain.'',$error));
}
} else {
$counts->{'user'} ++;
@@ -4763,8 +4903,8 @@ sub user_change_result {
if ($authresult ne 'ok') {
if ($authresult =~ /^error:(.+)$/) {
my $error = $1;
- $r->print('
'.
- &mt('[_1]: Unable to modify authentication: [_2]',''.$username.':'.$userdomain.'',$error));
+ push(@status,
+ &mt('[_1]: Unable to modify authentication: [_2]',''.$username.':'.$userdomain.'',$error));
}
} else {
$counts->{'auth'} ++;
@@ -4773,8 +4913,8 @@ sub user_change_result {
if ($roleresult ne 'ok') {
if ($roleresult =~ /^error:(.+)$/) {
my $error = $1;
- $r->print('
'.
- &mt('[_1]: Unable to add role: [_2]',''.$username.':'.$userdomain.'',$error));
+ push(@status,
+ &mt('[_1]: Unable to add role: [_2]',''.$username.':'.$userdomain.'',$error));
}
} else {
$counts->{'role'} ++;
@@ -4783,14 +4923,16 @@ sub user_change_result {
if ($okresult) {
$flushc++;
$userchg->{$username.':'.$userdomain}=1;
- $r->print('. ');
if ($flushc>15) {
$r->rflush;
$flushc=0;
}
}
if ($idresult) {
- $r->print($idresult);
+ push(@status,$idresult);
+ }
+ if (@status) {
+ $r->print('