--- loncom/interface/loncreateuser.pm 2003/07/19 00:51:05 1.63 +++ loncom/interface/loncreateuser.pm 2004/01/17 18:12:05 1.77 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Create a user # -# $Id: loncreateuser.pm,v 1.63 2003/07/19 00:51:05 www Exp $ +# $Id: loncreateuser.pm,v 1.77 2004/01/17 18:12:05 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -29,10 +29,41 @@ package Apache::loncreateuser; +=pod + +=head1 NAME + +Apache::loncreateuser - handler to create users and custom roles + +=head1 SYNOPSIS + +Apache::loncreateuser provides an Apache handler for creating users, + editing their login parameters, roles, and removing roles, and + also creating and assigning custom roles. + +=head1 OVERVIEW + +=head2 Custom Roles + +In LON-CAPA, roles are actually collections of privileges. "Teaching +Assistant", "Course Coordinator", and other such roles are really just +collection of privileges that are useful in many circumstances. + +Creating custom roles can be done by the Domain Coordinator through +the Create User functionality. That screen will show all privileges +that can be assigned to users. For a complete list of privileges, +please see C. + +Custom role definitions are stored in the C file of the role +author. + +=cut + use strict; use Apache::Constants qw(:common :http); use Apache::lonnet; use Apache::loncommon; +use Apache::lonlocal; my $loginscript; # piece of javascript used in two separate instances my $generalrule; @@ -93,13 +124,26 @@ sub print_username_entry_form { my @domains = &Apache::loncommon::get_domains(); my $domform = &Apache::loncommon::select_dom_form($defdom,'ccdomain'); my $bodytag =&Apache::loncommon::bodytag( - 'Create Users, Change User Privileges'); + 'Create Users, Change User Privileges'). + &Apache::loncommon::help_open_faq(282). + &Apache::loncommon::help_open_bug('Instructor Interface'); my $selscript=&Apache::loncommon::studentbrowser_javascript(); my $sellink=&Apache::loncommon::selectstudent_link ('crtuser','ccuname','ccdomain'); my %existingroles=&my_custom_roles(); my $choice=&Apache::loncommon::select_form('make new role','rolename', ('make new role' => 'Generate new role ...',%existingroles)); + my %lt=&Apache::lonlocal::texthash( + 'siur' => "Set Individual User Roles", + 'usr' => "Username", + 'dom' => "Domain", + 'usrr' => "User Roles", + 'ecrp' => "Edit Custom Role Privileges", + 'nr' => "Name of Role", + 'cre' => "Custom Role Editor" + ); + my $helpsiur=&Apache::loncommon::help_open_topic('Course_Change_Privileges'); + my $helpecpr=&Apache::loncommon::help_open_topic('Course_Editing_Custom_Roles'); $r->print(<<"ENDDOCUMENT"); @@ -109,19 +153,19 @@ $selscript $bodytag
-

Set Individual User Roles

+

$lt{siur}$helpsiur

- +$lt{'dom'}:
Username: +
$lt{usr}: $sellink
-Domain:$domform
$domform
- +
-

Edit Custom Role Privileges

-Name of Role: $choice
- +

$lt{'ecrp'}$helpecpr

+$lt{'nr'}: $choice
+ ENDDOCUMENT @@ -206,31 +250,44 @@ ENDFORMINFO ''."\n". &Apache::loncommon::home_server_option_list($ccdomain); + my %lt=&Apache::lonlocal::texthash( + 'cnu' => "Create New User", + 'nu' => "New User", + 'id' => "in domain", + 'pd' => "Personal Data", + 'fn' => "First Name", + 'mn' => "Middle Name", + 'ln' => "Last Name", + 'gen' => "Generation", + 'idsn' => "ID/Student Number", + 'hs' => "Home Server", + 'lg' => "Login Data" + ); $r->print(<Create New User +

$lt{'cnu'}

$forminfo -

New user "$ccuname" in domain $ccdomain

+

$lt{'nu'} "$ccuname" $lt{'id'} $ccdomain

-

Personal Data

+

$lt{'pd'}

- + - + - + - +
First Name
$lt{'fn'}
Middle Name
$lt{'mn'}
Last Name
$lt{'ln'}
Generation
$lt{'gen'}
-ID/Student Number

-Home Server: +$lt{'idsn'}

+$lt{'hs'}:
-

Login Data

+

$lt{'lg'}

$generalrule

$authformkrb

$authformint

@@ -238,11 +295,20 @@ Home Server: -Co-Author +$lt{'cau'} $cudom\_$cuname Set Start Date +"javascript:pjump('date_start','Start Date Co-Author',document.cu.start_$cudom\_$cuname\_ca.value,'start_$cudom\_$cuname\_ca','cu.pres','dateset')">$lt{'ssd'} Set End Date +"javascript:pjump('date_end','End Date Co-Author',document.cu.end_$cudom\_$cuname\_ca.value,'end_$cudom\_$cuname\_ca','cu.pres','dateset')">$lt{'sed'} ENDCOAUTH @@ -492,14 +611,18 @@ ENDCOAUTH # # Domain level # - $r->print('

Domain Level

'. - ''. - ''); + $r->print('

'.&mt('Domain Level').'

'. + '
ActivateRoleExtentStartEnd
'. + ''); foreach ( sort( keys(%incdomains))) { my $thisdomain=$_; - foreach ('dc','li','dg','au') { + foreach ('dc','li','dg','au','sc') { if (&Apache::lonnet::allowed('c'.$_,$thisdomain)) { my $plrole=&Apache::lonnet::plaintext($_); + my %lt=&Apache::lonlocal::texthash( + 'ssd' => "Set Start Date", + 'sed' => "Set End Date" + ); $r->print(< @@ -507,10 +630,10 @@ ENDCOAUTH +"javascript:pjump('date_start','Start Date $plrole',document.cu.start_$thisdomain\_$_.value,'start_$thisdomain\_$_','cu.pres','dateset')">$lt{'ssd'} +"javascript:pjump('date_end','End Date $plrole',document.cu.end_$thisdomain\_$_.value,'end_$thisdomain\_$_','cu.pres','dateset')">$lt{'sed'} ENDDROW } @@ -521,7 +644,7 @@ ENDDROW # Course level # $r->print(&course_level_table(%inccourses)); - $r->print("
\n"); + $r->print("
\n"); $r->print(""); } @@ -531,7 +654,7 @@ sub update_user_data { my $uhome=&Apache::lonnet::homeserver($ENV{'form.ccuname'}, $ENV{'form.ccdomain'}); # Error messages - my $error = 'Error:'; + my $error = ''.&mt('Error').':'; my $end = ''; # Print header $r->print(<print(&Apache::loncommon::bodytag($title)); # Check Inputs if (! $ENV{'form.ccuname'} ) { - $r->print($error.'No login name specified.'.$end); + $r->print($error.&mt('No login name specified').'.'.$end); return; } if ( $ENV{'form.ccuname'} =~/\W/) { - $r->print($error.'Invalid login name. '. - 'Only letters, numbers, and underscores are valid.'. + $r->print($error.&mt('Invalid login name').'. '. + &mt('Only letters, numbers, and underscores are valid').'.'. $end); return; } if (! $ENV{'form.ccdomain'} ) { - $r->print($error.'No domain specified.'.$end); + $r->print($error.&mt('No domain specified').'.'.$end); return; } if ( $ENV{'form.ccdomain'} =~/\W/) { - $r->print($error.'Invalid domain name. '. - 'Only letters, numbers, and underscores are valid.'. + $r->print($error.&mt ('Invalid domain name').'. '. + &mt('Only letters, numbers, and underscores are valid').'.'. $end); return; } if (! exists($ENV{'form.makeuser'})) { # Modifying an existing user, so check the validity of the name if ($uhome eq 'no_host') { - $r->print($error.'Unable to determine home server for '. - $ENV{'form.ccuname'}.' in domain '. + $r->print($error.&mt('Unable to determine home server for '). + $ENV{'form.ccuname'}.&mt(' in domain '). $ENV{'form.ccdomain'}.'.'); return; } @@ -601,17 +724,21 @@ ENDTHREEHEAD # If they are creating a new user but have not specified login # information this will be caught below. } else { - $r->print($error.'Invalid login mode or password'.$end); + $r->print($error.&mt('Invalid login mode or password').$end); return; } if ($ENV{'form.makeuser'}) { # Create a new user + my %lt=&Apache::lonlocal::texthash( + 'cru' => "Creating user", + 'id' => "in domain" + ); $r->print(<Creating user "$ENV{'form.ccuname'}" in domain "$ENV{'form.ccdomain'}" +

$lt{'cru'} "$ENV{'form.ccuname'}" $lt{'id'} "$ENV{'form.ccdomain'}"

ENDNEWUSERHEAD # Check for the authentication mode and password if (! $amode || ! $genpwd) { - $r->print($error.'Invalid login mode or password'.$end); + $r->print($error.&mt('Invalid login mode or password').$end); return; } # Determine desired host @@ -622,7 +749,7 @@ ENDNEWUSERHEAD my %home_servers = &Apache::loncommon::get_library_servers ($ENV{'form.ccdomain'}); if (! exists($home_servers{$desiredhost})) { - $r->print($error.'Invalid home server specified'); + $r->print($error.&mt('Invalid home server specified')); return; } } @@ -633,16 +760,20 @@ ENDNEWUSERHEAD $ENV{'form.cmiddle'},$ENV{'form.clast'},$ENV{'form.cgen'}, undef,$desiredhost ); - $r->print('Generating user: '.$result); + $r->print(&mt('Generating user').': '.$result); my $home = &Apache::lonnet::homeserver($ENV{'form.ccuname'}, $ENV{'form.ccdomain'}); - $r->print('
Home server: '.$home.' '. + $r->print('
'.&mt('Home server').': '.$home.' '. $Apache::lonnet::libserv{$home}); } elsif (($ENV{'form.login'} ne 'nochange') && ($ENV{'form.login'} ne '' )) { # Modify user privileges + my %lt=&Apache::lonlocal::texthash( + 'usr' => "User", + 'id' => "in domain" + ); $r->print(<User "$ENV{'form.ccuname'}" in domain "$ENV{'form.ccdomain'}" +

$lt{'usr'} "$ENV{'form.ccuname'}" $lt{'id'} "$ENV{'form.ccdomain'}"

ENDMODIFYUSERHEAD if (! $amode || ! $genpwd) { $r->print($error.'Invalid login mode or password'.$end); @@ -654,12 +785,11 @@ ENDMODIFYUSERHEAD &Apache::lonnet::modifyuserauth( $ENV{'form.ccdomain'},$ENV{'form.ccuname'}, $amode,$genpwd)); - $r->print('
Home server: '.&Apache::lonnet::homeserver + $r->print('
'.&mt('Home server').': '.&Apache::lonnet::homeserver ($ENV{'form.ccuname'},$ENV{'form.ccdomain'})); } else { # Okay, this is a non-fatal error. - $r->print($error.'You do not have the authority to modify '. - 'this users authentification information.'); + $r->print($error.&mt('You do not have the authority to modify this users authentification information').'.'); } } ## @@ -693,20 +823,29 @@ ENDMODIFYUSERHEAD $ENV{'form.ccdomain'},$ENV{'form.ccuname'}); if ($putresult eq 'ok') { # Tell the user we changed the name + my %lt=&Apache::lonlocal::texthash( + 'uic' => "User Information Changed", + 'frst' => "first", + 'mddl' => "middle", + 'lst' => "last", + 'gen' => "generation", + 'prvs' => "Previous", + 'chto' => "Changed To" + ); $r->print(<<"END");
'.&mt('Activate').''.&mt('Role').''.&mt('Extent').''.&mt('Start').''.&mt('End').'
$thisdomain Set Start Date Set End Date
- + - - - - - + + + + + - + @@ -714,35 +853,41 @@ ENDMODIFYUSERHEAD
User Information Changed$lt{'uic'}
 firstmiddlelastgeneration
Previous$lt{'frst'}$lt{'mddl'}$lt{'lst'}$lt{'gen'}
$lt{'prvs'} $userenv{'firstname'} $userenv{'middlename'} $userenv{'lastname'} $userenv{'generation'}
Changed To
$lt{'chto'} $ENV{'form.cfirstname'} $ENV{'form.cmiddlename'} $ENV{'form.clastname'}
END } else { # error occurred - $r->print("

Unable to successfully change environment for ". - $ENV{'form.ccuname'}." in domain ". + $r->print("

".&mt('Unable to successfully change environment for')." ". + $ENV{'form.ccuname'}." ".&mt('in domain')." ". $ENV{'form.ccdomain'}."

"); } } else { # End of if ($ENV ... ) logic # They did not want to change the users name but we can # still tell them what the name is + my %lt=&Apache::lonlocal::texthash( + 'usr' => "User", + 'id' => "in domain", + 'gen' => "Generation" + ); $r->print(<<"END"); -

User "$ENV{'form.ccuname'}" in domain "$ENV{'form.ccdomain'}"

+

$lt{'usr'} "$ENV{'form.ccuname'}" $lt{'id'} "$ENV{'form.ccdomain'}"

$userenv{'firstname'} $userenv{'middlename'} $userenv{'lastname'}

-

Generation: $userenv{'generation'}

+

$lt{'gen'}: $userenv{'generation'}

END } } ## my $now=time; - $r->print('

Modifying Roles

'); + $r->print('

'.&mt('Modifying Roles').'

'); foreach (keys (%ENV)) { next if (! $ENV{$_}); # Revoke roles if ($_=~/^form\.rev/) { - if ($_=~/^form\.rev\:([^\_]+)\_([^\_]+)$/) { - $r->print('Revoking '.$2.' in '.$1.': '. - &Apache::lonnet::assignrole($ENV{'form.ccdomain'}, - $ENV{'form.ccuname'},$1,$2,$now).'
'); + if ($_=~/^form\.rev\:([^\_]+)\_([^\_\.]+)$/) { +# Revoke standard role + $r->print(&mt('Revoking').' '.$2.' in '.$1.': '. + &Apache::lonnet::revokerole($ENV{'form.ccdomain'}, + $ENV{'form.ccuname'},$1,$2).'
'); if ($2 eq 'st') { $1=~/^\/(\w+)\/(\w+)/; my $cid=$1.'_'.$2; - $r->print('Drop from classlist: '. + $r->print(&mt('Drop from classlist').': '. &Apache::lonnet::critical('put:'. $ENV{'course.'.$cid.'.domain'}.':'. $ENV{'course.'.$cid.'.num'}.':classlist:'. @@ -752,15 +897,23 @@ END $ENV{'course.'.$cid.'.home'}).'
'); } } + if ($_=~/^form\.rev\:([^\_]+)\_cr\.cr\/(\w+)\/(\w+)\/(\w+)$/) { +# Revoke custom role + $r->print(&mt('Revoking custom role'). + ' '.$4.' by '.$3.'@'.$2.' in '.$1.': '. + &Apache::lonnet::revokecustomrole($ENV{'form.ccdomain'}, + $ENV{'form.ccuname'},$1,$2,$3,$4). + '
'); + } } elsif ($_=~/^form\.del/) { if ($_=~/^form\.del\:([^\_]+)\_([^\_]+)$/) { - $r->print('Deleting '.$2.' in '.$1.': '. + $r->print(&mt('Deleting').' '.$2.' in '.$1.': '. &Apache::lonnet::assignrole($ENV{'form.ccdomain'}, $ENV{'form.ccuname'},$1,$2,$now,0,1).'
'); if ($2 eq 'st') { $1=~/^\/(\w+)\/(\w+)/; my $cid=$1.'_'.$2; - $r->print('Drop from classlist: '. + $r->print(&mt('Drop from classlist').': '. &Apache::lonnet::critical('put:'. $ENV{'course.'.$cid.'.domain'}.':'. $ENV{'course.'.$cid.'.num'}.':classlist:'. @@ -771,7 +924,29 @@ END } } } elsif ($_=~/^form\.act/) { - if ($_=~/^form\.act\_([^\_]+)\_([^\_]+)\_([^\_]+)$/) { + if +($_=~/^form\.act\_([^\_]+)\_([^\_]+)\_cr_cr_([^\_]+)_(\w+)_([^\_]+)$/) { + # Activate a custom role + my $url='/'.$1.'/'.$2; + my $full=$1.'_'.$2.'_cr_cr_'.$3.'_'.$4.'_'.$5; + if ($ENV{'form.sec_'.$full}) { + $url.='/'.$ENV{'form.sec_'.$full}; + } + + my $start = ( $ENV{'form.start_'.$full} ? + $ENV{'form.start_'.$full} : + $now ); + my $end = ( $ENV{'form.end_'.$full} ? + $ENV{'form.end_'.$full} : + 0 ); + + $r->print(&mt('Assigning custom role').' "'.$5.'" by '.$4.'@'.$3.' in '.$url. + ($start?', '.&mt('starting').' '.localtime($start):''). + ($end?', ending '.localtime($end):'').': '. + &Apache::lonnet::assigncustomrole( + $ENV{'form.ccdomain'},$ENV{'form.ccuname'},$url,$3,$4,$5,$end,$start). + '
'); + } elsif ($_=~/^form\.act\_([^\_]+)\_([^\_]+)\_([^\_]+)$/) { # Activate roles for sections with 3 id numbers # set start, end times, and the url for the class @@ -786,9 +961,9 @@ END $url.='/'.$ENV{'form.sec_'.$1.'_'.$2.'_'.$3}; } # Assign the role and report it - $r->print('Assigning: '.$3.' in '.$url. - ($start?', starting '.localtime($start):''). - ($end?', ending '.localtime($end):'').': '. + $r->print(&mt('Assigning').' '.$3.' in '.$url. + ($start?', '.&mt('starting').' '.localtime($start):''). + ($end?', '.&mt('ending').' '.localtime($end):'').': '. &Apache::lonnet::assignrole( $ENV{'form.ccdomain'},$ENV{'form.ccuname'}, $url,$3,$end,$start). @@ -797,7 +972,7 @@ END if ($3 eq 'st') { $url=~/^\/(\w+)\/(\w+)/; my $cid=$1.'_'.$2; - $r->print('Add to classlist: '. + $r->print(&mt('Add to classlist').': '. &Apache::lonnet::critical( 'put:'.$ENV{'course.'.$cid.'.domain'}.':'. $ENV{'course.'.$cid.'.num'}.':classlist:'. @@ -819,16 +994,20 @@ END 0 ); my $url='/'.$1.'/'; # Assign the role and report it. - $r->print('Assigning: '.$2.' in '.$url.': '. - ($start?', starting '.localtime($start):''). - ($end?', ending '.localtime($end):'').': '. + $r->print(&mt('Assigning').' '.$2.' in '.$url.': '. + ($start?', '.&mt('starting').' '.localtime($start):''). + ($end?', '.&mt('ending').' '.localtime($end):'').': '. &Apache::lonnet::assignrole( $ENV{'form.ccdomain'},$ENV{'form.ccuname'}, $url,$2,$end,$start) .'
'); - } + } else { + $r->print('

'.&mt('ERROR').': '.&mt('Unknown command').' '.$_.'


'); + } } } # End of foreach (keys(%ENV)) +# Flush the course logs so reverse user roles immediately updated + &Apache::lonnet::flushcourselogs(); $r->print(''); } @@ -858,11 +1037,11 @@ sub custom_role_editor { &Apache::lonnet::get('roles',["rolesdef_$rolename"]); # ------------------------------------------------------- Does this role exist? if (($rdummy ne 'con_lost') && ($roledef ne '')) { - $r->print('Existing Role "'); + $r->print(&mt('Existing Role').' "'); # ------------------------------------------------- Get current role privileges ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef); } else { - $r->print('New Role "'); + $r->print(&mt('New Role').' "'); $roledef=''; } $r->print($rolename.'"'); @@ -901,13 +1080,19 @@ sub custom_role_editor { } $full{$priv}=1; } + my %lt=&Apache::lonlocal::texthash( + 'prv' => "Privilege", + 'crl' => "Course Level", + 'dml' => "Domain Level", + 'ssl' => "System Level" + ); $r->print(< - - + + ENDCCF foreach (sort keys %full) { $r->print(''); } $r->print( - '
PrivilegeCourse LevelDomain LevelSystem Level
$lt{'prv'}$lt{'crl'}$lt{'dml'}$lt{'ssl'}
'.&Apache::lonnet::plaintext($_).''. @@ -922,7 +1107,7 @@ ENDCCF '
'); + '
'); } # ---------------------------------------------------------- Call to definerole @@ -944,9 +1129,9 @@ sub set_custom_role { &Apache::lonnet::get('roles',["rolesdef_$rolename"]); # ------------------------------------------------------- Does this role exist? if (($rdummy ne 'con_lost') && ($roledef ne '')) { - $r->print('Existing Role "'); + $r->print(&mt('Existing Role').' "'); } else { - $r->print('New Role "'); + $r->print(&mt('New Role').' "'); $roledef=''; } $r->print($rolename.'"'); @@ -983,7 +1168,7 @@ sub set_custom_role { if ($ENV{'request.course.id'}) { my $url='/'.$ENV{'request.course.id'}; $url=~s/\_/\//g; - $r->print('
Assigning Role to Self: '. + $r->print('
'.&mt('Assigning Role to Self').': '. &Apache::lonnet::assigncustomrole($ENV{'user.domain'}, $ENV{'user.name'}, $url, @@ -999,7 +1184,7 @@ sub handler { my $r = shift; if ($r->header_only) { - $r->content_type('text/html'); + &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; return OK; } @@ -1010,7 +1195,7 @@ sub handler { (&Apache::lonnet::allowed('cep',$ENV{'request.course.id'})) || (&Apache::lonnet::allowed('cca',$ENV{'request.role.domain'})) || (&Apache::lonnet::allowed('mau',$ENV{'request.role.domain'}))) { - $r->content_type('text/html'); + &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; unless ($ENV{'form.phase'}) { &print_username_entry_form($r); @@ -1046,7 +1231,7 @@ sub course_level_table { $thiscourse=~s:_:/:g; my %coursedata=&Apache::lonnet::coursedescription($thiscourse); my $area=$coursedata{'description'}; - if (!defined($area)) { $area='Unavailable course: '.$_; } + if (!defined($area)) { $area=&mt('Unavailable course').': '.$_; } my $bgcol=$thiscourse; $bgcol=~s/[^7-9a-e]//g; $bgcol=substr($bgcol.$bgcol.$bgcol.'ffffff',2,6); @@ -1068,40 +1253,61 @@ ENDSECTION ENDSECTION } + my %lt=&Apache::lonlocal::texthash( + 'ssd' => "Set Start Date", + 'sed' => "Set End Date" + ); $table .= < Set Start Date +"javascript:pjump('date_start','Start Date $plrole',document.cu.start_$protectedcourse\_$_.value,'start_$protectedcourse\_$_','cu.pres','dateset')">$lt{'ssd'} +"javascript:pjump('date_end','End Date $plrole',document.cu.end_$protectedcourse\_$_.value,'end_$protectedcourse\_$_','cu.pres','dateset')">$lt{'sed'} ENDTIMEENTRY $table.= "\n"; } } foreach (sort keys %customroles) { - my $plrole=$_; - $table .= < "Set Start Date", + 'sed' => "Set End Date" + ); + $table .= < - + - - + - + +"javascript:pjump('date_end','End Date $plrole',document.cu.end_$customrole.value,'end_$customrole','cu.pres','dateset')">$lt{'sed'} ENDENTRY + } } } return '' if ($table eq ''); # return nothing if there is nothing # in the table + my %lt=&Apache::lonlocal::texthash( + 'crl' => "Course Level", + 'act' => "Activate", + 'rol' => "Role", + 'ext' => "Extent", + 'grs' => "Group/Section", + 'sta' => "Start", + 'end' => "End" + ); my $result = <Course Level -
  Set End Date
$plrole $area + Set Start Date +"javascript:pjump('date_start','Start Date $plrole',document.cu.start_$customrole.value,'start_$customrole','cu.pres','dateset')">$lt{'ssd'} Set End Date
- +

$lt{'crl'}

+
ActivateRoleExtentGroup/SectionStartEnd
+ $table
$lt{'act'}$lt{'rol'}$lt{'ext'}$lt{'grs'}$lt{'sta'}$lt{'end'}
ENDTABLE