--- loncom/interface/slotrequest.pm 2010/06/06 02:40:30 1.108
+++ loncom/interface/slotrequest.pm 2012/08/23 14:17:13 1.115
@@ -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.108 2010/06/06 02:40:30 raeburn Exp $
+# $Id: slotrequest.pm,v 1.115 2012/08/23 14:17:13 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -137,16 +137,20 @@ sub check_for_reservation {
return 'error: Unable to determine current status';
}
my @got;
- my @sorted_slots = &Apache::loncommon::sorted_slots(\@slots,\%slots);
+ my @sorted_slots = &Apache::loncommon::sorted_slots(\@slots,\%slots,'starttime');
foreach my $slot_name (@sorted_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
+ $slots{$slot_name}->{'startreserve'}." -- ".
+ $slots{$slot_name}->{'endreserve'});
+ if (($slots{$slot_name}->{'endtime'} > time) &&
+ ($slots{$slot_name}->{'startreserve'} < time) &&
+ ((!$slots{$slot_name}->{'endreserve'}) ||
+ ($slots{$slot_name}->{'endreserve'} > time))) {
+ # between start of reservation time and end of reservation time
+ # and before end of slot
if ($mode eq 'allslots') {
push(@got,$slot_name);
} else {
@@ -335,12 +339,12 @@ sub store_slot_parm {
context => $env{'form.context'},
);
- &Apache::lonnet::instructor_log('slotreservationslog',\%storehash,
- '',$env{'user.name'},$env{'user.domain'},
- $cnum,$cdom);
- &Apache::lonnet::instructor_log($cdom.'_'.$cnum.'_slotlog',\%storehash,
- 1,$env{'user.name'},$env{'user.domain'},
- $env{'user.name'},$env{'user.domain'});
+ &Apache::lonnet::write_log('slotreservationslog',\%storehash,
+ '',$env{'user.name'},$env{'user.domain'},
+ $cnum,$cdom);
+ &Apache::lonnet::write_log($cdom.'_'.$cnum.'_slotlog',\%storehash,
+ 1,$env{'user.name'},$env{'user.domain'},
+ $env{'user.name'},$env{'user.domain'});
return;
}
@@ -534,10 +538,10 @@ sub release_reservation {
action => 'release',
context => $env{'form.context'},
);
- &Apache::lonnet::instructor_log('slotreservationslog',\%storehash,
- 1,$uname,$udom,$cnum,$cdom);
- &Apache::lonnet::instructor_log($cdom.'_'.$cnum.'_slotlog',\%storehash,
- 1,$uname,$udom,$uname,$udom);
+ &Apache::lonnet::write_log('slotreservationslog',\%storehash,
+ 1,$uname,$udom,$cnum,$cdom);
+ &Apache::lonnet::write_log($cdom.'_'.$cnum.'_slotlog',\%storehash,
+ 1,$uname,$udom,$uname,$udom);
}
}
@@ -562,7 +566,11 @@ sub release_reservation {
if ($mgr eq 'F') {
$msg = &mt('Released Reservation for user: [_1]',"$uname:$udom");
} else {
- $msg = &mt('Released Reservation: [_1]',$description);
+ $msg = '<span style="font-weight: bold;">'.&mt('Released reservation: [_1]',$description).'</span><br /><br />';
+ my $person = &Apache::loncommon::plainname($env{'user.name'},$env{'user.domain'});
+ my $subject = &mt('Reservation change: [_1]',$description);
+ my $msgbody = &mt('Reservation released by [_1] for [_2].',$person,$description);
+ $msg .= &slot_change_messaging($slot{'reservationmsg'},$subject,$msgbody,'release');
}
return (1,$msg);
}
@@ -629,7 +637,6 @@ sub get_slot {
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('<p>'.&mt('Already have a reservation: [_1].',$description1).'</p>');
if ($slot_name ne $env{'form.slotname'}) {
$r->print(<<STUFF);
<form method="post" action="/adm/slotrequest">
@@ -638,19 +645,24 @@ sub get_slot {
<input type="hidden" name="releaseslot" value="$slot_name" />
<input type="hidden" name="command" value="change" />
STUFF
- $r->print('<p>'
- .&mt('You can either [_1]Change[_2] your reservation from [_3] to [_4] or'
- ,'<input type="submit" name="change" value="'
- ,'" />'
- ,'<b>'.$description1.'</b>'
- ,'<b>'.$description2.'</b>')
- .'<br /></p>'
- );
- &return_link($r);
+ $r->print('<p class="LC_error">'.&mt('Reservation currently unchanged').'</p>');
+ if ($slot_name ne '') {
+ $r->print('<p>'.&mt('To complete the transaction you [_1]must confirm[_2] you want to [_3]process the change[_4] to [_5].'
+ ,'<b>','</b>','<i>','</i>','<b>'.$description2.'</b>')
+ .'<br />'
+ .&mt('Or you can choose to [_1]make no change[_2] and continue[_2] with the reservation you already had: [_3].'
+ ,'<i>','</i>','<b>'.$description1.'</b>')
+ .'</p><p><span class="LC_nobreak">'
+ .'<input type="submit" name="change" value="'.&mt('Process the change').'" />'
+ .(' 'x3)
+ .'<input type="submit" name="nochange" value="'.&mt('Make no change').'" />'
+ .'</span></p>');
+ }
$r->print(<<STUFF);
</form>
STUFF
} else {
+ $r->print('<p>'.&mt('Already have a reservation: [_1].',$description1).'</p>');
&return_link($r);
}
return 0;
@@ -667,8 +679,15 @@ STUFF
.&mt('An error occurred while attempting to make a reservation. ([_1])',$1)
.'</span></p>');
} elsif ($reserved > -1) {
- $r->print('<p>'.&mt('Success: [_1]',$description).'</p>');
+ $r->print('<p style="font-weight: bold;">'.&mt('Successfully signed up: [_1]',$description).'</p>');
$retvalue = 1;
+ my $person = &Apache::loncommon::plainname($env{'user.name'},$env{'user.domain'});
+ my $subject = &mt('Reservation change: [_1]',$description);
+ my $msgbody = &mt('Successful reservation by [_1] for [_2].',$person,$description);
+ my $msg = &slot_change_messaging($slot{'reservationmsg'},$subject,$msgbody,'reserve');
+ if ($msg) {
+ $r->print($msg);
+ }
} elsif ($reserved < 0) {
$r->print('<p>'.&mt('Already reserved: [_1]',$description).'</p>');
}
@@ -741,6 +760,11 @@ sub allowed_slot {
if ($slot->{'startreserve'} > time) {
return 0;
}
+ # reserve time ended
+ if (($slot->{'endreserve'}) &&
+ ($slot->{'endreserve'} < time)) {
+ return 0;
+ }
&Apache::lonxml::debug("$slot_name reserve good");
my $userallowed=0;
@@ -818,7 +842,7 @@ sub show_choices {
my ($r,$symb,$formname)=@_;
my ($cnum,$cdom)=&get_course();
- my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
+ my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
my $consumed_uniqueperiods = &get_consumed_uniqueperiods(\%slots);
if (ref($consumed_uniqueperiods) eq 'HASH') {
if (&Apache::lonnet::error(%$consumed_uniqueperiods)) {
@@ -853,11 +877,12 @@ sub show_choices {
push(@available,$slot);
}
if (!@available) {
- $output = &mt('No available times.');
+ $output = '<div class="LC_info">'.&mt('No available times.');
if ($env{'form.command'} ne 'manageresv') {
$output .= ' <a href="/adm/flip?postdata=return:">'.
&mt('Return to last resource').'</a>';
}
+ $output .= '</div>';
$r->print($output);
return;
}
@@ -1081,6 +1106,8 @@ sub show_table {
'starttime' => 'Start time',
'endtime' => 'End Time',
'startreserve' => 'Time students can start reserving',
+ 'endreserve' => 'Time students can no longer reserve',
+ 'reservationmsg' => 'Message triggered by reservation',
'secret' => 'Secret Word',
'space' => '# of students/max',
'ip' => 'IP or DNS restrictions',
@@ -1092,11 +1119,12 @@ sub show_table {
'proctor' => 'List of proctors');
if ($crstype eq 'Community') {
$show_fields{'startreserve'} = &mt('Time members can start reserving');
+ $show_fields{'endreserve'} = &mt('Time members can no longer reserve');
$show_fields{'scheduled'} = &mt('Scheduled Members');
}
my @show_order=('name','description','type','starttime','endtime',
- 'startreserve','secret','space','ip','symb',
- 'allowedsections','allowedusers','uniqueperiod',
+ 'startreserve','endreserve','reservationmsg','secret','space',
+ 'ip','symb','allowedsections','allowedusers','uniqueperiod',
'scheduled','proctor');
my @show =
(exists($env{'form.show'})) ? &Apache::loncommon::get_env_multiple('form.show')
@@ -1207,7 +1235,7 @@ sub show_table {
my %name_cache;
my $slotsort = sub {
- if ($env{'form.order'}=~/^(type|description|endtime|startreserve|ip|symb|allowedsections|allowedusers)$/) {
+ if ($env{'form.order'}=~/^(type|description|endtime|startreserve|endreserve|ip|symb|allowedsections|allowedusers|reservationmsg)$/) {
if (lc($slots{$a}->{$env{'form.order'}})
ne lc($slots{$b}->{$env{'form.order'}})) {
return (lc($slots{$a}->{$env{'form.order'}})
@@ -1244,12 +1272,15 @@ sub show_table {
if ($tmp =~ /^error: /) { undef(%consumed); }
}
+ my %msgops = &slot_reservationmsg_options();
+
foreach my $slot (sort $slotsort (keys(%slots))) {
if (!&to_show($slot,$slots{$slot},$when,
$env{'form.deleted'},$name_filter)) { next; }
+ my $reservemsg;
if (defined($slots{$slot}->{'type'})
- && $slots{$slot}->{'type'} ne 'schedulable_student') {
- #next;
+ && $slots{$slot}->{'type'} eq 'schedulable_student') {
+ $reservemsg = $msgops{$slots{$slot}->{'reservationmsg'}};
}
my $description=&get_description($slot,$slots{$slot});
my ($id_count,$ids);
@@ -1286,6 +1317,8 @@ sub show_table {
&Apache::lonlocal::locallocaltime($slots{$slot}->{'endtime'}):'');
my $start_reserve=($slots{$slot}->{'startreserve'}?
&Apache::lonlocal::locallocaltime($slots{$slot}->{'startreserve'}):'');
+ my $end_reserve=($slots{$slot}->{'endreserve'}?
+ &Apache::lonlocal::locallocaltime($slots{$slot}->{'endreserve'}):'');
my $unique;
if (ref($slots{$slot}{'uniqueperiod'})) {
@@ -1393,6 +1426,12 @@ LOGLINK
if (exists($show{'startreserve'})) {
$colspan++;$r->print("<td>$start_reserve</td>\n");
}
+ if (exists($show{'endreserve'})) {
+ $colspan++;$r->print("<td>$end_reserve</td>\n");
+ }
+ if (exists($show{'reservationmsg'})) {
+ $colspan++;$r->print("<td>$reservemsg</td>\n");
+ }
if (exists($show{'secret'})) {
$colspan++;$r->print("<td>$slots{$slot}{'secret'}</td>\n");
}
@@ -1528,6 +1567,8 @@ sub manage_reservations {
} elsif ($slot_status == $resource->RESERVABLE) {
$msg=&mt('Reservation needed');
$get_choices = 1;
+ } elsif ($slot_status == $resource->RESERVABLE_LATER) {
+ $msg=&mt('Reservation needed: will be reservable later.');
} elsif ($slot_status == $resource->NOTRESERVABLE) {
$msg=&mt('Reservation needed: none available.');
} elsif ($slot_status == $resource->UNKNOWN) {
@@ -2119,6 +2160,42 @@ sub display_filter {
return $output;
}
+sub slot_change_messaging {
+ my ($setting,$subject,$msg,$action) = @_;
+ my $user = $env{'user.name'};
+ my $domain = $env{'user.domain'};
+ my ($message_status,$comment_status);
+ if ($setting eq 'only_student'
+ || $setting eq 'student_and_user_notes_screen') {
+ $message_status =
+ &Apache::lonmsg::user_normal_msg($user,$domain,$subject,$msg);
+ $message_status = '<li>'.&mt('Sent to you: [_1]',
+ $message_status).' </li>';
+ }
+ if ($setting eq 'student_and_user_notes_screen') {
+ $comment_status =
+ &Apache::lonmsg::store_instructor_comment($subject.'<br />'.
+ $msg,$user,$domain);
+ $comment_status = '<li>'.&mt('Entry added to course record (viewable by instructor): [_1]',
+ $comment_status).'</li>';
+ }
+ if ($message_status || $comment_status) {
+ my $msgtitle;
+ if ($action eq 'reserve') {
+ $msgtitle = &mt('Status of messages about saved reservation');
+ } elsif ($action eq 'release') {
+ $msgtitle = &mt('Status of messages about dropped reservation');
+ } elsif ($action eq 'nochange') {
+ $msgtitle = &mt('Status of messages about unchanged existing reservation');
+ }
+ return '<span class="LC_info">'.$msgtitle.'</span>'
+ .'<ul>'
+ .$message_status
+ .$comment_status
+ .'</ul><hr />';
+ }
+}
+
sub upload_start {
my ($r)=@_;
$r->print(
@@ -2289,6 +2366,8 @@ sub csvupload_fields {
['starttime','Start Time of slot'],
['endtime','End Time of slot'],
['startreserve','Reservation Start Time'],
+ ['endreserve','Reservation End Time'],
+ ['reservationmsg','Message when reservation changed'],
['ip','IP or DNS restriction'],
['proctor','List of proctor ids'],
['description','Slot Description'],
@@ -2370,6 +2449,30 @@ sub csv_upload_assign {
next;
}
+ if ($entries{$fields{'endreserve'}}) {
+ $slot{'endreserve'}=
+ &UnixDate($entries{$fields{'endreserve'}},"%s");
+ }
+ if (defined($slot{'endreserve'})
+ && $slot{'endreserve'} > $slot{'starttime'}) {
+ push(@errors,"$name not created -- Slot's reservation end time is after the slot's start time.");
+ next;
+ }
+
+ if ($slot{'type'} eq 'schedulable_student') {
+ if ($entries{$fields{'reservationmsg'}}) {
+ if (($entries{$fields{'reservationmsg'}} eq 'only_student') ||
+ ($entries{$fields{'reservationmsg'}} eq 'student_and_user_notes_screen')) {
+ $slot{'reservationmsg'}=$entries{$fields{'reservationmsg'}};
+ } else {
+ unless (($entries{$fields{'reservationmsg'}} eq 'none') ||
+ ($entries{$fields{'reservationmsg'}} eq '')) {
+ push(@errors,"$name -- Slot's reservationmsg setting ignored - not one of: 'only_student', 'student_and_user_notes_screen', 'none' or ''");
+ }
+ }
+ }
+ }
+
foreach my $key ('ip','proctor','description','maxspace',
'secret','symb') {
if ($entries{$fields{$key}}) {
@@ -2394,6 +2497,9 @@ sub csv_upload_assign {
$r->rflush();
$countdone++;
}
+ if ($countdone) {
+ &Apache::lonnet::devalidate_slots_cache($cname,$cdom);
+ }
$r->print('<p>'.&mt('Created [quant,_1,slot]',$countdone)."\n".'</p>');
foreach my $error (@errors) {
$r->print('<p><span class="LC_warning">'.$error.'</span></p>'."\n");
@@ -2419,6 +2525,15 @@ sub slot_command_titles {
return %titles;
}
+sub slot_reservationmsg_options {
+ my %options = &Apache::lonlocal::texthash (
+ only_student => 'Sent to student',
+ student_and_user_notes_screen => 'Sent to student and added to user notes',
+ none => 'None sent and no record in user notes',
+ );
+ return %options;
+}
+
sub handler {
my $r=shift;
@@ -2478,8 +2593,9 @@ sub handler {
if (ref($brcrum) eq 'ARRAY') {
push(@{$brcrum},{href=>"/adm/slotrequest?command=$env{'form.command'}",text=>$crumb_titles{$env{'form.command'}}});
}
-
}
+ } else {
+ $brcrum =[];
}
&start_page($r,$title,$brcrum);
@@ -2548,7 +2664,26 @@ sub handler {
} elsif ($env{'form.command'} eq 'get') {
&get_slot($r,$symb);
} elsif ($env{'form.command'} eq 'change') {
- if (&get_slot($r,$symb,$env{'form.releaseslot'},1)) {
+ if ($env{'form.nochange'}) {
+ my $slot_name = $env{'form.releaseslot'};
+ my @slots = &check_for_reservation($symb,'allslots');
+ my $msg;
+ if (($slot_name ne '') && (grep(/^\Q$slot_name\E/,@slots))) {
+ my %slot=&Apache::lonnet::get_slot($env{'form.releaseslot'});
+ my $description=&get_description($slot_name,\%slot);
+ $msg = '<span style="font-weight: bold;">'.
+ &mt('Unchanged reservation: [_1]',$description).'</span><br /><br />';
+ my $person =
+ &Apache::loncommon::plainname($env{'user.name'},$env{'user.domain'});
+ my $subject = &mt('Reservation unchanged: [_1]',$description);
+ my $msgbody = &mt('No change to existing registration by [_1] for [_2].',$person,$description);
+ $msg .= &slot_change_messaging($slot{'reservationmsg'},$subject,$msgbody,'nochange');
+ } else {
+ $msg = '<span class="LC_warning">'.&mt('Reservation no longer reported as available.').'</span>';
+ }
+ $r->print($msg);
+ &return_link($r);
+ } elsif (&get_slot($r,$symb,$env{'form.releaseslot'},1)) {
&release_slot($r,$symb,$env{'form.releaseslot'});
}
} else {