--- loncom/interface/slotrequest.pm 2009/03/27 06:47:59 1.91
+++ loncom/interface/slotrequest.pm 2011/12/18 17:15:03 1.111
@@ -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.91 2009/03/27 06:47:59 raeburn Exp $
+# $Id: slotrequest.pm,v 1.111 2011/12/18 17:15:03 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -143,10 +143,14 @@ sub check_for_reservation {
!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 {
@@ -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 = ''.&mt('Released reservation: [_1]',$description).'
';
+ 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('
'.&mt('Already have a reservation: [_1].',$description1).'
');
if ($slot_name ne $env{'form.slotname'}) {
$r->print(<
@@ -638,19 +645,24 @@ sub get_slot {
STUFF
- $r->print('
'
- .&mt('You can either [_1]Change[_2] your reservation from [_3] to [_4] or'
- ,''
- ,''.$description1.''
- ,''.$description2.'')
- .'
'
- );
- &return_link($r);
+ $r->print('
'.&mt('Reservation currently unchanged').'
');
+ if ($slot_name ne '') {
+ $r->print('
'.&mt('To complete the transaction you [_1]must confirm[_2] you want to [_3]process the change[_4] to [_5].'
+ ,'','','','',''.$description2.'')
+ .' '
+ .&mt('Or you can choose to [_1]make no change[_2] and continue[_2] with the reservation you already had: [_3].'
+ ,'','',''.$description1.'')
+ .'
'
+ .''
+ .(' 'x3)
+ .''
+ .'
');
+ }
$r->print(<
STUFF
} else {
+ $r->print('
'.&mt('Already have a reservation: [_1].',$description1).'
');
&return_link($r);
}
return 0;
@@ -667,8 +679,15 @@ STUFF
.&mt('An error occurred while attempting to make a reservation. ([_1])',$1)
.'');
} elsif ($reserved > -1) {
- $r->print('
'.&mt('Success: [_1]',$description).'
');
+ $r->print('
'.&mt('Successfully signed up: [_1]',$description).'
');
$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('
'.&mt('Already reserved: [_1]',$description).'
');
}
@@ -707,7 +726,8 @@ $lt{'or'}
STUFF
if (!$inhibit_return_link) {
- $r->print(&mt('or').'').&return_link($r);
+ $r->print(&mt('or').'');
+ &return_link($r);
} else {
$r->print('');
}
@@ -740,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;
@@ -846,7 +871,7 @@ sub show_choices {
(keys(%slots))) {
&Apache::lonxml::debug("Checking Slot $slot");
- next if (!&allowed_slot($slot,$slots{$slot},undef,\%slots,
+ next if (!&allowed_slot($slot,$slots{$slot},$symb,\%slots,
$consumed_uniqueperiods));
push(@available,$slot);
@@ -1025,6 +1050,7 @@ sub show_table {
my ($r,$mgr)=@_;
my ($cnum,$cdom)=&get_course();
+ my $crstype=&Apache::loncommon::course_type($cdom.'_'.$cnum);
my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
if ( (keys(%slots))[0] =~ /^error: 2 /) {
undef(%slots);
@@ -1048,7 +1074,11 @@ sub show_table {
}
if (!keys(%slots)) {
- $r->print('
'.&mt('No slots have been created in this course.').'
');
+ if ($crstype eq 'Community') {
+ $r->print('
'.&mt('No slots have been created in this community.').'
');
+ } else {
+ $r->print('
'.&mt('No slots have been created in this course.').'
');
+ }
return;
}
@@ -1075,6 +1105,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',
@@ -1084,9 +1116,14 @@ sub show_table {
'uniqueperiod' => 'Period of time slot is unique',
'scheduled' => 'Scheduled Students',
'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')
@@ -1159,11 +1196,11 @@ sub show_table {
6,\%stu_display_fields,
\@stu_display_order).'
-
'.&Apache::loncommon::select_form($name_filter_type,
'name_filter_type',
- %name_filter_type_fields).
+ \%name_filter_type_fields).
' '.
&Apache::lonhtmlcommon::textbox('name_filter_value',
$env{'form.name_filter_value'},
@@ -1197,7 +1234,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'}})
@@ -1234,12 +1271,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);
@@ -1276,6 +1316,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'})) {
@@ -1351,9 +1393,13 @@ LOGLINK
my $remove_all=&remove_link($slot,'remove all').' ';
- if ($ids ne '') { undef($delete); }
- if ($slots{$slot}{'type'} ne 'schedulable_student'
- || $ids eq '') {
+ if ($ids eq '') {
+ undef($remove_all);
+ } else {
+ undef($delete);
+ }
+ if ($slots{$slot}{'type'} ne 'schedulable_student') {
+ undef($showlog);
undef($remove_all);
}
@@ -1379,6 +1425,12 @@ LOGLINK
if (exists($show{'startreserve'})) {
$colspan++;$r->print("
$start_reserve
\n");
}
+ if (exists($show{'endreserve'})) {
+ $colspan++;$r->print("
$end_reserve
\n");
+ }
+ if (exists($show{'reservationmsg'})) {
+ $colspan++;$r->print("
$reservemsg
\n");
+ }
if (exists($show{'secret'})) {
$colspan++;$r->print("
$slots{$slot}{'secret'}
\n");
}
@@ -1424,14 +1476,23 @@ STUFF
}
sub manage_reservations {
- my ($r,$type) = @_;
+ my ($r,$crstype) = @_;
my $navmap = Apache::lonnavmaps::navmap->new();
- $r->print('
'.&mt('Instructors may use a reservation system to place restrictions on when and where assignments can be worked on.').' '.&mt('One example is for management of laboratory space, which is only available at certain times, and has a limited number of seats.').'
'.&mt('Your reservation status for any such assignments is listed below:').'
');
+ $r->print('
'
+ .&mt('Instructors may use a reservation system to place restrictions on when and where assignments can be worked on.')
+ .' '
+ .&mt('One example is for management of laboratory space, which is only available at certain times, and has a limited number of seats.')
+ .'
'
+ );
if (!defined($navmap)) {
- $r->print('
'.
- &mt('Unable to retrieve information about course contents').
- '
');
- &Apache::lonnet::logthis('Manage Reservations - could not create navmap object in '.lc($type).':'.$env{'request.course.id'});
+ $r->print('
');
+ if ($crstype eq 'Community') {
+ $r->print(&mt('Unable to retrieve information about community contents'));
+ } else {
+ $r->print(&mt('Unable to retrieve information about course contents'));
+ }
+ $r->print('
');
+ &Apache::lonnet::logthis('Manage Reservations - could not create navmap object in '.lc($crstype).':'.$env{'request.course.id'});
return;
}
my (%parent,%shownparent,%container,%container_title,%contents);
@@ -1439,7 +1500,11 @@ sub manage_reservations {
my @backgrounds = ("LC_odd_row","LC_even_row");
my $numcolors = scalar(@backgrounds);
my $location=&Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace_21.gif");
- $r->print('
'."\n");
+ my $slotheader = '
'.
+ &mt('Your reservation status for any such assignments is listed below:').
+ '
'.
+ '
'."\n";
+ my $shownheader = 0;
my $it=$navmap->getIterator(undef,undef,undef,1,undef,undef);
while (my $resource = $it->next()) {
if ($resource == $it->BEGIN_MAP()) {
@@ -1534,11 +1599,19 @@ sub manage_reservations {
foreach my $item (@maprows) {
$rownum ++;
my $bgcolor = $backgrounds[$rownum % $numcolors];
+ if (!$shownheader) {
+ $r->print($slotheader);
+ $shownheader = 1;
+ }
$r->print('
'."\n");
for (my $i=0; $i<$depth; $i++) {
$r->print('');
@@ -1573,11 +1646,19 @@ sub manage_reservations {
}
}
}
+ if ($shownheader) {
+ $r->print('
');
+ }
if (!$reservable) {
- $r->print(''.&mt('No course items currently require a reservation to gain access.').'');
+ $r->print('');
+ if ($crstype eq 'Community') {
+ $r->print(&mt('No community items currently require a reservation to gain access.'));
+ } else {
+ $r->print(&mt('No course items currently require a reservation to gain access.'));
+ }
+ $r->print('');
}
- $r->print('
'.
- ''.
- &mt('[_1]Note:[_2] Only changes made from servers running LON-CAPA 2.8.99.0 or later are displayed.');
+ '
'.
+ &mt('Only changes made from servers running LON-CAPA [_1] or later are displayed.'
+ ,'2.9.0');
if ($version) {
- $output .= ' '.&mt('This server is version [_3].','','',$version);
+ $output .= ' '.&mt('This LON-CAPA server is version [_1]',$version);
}
- $output .= '
';
+ $output .= ' ';
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 = '
'.&mt('Specify a file containing the slot definitions.').'
'
+ .''
+ );
}
sub csvuploadmap_header {
@@ -2066,8 +2239,8 @@ sub csvuploadmap_header {
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.
-
-
+
+
@@ -2091,7 +2264,7 @@ sub csvuploadmap_footer {
-
+
ENDPICK
}
@@ -2190,6 +2363,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'],
@@ -2271,6 +2446,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}}) {
@@ -2320,6 +2519,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;
@@ -2449,7 +2657,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 = ''.
+ &mt('Unchanged reservation: [_1]',$description).'
';
+ 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 = ''.&mt('Reservation no longer reported as available.').'';
+ }
+ $r->print($msg);
+ &return_link($r);
+ } elsif (&get_slot($r,$symb,$env{'form.releaseslot'},1)) {
&release_slot($r,$symb,$env{'form.releaseslot'});
}
} else {