--- loncom/interface/slotrequest.pm 2005/05/31 21:13:01 1.2
+++ loncom/interface/slotrequest.pm 2005/11/21 21:20:06 1.35
@@ -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.2 2005/05/31 21:13:01 albertel Exp $
+# $Id: slotrequest.pm,v 1.35 2005/11/21 21:20:06 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -34,24 +34,29 @@ use Apache::Constants qw(:common :http :
use Apache::loncommon();
use Apache::lonlocal;
use Apache::lonnet;
+use Date::Manip;
sub fail {
my ($r,$code)=@_;
if ($code eq 'not_valid') {
- $r->print(''.&mt('Unable to understand what resource you wanted to sign up for.').'
'.$env{'form.symb'});
+ $r->print(''.&mt('Unable to understand what resource you wanted to sign up for.').'
');
+ } elsif ($code eq 'not_allowed') {
+ $r->print(''.&mt('Not allowed to sign up or change reservations at this time.').'
');
+ } else {
+ $r->print(''.&mt('Failed.').'
');
}
+
$r->print(''.
&mt('Return to last resource').'
');
&end_page($r);
}
sub start_page {
- my ($r)=@_;
+ my ($r,$title)=@_;
my $html=&Apache::lonxml::xmlbegin();
- $r->print($html.''.
- &mt('Request another Worktime').' ');
- $r->print(&Apache::loncommon::bodytag('Requesting another Worktime'));
+ $r->print($html.''.&mt($title).' ');
+ $r->print(&Apache::loncommon::bodytag($title));
}
sub end_page {
@@ -104,16 +109,88 @@ sub space_available {
}
return 0;
}
-
+
+sub check_for_reservation {
+ my ($symb)=@_;
+ my $student = &Apache::lonnet::EXT("resource.0.availablestudent", $symb,
+ $env{'user.domain'}, $env{'user.name'});
+
+ my $course = &Apache::lonnet::EXT("resource.0.available", $symb,
+ $env{'user.domain'}, $env{'user.name'});
+ my @slots = (split(/:/,$student), split(/:/, $course));
+
+ &Apache::lonxml::debug(" slot list is ".join(':',@slots));
+
+ my ($cnum,$cdom)=&get_course();
+ my %slots=&Apache::lonnet::get('slots', [@slots], $cdom, $cnum);
+
+ foreach my $slot_name (@slots) {
+ next if (!defined($slots{$slot_name}) ||
+ !ref($slots{$slot_name}));
+ &Apache::lonxml::debug(time." $slot_name ".
+ $slots{$slot_name}->{'starttime'}." -- ".
+ $slots{$slot_name}->{'startreserve'});
+ if ($slots{$slot_name}->{'endtime'} > time &&
+ $slots{$slot_name}->{'startreserve'} < time) {
+ # between start of reservation times and end of slot
+ return($slot_name, $slots{$slot_name});
+ }
+ }
+ return (undef,undef);
+}
+
+sub check_for_conflict {
+ my ($symb,$new_slot_name)=@_;
+ my $student = &Apache::lonnet::EXT("resource.0.availablestudent", $symb,
+ $env{'user.domain'}, $env{'user.name'});
+ my $course = &Apache::lonnet::EXT("resource.0.available", $symb,
+ $env{'user.domain'}, $env{'user.name'});
+ my @slots = (split(/:/,$student), split(/:/, $course));
+ my ($cnum,$cdom)=&get_course();
+ my %slots=&Apache::lonnet::get('slots', [@slots], $cdom, $cnum);
+ foreach my $slot_name (@slots) {
+ next if (!defined($slots{$slot_name}) ||
+ !ref($slots{$slot_name}));
+
+ next if (!defined($slots{$slot_name}->{'uniqueperiod'}) ||
+ !ref($slots{$slot_name}->{'uniqueperiod'}));
+ my ($start,$end)=@{$slots{$slot_name}->{'uniqueperiod'}};
+ if ($start{'maxspace'};
- if (!defined($max)) { return 1; }
+ my ($cnum,$cdom)=&get_course();
+
+ my $value=&Apache::lonnet::EXT("resource.0.availablestudent",$symb,
+ $env{'user.domain'},$env{'user.name'});
+ &Apache::lonxml::debug("value is $value Remove $name from slot $env{'form.slotname'} for $title
+
+
+END_CONFIRM
+
+}
+
+sub release_slot {
+ my ($r,$symb,$slot_name,$inhibit_return_link,$mgr)=@_;
+
+ if ($slot_name eq '') { $slot_name=$env{'form.slotname'}; }
+ my ($cnum,$cdom)=&get_course();
+
+ my ($uname,$udom) = ($env{'user.name'}, $env{'user.domain'});
+ if ($mgr eq 'F'
+ && defined($env{'form.uname'}) && defined($env{'form.udom'})) {
+ ($uname,$udom) = ($env{'form.uname'}, $env{'form.udom'});
+ }
+
+ if ($mgr eq 'F'
+ && defined($env{'form.symb'})) {
+ $symb = $env{'form.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 @new_slots;
+ foreach my $exist_slot (@slots) {
+ if ($exist_slot eq $slot_name) { next; }
+ push(@new_slots,$exist_slot);
+ }
+ my $new_param = join(':',@new_slots);
+
+ # get slot reservations, check if user has one, if so remove 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) ) {
+ &Apache::lonnet::del('slot_reservations',[$entry],
+ $cdom,$cnum);
+ }
+ }
+
+ # store new parameter string
+ my $result=&Apache::lonparmset::storeparm_by_symb($symb,
+ '0_availablestudent',
+ 1, $new_param, 'string',
+ $uname,$udom);
+ my %slot=&Apache::lonnet::get_slot($slot_name);
+ my $description=&get_description($env{'form.slotname'},\%slot);
+ $r->print("Released Reservation: $description
");
+ if ($mgr eq 'F') {
+ $r->print(''.
+ &mt('Return to slot list').'
');
+ }
+ if (!$inhibit_return_link) {
+ $r->print(''.
+ &mt('Return to last resource').'
');
+ }
+ return 1;
}
+sub delete_slot {
+ my ($r)=@_;
+
+ my $slot_name = $env{'form.slotname'};
+ my %slot=&Apache::lonnet::get_slot($slot_name);
+
+ my ($cnum,$cdom)=&get_course();
+ my %consumed=&Apache::lonnet::dump('slot_reservations',$cdom,$cnum,
+ "^$slot_name\0");
+
+ if (%slot && !%consumed) {
+ $slot{'type'} = 'deleted';
+ my $ret = &Apache::lonnet::cput('slots', {$slot_name => \%slot},
+ $cdom, $cnum);
+ 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 .
");
+ }
+ } else {
+ if (%consumed) {
+ $r->print("Slot $slot_name has active reservations.
");
+ } else {
+ $r->print("Slot $slot_name does not exist.
");
+ }
+ }
+ $r->print(''.
+ &mt('Return to slot list').'
');
+ $r->print(''.
+ &mt('Return to last resource').'
');
+}
+
+sub get_slot {
+ my ($r,$symb)=@_;
+
+ my $slot_name=&check_for_conflict($symb,$env{'form.slotname'});
+ if ($slot_name) {
+ my %slot=&Apache::lonnet::get_slot($slot_name);
+ my $description1=&get_description($slot_name,\%slot);
+ %slot=&Apache::lonnet::get_slot($env{'form.slotname'});
+ my $description2=&get_description($env{'form.slotname'},\%slot);
+ $r->print("Already have a reservation: $description1
");
+ if ($slot_name ne $env{'form.slotname'}) {
+ $r->print(<
+ You can either ");
+ $r->print(<'.$description1.' to '.
+ $description2.
+ ' '.
+ &mt('Return to last resource').'
');
+ $r->print(<
+STUFF
+ } else {
+ $r->print(''.
+ &mt('Return to last resource').'
');
+ }
+ return;
+ }
+ my %slot=&Apache::lonnet::get_slot($env{'form.slotname'});
+ my $reserved=&make_reservation($env{'form.slotname'},
+ \%slot,$symb);
+ my $description=&get_description($env{'form.slotname'},\%slot);
+ if (defined($reserved)) {
+ if ($reserved > -1) {
+ $r->print("Success: $description
");
+ $r->print(''.
+ &mt('Return to last resource').'
');
+ return;
+ } elsif ($reserved < 0) {
+ $r->print("Already reserved: $description
");
+ $r->print(''.
+ &mt('Return to last resource').'
');
+ return;
+ }
+ }
+
+ my %lt=('request'=>"Availibility list",
+ 'try' =>'Try again');
+ %lt=&Apache::lonlocal::texthash(%lt);
+
+ $r->print(< Failed to reserve a spot for $description.
+
+
+?
+
+
+or
+
+
+or
+STUFF
+ $r->print(''.
+ &mt('Return to last resource').'
');
+ return;
+}
+
+sub allowed_slot {
+ my ($slot_name,$slot,$symb)=@_;
+ #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;
+ }
+ &Apache::lonxml::debug("$slot_name symb good");
+ return 1;
+}
+
+sub get_description {
+ my ($slot_name,$slot)=@_;
+ my $description=$slot->{'description'};
+ if (!defined($description)) {
+ $description=&mt('[_1] From [_2] to [_3]',$slot_name,
+ &Apache::lonlocal::locallocaltime($slot->{'starttime'}),
+ &Apache::lonlocal::locallocaltime($slot->{'endtime'}));
+ }
+ return $description;
+}
sub show_choices {
my ($r,$symb)=@_;
my ($cnum,$cdom)=&get_course();
my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
+ my $available;
$r->print('');
+ &Apache::lonxml::debug("Checking Slots");
+ my ($got_slot)=&check_for_reservation($symb);
foreach my $slot (sort
{ return $slots{$a}->{'starttime'} <=> $slots{$b}->{'starttime'} }
(keys(%slots))) {
- my $description=$slots{$slot}->{'description'};
- if (!defined($description)) {
- $description=&mt('[_1] From [_2] to [_3]',$slot,
- &Apache::lonlocal::locallocaltime($slots{$slot}->{'starttime'}),
- &Apache::lonlocal::locallocaltime($slots{$slot}->{'endtime'}));
- }
+
+ &Apache::lonxml::debug("Checking Slot $slot");
+ next if (!&allowed_slot($slot,$slots{$slot}));
+
+ $available++;
+
+ my $description=&get_description($slot,$slots{$slot});
my $form=&mt('Unavailable');
- if (&space_available($slot,$slots{$slot})) {
+ if (($slot eq $got_slot) ||
+ &space_available($slot,$slots{$slot},$symb)) {
+ my $text=&mt('Select');
+ my $command='get';
+ if ($slot eq $got_slot) {
+ $text=&mt('Free Reservation');
+ $command='release';
+ }
+ my $escsymb=&Apache::lonnet::escape($symb);
$form=<
- No available times. '.
+ &mt('Return to last resource').'
');
+}
+
+sub to_show {
+ my ($slot,$when,$deleted) = @_;
+ my $time=time;
+ my $week=60*60*24*7;
+ if ($deleted eq 'hide' && $slot->{'type'} eq 'deleted') {
+ return 0;
+ }
+ if ($when eq 'any') {
+ return 1;
+ } elsif ($when eq 'now') {
+ if ($time > $slot->{'starttime'} &&
+ $time < $slot->{'endtime'}) {
+ return 1;
+ }
+ return 0;
+ } elsif ($when eq 'nextweek') {
+ if ( ($time < $slot->{'starttime'} &&
+ ($time+$week) > $slot->{'starttime'})
+ ||
+ ($time < $slot->{'endtime'} &&
+ ($time+$week) > $slot->{'endtime'}) ) {
+ return 1;
+ }
+ return 0;
+ } elsif ($when eq 'lastweek') {
+ if ( ($time > $slot->{'starttime'} &&
+ ($time-$week) < $slot->{'starttime'})
+ ||
+ ($time > $slot->{'endtime'} &&
+ ($time-$week) < $slot->{'endtime'}) ) {
+ return 1;
+ }
+ return 0;
+ } elsif ($when eq 'willopen') {
+ if ($time < $slot->{'starttime'}) {
+ return 1;
+ }
+ return 0;
+ } elsif ($when eq 'wereopen') {
+ if ($time > $slot->{'endtime'}) {
+ return 1;
+ }
+ return 0;
+ }
+
+ return 1;
+}
+
+sub remove_link {
+ my ($slotname,$entry,$uname,$udom,$symb) = @_;
+
+ $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);
+
+ my $remove= &mt('Remove');
+
+ return <<"END_LINK";
+ ($remove)
+END_LINK
+
+}
+
+sub show_table {
+ my ($r,$mgr)=@_;
+
+ my ($cnum,$cdom)=&get_course();
+ my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
+ if ( (keys(%slots))[0] =~ /^error: 2 /) {
+ undef(%slots);
+ }
+ my $available;
+ if ($mgr eq 'F') {
+ $r->print('');
+ $r->print('');
+ $r->print('');
+ $r->print('
');
+ }
+
+ my %Saveable_Parameters = ('show' => 'array',
+ 'when' => 'scalar',
+ 'order' => 'scalar',
+ 'deleted' => 'scalar',
+ );
+ &Apache::loncommon::store_course_settings('slotrequest',\%Saveable_Parameters);
+ &Apache::loncommon::restore_course_settings('slotrequest',\%Saveable_Parameters);
+
+ 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' => 'Maxium # of students',
+ 'ip' => 'IP or DNS restrictions',
+ 'symb' => 'Resource slot is restricted to.',
+ 'uniqueperiod' => 'Period of time slot is unique',
+ 'proctor' => 'List of proctors');
+ my @show_order=('name','description','type','starttime','endtime',
+ 'startreserve','secret','maxspace','ip','symb',
+ 'uniqueperiod','proctor');
+ my @show =
+ (exists($env{'form.show'})) ? &Apache::loncommon::get_env_multiple('form.show')
+ : keys(%show_fields);
+ my %show = map { $_ => 1 } (@show);
+
+ my %when_fields=&Apache::lonlocal::texthash(
+ 'now' => 'Open now',
+ 'nextweek' => 'Open within the next week',
+ 'lastweek' => 'Were open last week',
+ 'willopen' => 'Will open later',
+ 'wereopen' => 'Were open',
+ 'any' => 'Anytime',
+ );
+ my @when_order=('any','now','nextweek','lastweek','willopen','wereopen');
+ $when_fields{'select_form_order'} = \@when_order;
+ my $when = (exists($env{'form.when'})) ? $env{'form.when'}
+ : 'now';
+
+ my $hide_radio =
+ &Apache::lonhtmlcommon::radio('deleted',$env{'form.deleted'},'hide');
+ my $show_radio =
+ &Apache::lonhtmlcommon::radio('deleted',$env{'form.deleted'},'show');
+
+ $r->print('
+ENDPICK
+}
+
+sub csvupload_javascript_reverse_associate {
+ my $error1=&mt('You need to specify the name, starttime, endtime and a type');
+ return(<[0].','; }
+ chop($keyfields);
+ } else {
+ unshift(@fields,['none','']);
+ $i=&Apache::loncommon::csv_samples_select_table($r,\@records,
+ \@fields);
+ my %sone=&Apache::loncommon::record_sep($records[0]);
+ $keyfields=join(',',sort(keys(%sone)));
+ }
+ }
+ &csvuploadmap_footer($r,$i,$keyfields);
+
+ return '';
+}
+
+sub csvupload_fields {
+ return (['name','Slot name'],
+ ['type','Type of slot'],
+ ['starttime','Start Time of slot'],
+ ['endtime','End Time of slot'],
+ ['startreserve','Reservation Start Time'],
+ ['ip','IP or DNS restriction'],
+ ['proctor','List of proctor ids'],
+ ['description','Slot Description'],
+ ['maxspace','Maximum number of reservations'],
+ ['symb','Resource Restriction'],
+ ['uniqueperiod','Date range of slot exclusion'],
+ ['secret','Secret word proctor uses to validate']);
+}
+
+sub csv_upload_assign {
+ my ($r,$mgr)= @_;
+ &Apache::loncommon::load_tmp_file($r);
+ my @slotdata = &Apache::loncommon::upfile_record_sep();
+ if ($env{'form.noFirstLine'}) { shift(@slotdata); }
+ my %fields=&Apache::grades::get_fields();
+ $r->print('Creating Slots ');
+ my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
+ my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
+ my $countdone=0;
+ my @errors;
+ foreach my $slot (@slotdata) {
+ my %slot;
+ my %entries=&Apache::loncommon::record_sep($slot);
+ my $domain;
+ my $name=$entries{$fields{'name'}};
+ if ($name=~/^\s*$/) {
+ push(@errors,"Did not create slot with no name");
+ next;
+ }
+ if ($name=~/\s/) {
+ push(@errors,"$name not created -- Name must not contain spaces");
+ next;
+ }
+ if ($name=~/\W/) {
+ push(@errors,"$name not created -- Name must contain only letters, numbers and _");
+ next;
+ }
+ if ($entries{$fields{'type'}}) {
+ $slot{'type'}=$entries{$fields{'type'}};
+ } else {
+ $slot{'type'}='preassigned';
+ }
+ if ($slot{'type'} ne 'preassigned' &&
+ $slot{'type'} ne 'schedulable_student') {
+ push(@errors,"$name not created -- invalid type ($slot{'type'}) must be either preassigned or schedulable_student");
+ next;
+ }
+ if ($entries{$fields{'starttime'}}) {
+ $slot{'starttime'}=&UnixDate($entries{$fields{'starttime'}},"%s");
+ }
+ if ($entries{$fields{'endtime'}}) {
+ $slot{'endtime'}=&UnixDate($entries{$fields{'endtime'}},"%s");
+ }
+ if ($entries{$fields{'startreserve'}}) {
+ $slot{'startreserve'}=
+ &UnixDate($entries{$fields{'startreserve'}},"%s");
+ }
+ 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;
+ }
+
+ &Apache::lonnet::cput('slots',{$name=>\%slot},$cdom,$cname);
+ $r->print('.');
+ $r->rflush();
+ $countdone++;
+ }
+ $r->print("Created $countdone slots\n
");
+ foreach my $error (@errors) {
+ $r->print("$error\n
");
+ }
+ &show_table($r,$mgr);
+ return '';
+}
+
sub handler {
my $r=shift;
- &start_page($r);
- my $symb=&Apache::lonnet::unescape($env{'form.symb'});
- my (undef,undef,$res)=&Apache::lonnet::decode_symb($symb);
- if ($res !~ /\.task$/) {
- &fail($r,'not_valid');
+ &Apache::loncommon::content_type($r,'text/html');
+ &Apache::loncommon::no_cache($r);
+ if ($r->header_only()) {
+ $r->send_http_header();
return OK;
}
+
+ &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'});
- if ($env{'form.requestattempt'}) {
- &show_choices($r,$symb);
+ my $vgr=&Apache::lonnet::allowed('vgr',$env{'request.course.id'});
+ my $mgr=&Apache::lonnet::allowed('mgr',$env{'request.course.id'});
+ my $title='Requesting Another Worktime';
+ if ($env{'form.command'} =~ /^(showslots|uploadstart|csvuploadmap|csvuploadassign)$/ && $vgr eq 'F') {
+ $title = 'Managing Slots';
}
+ &start_page($r,$title);
+ if ($env{'form.command'} eq 'showslots' && $vgr eq 'F') {
+ &show_table($r,$mgr);
+ } elsif ($env{'form.command'} eq 'remove_registration' && $mgr eq 'F') {
+ &remove_registration($r);
+ } elsif ($env{'form.command'} eq 'release' && $mgr eq 'F') {
+ &release_slot($r,undef,undef,undef,$mgr);
+ } elsif ($env{'form.command'} eq 'delete' && $mgr eq 'F') {
+ &delete_slot($r);
+ } elsif ($env{'form.command'} eq 'uploadstart' && $mgr eq 'F') {
+ &upload_start($r);
+ } elsif ($env{'form.command'} eq 'csvuploadmap' && $mgr eq 'F') {
+ &csv_upload_map($r);
+ } elsif ($env{'form.command'} eq 'csvuploadassign' && $mgr eq 'F') {
+ if ($env{'form.associate'} ne 'Reverse Association') {
+ &csv_upload_assign($r,$mgr);
+ } else {
+ if ( $env{'form.upfile_associate'} ne 'reverse' ) {
+ $env{'form.upfile_associate'} = 'reverse';
+ } else {
+ $env{'form.upfile_associate'} = 'forward';
+ }
+ &csv_upload_map($r);
+ }
+ } else {
+ my $symb=&Apache::lonnet::unescape($env{'form.symb'});
+ my (undef,undef,$res)=&Apache::lonnet::decode_symb($symb);
+ if ($res !~ /\.task$/) {
+ &fail($r,'not_valid');
+ return OK;
+ }
+ $env{'request.symb'}=$symb;
+ my ($status) = &Apache::lonhomework::check_task_access('0');
+ if ($status eq 'CAN_ANSWER' ||
+ $status eq 'NEEDS_CHECKIN' ||
+ $status eq 'WAITING_FOR_GRADE') {
+ &fail($r,'not_allowed');
+ return OK;
+ }
+ if ($env{'form.requestattempt'}) {
+ &show_choices($r,$symb);
+ } elsif ($env{'form.command'} eq 'release') {
+ &release_slot($r,$symb);
+ } elsif ($env{'form.command'} eq 'get') {
+ &get_slot($r,$symb);
+ } elsif ($env{'form.command'} eq 'change') {
+ &release_slot($r,$symb,$env{'form.releaseslot'},1);
+ &get_slot($r,$symb);
+ } else {
+ $r->print("Unknown command: ".$env{'form.command'}."
");
+ }
+ }
&end_page($r);
return OK;
}
+
+1;
+__END__