--- loncom/interface/slotrequest.pm 2006/03/30 04:37:22 1.48.2.2 +++ loncom/interface/slotrequest.pm 2006/12/18 14:59:16 1.72 @@ -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.48.2.2 2006/03/30 04:37:22 albertel Exp $ +# $Id: slotrequest.pm,v 1.72 2006/12/18 14:59:16 rezaferry 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 { @@ -54,14 +57,12 @@ sub fail { sub start_page { my ($r,$title)=@_; - my $html=&Apache::lonxml::xmlbegin(); - $r->print($html.''.&mt($title).''); - $r->print(&Apache::loncommon::bodytag($title)); + $r->print(&Apache::loncommon::start_page($title)); } sub end_page { my ($r)=@_; - $r->print(&Apache::loncommon::endbodytag().''); + $r->print(&Apache::loncommon::end_page()); } =pod @@ -76,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); @@ -89,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; @@ -126,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; @@ -174,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)) { @@ -185,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; @@ -211,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'; } } @@ -229,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)=@_; @@ -245,18 +240,31 @@ 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"); + &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'}; + my $me=$env{'user.name'}.':'.$env{'user.domain'}; foreach my $key (keys(%consumed)) { if ($consumed{$key}->{'name'} eq $me) { my $num=(split('\0',$key))[1]; @@ -270,7 +278,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,9 +294,9 @@ sub make_reservation { return undef; } - my %reservation=('name' => $env{'user.name'}.'@'.$env{'user.domain'}, + 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" => @@ -302,7 +310,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"); @@ -324,7 +333,7 @@ sub remove_registration { my ($cnum,$cdom)=&get_course(); my %consumed=&Apache::lonnet::dump('slot_reservations',$cdom,$cnum, "^$slot_name\0"); - if (&network_error(%consumed)) { + if (&Apache::lonnet::error(%consumed)) { $r->print("

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

'); return; } @@ -371,13 +380,13 @@ sub remove_registration_confirmation { 'no' => 'No',); $r->print(<<"END_CONFIRM");

$msg

-
+ $hidden_input
-
+
@@ -399,7 +408,7 @@ sub release_all_slot { foreach my $entry (sort { $consumed{$a}{'name'} cmp $consumed{$b}{'name'} } (keys(%consumed))) { - my ($uname,$udom) = split('@',$consumed{$entry}{'name'}); + my ($uname,$udom) = split(':',$consumed{$entry}{'name'}); my ($result,$msg) = &release_reservation($slot_name,$uname,$udom, $consumed{$entry}{'symb'},$mgr); @@ -424,7 +433,7 @@ sub release_slot { if ($mgr eq 'F' && defined($env{'form.symb'})) { - $symb = $env{'form.symb'}; + $symb = &unescape($env{'form.symb'}); } my ($result,$msg) = @@ -467,17 +476,28 @@ sub release_reservation { my %consumed=&Apache::lonnet::dump('slot_reservations',$cdom,$cnum, "^$slot_name\0"); foreach my $entry (keys(%consumed)) { - if ( $consumed{$entry}->{'name'} eq ($uname.'@'.$udom) ) { + if ( $consumed{$entry}->{'name'} eq ($uname.':'.$udom) ) { &Apache::lonnet::del('slot_reservations',[$entry], $cdom,$cnum); } } + my $use_slots = &Apache::lonnet::EXT("resource.0.useslots"); + &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') { @@ -546,7 +566,7 @@ sub get_slot { $r->print("

Already have a reservation: $description1

"); if ($slot_name ne $env{'form.slotname'}) { $r->print(< +
@@ -591,7 +611,7 @@ STUFF $r->print(< Failed to reserve a spot for $description.

- + @@ -601,7 +621,7 @@ STUFF

or - +

@@ -615,34 +635,80 @@ STUFF sub allowed_slot { my ($slot_name,$slot,$symb,$slots,$consumed_uniqueperiods)=@_; + #already started if ($slot->{'starttime'} < time) { # all open slot to be schedulable #return 0; } &Apache::lonxml::debug("$slot_name starttime good"); + #already ended if ($slot->{'endtime'} < time) { return 0; } &Apache::lonxml::debug("$slot_name endtime good"); + # not allowed to pick this one if (defined($slot->{'type'}) && $slot->{'type'} ne 'schedulable_student') { return 0; } &Apache::lonxml::debug("$slot_name type good"); - # not allowed for this resource - if (defined($slot->{'symb'}) - && $slot->{'symb'} ne $symb) { - return 0; - } + # reserve time not yet started if ($slot->{'startreserve'} > time) { return 0; } &Apache::lonxml::debug("$slot_name reserve good"); + my $userallowed=0; + # its for a different set of users + if (defined($slot->{'allowedsections'})) { + if (!defined($env{'request.role.sec'}) + && grep(/^No section assigned$/, + split(',',$slot->{'allowedsections'}))) { + $userallowed=1; + } + if (defined($env{'request.role.sec'}) + && grep(/^\Q$env{'request.role.sec'}\E$/, + 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"); + + # its for a different set of users + if (defined($slot->{'allowedusers'}) + && grep(/^\Q$env{'user.name'}:$env{'user.domain'}\E$/, + split(',',$slot->{'allowedusers'}))) { + $userallowed=1; + } + + if (!defined($slot->{'allowedusers'}) + && !defined($slot->{'allowedsections'})) { + $userallowed=1; + } + + &Apache::lonxml::debug("$slot_name user is $userallowed"); + return 0 if (!$userallowed); + + # not allowed for this resource + if (defined($slot->{'symb'}) + && $slot->{'symb'} ne $symb) { + return 0; + } + my $conflict = &check_for_conflict($symb,$slot_name,$slot,$slots, $consumed_uniqueperiods); if ($conflict) { @@ -693,7 +759,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}, @@ -704,9 +770,9 @@ sub show_choices { $command='get'; } } - my $escsymb=&Apache::lonnet::escape($symb); + my $escsymb=&escape($symb); $form=< +
@@ -803,14 +869,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 @@ -826,14 +892,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('
'); } @@ -854,22 +925,25 @@ sub show_table { # what to display filtering my %show_fields=&Apache::lonlocal::texthash( - 'name' => 'Slot Name', - 'description' => 'Description', - 'type' => 'Type', - 'starttime' => 'Start time', - 'endtime' => 'End Time', - 'startreserve' => 'Time students can start reserving', - 'secret' => 'Secret Word', - 'maxspace' => 'Maximum # of students', - 'ip' => 'IP or DNS restrictions', - 'symb' => 'Resource slot is restricted to.', - 'uniqueperiod' => 'Period of time slot is unique', - 'scheduled' => 'Scheduled Students', - 'proctor' => 'List of proctors'); + 'name' => 'Slot Name', + 'description' => 'Description', + 'type' => 'Type', + 'starttime' => 'Start time', + 'endtime' => 'End Time', + 'startreserve' => 'Time students can start reserving', + 'secret' => 'Secret Word', + 'maxspace' => 'Maximum # of students', + 'ip' => 'IP or DNS restrictions', + 'symb' => 'Resource slot is restricted to.', + 'allowedsections' => 'Sections slot is restricted to.', + 'allowedusers' => 'Users slot is restricted to.', + 'uniqueperiod' => 'Period of time slot is unique', + 'scheduled' => 'Scheduled Students', + 'proctor' => 'List of proctors'); my @show_order=('name','description','type','starttime','endtime', - 'startreserve','secret','maxspace','ip','symb', - 'uniqueperiod','scheduled','proctor'); + 'startreserve','secret','maxspace','ip','symb', + 'allowedsections','allowedusers','uniqueperiod', + 'scheduled','proctor'); my @show = (exists($env{'form.show'})) ? &Apache::loncommon::get_env_multiple('form.show') : keys(%show_fields); @@ -915,13 +989,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(' @@ -964,18 +1041,19 @@ 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)$/) { + if ($env{'form.order'}=~/^(type|description|endtime|startreserve|maxspace|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'}}) @@ -1018,14 +1096,14 @@ sub show_table { $consumed{$b}{name} } (keys(%consumed))) { my (undef,$id)=split("\0",$entry); - my ($uname,$udom) = split('@',$consumed{$entry}{'name'}); + my ($uname,$udom) = split(':',$consumed{$entry}{'name'}); $ids.= ''; foreach my $item (@stu_display_order) { if ($stu_display{$item}) { if ($item eq 'fullname') { $ids.=$fullname->{"$uname:$udom"}.' '; } elsif ($item eq 'username') { - $ids.="$uname\@$udom "; + $ids.="$uname:$udom "; } } } @@ -1044,7 +1122,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]); } @@ -1057,16 +1135,37 @@ sub show_table { $title=''.$title.''; } + my $allowedsections; + if (exists($show{'allowedsections'})) { + $allowedsections = + join(', ',sort(split(/\s*,\s*/, + $slots{$slot}->{'allowedsections'}))); + } + + my @allowedusers; + if (exists($show{'allowedusers'})) { + @allowedusers= map { + my ($uname,$udom)=split(/:/,$_); + my $fullname=$name_cache{$_}; + if (!defined($fullname)) { + $fullname = &Apache::loncommon::plainname($uname,$udom); + $fullname =~s/\s/ /g; + $name_cache{$_} = $fullname; + } + &Apache::loncommon::aboutmewrapper($fullname,$uname,$udom); + } (sort(split(/\s*,\s*/,$slots{$slot}->{'allowedusers'}))); + } + my $allowedusers=join(', ',@allowedusers); + my @proctors; my $rowspan=1; my $colspan=1; if (exists($show{'proctor'})) { $rowspan=2; @proctors= map { - my ($uname,$udom)=split(/@/,$_); + my ($uname,$udom)=split(/:/,$_); my $fullname=$name_cache{$_}; if (!defined($fullname)) { - &Apache::lonnet::logthis("Gettign $uname $udom"); $fullname = &Apache::loncommon::plainname($uname,$udom); $fullname =~s/\s/ /g; $name_cache{$_} = $fullname; @@ -1081,17 +1180,21 @@ sub show_table { EDITLINK my $delete=(<<"DELETELINK"); -Delete +Delete DELETELINK - my $remove_all=&remove_link($slot,'remove all'); + my $remove_all=&remove_link($slot,'remove all').'
'; if ($ids ne '') { undef($delete); } - if ($slots{$slot}{'type'} ne 'schedulable_student') { + if ($slots{$slot}{'type'} ne 'schedulable_student' + || $ids eq '') { 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(""); } @@ -1122,21 +1225,28 @@ DELETELINK if (exists($show{'symb'})) { $colspan++;$r->print("\n"); } + if (exists($show{'allowedsections'})) { + $colspan++;$r->print("\n"); + } + 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 $remove_all$edit $delete$slot$title$allowedsections$allowedusers$unique$ids
$remove_all $ids$proctors
'); + $r->print(''); } sub upload_start { @@ -1173,9 +1283,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.
@@ -1308,7 +1420,10 @@ sub csvupload_fields { ['maxspace','Maximum number of reservations'], ['symb','Resource Restriction'], ['uniqueperiod','Date range of slot exclusion'], - ['secret','Secret word proctor uses to validate']); + ['secret','Secret word proctor uses to validate'], + ['allowedsections','Sections slot is restricted to'], + ['allowedusers','Users slot is restricted to'], + ); } sub csv_upload_assign { @@ -1355,22 +1470,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('.'); @@ -1433,11 +1575,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;