--- loncom/interface/slotrequest.pm 2006/04/10 07:37:16 1.57 +++ loncom/interface/slotrequest.pm 2008/12/11 14:55:15 1.84 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler for requesting to have slots added to a students record # -# $Id: slotrequest.pm,v 1.57 2006/04/10 07:37:16 albertel Exp $ +# $Id: slotrequest.pm,v 1.84 2008/12/11 14:55:15 bisitz Exp $ # # Copyright Michigan State University Board of Trustees # @@ -36,12 +36,15 @@ use Apache::lonlocal; use Apache::lonnet; use Apache::lonnavmaps(); use Date::Manip; +use lib '/home/httpd/lib/perl/'; +use LONCAPA; sub fail { my ($r,$code)=@_; if ($code eq 'not_valid') { $r->print('

'.&mt('Unable to understand what resource you wanted to sign up for.').'

'); - + } elsif ($code eq 'not_available') { + $r->print('

'.&mt('No slots are available.').'

'); } elsif ($code eq 'not_allowed') { $r->print('

'.&mt('Not allowed to sign up or change reservations at this time.').'

'); } else { @@ -74,7 +77,7 @@ sub end_page { =cut sub get_course { - (undef,my $courseid)=&Apache::lonxml::whichuser(); + (undef,my $courseid)=&Apache::lonnet::whichuser(); my $cdom=$env{'course.'.$courseid.'.domain'}; my $cnum=$env{'course.'.$courseid.'.num'}; return ($cnum,$cdom); @@ -87,7 +90,7 @@ sub get_reservation_ids { my %consumed=&Apache::lonnet::dump('slot_reservations',$cdom,$cnum, "^$slot_name\0"); - if (&network_error(%consumed)) { + if (&Apache::lonnet::error(%consumed)) { return 'error: Unable to determine current status'; } my ($tmp)=%consumed; @@ -124,8 +127,9 @@ sub check_for_reservation { my ($cnum,$cdom)=&get_course(); my %slots=&Apache::lonnet::get('slots', [@slots], $cdom, $cnum); - if (&network_error($student) || &network_error($course) || - &network_error(%slots)) { + if (&Apache::lonnet::error($student) + || &Apache::lonnet::error($course) + || &Apache::lonnet::error(%slots)) { return 'error: Unable to determine current status'; } my @got; @@ -172,7 +176,8 @@ sub get_consumed_uniqueperiods { my $course = &Apache::lonnet::EXT("resource.0.available", $symb, $env{'user.domain'}, $env{'user.name'}); - if (&network_error($student) || &network_error($course)) { + if (&Apache::lonnet::error($student) + || &Apache::lonnet::error($course)) { return 'error: Unable to determine current status'; } foreach my $slot (split(/:/,$student), split(/:/, $course)) { @@ -183,7 +188,7 @@ sub get_consumed_uniqueperiods { if (!ref($slots)) { my ($cnum,$cdom)=&get_course(); my %slots=&Apache::lonnet::get('slots', [keys(%used_slots)], $cdom, $cnum); - if (&network_error(%slots)) { + if (&Apache::lonnet::error(%slots)) { return 'error: Unable to determine current status'; } $slots = \%slots; @@ -209,7 +214,7 @@ sub check_for_conflict { if (!ref($consumed_uniqueperiods)) { $consumed_uniqueperiods = &get_consumed_uniqueperiods($slots); - if (&network_error(%$consumed_uniqueperiods)) { + if (&Apache::lonnet::error(%$consumed_uniqueperiods)) { return 'error: Unable to determine current status'; } } @@ -227,14 +232,6 @@ sub check_for_conflict { } -sub network_error { - my ($result) = @_; - if ($result =~ /^(con_lost|no_such_host|error: [^2])/) { - return 1; - } - return 0; -} - sub make_reservation { my ($slot_name,$slot,$symb)=@_; @@ -243,15 +240,29 @@ sub make_reservation { my $value=&Apache::lonnet::EXT("resource.0.availablestudent",$symb, $env{'user.domain'},$env{'user.name'}); &Apache::lonxml::debug("value is $value
"); - if (&network_error($value)) { + + my $use_slots = &Apache::lonnet::EXT("resource.0.useslots",$symb, + $env{'user.domain'},$env{'user.name'}); + &Apache::lonxml::debug("use_slots is $use_slots
"); + + if (&Apache::lonnet::error($value) + || &Apache::lonnet::error($use_slots)) { return 'error: Unable to determine current status'; } + my $parm_symb = $symb; + my $parm_level = 1; + if ($use_slots eq 'map' || $use_slots eq 'map_map') { + my ($map) = &Apache::lonnet::decode_symb($symb); + $parm_symb = &Apache::lonnet::symbread($map); + $parm_level = 2; + } + foreach my $other_slot (split(/:/, $value)) { if ($other_slot eq $slot_name) { my %consumed=&Apache::lonnet::dump('slot_reservations', $cdom, $cnum, "^$slot_name\0"); - if (&network_error($value)) { + if (&Apache::lonnet::error($value)) { return 'error: Unable to determine current status'; } my $me=$env{'user.name'}.':'.$env{'user.domain'}; @@ -268,7 +279,7 @@ sub make_reservation { if (!defined($max)) { $max=99999; } my (@ids)=&get_reservation_ids($slot_name); - if (&network_error(@ids)) { + if (&Apache::lonnet::error(@ids)) { return 'error: Unable to determine current status'; } my $last=0; @@ -286,7 +297,7 @@ sub make_reservation { my %reservation=('name' => $env{'user.name'}.':'.$env{'user.domain'}, 'timestamp' => time, - 'symb' => $symb); + 'symb' => $parm_symb); my $success=&Apache::lonnet::newput('slot_reservations', {"$slot_name\0$wanted" => @@ -300,7 +311,8 @@ sub make_reservation { } my $result=&Apache::lonparmset::storeparm_by_symb($symb, '0_availablestudent', - 1, $new_value, 'string', + $parm_level, $new_value, + 'string', $env{'user.name'}, $env{'user.domain'}); &Apache::lonxml::debug("hrrm $result"); @@ -322,8 +334,8 @@ sub remove_registration { my ($cnum,$cdom)=&get_course(); my %consumed=&Apache::lonnet::dump('slot_reservations',$cdom,$cnum, "^$slot_name\0"); - if (&network_error(%consumed)) { - $r->print("

".&mt('A network error has occured.').'

'); + if (&Apache::lonnet::error(%consumed)) { + $r->print("

".&mt('A network error has occurred.').'

'); return; } if (!%consumed) { @@ -369,13 +381,13 @@ sub remove_registration_confirmation { 'no' => 'No',); $r->print(<<"END_CONFIRM");

$msg

-
+ $hidden_input
-
+
@@ -422,7 +434,7 @@ sub release_slot { if ($mgr eq 'F' && defined($env{'form.symb'})) { - $symb = $env{'form.symb'}; + $symb = &unescape($env{'form.symb'}); } my ($result,$msg) = @@ -448,9 +460,22 @@ sub release_reservation { return (0,&mt('Not allowed to release Reservation: [_1], as it has already ended.',$description)); } } + + # if the reservation symb is for a map get a resource in that map + # to check slot parameters on + my $navmap=Apache::lonnavmaps::navmap->new; + my $passed_resource = $navmap->getBySymb($symb); + if ($passed_resource->is_map()) { + my ($a_resource) = + $navmap->retrieveResources($passed_resource, + sub {$_[0]->is_problem()},0,1); + $symb = $a_resource->symb(); + } + # get parameter string, check for existance, rebuild string with the slot - my @slots = split(/:/,&Apache::lonnet::EXT("resource.0.availablestudent", - $symb,$udom,$uname)); + my $student = &Apache::lonnet::EXT("resource.0.availablestudent", + $symb,$udom,$uname); + my @slots = split(/:/,$student); my @new_slots; foreach my $exist_slot (@slots) { @@ -471,11 +496,23 @@ sub release_reservation { } } + my $use_slots = &Apache::lonnet::EXT("resource.0.useslots", + $symb,$udom,$uname); + &Apache::lonxml::debug("use_slots is $use_slots
"); + + if (&Apache::lonnet::error($use_slots)) { + return (0,'error: Unable to determine current status'); + } + + my $parm_level = 1; + if ($use_slots eq 'map' || $use_slots eq 'map_map') { + $parm_level = 2; + } # store new parameter string my $result=&Apache::lonparmset::storeparm_by_symb($symb, '0_availablestudent', - 1, $new_param, 'string', - $uname,$udom); + $parm_level, $new_param, + 'string', $uname, $udom); my $msg; if ($mgr eq 'F') { @@ -505,7 +542,7 @@ sub delete_slot { if ($ret eq 'ok') { $r->print("

Slot $slot_name marked as deleted.

"); } else { - $r->print("

An error ($ret) occurse when attempting to delete Slot $slot_name.

"); + $r->print("

An error ($ret) occurse when attempting to delete Slot $slot_name.

"); } } else { if (%consumed) { @@ -526,17 +563,19 @@ sub return_link { } sub get_slot { - my ($r,$symb)=@_; + my ($r,$symb,$conflictable_slot,$inhibit_return_link)=@_; my %slot=&Apache::lonnet::get_slot($env{'form.slotname'}); my $slot_name=&check_for_conflict($symb,$env{'form.slotname'},\%slot); if ($slot_name =~ /^error: (.*)/) { - $r->print("

An error occured while attempting to make a reservation. ($1)

"); + $r->print('

' + .&mt('An error occurred while attempting to make a reservation. ([_1])',$1) + .'

'); &return_link($r); - return; + return 0; } - if ($slot_name) { + if ($slot_name && $slot_name ne $conflictable_slot) { my %slot=&Apache::lonnet::get_slot($slot_name); my $description1=&get_description($slot_name,\%slot); %slot=&Apache::lonnet::get_slot($env{'form.slotname'}); @@ -544,7 +583,7 @@ sub get_slot { $r->print("

Already have a reservation: $description1

"); if ($slot_name ne $env{'form.slotname'}) { $r->print(< +
@@ -564,42 +603,52 @@ STUFF } else { &return_link($r); } - return; + return 0; } my $reserved=&make_reservation($env{'form.slotname'}, \%slot,$symb); my $description=&get_description($env{'form.slotname'},\%slot); if (defined($reserved)) { + my $retvalue = 0; if ($slot_name =~ /^error: (.*)/) { - $r->print("

An error occured while attempting to make a reservation. ($1)

"); + $r->print('

' + .&mt('An error occurred while attempting to make a reservation. ([_1])',$1) + .'

'); } elsif ($reserved > -1) { $r->print("

Success: $description

"); + $retvalue = 1; } elsif ($reserved < 0) { $r->print("

Already reserved: $description

"); } - &return_link($r); - return; + if (!$inhibit_return_link) { &return_link($r); } + return 1; } my %lt=('request'=>"Availibility list", 'try' =>'Try again'); %lt=&Apache::lonlocal::texthash(%lt); + my $extra_input; + if ($conflictable_slot) { + $extra_input=''; + } + $r->print(< Failed to reserve a spot for $description.

+

Failed to reserve a spot for $description.

- + - + + $extra_input

?

or -

+
@@ -607,8 +656,8 @@ or or STUFF - &return_link($r); - return; + if (!$inhibit_return_link) { &return_link($r); } + return 0; } sub allowed_slot { @@ -616,8 +665,7 @@ sub allowed_slot { #already started if ($slot->{'starttime'} < time) { - # all open slot to be schedulable - #return 0; + return 0; } &Apache::lonxml::debug("$slot_name starttime good"); @@ -653,6 +701,16 @@ sub allowed_slot { split(',',$slot->{'allowedsections'}))) { $userallowed=1; } + if (defined($env{'request.course.groups'})) { + my @groups = split(/:/,$env{'request.course.groups'}); + my @allowed_sec = split(',',$slot->{'allowedsections'}); + foreach my $group (@groups) { + if (grep {$_ eq $group} (@allowed_sec)) { + $userallowed=1; + last; + } + } + } } &Apache::lonxml::debug("$slot_name sections is $userallowed"); @@ -727,7 +785,7 @@ sub show_choices { my $text=&mt('Select'); my $command='get'; if (grep(/^\Q$slot\E$/,@got_slots)) { - $text=&mt('Free Reservation'); + $text=&mt('Drop Reservation'); $command='release'; } else { my $conflict = &check_for_conflict($symb,$slot,$slots{$slot}, @@ -738,9 +796,9 @@ sub show_choices { $command='get'; } } - my $escsymb=&Apache::lonnet::escape($symb); + my $escsymb=&escape($symb); $form=< +
@@ -837,14 +895,14 @@ sub remove_link { undef($udom); } - $slotname = &Apache::lonnet::escape($slotname); - $entry = &Apache::lonnet::escape($entry); - $uname = &Apache::lonnet::escape($uname); - $udom = &Apache::lonnet::escape($udom); - $symb = &Apache::lonnet::escape($symb); + $slotname = &escape($slotname); + $entry = &escape($entry); + $uname = &escape($uname); + $udom = &escape($udom); + $symb = &escape($symb); return <<"END_LINK"; - ($remove) END_LINK @@ -860,14 +918,19 @@ sub show_table { } my $available; if ($mgr eq 'F') { + # FIXME: This line should be deleted once Slots uses breadcrumbs + $r->print(&Apache::loncommon::help_open_topic('Slot About', 'Help on slots')); + $r->print('
'); - $r->print(' + $r->print(' '); - $r->print('
+ $r->print(&Apache::loncommon::help_open_topic('Slot CommaDelimited')); + $r->print('
'); + $r->print(&Apache::loncommon::help_open_topic('Slot AddInterface')); $r->print('
'); } @@ -895,7 +958,7 @@ sub show_table { 'endtime' => 'End Time', 'startreserve' => 'Time students can start reserving', 'secret' => 'Secret Word', - 'maxspace' => 'Maximum # of students', + 'space' => '# of students/max', 'ip' => 'IP or DNS restrictions', 'symb' => 'Resource slot is restricted to.', 'allowedsections' => 'Sections slot is restricted to.', @@ -904,7 +967,7 @@ sub show_table { 'scheduled' => 'Scheduled Students', 'proctor' => 'List of proctors'); my @show_order=('name','description','type','starttime','endtime', - 'startreserve','secret','maxspace','ip','symb', + 'startreserve','secret','space','ip','symb', 'allowedsections','allowedusers','uniqueperiod', 'scheduled','proctor'); my @show = @@ -952,13 +1015,16 @@ sub show_table { my $name_filter = {'type' => $name_filter_type, 'value' => $env{'form.name_filter_value'},}; + #deleted slot filtering + #default to hide if no value + $env{'form.deleted'} ||= 'hide'; my $hide_radio = &Apache::lonhtmlcommon::radio('deleted',$env{'form.deleted'},'hide'); my $show_radio = &Apache::lonhtmlcommon::radio('deleted',$env{'form.deleted'},'show'); - $r->print('
+ $r->print(' '); $r->print('
'); $r->print(' @@ -1001,23 +1067,28 @@ sub show_table { $r->print(''); $r->print('

'); my $linkstart=' - - '); + $r->print(&Apache::loncommon::start_data_table(). + &Apache::loncommon::start_data_table_header_row().' + '); foreach my $which (@show_order) { if ($which ne 'proctor' && exists($show{$which})) { $r->print(''); } } + $r->print(&Apache::loncommon::end_data_table_header_row()); my %name_cache; my $slotsort = sub { - if ($env{'form.order'}=~/^(type|description|endtime|startreserve|maxspace|ip|symb|allowedsections|allowedusers)$/) { + if ($env{'form.order'}=~/^(type|description|endtime|startreserve|ip|symb|allowedsections|allowedusers)$/) { if (lc($slots{$a}->{$env{'form.order'}}) ne lc($slots{$b}->{$env{'form.order'}})) { return (lc($slots{$a}->{$env{'form.order'}}) cmp lc($slots{$b}->{$env{'form.order'}})); } + } elsif ($env{'form.order'} eq 'space') { + if ($slots{$a}{'maxspace'} ne $slots{$b}{'maxspace'}) { + return ($slots{$a}{'maxspace'} cmp $slots{$b}{'maxspace'}); + } } elsif ($env{'form.order'} eq 'name') { if (lc($a) cmp lc($b)) { return lc($a) cmp lc($b); @@ -1037,6 +1108,14 @@ sub show_table { } return $slots{$a}->{'starttime'} <=> $slots{$b}->{'starttime'}; }; + + my %consumed; + if (exists($show{'scheduled'}) || exists($show{'space'}) ) { + %consumed=&Apache::lonnet::dump('slot_reservations',$cdom,$cnum); + my ($tmp)=%consumed; + if ($tmp =~ /^error: /) { undef(%consumed); } + } + foreach my $slot (sort $slotsort (keys(%slots))) { if (!&to_show($slot,$slots{$slot},$when, $env{'form.deleted'},$name_filter)) { next; } @@ -1045,18 +1124,19 @@ sub show_table { #next; } my $description=&get_description($slot,$slots{$slot}); - my $ids; - if (exists($show{'scheduled'})) { - my %consumed=&Apache::lonnet::dump('slot_reservations',$cdom,$cnum, - "^$slot\0"); - my ($tmp)=%consumed; - if ($tmp !~ /^error: /) { + my ($id_count,$ids); + + if (exists($show{'scheduled'}) || exists($show{'space'}) ) { + my $re_str = "$slot\0"; + my @this_slot = grep(/^\Q$re_str\E/,keys(%consumed)); + $id_count = scalar(@this_slot); + if (exists($show{'scheduled'})) { foreach my $entry (sort { $consumed{$a}{name} cmp $consumed{$b}{name} } - (keys(%consumed))) { + (@this_slot)) { my (undef,$id)=split("\0",$entry); my ($uname,$udom) = split(':',$consumed{$entry}{'name'}); - $ids.= ''; + $ids.= ''; foreach my $item (@stu_display_order) { if ($stu_display{$item}) { if ($item eq 'fullname') { @@ -1067,7 +1147,7 @@ sub show_table { } } $ids.=&remove_link($slot,$entry,$uname,$udom, - $consumed{$entry}{'symb'}).'
'; + $consumed{$entry}{'symb'}).'
'; } } } @@ -1081,7 +1161,7 @@ sub show_table { my $unique; if (ref($slots{$slot}{'uniqueperiod'})) { - $unique=localtime($slots{$slot}{'uniqueperiod'}[0]).','. + $unique=localtime($slots{$slot}{'uniqueperiod'}[0]).', '. localtime($slots{$slot}{'uniqueperiod'}[1]); } @@ -1122,7 +1202,7 @@ sub show_table { if (exists($show{'proctor'})) { $rowspan=2; @proctors= map { - my ($uname,$udom)=split(/@/,$_); + my ($uname,$udom)=split(/:/,$_); my $fullname=$name_cache{$_}; if (!defined($fullname)) { $fullname = &Apache::loncommon::plainname($uname,$udom); @@ -1139,7 +1219,7 @@ sub show_table { EDITLINK my $delete=(<<"DELETELINK"); -Delete +Delete DELETELINK my $remove_all=&remove_link($slot,'remove all').'
'; @@ -1150,7 +1230,10 @@ DELETELINK undef($remove_all); } - $r->print("\n\n"); + my $row_start=&Apache::loncommon::start_data_table_row(); + my $row_end=&Apache::loncommon::end_data_table_row(); + $r->print($row_start. + "\n\n"); if (exists($show{'name'})) { $colspan++;$r->print(""); } @@ -1172,8 +1255,15 @@ DELETELINK if (exists($show{'secret'})) { $colspan++;$r->print("\n"); } - if (exists($show{'maxspace'})) { - $colspan++;$r->print("\n"); + if (exists($show{'space'})) { + my $display = $id_count; + if ($slots{$slot}{'maxspace'}>0) { + $display.='/'.$slots{$slot}{'maxspace'}; + if ($slots{$slot}{'maxspace'} <= $id_count) { + $display = ''.$display.' (full) '; + } + } + $colspan++;$r->print("\n"); } if (exists($show{'ip'})) { $colspan++;$r->print("\n"); @@ -1187,18 +1277,22 @@ DELETELINK if (exists($show{'allowedusers'})) { $colspan++;$r->print("\n"); } + if (exists($show{'uniqueperiod'})) { + $colspan++;$r->print("\n"); + } if (exists($show{'scheduled'})) { - $colspan++;$r->print("\n\n"); + $colspan++;$r->print("\n"); } + $r->print("$row_end\n"); if (exists($show{'proctor'})) { $r->print(< +$row_start - +$row_end STUFF } } - $r->print('
'.$linkstart.$which.'">'.$show_fields{$which}.'
$edit $delete$edit $delete$slot$slots{$slot}{'secret'}$slots{$slot}{'maxspace'}$display$slots{$slot}{'ip'}$allowedusers$unique$remove_all $ids
$remove_all $ids$proctors
'); + $r->print(''); } sub upload_start { @@ -1235,9 +1329,11 @@ sub csvuploadmap_header { my $checked=(($env{'form.noFirstLine'})?' checked="checked"':''); my $ignore=&mt('Ignore First Line'); + my $help_field = &Apache::loncommon::help_open_topic('Slot SelectingField'); + $r->print(< -

Identify fields

+

Identify fields $help_field

Total number of records found in file: $distotal
Enter as many fields as you can. The system will inform you and bring you back to this page if the data selected is insufficient to create the slots.
@@ -1420,22 +1516,49 @@ sub csv_upload_assign { if ($entries{$fields{'endtime'}}) { $slot{'endtime'}=&UnixDate($entries{$fields{'endtime'}},"%s"); } + + # start/endtime must be defined and greater than zero + if (!$slot{'starttime'}) { + push(@errors,"$name not created -- Invalid start time"); + next; + } + if (!$slot{'endtime'}) { + push(@errors,"$name not created -- Invalid end time"); + next; + } + if ($slot{'starttime'} > $slot{'endtime'}) { + push(@errors,"$name not created -- Slot starts after it ends"); + next; + } + if ($entries{$fields{'startreserve'}}) { $slot{'startreserve'}= &UnixDate($entries{$fields{'startreserve'}},"%s"); } + if (defined($slot{'startreserve'}) + && $slot{'startreserve'} > $slot{'starttime'}) { + push(@errors,"$name not created -- Slot's reservation start time is after the slot's start time."); + next; + } + foreach my $key ('ip','proctor','description','maxspace', 'secret','symb') { if ($entries{$fields{$key}}) { $slot{$key}=$entries{$fields{$key}}; } } + if ($entries{$fields{'uniqueperiod'}}) { my ($start,$end)=split(',',$entries{$fields{'uniqueperiod'}}); my @times=(&UnixDate($start,"%s"), &UnixDate($end,"%s")); $slot{'uniqueperiod'}=\@times; } + if (defined($slot{'uniqueperiod'}) + && $slot{'uniqueperiod'}[0] > $slot{'uniqueperiod'}[1]) { + push(@errors,"$name not created -- Slot's unique period start time is later than the unique period's end time."); + next; + } &Apache::lonnet::cput('slots',{$name=>\%slot},$cdom,$cname); $r->print('.'); @@ -1444,7 +1567,7 @@ sub csv_upload_assign { } $r->print("

Created $countdone slots\n

"); foreach my $error (@errors) { - $r->print("

$error\n

"); + $r->print("

$error

\n"); } &show_table($r,$mgr); return ''; @@ -1498,11 +1621,17 @@ sub handler { &csv_upload_map($r); } } else { - my $symb=&Apache::lonnet::unescape($env{'form.symb'}); + my $symb=&unescape($env{'form.symb'}); + if (!defined($symb)) { + &fail($r,'not_valid'); + return OK; + } my (undef,undef,$res)=&Apache::lonnet::decode_symb($symb); my $useslots = &Apache::lonnet::EXT("resource.0.useslots",$symb); - if ($useslots ne 'resource') { - &fail($r,'not_valid'); + if ($useslots ne 'resource' + && $useslots ne 'map' + && $useslots ne 'map_map') { + &fail($r,'not_available'); return OK; } $env{'request.symb'}=$symb; @@ -1522,8 +1651,8 @@ sub handler { } elsif ($env{'form.command'} eq 'get') { &get_slot($r,$symb); } elsif ($env{'form.command'} eq 'change') { - if (&release_slot($r,$symb,$env{'form.releaseslot'},1)) { - &get_slot($r,$symb); + if (&get_slot($r,$symb,$env{'form.releaseslot'},1)) { + &release_slot($r,$symb,$env{'form.releaseslot'}); } } else { $r->print("

Unknown command: ".$env{'form.command'}."

");