[LON-CAPA-cvs] cvs: loncom /html/adm/helper newslot.helper /interface slotrequest.pm

raeburn raeburn@source.lon-capa.org
Sun, 31 Oct 2010 15:32:15 -0000


This is a MIME encoded message

--raeburn1288539135
Content-Type: text/plain

raeburn		Sun Oct 31 15:32:15 2010 EDT

  Modified files:              
    /loncom/interface	slotrequest.pm 
    /loncom/html/adm/helper	newslot.helper 
  Log:
  - For slots schedulable by student slot setting to send message(s)
    when student reserves slot or releases reservation
  - Make wording clearer on screen displayed when student wishes to
    swap reservations when uniqueperiod constraint applies. 
  
  
--raeburn1288539135
Content-Type: text/plain
Content-Disposition: attachment; filename="raeburn-20101031153215.txt"

Index: loncom/interface/slotrequest.pm
diff -u loncom/interface/slotrequest.pm:1.108 loncom/interface/slotrequest.pm:1.109
--- loncom/interface/slotrequest.pm:1.108	Sun Jun  6 02:40:30 2010
+++ loncom/interface/slotrequest.pm	Sun Oct 31 15:32:10 2010
@@ -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.109 2010/10/31 15:32:10 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -562,7 +562,11 @@
     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 @@
 	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 @@
    <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 @@
                      .&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>');
 	}
@@ -1081,6 +1093,7 @@
 	     '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',
@@ -1095,7 +1108,7 @@
         $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 = 
@@ -1207,7 +1220,7 @@
 
     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'}}) 
@@ -1244,12 +1257,15 @@
 	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);
@@ -1393,6 +1409,9 @@
 	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");
 	}
@@ -2119,6 +2138,40 @@
     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(
@@ -2289,6 +2342,7 @@
 	    ['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'],
@@ -2370,6 +2424,20 @@
 	    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}}) {
@@ -2419,6 +2487,15 @@
     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;
 
Index: loncom/html/adm/helper/newslot.helper
diff -u loncom/html/adm/helper/newslot.helper:1.26 loncom/html/adm/helper/newslot.helper:1.27
--- loncom/html/adm/helper/newslot.helper:1.26	Mon Mar 30 12:46:22 2009
+++ loncom/html/adm/helper/newslot.helper	Sun Oct 31 15:32:15 2010
@@ -149,6 +149,20 @@
 	   return undef;
         </validator>
       </date>
+      <message>
+        </p><p>Message(s) triggered by reservation change by student 
+      </message>
+    <choices variable="reservationmsg">
+      <choice computer='only_student'>Sent to student</choice>
+      <choice computer='student_and_user_notes_screen'>Sent to student and added to user notes</choice>
+      <choice computer='none'>None sent and no record in user notes</choice>
+      <defaultvalue>
+        my $default=&{$helper->{DATA}{origslot}}('reservationmsg');
+        if ($default eq 'only_student') { return $default; }
+        if ($default eq 'student_and_user_notes_screen') { return $default; }
+        return 'none';
+      </defaultvalue>
+    </choices>
     </condition>
     <condition>
       <clause>$helper->{'VARS'}{'type'} eq 'preassigned'</clause>
@@ -303,6 +317,15 @@
 	    }
 	}
 
+        if ($helper->{'VARS'}{'type'} eq 'schedulable_student') {
+            if (($helper->{'VARS'}{'reservationmsg'} eq 'only_student') ||
+               ($helper->{'VARS'}{'reservationmsg'} eq 'student_and_user_notes_screen')) {
+                $slot{'reservationmsg'} = $helper->{'VARS'}{'reservationmsg'}; 
+            } else {
+                $slot{'reservationmsg'} = 'none';
+            }
+        }
+
 	if ( $helper->{'VARS'}{'startreserve'} > 0) {
 		$slot{'startreserve'} = $helper->{'VARS'}{'startreserve'};
 	}
@@ -371,6 +394,13 @@
 	    $result.="\n".'<li> '.$labels{'startreserve'}.': '.
 		    &Apache::lonlocal::locallocaltime($slot{'startreserve'}).'</li>';
 	}
+
+        if (exists($slot{'reservationmsg'})) {
+            my %options = &Apache::slotrequest::slot_reservationmsg_options();
+            $result.="\n".'<li> '.$labels{'reservationmsg'}.': '.
+                          $options{$slot{'reservationmsg'}}.'</li>';
+        }
+
         if (exists($slot{'proctor'})) {
 	    my $proctors = $slot{'proctor'};
 	    $proctors =~ s/,/, /g;

--raeburn1288539135--