--- loncom/interface/slotrequest.pm 2009/06/30 15:03:28 1.99 +++ loncom/interface/slotrequest.pm 2010/10/31 15:32:10 1.109 @@ -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.99 2009/06/30 15:03:28 bisitz Exp $ +# $Id: slotrequest.pm,v 1.109 2010/10/31 15:32:10 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -562,7 +562,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 +633,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 +641,21 @@ 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>' - ); + $r->print('<p class="LC_error">'.&mt('Reservation currently unchanged').'</p>'. + '<p class="LC_warning">'); + if ($slot_name ne '') { + $r->print(&mt('To complete the transaction you [_1]must[_2] confirm you want the change to [_3] to be processed.' + ,'<b>','</b>','<b>'.$description2.'</b>').'<br />' + .'<input type="submit" name="change" value="'.&mt('Process change').'" /></p>' + .&mt('or').'<br /><p>'.&mt('you will continue with the reservation you already had: [_1]' + ,'<b>'.$description1.'</b>').'</p>'); + } &return_link($r); $r->print(<<STUFF); </form> STUFF } else { + $r->print('<p>'.&mt('Already have a reservation: [_1].',$description1).'</p>'); &return_link($r); } return 0; @@ -667,8 +672,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>'); } @@ -847,7 +859,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); @@ -1026,6 +1038,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); @@ -1049,7 +1062,11 @@ sub show_table { } if (!keys(%slots)) { - $r->print('<div>'.&mt('No slots have been created in this course.').'</div>'); + if ($crstype eq 'Community') { + $r->print('<div>'.&mt('No slots have been created in this community.').'</div>'); + } else { + $r->print('<div>'.&mt('No slots have been created in this course.').'</div>'); + } return; } @@ -1076,6 +1093,7 @@ sub show_table { 'starttime' => 'Start time', 'endtime' => 'End Time', 'startreserve' => 'Time students can start reserving', + 'reservationmsg' => 'Message triggered by reservation', 'secret' => 'Secret Word', 'space' => '# of students/max', 'ip' => 'IP or DNS restrictions', @@ -1085,8 +1103,12 @@ 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{'scheduled'} = &mt('Scheduled Members'); + } my @show_order=('name','description','type','starttime','endtime', - 'startreserve','secret','space','ip','symb', + 'startreserve','reservationmsg','secret','space','ip','symb', 'allowedsections','allowedusers','uniqueperiod', 'scheduled','proctor'); my @show = @@ -1160,11 +1182,11 @@ sub show_table { 6,\%stu_display_fields, \@stu_display_order).' </td> - <td valign="top">'.&Apache::loncommon::select_form($when,'when',%when_fields). + <td valign="top">'.&Apache::loncommon::select_form($when,'when',\%when_fields). '</td> <td valign="top">'.&Apache::loncommon::select_form($name_filter_type, 'name_filter_type', - %name_filter_type_fields). + \%name_filter_type_fields). '<br />'. &Apache::lonhtmlcommon::textbox('name_filter_value', $env{'form.name_filter_value'}, @@ -1198,7 +1220,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|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'}}) @@ -1235,12 +1257,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); @@ -1384,6 +1409,9 @@ LOGLINK if (exists($show{'startreserve'})) { $colspan++;$r->print("<td>$start_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"); } @@ -1429,21 +1457,23 @@ STUFF } sub manage_reservations { - my ($r,$type) = @_; + my ($r,$crstype) = @_; my $navmap = Apache::lonnavmaps::navmap->new(); $r->print('<p>' .&mt('Instructors may use a reservation system to place restrictions on when and where assignments can be worked on.') .'<br />' .&mt('One example is for management of laboratory space, which is only available at certain times, and has a limited number of seats.') - .'</p><p>' - .&mt('Your reservation status for any such assignments is listed below:') .'</p>' ); if (!defined($navmap)) { - $r->print('<div class="LC_error">'. - &mt('Unable to retrieve information about course contents'). - '</div>'); - &Apache::lonnet::logthis('Manage Reservations - could not create navmap object in '.lc($type).':'.$env{'request.course.id'}); + $r->print('<div class="LC_error">'); + 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('</div>'); + &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); @@ -1451,7 +1481,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('<table class="LC_data_table LC_tableOfContent">'."\n"); + my $slotheader = '<p>'. + &mt('Your reservation status for any such assignments is listed below:'). + '</p>'. + '<table class="LC_data_table LC_tableOfContent">'."\n"; + my $shownheader = 0; my $it=$navmap->getIterator(undef,undef,undef,1,undef,undef); while (my $resource = $it->next()) { if ($resource == $it->BEGIN_MAP()) { @@ -1546,11 +1580,19 @@ sub manage_reservations { foreach my $item (@maprows) { $rownum ++; my $bgcolor = $backgrounds[$rownum % $numcolors]; + if (!$shownheader) { + $r->print($slotheader); + $shownheader = 1; + } $r->print('<tr class="'.$bgcolor.'">'.$item.'</tr>'."\n"); } } $rownum ++; my $bgcolor = $backgrounds[$rownum % $numcolors]; + if (!$shownheader) { + $r->print($slotheader); + $shownheader = 1; + } $r->print('<tr class="'.$bgcolor.'"><td>'."\n"); for (my $i=0; $i<$depth; $i++) { $r->print('<img src="'.$location.'" alt="" />'); @@ -1585,11 +1627,19 @@ sub manage_reservations { } } } + if ($shownheader) { + $r->print('</table>'); + } if (!$reservable) { - $r->print('<span class="LC_info">'.&mt('No course items currently require a reservation to gain access.').'</span>'); + $r->print('<span class="LC_info">'); + 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('</span>'); } - $r->print('</table>'. - '<p><a href="/adm/slotrequest?command=showresv">'. + $r->print('<p><a href="/adm/slotrequest?command=showresv">'. &mt('Reservation History').'</a></p>'); } @@ -1620,12 +1670,21 @@ sub show_reservations { my $formname = 'slotlog'; my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; + my $crstype = &Apache::loncommon::course_type(); my %log=&Apache::lonnet::dump('nohist_'.$cdom.'_'.$cnum.'_slotlog',$udom,$uname); if ($env{'form.origin'} eq 'aboutme') { - $r->print('<div class="LC_fontsize_large">'. - &mt('History of student-reservable slots for: [_1]', - &Apache::loncommon::plainname($env{'form.uname'},$env{'form.udom'}, - 'firstname')).'</div>'); + $r->print('<div class="LC_fontsize_large">'); + my $name = &Apache::loncommon::plainname($env{'form.uname'},$env{'form.udom'}, + 'firstname'); + if ($crstype eq 'Community') { + $r->print(&mt('History of member-reservable slots for: [_1]', + $name)); + } else { + $r->print(&mt('History of student-reservable slots for: [_1]', + $name)); + + } + $r->print('</div>'); } $r->print('<form action="/adm/slotrequest" method="post" name="'.$formname.'">'); # set defaults @@ -1674,7 +1733,7 @@ sub show_reservations { } } my (%titles,%maptitles); - my %lt = &reservationlog_contexts(); + my %lt = &reservationlog_contexts($crstype); foreach my $id (sort { $log{$b}{'exe_time'}<=>$log{$a}{'exe_time'} } (keys(%log))) { next if (($log{$id}{'exe_time'} < $curr{'log_start_date'}) || ($log{$id}{'exe_time'} > $curr{'log_end_date'})); @@ -1736,7 +1795,7 @@ ENDSCRIPT } } else { $r->print('<span class="LC_info">' - .&mt('There are no transactions to display') + .&mt('There are no transactions to display.') .'</span>' ); } @@ -1754,6 +1813,7 @@ ENDSCRIPT sub show_reservations_log { my ($r) = @_; my $badslot; + my $crstype = &Apache::loncommon::course_type(); if ($env{'form.slotname'} eq '') { $r->print('<div class="LC_warning">'.&mt('No slot name provided').'</div>'); $badslot = 1; @@ -1764,7 +1824,13 @@ sub show_reservations_log { $badslot = 1; } elsif ($slot{type} ne 'schedulable_student') { my $description = &get_description($env{'form.slotname'},\%slot); - $r->print('<div class="LC_warning">'.&mt('Reservation history unavailable for non-student-reservable slot: [_1].',$description).'</div>'); + $r->print('<div class="LC_warning">'); + if ($crstype eq 'Community') { + $r->print(&mt('Reservation history unavailable for non-member-reservable slot: [_1].',$description)); + } else { + $r->print(&mt('Reservation history unavailable for non-student-reservable slot: [_1].',$description)); + } + $r->print('</div>'); $badslot = 1; } } @@ -1835,9 +1901,13 @@ sub show_reservations_log { my %slot=&Apache::lonnet::get_slot($env{'form.slotname'}); my $description = $slot{'description'}; - $r->print('<span class="LC_fontsize_large">'. - &mt('Reservation changes for student-reservable slot: [_1]',$description).'</span><br />'); - + $r->print('<span class="LC_fontsize_large">'); + if ($crstype eq 'Community') { + $r->print(&mt('Reservation changes for member-reservable slot: [_1]',$description)); + } else { + $r->print(&mt('Reservation changes for student-reservable slot: [_1]',$description)); + } + $r->print('</span><br />'); $r->print(&display_filter($formname,$cdom,$cnum,\%curr,$version,\@allsymbs)); my $showntablehdr = 0; my $tablehdr = &Apache::loncommon::start_data_table(). @@ -1855,7 +1925,7 @@ sub show_reservations_log { $minshown = 1 + ($curr{'page'} - 1) * $curr{'show'}; } } - my %lt = &reservationlog_contexts(); + my %lt = &reservationlog_contexts($crstype); my (%titles,%maptitles); foreach my $id (sort { $log{$b}{'exe_time'}<=>$log{$a}{'exe_time'} } (keys(%log))) { next if (($log{$id}{'exe_time'} < $curr{'log_start_date'}) || @@ -1933,7 +2003,7 @@ function chgPage(caller) { ENDSCRIPT } } else { - $r->print(&mt('There are no records to display')); + $r->print(&mt('There are no records to display.')); } $r->print('<input type="hidden" name="page" value="'.$curr{'page'}.'" />'. '<input type="hidden" name="slotname" value="'.$env{'form.slotname'}.'" />'. @@ -1975,6 +2045,7 @@ sub get_resource_title { } sub reservationlog_contexts { + my ($crstype) = @_; my %lt = &Apache::lonlocal::texthash ( any => 'Any', user => 'By student', @@ -1984,6 +2055,10 @@ sub reservationlog_contexts { release => 'Dropped reservation', usermanage => 'By student', ); + if ($crstype eq 'Community') { + $lt{'user'} = &mt('By member'); + $lt{'usermanage'} = $lt{'user'}; + } return %lt; } @@ -2004,7 +2079,8 @@ sub display_filter { &Apache::lonhtmlcommon::date_setter($formname,'log_end_date', $curr->{'log_end_date'},undef, undef,undef,undef,undef,undef,undef,$nolink); - my %lt = &reservationlog_contexts(); + my $crstype = &Apache::loncommon::course_type(); + my %lt = &reservationlog_contexts($crstype); $output .= '<td valign="top"><b>'.&mt('Window during which changes occurred:'). '</b><br /><table><tr><td>'.&mt('After:'). '</td><td>'.$startform.'</td></tr><tr><td>'.&mt('Before:').'</td><td>'. @@ -2052,36 +2128,75 @@ sub display_filter { } $output .= '<td> </td><td valign="middle"><input type="submit" value="'. &mt('Update Display').'" /></tr></table>'. - '<span class="LC_roleslog_note">'. - &mt('[_1]Note:[_2] Only changes made from servers running LON-CAPA 2.8.99.0 or later are displayed.'); + '<p class="LC_info">'. + &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].','<b>','</b>',$version); + $output .= ' '.&mt('This LON-CAPA server is version [_1]',$version); } - $output .= '</span><hr /><br />'; + $output .= '</p><hr /><br />'; 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'); + } + return '<span class="LC_info">'.$msgtitle.'</span>' + .'<ul>' + .$message_status + .$comment_status + .'</ul><hr />'; + } +} + sub upload_start { my ($r)=@_; - $r->print(&Apache::grades::checkforfile_js()); - my $result.='<table width="100%" border="0"><tr bgcolor="#E6FFFF"><td>'."\n"; - $result.=' <b>'. - &mt('Specify a file containing the slot definitions.'). - '</b></td></tr>'."\n"; - $result.='<tr bgcolor="#ffffe6"><td>'."\n"; - my $upfile_select=&Apache::loncommon::upfile_select_html(); - my $ignore=&mt('Ignore First Line'); - $result.=<<ENDUPFORM; -<form method="post" enctype="multipart/form-data" action="/adm/slotrequest" name="slotupload"> -<input type="hidden" name="command" value="csvuploadmap" /> -$upfile_select -<br /><input type="button" onClick="javascript:checkUpload(this.form);" value="Upload Data" /> -<label><input type="checkbox" name="noFirstLine" />$ignore</label> -</form> -ENDUPFORM - $result.='</td></tr></table>'."\n"; - $result.='</td></tr></table>'."\n"; - $r->print($result); + $r->print( + &Apache::grades::checkforfile_js() + .'<h3>'.&mt('Specify a file containing the slot definitions.').'</h3>' + .'<form method="post" enctype="multipart/form-data"' + .' action="/adm/slotrequest" name="slotupload">' + .'<input type="hidden" name="command" value="csvuploadmap" />' + .&Apache::lonhtmlcommon::start_pick_box() + .&Apache::lonhtmlcommon::row_title(&mt('File')) + .&Apache::loncommon::upfile_select_html() + .&Apache::lonhtmlcommon::row_closure() + .&Apache::lonhtmlcommon::row_title( + '<label for="noFirstLine">' + .&mt('Ignore First Line') + .'</label>') + .'<input type="checkbox" name="noFirstLine" id="noFirstLine" />' + .&Apache::lonhtmlcommon::row_closure(1) + .&Apache::lonhtmlcommon::end_pick_box() + .'<p>' + .'<input type="button" onclick="javascript:checkUpload(this.form);"' + .' value="'.&mt('Next').'" />' + .'</p>' + .'</form>' + ); } sub csvuploadmap_header { @@ -2103,7 +2218,7 @@ sub csvuploadmap_header { Total number of records found in file: $distotal <hr /> 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.<hr /> -<input type="button" value="Reverse Association" onClick="javascript:this.form.associate.value='Reverse Association';submit(this.form);" /> +<input type="button" value="Reverse Association" onclick="javascript:this.form.associate.value='Reverse Association';submit(this.form);" /> <label><input type="checkbox" name="noFirstLine"$checked />$ignore</label> <input type="hidden" name="associate" value="" /> <input type="hidden" name="datatoken" value="$datatoken" /> @@ -2128,7 +2243,7 @@ sub csvuploadmap_footer { </table> <input type="hidden" name="nfields" value="$i" /> <input type="hidden" name="keyfields" value="$keyfields" /> -<input type="button" onClick="javascript:verify(this.form)" value="$buttontext" /><br /> +<input type="button" onclick="javascript:verify(this.form)" value="$buttontext" /><br /> </form> ENDPICK } @@ -2227,6 +2342,7 @@ sub csvupload_fields { ['starttime','Start Time of slot'], ['endtime','End Time of slot'], ['startreserve','Reservation Start Time'], + ['reservationmsg','Message when reservation changed'], ['ip','IP or DNS restriction'], ['proctor','List of proctor ids'], ['description','Slot Description'], @@ -2308,6 +2424,20 @@ sub csv_upload_assign { 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}}) { @@ -2357,6 +2487,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;