--- loncom/interface/loncreateuser.pm 2004/02/01 20:42:01 1.78 +++ loncom/interface/loncreateuser.pm 2005/06/17 21:04:40 1.104 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Create a user # -# $Id: loncreateuser.pm,v 1.78 2004/02/01 20:42:01 www Exp $ +# $Id: loncreateuser.pm,v 1.104 2005/06/17 21:04:40 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -73,10 +73,9 @@ my $authformint; my $authformfsys; my $authformloc; -BEGIN { - $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/; - my $krbdefdom=$1; - $krbdefdom=~tr/a-z/A-Z/; +sub initialize_authen_forms { + my ($krbdefdom)=( $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/); + $krbdefdom= uc($krbdefdom); my %param = ( formname => 'document.cu', kerb_def_dom => $krbdefdom ); @@ -109,10 +108,7 @@ sub my_custom_roles { sub authorpriv { my ($auname,$audom)=@_; - if (($auname ne $ENV{'user.name'}) || - (($audom ne $ENV{'user.domain'}) && - ($audom ne $ENV{'request.role.domain'}))) { return ''; } - unless (&Apache::lonnet::allowed('cca',$audom)) { return ''; } + unless (&Apache::lonnet::allowed('cca',$audom.'/'.$auname)) { return ''; } return 1; } @@ -120,13 +116,11 @@ sub authorpriv { sub print_username_entry_form { my $r=shift; - my $defdom=$ENV{'request.role.domain'}; + my $defdom=$env{'request.role.domain'}; 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'). - &Apache::loncommon::help_open_faq(282). - &Apache::loncommon::help_open_bug('Instructor Interface'); + my $html=&Apache::lonxml::xmlbegin(); + my $bodytag =&Apache::loncommon::bodytag('Create Users, Change User Privileges').&Apache::loncommon::help_open_menu('',undef,undef,'',282,'Instructor Interface'); my $selscript=&Apache::loncommon::studentbrowser_javascript(); my $sellink=&Apache::loncommon::selectstudent_link ('crtuser','ccuname','ccdomain'); @@ -145,7 +139,7 @@ sub print_username_entry_form { my $helpsiur=&Apache::loncommon::help_open_topic('Course_Change_Privileges'); my $helpecpr=&Apache::loncommon::help_open_topic('Course_Editing_Custom_Roles'); $r->print(<<"ENDDOCUMENT"); - +$html The LearningOnline Network with CAPA $selscript @@ -174,18 +168,18 @@ ENDDOCUMENT # =================================================================== Phase two sub print_user_modification_page { my $r=shift; - my $ccuname=$ENV{'form.ccuname'}; - my $ccdomain=$ENV{'form.ccdomain'}; + my $ccuname=$env{'form.ccuname'}; + my $ccdomain=$env{'form.ccdomain'}; - $ccuname=~s/\W//gs; - $ccdomain=~s/\W//gs; + $ccuname=~s/\W//g; + $ccdomain=~s/\W//g; unless (($ccuname) && ($ccdomain)) { &print_username_entry_form($r); return; } - my $defdom=$ENV{'request.role.domain'}; + my $defdom=$env{'request.role.domain'}; my ($krbdef,$krbdefdom) = &Apache::loncommon::get_kerberos_defaults($defdom); @@ -200,8 +194,84 @@ sub print_user_modification_page { $ccuname=~s/\W//g; $ccdomain=~s/\W//g; my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition(); + my $dc_setcourse_code = ''; + my $loaditem; + if ($env{'request.role'} =~ m-^dc\./(\w+)/$-) { + my $dcdom = $1; + $loaditem = qq|OnLoad="document.cu.coursedesc.value=''"|; + $dc_setcourse_code = <<"ENDSCRIPT"; + function setCourse() { + var course = document.cu.dccourse.value; + if (course != "") { + if (document.cu.dcdomain.value != document.cu.origdom.value) { + alert("You must select a course in the current domain"); + return; + } + var userrole = document.cu.role.options[document.cu.role.selectedIndex].value + var section=""; + var numsections = 0; + for (var i=0; i 1)) { + alert("In each course, each user may only have one student role at a time. You had selected "+numsections+" sections.\\nPlease modify your selections so they include no more than one section.") + return; + } + if ((userrole == 'cc') && (numsections > 0)) { + alert("Section designations do not apply to Course Coordinator roles.\\nA course coordinator role will be added with access to all sections."); + section = ""; + } + var numcourse = getIndex(document.cu.dccourse); + if (numcourse == "-1") { + alert("There was a problem with your course selection"); + return + } + else { + var coursename = "_$dcdom"+"_"+course+"_"+userrole + document.cu.elements[numcourse].name = "act"+coursename + document.cu.elements[numcourse+4].name = "sec"+coursename + document.cu.elements[numcourse+4].value = section + document.cu.elements[numcourse+5].name = "start"+coursename + document.cu.elements[numcourse+6].name = "end"+coursename + } + } + document.cu.submit(); + } + + function getIndex(caller) { + for (var i=0;i +$html The LearningOnline Network with CAPA ENDDOCHEAD $r->print(&Apache::loncommon::bodytag( - 'Create Users, Change User Privileges')); + 'Create Users, Change User Privileges',undef,$loaditem)); my $forminfo =<<"ENDFORMINFO";
@@ -240,7 +371,7 @@ ENDFORMINFO foreach (values(%Apache::lonnet::hostdom)) { $incdomains{$_}=1; } - foreach (keys(%ENV)) { + foreach (keys(%env)) { if ($_=~/^user\.priv\.cm\.\/(\w+)\/(\w+)/) { $inccourses{$1.'_'.$2}=1; } @@ -250,7 +381,7 @@ ENDFORMINFO ''."\n". &Apache::loncommon::home_server_option_list($ccdomain); - my %lt=&Apache::lonlocal::texthash( + my %lt=&Apache::lonlocal::texthash( 'cnu' => "Create New User", 'nu' => "New User", 'id' => "in domain", @@ -264,6 +395,7 @@ ENDFORMINFO 'lg' => "Login Data" ); my $genhelp=&Apache::loncommon::help_open_topic('Generation'); + &initialize_authen_forms(); $r->print(<$lt{'cnu'} @@ -296,7 +428,7 @@ $lt{'hs'}: '; + } else { + $row.=' '; + } + $row.=''; if ($delallowed) { $row.= ''; } else { @@ -468,9 +619,43 @@ END ''.($role_end_time ?localtime($role_end_time) : ' ' ) ."\n"; - $r->print($row); + $sortrole{$sortkey}=$envkey; + $roletext{$envkey}=$row; + $roleclass{$envkey}=$class; + $rolepriv{$envkey}=$allowed; + #$r->print($row); } # end of foreach (table building loop) - $r->print(''); + my $rolesdisplay = 0; + my %output = (); + foreach my $type ('Construction Space','Course','Domain','System','Unknown') { + $output{$type} = ''; + foreach my $which (sort {uc($a) cmp uc($b)} (keys(%sortrole))) { + if ( ($roleclass{$sortrole{$which}} =~ /^\Q$type\E/ ) && ($rolepriv{$sortrole{$which}}) ) { + $output{$type}.=$roletext{$sortrole{$which}}; + } + } + unless($output{$type} eq '') { + $output{$type} = "". + "".&mt($type)."". + $output{$type}; + $rolesdisplay = 1; + } + } + if ($rolesdisplay == 1) { + $r->print(< +

$lt{'rer'}

+ + +END + foreach my $type ('Construction Space','Course','Domain','System','Unknown') { + if ($output{$type}) { + $r->print($output{$type}."\n"); + } + } + $r->print('
$lt{'rev'}$lt{'ren'}$lt{'del'}$lt{'rol'}$lt{'e +xt'}$lt{'sta'}$lt{'end'}
'); + } } # End of unless my $currentauth=&Apache::lonnet::queryauthenticate($ccuname,$ccdomain); if ($currentauth=~/^krb(4|5):/) { @@ -487,7 +672,8 @@ END $currentauth=~/^internal:/ or $currentauth=~/^localauth:/ ) { # bad authentication scheme - if (&Apache::lonnet::allowed('mau',$ENV{'request.role.domain'})) { + if (&Apache::lonnet::allowed('mau',$env{'request.role.domain'})) { + &initialize_authen_forms(); my %lt=&Apache::lonlocal::texthash( 'err' => "ERROR", 'uuas' => "This user has an unrecognized authentication scheme", @@ -529,6 +715,7 @@ ENDBADAUTH } else { # Authentication type is valid my $authformcurrent=''; my $authform_other=''; + &initialize_authen_forms(); if ($currentauth=~/^krb(4|5):/) { $authformcurrent=$authformkrb; $authform_other="

$authformint

\n". @@ -550,7 +737,7 @@ ENDBADAUTH "

$authformint

$authformfsys

"; } $authformcurrent.=' (will override current values)
'; - if (&Apache::lonnet::allowed('mau',$ENV{'request.role.domain'})) { + if (&Apache::lonnet::allowed('mau',$env{'request.role.domain'})) { # Current user has login modification privileges my %lt=&Apache::lonlocal::texthash( 'ccld' => "Change Current Login Data", @@ -575,18 +762,18 @@ ENDOTHERAUTHS # # Co-Author # - if (&authorpriv($ENV{'user.name'},$ENV{'request.role.domain'}) && - ($ENV{'user.name'} ne $ccuname || $ENV{'user.domain'} ne $ccdomain)) { + if (&authorpriv($env{'user.name'},$env{'request.role.domain'}) && + ($env{'user.name'} ne $ccuname || $env{'user.domain'} ne $ccdomain)) { # No sense in assigning co-author role to yourself - my $cuname=$ENV{'user.name'}; - my $cudom=$ENV{'request.role.domain'}; + my $cuname=$env{'user.name'}; + my $cudom=$env{'request.role.domain'}; my %lt=&Apache::lonlocal::texthash( 'cs' => "Construction Space", 'act' => "Activate", 'rol' => "Role", 'ext' => "Extent", 'sta' => "Start", - 'end' => "End". + 'end' => "End", 'cau' => "Co-Author", 'ssd' => "Set Start Date", 'sed' => "Set End Date" @@ -596,13 +783,13 @@ ENDOTHERAUTHS - + - - @@ -612,9 +799,11 @@ ENDCOAUTH # # Domain level # - $r->print('

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

'. + my $num_domain_level = 0; + my $domaintext = + '

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

'. '
$lt{'act'}$lt{'rol'}$lt{'ext'} $lt{'sta'}$lt{'end'}
$lt{'cau'} $cudom\_$cuname + $lt{'ssd'} + $lt{'sed'}
'. - ''); + ''; foreach ( sort( keys(%incdomains))) { my $thisdomain=$_; foreach ('dc','li','dg','au','sc') { @@ -624,7 +813,8 @@ ENDCOAUTH 'ssd' => "Set Start Date", 'sed' => "Set End Date" ); - $r->print(< @@ -640,86 +830,97 @@ ENDDROW } } } - $r->print('
'.&mt('Activate').''.&mt('Role').''.&mt('Extent').''.&mt('Start').''.&mt('End').'
'.&mt('Start').''.&mt('End').'
$plrole
'); + $domaintext.=''; + if ($num_domain_level > 0) { + $r->print($domaintext); + } # # Course level # - $r->print(&course_level_table(%inccourses)); - $r->print("
\n"); + my $num_sections; + + if ($env{'request.role'} =~ m-^dc\./(\w+)/$-) { + $r->print(&course_level_dc($1)); + $r->print('
'."\n"); + } else { + $r->print(&course_level_table(%inccourses)); + $r->print('
'."\n"); + } $r->print(""); } # ================================================================= Phase Three sub update_user_data { my $r=shift; - my $uhome=&Apache::lonnet::homeserver($ENV{'form.ccuname'}, - $ENV{'form.ccdomain'}); + my $uhome=&Apache::lonnet::homeserver($env{'form.ccuname'}, + $env{'form.ccdomain'}); # Error messages my $error = ''.&mt('Error').':'; my $end = ''; # Print header + my $html=&Apache::lonxml::xmlbegin(); $r->print(< +$html The LearningOnline Network with CAPA ENDTHREEHEAD my $title; - if (exists($ENV{'form.makeuser'})) { + if (exists($env{'form.makeuser'})) { $title='Set Privileges for New User'; } else { $title='Modify User Privileges'; } $r->print(&Apache::loncommon::bodytag($title)); # Check Inputs - if (! $ENV{'form.ccuname'} ) { + if (! $env{'form.ccuname'} ) { $r->print($error.&mt('No login name specified').'.'.$end); return; } - if ( $ENV{'form.ccuname'} =~/\W/) { + if ( $env{'form.ccuname'} =~/\W/) { $r->print($error.&mt('Invalid login name').'. '. &mt('Only letters, numbers, and underscores are valid').'.'. $end); return; } - if (! $ENV{'form.ccdomain'} ) { + if (! $env{'form.ccdomain'} ) { $r->print($error.&mt('No domain specified').'.'.$end); return; } - if ( $ENV{'form.ccdomain'} =~/\W/) { + if ( $env{'form.ccdomain'} =~/\W/) { $r->print($error.&mt ('Invalid domain name').'. '. &mt('Only letters, numbers, and underscores are valid').'.'. $end); return; } - if (! exists($ENV{'form.makeuser'})) { + if (! exists($env{'form.makeuser'})) { # Modifying an existing user, so check the validity of the name if ($uhome eq 'no_host') { $r->print($error.&mt('Unable to determine home server for '). - $ENV{'form.ccuname'}.&mt(' in domain '). - $ENV{'form.ccdomain'}.'.'); + $env{'form.ccuname'}.&mt(' in domain '). + $env{'form.ccdomain'}.'.'); return; } } # Determine authentication method and password for the user being modified my $amode=''; my $genpwd=''; - if ($ENV{'form.login'} eq 'krb') { + if ($env{'form.login'} eq 'krb') { $amode='krb'; - $amode.=$ENV{'form.krbver'}; - $genpwd=$ENV{'form.krbarg'}; - } elsif ($ENV{'form.login'} eq 'int') { + $amode.=$env{'form.krbver'}; + $genpwd=$env{'form.krbarg'}; + } elsif ($env{'form.login'} eq 'int') { $amode='internal'; - $genpwd=$ENV{'form.intarg'}; - } elsif ($ENV{'form.login'} eq 'fsys') { + $genpwd=$env{'form.intarg'}; + } elsif ($env{'form.login'} eq 'fsys') { $amode='unix'; - $genpwd=$ENV{'form.fsysarg'}; - } elsif ($ENV{'form.login'} eq 'loc') { + $genpwd=$env{'form.fsysarg'}; + } elsif ($env{'form.login'} eq 'loc') { $amode='localauth'; - $genpwd=$ENV{'form.locarg'}; + $genpwd=$env{'form.locarg'}; $genpwd=" " if (!$genpwd); - } elsif (($ENV{'form.login'} eq 'nochange') || - ($ENV{'form.login'} eq '' )) { + } elsif (($env{'form.login'} eq 'nochange') || + ($env{'form.login'} eq '' )) { # There is no need to tell the user we did not change what they # did not ask us to change. # If they are creating a new user but have not specified login @@ -728,14 +929,14 @@ ENDTHREEHEAD $r->print($error.&mt('Invalid login mode or password').$end); return; } - if ($ENV{'form.makeuser'}) { + if ($env{'form.makeuser'}) { # Create a new user my %lt=&Apache::lonlocal::texthash( 'cru' => "Creating user", 'id' => "in domain" ); $r->print(<$lt{'cru'} "$ENV{'form.ccuname'}" $lt{'id'} "$ENV{'form.ccdomain'}" +

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

ENDNEWUSERHEAD # Check for the authentication mode and password if (! $amode || ! $genpwd) { @@ -743,12 +944,12 @@ ENDNEWUSERHEAD return; } # Determine desired host - my $desiredhost = $ENV{'form.hserver'}; + my $desiredhost = $env{'form.hserver'}; if (lc($desiredhost) eq 'default') { $desiredhost = undef; } else { my %home_servers = &Apache::loncommon::get_library_servers - ($ENV{'form.ccdomain'}); + ($env{'form.ccdomain'}); if (! exists($home_servers{$desiredhost})) { $r->print($error.&mt('Invalid home server specified')); return; @@ -756,49 +957,49 @@ ENDNEWUSERHEAD } # Call modifyuser my $result = &Apache::lonnet::modifyuser - ($ENV{'form.ccdomain'},$ENV{'form.ccuname'},$ENV{'form.cstid'}, - $amode,$genpwd,$ENV{'form.cfirst'}, - $ENV{'form.cmiddle'},$ENV{'form.clast'},$ENV{'form.cgen'}, + ($env{'form.ccdomain'},$env{'form.ccuname'},$env{'form.cstid'}, + $amode,$genpwd,$env{'form.cfirst'}, + $env{'form.cmiddle'},$env{'form.clast'},$env{'form.cgen'}, undef,$desiredhost ); $r->print(&mt('Generating user').': '.$result); - my $home = &Apache::lonnet::homeserver($ENV{'form.ccuname'}, - $ENV{'form.ccdomain'}); + my $home = &Apache::lonnet::homeserver($env{'form.ccuname'}, + $env{'form.ccdomain'}); $r->print('
'.&mt('Home server').': '.$home.' '. $Apache::lonnet::libserv{$home}); - } elsif (($ENV{'form.login'} ne 'nochange') && - ($ENV{'form.login'} ne '' )) { + } 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(<$lt{'usr'} "$ENV{'form.ccuname'}" $lt{'id'} "$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); return; } # Only allow authentification modification if the person has authority - if (&Apache::lonnet::allowed('mau',$ENV{'form.ccdomain'})) { + if (&Apache::lonnet::allowed('mau',$env{'form.ccdomain'})) { $r->print('Modifying authentication: '. &Apache::lonnet::modifyuserauth( - $ENV{'form.ccdomain'},$ENV{'form.ccuname'}, + $env{'form.ccdomain'},$env{'form.ccuname'}, $amode,$genpwd)); - $r->print('
'.&mt('Home server').': '.&Apache::lonnet::homeserver - ($ENV{'form.ccuname'},$ENV{'form.ccdomain'})); + $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.&mt('You do not have the authority to modify this users authentification information').'.'); } } ## - if (! $ENV{'form.makeuser'} ) { + if (! $env{'form.makeuser'} ) { # Check for need to change my %userenv = &Apache::lonnet::get ('environment',['firstname','middlename','lastname','generation'], - $ENV{'form.ccdomain'},$ENV{'form.ccuname'}); + $env{'form.ccdomain'},$env{'form.ccuname'}); my ($tmp) = keys(%userenv); if ($tmp =~ /^(con_lost|error)/i) { %userenv = (); @@ -806,22 +1007,22 @@ ENDMODIFYUSERHEAD # Check to see if we need to change user information foreach ('firstname','middlename','lastname','generation') { # Strip leading and trailing whitespace - $ENV{'form.c'.$_} =~ s/(\s+$|^\s+)//g; + $env{'form.c'.$_} =~ s/(\s+$|^\s+)//g; } - if (&Apache::lonnet::allowed('mau',$ENV{'form.ccdomain'}) && - ($ENV{'form.cfirstname'} ne $userenv{'firstname'} || - $ENV{'form.cmiddlename'} ne $userenv{'middlename'} || - $ENV{'form.clastname'} ne $userenv{'lastname'} || - $ENV{'form.cgeneration'} ne $userenv{'generation'} )) { + if (&Apache::lonnet::allowed('mau',$env{'form.ccdomain'}) && + ($env{'form.cfirstname'} ne $userenv{'firstname'} || + $env{'form.cmiddlename'} ne $userenv{'middlename'} || + $env{'form.clastname'} ne $userenv{'lastname'} || + $env{'form.cgeneration'} ne $userenv{'generation'} )) { # Make the change my %changeHash; - $changeHash{'firstname'} = $ENV{'form.cfirstname'}; - $changeHash{'middlename'} = $ENV{'form.cmiddlename'}; - $changeHash{'lastname'} = $ENV{'form.clastname'}; - $changeHash{'generation'} = $ENV{'form.cgeneration'}; + $changeHash{'firstname'} = $env{'form.cfirstname'}; + $changeHash{'middlename'} = $env{'form.cmiddlename'}; + $changeHash{'lastname'} = $env{'form.clastname'}; + $changeHash{'generation'} = $env{'form.cgeneration'}; my $putresult = &Apache::lonnet::put ('environment',\%changeHash, - $ENV{'form.ccdomain'},$ENV{'form.ccuname'}); + $env{'form.ccdomain'},$env{'form.ccuname'}); if ($putresult eq 'ok') { # Tell the user we changed the name my %lt=&Apache::lonlocal::texthash( @@ -847,18 +1048,18 @@ ENDMODIFYUSERHEAD $userenv{'lastname'} $userenv{'generation'} $lt{'chto'} - $ENV{'form.cfirstname'} - $ENV{'form.cmiddlename'} - $ENV{'form.clastname'} - $ENV{'form.cgeneration'} + $env{'form.cfirstname'} + $env{'form.cmiddlename'} + $env{'form.clastname'} + $env{'form.cgeneration'} END } else { # error occurred $r->print("

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

"); + $env{'form.ccuname'}." ".&mt('in domain')." ". + $env{'form.ccdomain'}.""); } - } else { # End of if ($ENV ... ) logic + } 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( @@ -867,7 +1068,7 @@ END 'gen' => "Generation" ); $r->print(<<"END"); -

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

+

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

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

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

END @@ -876,150 +1077,305 @@ END ## my $now=time; $r->print('

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

'); - foreach (keys (%ENV)) { - next if (! $ENV{$_}); + foreach (keys (%env)) { + next if (! $env{$_}); # Revoke roles if ($_=~/^form\.rev/) { if ($_=~/^form\.rev\:([^\_]+)\_([^\_\.]+)$/) { # Revoke standard role $r->print(&mt('Revoking').' '.$2.' in '.$1.': '. - &Apache::lonnet::revokerole($ENV{'form.ccdomain'}, - $ENV{'form.ccuname'},$1,$2).'
'); + &Apache::lonnet::revokerole($env{'form.ccdomain'}, + $env{'form.ccuname'},$1,$2).'
'); if ($2 eq 'st') { $1=~/^\/(\w+)\/(\w+)/; my $cid=$1.'_'.$2; $r->print(&mt('Drop from classlist').': '. &Apache::lonnet::critical('put:'. - $ENV{'course.'.$cid.'.domain'}.':'. - $ENV{'course.'.$cid.'.num'}.':classlist:'. - &Apache::lonnet::escape($ENV{'form.ccuname'}.':'. - $ENV{'form.ccdomain'}).'='. + $env{'course.'.$cid.'.domain'}.':'. + $env{'course.'.$cid.'.num'}.':classlist:'. + &Apache::lonnet::escape($env{'form.ccuname'}.':'. + $env{'form.ccdomain'}).'='. &Apache::lonnet::escape($now.':'), - $ENV{'course.'.$cid.'.home'}).'
'); + $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). - '
'); + &Apache::lonnet::revokecustomrole($env{'form.ccdomain'}, + $env{'form.ccuname'},$1,$2,$3,$4). + '
'); } } elsif ($_=~/^form\.del/) { if ($_=~/^form\.del\:([^\_]+)\_([^\_]+)$/) { $r->print(&mt('Deleting').' '.$2.' in '.$1.': '. - &Apache::lonnet::assignrole($ENV{'form.ccdomain'}, - $ENV{'form.ccuname'},$1,$2,$now,0,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(&mt('Drop from classlist').': '. &Apache::lonnet::critical('put:'. - $ENV{'course.'.$cid.'.domain'}.':'. - $ENV{'course.'.$cid.'.num'}.':classlist:'. - &Apache::lonnet::escape($ENV{'form.ccuname'}.':'. - $ENV{'form.ccdomain'}).'='. + $env{'course.'.$cid.'.domain'}.':'. + $env{'course.'.$cid.'.num'}.':classlist:'. + &Apache::lonnet::escape($env{'form.ccuname'}.':'. + $env{'form.ccdomain'}).'='. &Apache::lonnet::escape($now.':'), - $ENV{'course.'.$cid.'.home'}).'
'); + $env{'course.'.$cid.'.home'}).'
'); + } + } + } elsif ($_=~/^form\.ren/) { + my $udom = $env{'form.ccdomain'}; + my $uname = $env{'form.ccuname'}; + if ($_=~/^form\.ren\:([^\_]+)\_([^\_]+)$/) { + my $url = $1; + my $role = $2; + my $logmsg; + my $output; + if ($role eq 'st') { + if ($url =~ m-^/(\w+)/(\w+)/?(\w*)$-) { + my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$role,$now,0,$1,$2,$3); + if (($result =~ /^error/) || ($result eq 'not_in_class') || ($result eq 'unknown_course')) { + $output = "Error: $result\n"; + } else { + $output = &mt('Assigning').' '.$role.' in '.$url. + &mt('starting').' '.localtime($now). + ':
'.$logmsg.'
'. + &mt('Add to classlist').': ok
'; + } + } + } else { + my $result=&Apache::lonnet::assignrole($env{'form.ccdomain'}, + $env{'form.ccuname'},$url,$role,0,$now); + $output = &mt('Re-Enabling [_1] in [_2]: [_3]', + $role,$url,$result).'
'; } + $r->print($output); } } elsif ($_=~/^form\.act/) { - if -($_=~/^form\.act\_([^\_]+)\_([^\_]+)\_cr_cr_([^\_]+)_(\w+)_([^\_]+)$/) { + my $udom = $env{'form.ccdomain'}; + my $uname = $env{'form.ccuname'}; + 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\_([^\_]+)\_([^\_]+)\_([^\_]+)$/) { + my ($one,$two,$three,$four,$five)=($1,$2,$3,$4,$5); + my $url='/'.$one.'/'.$two; + my $full=$one.'_'.$two.'_cr_cr_'.$three.'_'.$four.'_'.$five; + + my $start = ( $env{'form.start_'.$full} ? + $env{'form.start_'.$full} : + $now ); + my $end = ( $env{'form.end_'.$full} ? + $env{'form.end_'.$full} : + 0 ); + + # split multiple sections + my %sections = (); + my $num_sections = &build_roles($env{'form.sec_'.$full},\%sections,$5); + if ($num_sections == 0) { + $r->print(&commit_customrole($udom,$uname,$url,$three,$four,$five,$start,$end)); + } else { + foreach (sort {$a cmp $b} keys %sections) { + my $securl = $url.'/'.$_; + $r->print(&commit_customrole($udom,$uname,$securl,$three,$four,$five,$start,$end)); + } + } + } elsif ($_=~/^form\.act\_([^\_]+)\_(\w+)\_([^\_]+)$/) { # Activate roles for sections with 3 id numbers # set start, end times, and the url for the class - - my $start = ( $ENV{'form.start_'.$1.'_'.$2.'_'.$3} ? - $ENV{'form.start_'.$1.'_'.$2.'_'.$3} : + my ($one,$two,$three)=($1,$2,$3); + my $start = ( $env{'form.start_'.$one.'_'.$two.'_'.$three} ? + $env{'form.start_'.$one.'_'.$two.'_'.$three} : $now ); - my $end = ( $ENV{'form.end_'.$1.'_'.$2.'_'.$3} ? - $ENV{'form.end_'.$1.'_'.$2.'_'.$3} : + my $end = ( $env{'form.end_'.$one.'_'.$two.'_'.$three} ? + $env{'form.end_'.$one.'_'.$two.'_'.$three} : 0 ); - my $url='/'.$1.'/'.$2; - if ($ENV{'form.sec_'.$1.'_'.$2.'_'.$3}) { - $url.='/'.$ENV{'form.sec_'.$1.'_'.$2.'_'.$3}; - } - # Assign the role and report it - $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). - '
'); - # Handle students differently - if ($3 eq 'st') { - $url=~/^\/(\w+)\/(\w+)/; - my $cid=$1.'_'.$2; - $r->print(&mt('Add to classlist').': '. - &Apache::lonnet::critical( - 'put:'.$ENV{'course.'.$cid.'.domain'}.':'. - $ENV{'course.'.$cid.'.num'}.':classlist:'. - &Apache::lonnet::escape( - $ENV{'form.ccuname'}.':'. - $ENV{'form.ccdomain'} ).'='. - &Apache::lonnet::escape($end.':'.$start), - $ENV{'course.'.$cid.'.home'}) - .'
'); - } + my $url='/'.$one.'/'.$two; + my $type = 'three'; + # split multiple sections + my %sections = (); + my $num_sections = &build_roles($env{'form.sec_'.$one.'_'.$two.'_'.$three},\%sections,$three); + if ($num_sections == 0) { + $r->print(&commit_standardrole($udom,$uname,$url,$three,$start,$end,$one,$two,'')); + } else { + my $emptysec = 0; + foreach my $sec (sort {$a cmp $b} keys %sections) { + $sec =~ s/\W//g; + if ($sec ne '') { + my $securl = $url.'/'.$sec; + $r->print(&commit_standardrole($udom,$uname,$securl,$three,$start,$end,$one,$two,$sec)); + } else { + $emptysec = 1; + } + } + if ($emptysec) { + $r->print(&commit_standardrole($udom,$uname,$url,$three,$start,$end,$one,$two,'')); + } + } } elsif ($_=~/^form\.act\_([^\_]+)\_([^\_]+)$/) { # Activate roles for sections with two id numbers # set start, end times, and the url for the class - my $start = ( $ENV{'form.start_'.$1.'_'.$2} ? - $ENV{'form.start_'.$1.'_'.$2} : + my $start = ( $env{'form.start_'.$1.'_'.$2} ? + $env{'form.start_'.$1.'_'.$2} : $now ); - my $end = ( $ENV{'form.end_'.$1.'_'.$2} ? - $ENV{'form.end_'.$1.'_'.$2} : + my $end = ( $env{'form.end_'.$1.'_'.$2} ? + $env{'form.end_'.$1.'_'.$2} : 0 ); my $url='/'.$1.'/'; - # Assign the role and report it. - $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) - .'
'); + # split multiple sections + my %sections = (); + my $num_sections = &build_roles($env{'form.sec_'.$1.'_'.$2},\%sections,$2); + if ($num_sections == 0) { + $r->print(&commit_standardrole($udom,$uname,$url,$2,$start,$end,$1,undef,'')); + } else { + my $emptysec = 0; + foreach my $sec (sort {$a cmp $b} keys %sections) { + if ($sec ne '') { + my $securl = $url.'/'.$sec; + $r->print(&commit_standardrole($udom,$uname,$securl,$2,$start,$end,$1,undef,$sec)); + } else { + $emptysec = 1; + } + } + if ($emptysec) { + $r->print(&commit_standardrole($udom,$uname,$url,$2,$start,$end,$1,undef,'')); + } + } } else { - $r->print('

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


'); + $r->print('

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


'); } } - } # End of foreach (keys(%ENV)) + } # End of foreach (keys(%env)) # Flush the course logs so reverse user roles immediately updated &Apache::lonnet::flushcourselogs(); + $r->print('

Create/Modify Another User

'); $r->print(''); } +sub commit_customrole { + my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_; + my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.'@'.$three.' in '.$url. + ($start?', '.&mt('starting').' '.localtime($start):''). + ($end?', ending '.localtime($end):'').': '. + &Apache::lonnet::assigncustomrole( + $udom,$uname,$url,$three,$four,$five,$end,$start). + '
'; + return $output; +} + +sub commit_standardrole { + my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec) = @_; + my $output; + my $logmsg; + if ($three eq 'st') { + my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec); + if (($result =~ /^error/) || ($result eq 'not_in_class') || ($result eq 'unknown_course')) { + $output = "Error: $result\n"; + } else { + $output = &mt('Assigning').' '.$three.' in '.$url. + ($start?', '.&mt('starting').' '.localtime($start):''). + ($end?', '.&mt('ending').' '.localtime($end):''). + ': '.$result.'
'. + &mt('Add to classlist').': ok
'; + } + } else { + $output = &mt('Assigning').' '.$three.' in '.$url. + ($start?', '.&mt('starting').' '.localtime($start):''). + ($end?', '.&mt('ending').' '.localtime($end):'').': '. + &Apache::lonnet::assignrole( + $udom,$uname,$url,$three,$end,$start). + '
'; + } + return $output; +} + +sub commit_studentrole { + my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec) = @_; + my $linefeed = '
'."\n"; + my $result; + if (defined($one) && defined($two)) { + my $cid=$one.'_'.$two; + my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid); + my $secchange = 0; + my $expire_role_result; + my $modify_section_result; + unless ($oldsec eq '-1') { + unless ($sec eq $oldsec) { + $secchange = 1; + my $uurl='/'.$cid; + $uurl=~s/\_/\//g; + if ($oldsec) { + $uurl.='/'.$oldsec; + } + $expire_role_result = &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',time); + $result = $expire_role_result; + } + } + if (($expire_role_result eq 'ok') || ($secchange == 0)) { + $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid); + if ($modify_section_result =~ /^ok/) { + if ($secchange == 1) { + $$logmsg .= "Section for $uname switched from old section: $oldsec to new section: $sec".$linefeed; + } elsif ($oldsec eq '-1') { + $$logmsg .= "New student role for $uname in section $sec in course $cid".$linefeed; + } else { + $$logmsg .= "Student $uname assigned to unchanged section $sec in course $cid".$linefeed; + } + } else { + $$logmsg .= "Error when attempting section change for $uname from old section $oldsec to new section: $sec in course $cid -error: $modify_section_result".$linefeed; + } + $result = $modify_section_result; + } elsif ($secchange == 1) { + $$logmsg .= "Error when attempting to expire role for $uname in old section $oldsec in course $cid -error: $expire_role_result".$linefeed; + } + } else { + $$logmsg .= "Incomplete course id defined. Addition of user $uname from domain $udom to course $one\_$two, section $sec not completed.$linefeed"; + $result = "Error: incomplete course id\n"; + } + return $result; +} + +sub build_roles { + my ($sectionstr,$sections,$role) = @_; + my $num_sections = 0; + if ($sectionstr=~ /,/) { + my @secnums = split/,/,$sectionstr; + if ($role eq 'st') { + $secnums[0] =~ s/\W//g; + $$sections{$secnums[0]} = 1; + $num_sections = 1; + } else { + foreach my $sec (@secnums) { + $sec =~ ~s/\W//g; + unless ($sec eq "") { + if (exists($$sections{$sec})) { + $$sections{$sec} ++; + } else { + $$sections{$sec} = 1; + $num_sections ++; + } + } + } + } + } else { + $sectionstr=~s/\W//g; + unless ($sectionstr eq '') { + $$sections{$sectionstr} = 1; + $num_sections ++; + } + } + + return $num_sections; +} + # ========================================================== Custom Role Editor sub custom_role_editor { my $r=shift; - my $rolename=$ENV{'form.rolename'}; + my $rolename=$env{'form.rolename'}; if ($rolename eq 'make new role') { - $rolename=$ENV{'form.newrolename'}; + $rolename=$env{'form.newrolename'}; } $rolename=~s/[^A-Za-z0-9]//gs; @@ -1115,7 +1471,7 @@ ENDCCF sub set_custom_role { my $r=shift; - my $rolename=$ENV{'form.rolename'}; + my $rolename=$env{'form.rolename'}; $rolename=~s/[^A-Za-z0-9]//gs; @@ -1144,7 +1500,7 @@ sub set_custom_role { foreach (split(/\:/,$Apache::lonnet::pr{'cr:c'})) { my ($priv,$restrict)=split(/\&/,$_); unless ($restrict) { $restrict=''; } - if ($ENV{'form.'.$priv.':c'}) { + if ($env{'form.'.$priv.':c'}) { $courole.=':'.$_; } } @@ -1152,7 +1508,7 @@ sub set_custom_role { foreach (split(/\:/,$Apache::lonnet::pr{'cr:d'})) { my ($priv,$restrict)=split(/\&/,$_); unless ($restrict) { $restrict=''; } - if ($ENV{'form.'.$priv.':d'}) { + if ($env{'form.'.$priv.':d'}) { $domrole.=':'.$_; } } @@ -1160,21 +1516,21 @@ sub set_custom_role { foreach (split(/\:/,$Apache::lonnet::pr{'cr:s'})) { my ($priv,$restrict)=split(/\&/,$_); unless ($restrict) { $restrict=''; } - if ($ENV{'form.'.$priv.':s'}) { + if ($env{'form.'.$priv.':s'}) { $sysrole.=':'.$_; } } $r->print('
Defining Role: '. &Apache::lonnet::definerole($rolename,$sysrole,$domrole,$courole)); - if ($ENV{'request.course.id'}) { - my $url='/'.$ENV{'request.course.id'}; + if ($env{'request.course.id'}) { + my $url='/'.$env{'request.course.id'}; $url=~s/\_/\//g; $r->print('
'.&mt('Assigning Role to Self').': '. - &Apache::lonnet::assigncustomrole($ENV{'user.domain'}, - $ENV{'user.name'}, + &Apache::lonnet::assigncustomrole($env{'user.domain'}, + $env{'user.name'}, $url, - $ENV{'user.domain'}, - $ENV{'user.name'}, + $env{'user.domain'}, + $env{'user.name'}, $rolename)); } $r->print(''); @@ -1190,28 +1546,28 @@ sub handler { return OK; } - if ((&Apache::lonnet::allowed('cta',$ENV{'request.course.id'})) || - (&Apache::lonnet::allowed('cin',$ENV{'request.course.id'})) || - (&Apache::lonnet::allowed('ccr',$ENV{'request.course.id'})) || - (&Apache::lonnet::allowed('cep',$ENV{'request.course.id'})) || - (&Apache::lonnet::allowed('cca',$ENV{'request.role.domain'})) || - (&Apache::lonnet::allowed('mau',$ENV{'request.role.domain'}))) { + if ((&Apache::lonnet::allowed('cta',$env{'request.course.id'})) || + (&Apache::lonnet::allowed('cin',$env{'request.course.id'})) || + (&Apache::lonnet::allowed('ccr',$env{'request.course.id'})) || + (&Apache::lonnet::allowed('cep',$env{'request.course.id'})) || + (&authorpriv($env{'user.name'},$env{'request.role.domain'})) || + (&Apache::lonnet::allowed('mau',$env{'request.role.domain'}))) { &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; - unless ($ENV{'form.phase'}) { + unless ($env{'form.phase'}) { &print_username_entry_form($r); } - if ($ENV{'form.phase'} eq 'get_user_info') { + if ($env{'form.phase'} eq 'get_user_info') { &print_user_modification_page($r); - } elsif ($ENV{'form.phase'} eq 'update_user_data') { + } elsif ($env{'form.phase'} eq 'update_user_data') { &update_user_data($r); - } elsif ($ENV{'form.phase'} eq 'selected_custom_edit') { + } elsif ($env{'form.phase'} eq 'selected_custom_edit') { &custom_role_editor($r); - } elsif ($ENV{'form.phase'} eq 'set_custom_roles') { + } elsif ($env{'form.phase'} eq 'set_custom_roles') { &set_custom_role($r); } } else { - $ENV{'user.error.msg'}= + $env{'user.error.msg'}= "/adm/createuser:mau:0:0:Cannot modify user data"; return HTTP_NOT_ACCEPTABLE; } @@ -1220,11 +1576,24 @@ sub handler { #-------------------------------------------------- functions for &phase_two sub course_level_table { - my %inccourses = @_; + my (%inccourses) = @_; my $table = ''; # Custom Roles? my %customroles=&my_custom_roles(); + my %lt=&Apache::lonlocal::texthash( + 'exs' => "Existing sections", + 'new' => "Define new section", + 'ssd' => "Set Start Date", + 'sed' => "Set End Date", + 'crl' => "Course Level", + 'act' => "Activate", + 'rol' => "Role", + 'ext' => "Extent", + 'grs' => "Group/Section", + 'sta' => "Start", + 'end' => "End" + ); foreach (sort( keys(%inccourses))) { my $thiscourse=$_; @@ -1236,6 +1605,14 @@ sub course_level_table { my $bgcol=$thiscourse; $bgcol=~s/[^7-9a-e]//g; $bgcol=substr($bgcol.$bgcol.$bgcol.'ffffff',2,6); + my ($domain,$cnum)=split(/\//,$thiscourse); + my %sections_count = (); + my $num_sections = 0; + if (defined($env{'request.course.id'})) { + if ($env{'request.course.id'} eq $domain.'_'.$cnum) { + $num_sections = &Apache::loncommon::get_sections($domain,$cnum,\%sections_count); + } + } foreach ('st','ta','ep','ad','in','cc') { if (&Apache::lonnet::allowed('c'.$_,$thiscourse)) { my $plrole=&Apache::lonnet::plaintext($_); @@ -1243,21 +1620,28 @@ sub course_level_table { $plrole -$area +$area
Domain: $domain ENDEXTENT if ($_ ne 'cc') { - $table .= < -ENDSECTION + if ($num_sections > 0) { + my $currsec = &course_sections($num_sections,\%sections_count,$protectedcourse.'_'.$_); + $table .= + ''. + ''. + ''. + ''. + ''. + '
'.$lt{'exs'}.'
'. + $currsec.'		   '.$lt{'new'}.'
'. + '
'; + } else { + $table .= ''; + } } else { - $table .= <  -ENDSECTION + $table .= ' '; } - my %lt=&Apache::lonlocal::texthash( - 'ssd' => "Set Start Date", - 'sed' => "Set End Date" - ); $table .= < "Set Start Date", - 'sed' => "Set End Date" - ); - $table .= < $plrole $area - +END + if ($num_sections > 0) { + my $currsec = &course_sections($num_sections,\%sections_count,$customrole); + $table.= + ''. + ''. + ''. + ''. + ''. + '
'.$lt{'exs'}.'
'. + $currsec.'		   '.$lt{'new'}.'
'. + '
'; + } else { + $table .= ''; + } + $table .= < $lt{'ssd'} @@ -1296,15 +1693,6 @@ 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 = <$lt{'crl'} @@ -1314,6 +1702,86 @@ $table ENDTABLE return $result; } + +sub course_sections { + my ($num_sections,$sections_count,$role) = @_; + my $output = ''; + my @sections = (sort {$a <=> $b} keys %{$sections_count}); + if ($num_sections == 1) { + $output = ''."\n"; + foreach (@sections) { + $output .= '\n"; + } + } + $output .= ''; + return $output; +} + +sub course_level_dc { + my ($dcdom) = @_; + my %customroles=&my_custom_roles(); + my $hiddenitems = ''. + ''. + ''; + my $courseform=''.&Apache::loncommon::selectcourse_link + ('cu','dccourse','dcdomain','coursedesc').''; + + my $cb_jscript = &Apache::loncommon::coursebrowser_javascript($dcdom,$dcdom); + my %lt=&Apache::lonlocal::texthash( + 'crl' => "Course Level", + 'crt' => "Course Title", + 'rol' => "Role", + 'grs' => "Group/Section", + 'exs' => "Existing sections", + 'new' => "Define new section", + 'sta' => "Start", + 'end' => "End", + 'ssd' => "Set Start Date", + 'sed' => "Set End Date" + ); + my $header = '

'.$lt{'crl'}.'

'. + '
$lt{'act'}$lt{'rol'}$lt{'ext'}
'; + my $otheritems = ''. + ''; + $otheritems .= < +$lt{'ssd'} + +ENDTIMEENTRY + $otheritems .= "
'.$courseform.''.$lt{'rol'}.''.$lt{'grs'}.''.$lt{'sta'}.''.$lt{'end'}.'
'. + ''. + ''. + ''. + ''. + '
'.$lt{'exs'}.'
   '.$lt{'new'}.'
'. + '
 +$lt{'sed'}
\n"; + return $cb_jscript.$header.$hiddenitems.$otheritems; +} + #---------------------------------------------- end functions for &phase_two #--------------------------------- functions for &phase_two and &phase_three