--- loncom/interface/lonmsgdisplay.pm	2007/01/17 18:05:57	1.64
+++ loncom/interface/lonmsgdisplay.pm	2007/05/02 01:33:49	1.72
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Routines for messaging display
 #
-# $Id: lonmsgdisplay.pm,v 1.64 2007/01/17 18:05:57 raeburn Exp $
+# $Id: lonmsgdisplay.pm,v 1.72 2007/05/02 01:33:49 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -33,12 +33,13 @@ package Apache::lonmsgdisplay;
 
 =head1 NAME
 
-Apache::lonmsg: supports internal messaging
+Apache::lonmsgdisplay: supports internal messaging
 
 =head1 SYNOPSIS
 
-lonmsg provides routines for sending messages, receiving messages, and
-a handler to allow users to read, send, and delete messages.
+lonmsgdisplay provides a handler to allow users to read, send, 
+and delete messages, and to create and delete message folders,
+and to move messages between folders.
 
 =head1 OVERVIEW
 
@@ -93,25 +94,6 @@ addresses on their B<PREF> screen, but g
 are much more useful than traditional email can be made to be, even
 with HTML support.
 
-Right now, this document will cover just how to send a message, since
-it is likely you will not need to programmatically read messages,
-since lonmsg already implements that functionality.
-
-The routines used to package messages and unpackage messages are not
-only used by lonmsg when creating/extracting messages for LON-CAPA's
-internal messaging system, but also by lonnotify.pm which is available
-for use by Domain Coordinators to broadcast standard e-mail to specified
-users in their domain.  The XML packaging used in the two cases is very
-similar.  The differences are the use of <recuser>$uname</recuser> and 
-<recdomain>$udom</recdomain> in stored internal messages, compared 
-with <recipient username="$uname:$udom">$email</recipient> in stored
-Domain Coordinator e-mail for the storage of information about 
-recipients of the message/e-mail.
-
-=head1 FUNCTIONS
-
-=over 4
-
 =cut
 
 use strict;
@@ -119,6 +101,7 @@ use Apache::lonnet;
 use HTML::TokeParser();
 use Apache::Constants qw(:common);
 use Apache::loncommon();
+use Apache::lonhtmlcommon();
 use Apache::lontexconvert();
 use HTML::Entities();
 use Apache::lonlocal;
@@ -980,6 +963,10 @@ ENDDISHEADER
         } else { 
             $r->print('<h2>'.&mt('There are no '.lc($statushash{$msgstatus}).' messages in this folder.').'</h2>');
         }
+        if ($numblocked > 0) {
+            $r->print(&blocked_in_folder($numblocked,$startblock,$endblock,
+                                         \%setters));
+        }
 	return;
     }
     my $interdis = $env{'form.interdis'};
@@ -1050,16 +1037,23 @@ ENDDISHEADER
 	    }
 	    my ($dis_name,$dis_domain) = ($fromname,$fromdomain);
 	    if ($folder eq 'sent') {
-		if (defined($recv_name) && !defined($recv_domain)) {
-		    $dis_name   = join('<br />',@{$recv_name});
-		    $dis_domain = join('<br />',@{$recv_domain});
+                if (defined($recv_name) && defined($recv_domain)) {
+		    if (ref($recv_name) eq 'ARRAY' && 
+                        ref($recv_domain) eq 'ARRAY') {
+		        $dis_name   = join('<br />',@{$recv_name});
+		        $dis_domain = join('<br />',@{$recv_domain});
+                    }
 		} else {
 		    my $msg_id  = &unescape($origID);
 		    my %message = &Apache::lonnet::get('nohist_email'.$suffix,
 						       [$msg_id]);
 		    my %content = &Apache::lonmsg::unpackagemsg($message{$msg_id});
-		    $dis_name   = join('<br />',@{$content{'recuser'}});
-		    $dis_domain = join('<br />',@{$content{'recdomain'}});
+                    if (ref($content{'recuser'}) eq 'ARRAY') {
+		        $dis_name   = join('<br />',@{$content{'recuser'}});
+                    }
+                    if (ref($content{'recdomain'}) eq 'ARRAY') {
+		        $dis_domain = join('<br />',@{$content{'recdomain'}});
+                    }
 		}
 	    }
             my $localsenttime = &Apache::lonlocal::locallocaltime($sendtime);
@@ -1136,15 +1130,22 @@ ENDDISHEADER
     my $postedstartdis=$startdis+1;
     $r->print('<input type="hidden" name="folder" value="'.$folder.'" /><input type="hidden" name="startdis" value="'.$postedstartdis.'" /><input type="hidden" name="interdis" value="'.$env{'form.interdis'}.'" /><input type="hidden" name="msgstatus" value="'.$msgstatus.'" ><input type="hidden" name="markedaction" value="" /></form>');
     if ($numblocked > 0) {
-        my $beginblock = &Apache::lonlocal::locallocaltime($startblock);
-        my $finishblock = &Apache::lonlocal::locallocaltime($endblock);
-        $r->print('<br /><br />'.
-                  &mt('[quant,_1,message is, messages are] not viewable because display of LON-CAPA messages sent to you by other students between [_2] and [_3] is currently being blocked because of online exams.',$numblocked,$beginblock,$finishblock));
-        $r->print(&Apache::loncommon::build_block_table($startblock,$endblock,
-                                                        \%setters));
+        $r->print(&blocked_in_folder($numblocked,$startblock,$endblock,
+                                     \%setters));
     }
 }
 
+sub blocked_in_folder {
+    my ($numblocked,$startblock,$endblock,$setters) = @_;
+    my $beginblock = &Apache::lonlocal::locallocaltime($startblock);
+    my $finishblock = &Apache::lonlocal::locallocaltime($endblock);
+    my $output = '<br /><br />'.
+                  &mt('[quant,_1,message is, messages are] not viewable because display of LON-CAPA messages sent to you by other students between [_2] and [_3] is currently being blocked because of online exams.',$numblocked,$beginblock,$finishblock);
+    $output .= &Apache::loncommon::build_block_table($startblock,$endblock,
+                                                     $setters);
+    return $output;
+}
+
 # ============================================================== Compose output
 
 sub compout {
@@ -1185,7 +1186,13 @@ sub compout {
           text=>"Display All Messages"});
         &printheader($r,'/adm/email?compose=multiforward',
              'Forwarding Multiple Messages');
-        $r->print(&mt('Each of the <b>[quant,_1,message]</b> you checked will be forwarded to the recipient(s) you select below.',$multiforward).'<br />');
+        if ($multiforward > 1) {
+            $r->print(&mt('Each of the <b>[quant,_1,message]</b> you checked
+will be forwarded to the recipient(s) you select below.',$multiforward).'<br />');
+        } else {
+            $r->print(&mt('The message you checked will be forwarded to the recipient(s) you select below.').'<br />');
+        }
+
     } else {
 	&printheader($r,'/adm/email?compose=upload',
 	     'Distribute from Uploaded File');
@@ -1221,7 +1228,19 @@ sub compout {
 &mt('Send copy to permanent email address (if known)').'</label></p>'.
 '<p><label><input type="checkbox" name="rsspost" /> '.
 		  &mt('Include in course RSS newsfeed').'</label></p>';
-     }
+    }
+    if ($broadcast ne 'group') {
+        if (&Apache::lonnet::allowed('dff',$env{'request.course.id'}) ||
+            &Apache::lonnet::allowed('dff',$env{'request.course.id'}.
+                                     '/'.$env{'request.course.sec'})) {
+
+            $dispcrit.='<p><label>'.
+                       '<input type="checkbox" name="courserecord" value="1" /> '.
+                       &mt("Include in course's 'User records' for recipient(s)").
+                       '</label></p>';
+        }
+    }
+
     my %message;
     my %content;
     my $defdom=$env{'user.domain'};
@@ -1254,7 +1273,7 @@ sub compout {
 	if ($content{'baseurl'}) {
 	    $disbase='<input type="hidden" name="baseurl" value="'.&escape($content{'baseurl'}).'" />';
 	    if ($env{'user.adv'}) {
-		$disbase.='<label><input type="checkbox" name="storebasecomment" />'.&mt('Store message for re-use').
+		$disbase.='<label><input type="checkbox" name="storebasecomment" />'.&mt('Save message for re-use').
 		    '</label> <a href="/adm/email?showcommentbaseurl='.
 		    &escape($content{'baseurl'}).'" target="comments">'.
 		    &mt('Show re-usable messages').'</a><br />';
@@ -1506,7 +1525,20 @@ sub disfacetoface {
                     '<b>'.&mt('Subject').': '.$content{'subject'}.'</b><br />'.
                     $content{'message'};
                 }
-            }    
+            }
+        } elsif ($content{'subject'}=~/^Archive/) {
+            $result.='<h3>'.&mt('Archived Message').'</h3>';
+            if (defined($content{'coursemsgid'})) {
+                my $crsmsgid = &escape($content{'coursemsgid'});
+                my $archive_message = &general_message($crsmsgid);
+                $content{'message'} = '<b>'.&mt('Subject').': '.$content{'message'}.'</b><br />'.$archive_message;
+            } else {
+                %content=&Apache::lonmsg::unpackagemsg($content{'message'});
+                $content{'message'} =
+                '<b>'.&mt('Subject').': '.$content{'subject'}.'</b><br
+'.
+                $content{'message'};
+            }
         } else {
             $result.='<h3>'.&mt('Critical Message').'</h3>';
             if (defined($content{'coursemsgid'})) {
@@ -1569,7 +1601,7 @@ sub facetoface {
                                         : 'faculty and staff';
     &printheader($r,
 		 '/adm/email?recordftf=query',
-		 "User Notes, Face-to-Face, Critical Messages, Broadcast Messages");
+		 "User Notes, Face-to-Face, Critical Messages, Broadcast Messages, Archived Messages");
 # from query string
 
     if ($env{'form.recname'}) { $env{'form.recuname'}=$env{'form.recname'}; }
@@ -1584,7 +1616,7 @@ sub facetoface {
 	('stdselect','recuname','recdomain');
     my %lt=&Apache::lonlocal::texthash('user' => 'Username',
 				       'dom' => 'Domain',
-				       'head' => "User Notes, Records of Face-To-Face Discussions, Critical Messages, and Broadcast Messages in $crstype",
+				       'head' => "User Notes, Records of Face-To-Face Discussions, Critical Messages, Broadcast Messages and Archived Messages in $crstype",
 				       'subm' => 'Retrieve discussion and message records',
 				       'newr' => 'New Record (record is visible to '.lc($crstype).' '.$leaders.')',
 				       'post' => 'Post this Record');
@@ -1648,8 +1680,8 @@ sub examblock {
             'cbds' => 'Communication blocking during scheduled exams',
             'desc' => "You can use communication blocking to prevent $usertype enrolled in this course from displaying LON-CAPA messages sent by other $usertype during an online exam. As blocking of communication could potentially interrupt legitimate communication between $usertype who are also both enrolled in a different LON-CAPA course, please be careful that you select the correct start and end times for your scheduled exam when setting or modifying these parameters.",
              'mecb' => 'Modify existing communication blocking periods',
-             'ncbc' => 'No communication blocks currently stored',
-             'stor' => 'Store',
+             'ncbc' => 'No communication blocks currently saved',
+             'stor' => 'Save',
     );
 
     my %ltext = &Apache::lonlocal::texthash(
@@ -2028,6 +2060,7 @@ sub displaymessage {
     if (defined($content{'baseurl'})) {
         $baseurl = &Apache::lonenc::check_encrypt($content{'baseurl'});
     }
+    $r->print(&Apache::loncommon::student_image_tag($content{'senderdomain'},$content{'sendername'}));
     $r->print('<br /><b>'.&mt('Subject').':</b> '.$content{'subject'}.
 	      ($folder ne 'sent'?'<br /><b>'.&mt('From').':</b> '.
 	      &Apache::loncommon::aboutmewrapper(
@@ -2175,10 +2208,10 @@ sub storedcommentlisting {
     my ($r)=@_;
     my %msgs=&Apache::lonnet::dump('nohist_stored_comments',undef,undef,
        '^'.&escape(&escape($env{'form.showcommentbaseurl'})));
-    $r->print(&Apache::loncommon::start_page('Stored Comment Listing',undef,
+    $r->print(&Apache::loncommon::start_page('Saved Comment Listing',undef,
 					     {'onlybody' => 1}));
     if ((keys %msgs)[0]=~/^error\:/) {
-	$r->print(&mt('No stored comments yet.'));
+	$r->print(&mt('No saved comments yet.'));
     } else {
 	my $found=0;
 	foreach my $key (sort(keys(%msgs))) {
@@ -2186,7 +2219,7 @@ sub storedcommentlisting {
 	    $found=1;
 	}
 	unless ($found) {
-	    $r->print(&mt('No stored comments yet for this resource.'));
+	    $r->print(&mt('No saved comments yet for this resource.'));
 	}
     }
 }
@@ -2197,8 +2230,9 @@ sub sendoffmail {
     my ($r,$folder)=@_;
     my $suffix=&Apache::lonmsg::foldersuffix($folder);
     my $sendstatus='';
-    my %specialmsg_status;
-    my $numspecial = 0;
+    my %msg_status;
+    my $numsent = 0;
+    my $nosentstore = 1;
     my ($cdom,$cnum,$group);
     if (exists($env{'form.group'})) {
         $group = $env{'form.group'};
@@ -2255,6 +2289,7 @@ sub sendoffmail {
 	 	}
 	    }
 	} elsif ($env{'form.sendmode'} eq 'upload') {
+            $nosentstore = 0;
 	    foreach my $line (split(/[\n\r\f]+/,$env{'form.upfile'})) {
                 my ($rec,$txt) = ($line =~ /^([^:]+:[^:]+):(.*)$/);
 		if ($txt) {
@@ -2269,7 +2304,7 @@ sub sendoffmail {
 	    }
 	}
 	if ($env{'form.additionalrec'}) {
-	    foreach my $rec (split(/\,/,$env{'form.additionalrec'})) {
+	    foreach my $rec (split(/\s*,\s*/,$env{'form.additionalrec'})) {
 		my ($auname,$audom)=split(/:/,$rec);
 		if (($auname ne "") && ($audom ne "")) {
 		    $toaddr{$auname.':'.$audom}='';
@@ -2292,7 +2327,8 @@ sub sendoffmail {
         } else {
             $savemsg=&Apache::lonfeedback::clear_out_html($env{'form.message'});
         }
-	
+        my @recusers;
+        my @recudoms;
 	foreach my $address (sort(keys(%toaddr))) {
 	    my ($recuname,$recdomain)=split(/\:/,$address);
             my $msgtxt = $savemsg;
@@ -2306,7 +2342,8 @@ sub sendoffmail {
 						   $msgsubj,$msgtxt,
 						   $env{'form.sendbck'},
 						   $env{'form.permanent'},
-						   \$sentmessage{$address});
+						   \$sentmessage{$address},
+                                                   $nosentstore);
 	    } else {
 		$r->print(&mt('Sending').' '.$recuname.':'.$recdomain.': ');
 		@thismsg=
@@ -2315,95 +2352,93 @@ sub sendoffmail {
 						     $content{'citation'},
 						     undef,undef,
 						     $env{'form.permanent'},
-						     \$sentmessage{$address});
-            }
-	    if (($env{'request.course.id'}) && (($msgtype eq 'critical') || 
-                                         ($env{'form.sendmode'} eq 'group'))) {
-	        $specialmsg_status{$recuname.':'.$recdomain} =
-		    join(' ',@thismsg);
-		foreach my $result (@thismsg) {
-		    if ($result eq 'ok' || $result eq 'con_delayed') {
-			$numspecial++;
-		    }
-		}
+						     \$sentmessage{$address},
+                                                     undef,undef,undef,
+                                                     $nosentstore);
+            }
+	    $msg_status{$recuname.':'.$recdomain}=join(' ',@thismsg);
+	    if ($msg_status{$recuname.':'.$recdomain} =~ /(ok|con_delayed)/) {  
+	        $numsent++;
+                push(@recusers,$recuname);
+                push(@recudoms,$recdomain);
 	    }
 	    $sendstatus.=' '.join(' ',@thismsg);
 	}
-        if (($env{'request.course.id'}) && (($env{'form.sendmode'} eq 'group')
-                                              || ($msgtype eq 'critical'))) {
-            my $subj_prefix;
-            if ($msgtype eq 'critical') {
-                $subj_prefix = 'Critical.';
-            } else {
-                $subj_prefix = 'Broadcast.';
-            }
-            my ($specialmsgid,$specialresult);
-            my $course_str = &escape('['.$cnum.':'.$cdom.']');
+        my $subj_prefix;
+        if ($numsent > 0) {
+            if (($env{'request.course.id'}) && 
+                (($env{'form.sendmode'} eq 'group') ||
+                 ($env{'form.courserecord'}) ||
+                 ($msgtype eq 'critical'))) {
+                if ($msgtype eq 'critical') {
+                    $subj_prefix = 'Critical.';
+                } elsif ($env{'form.sendmode'} eq 'group') {
+                    $subj_prefix = 'Broadcast.';
+                } else {
+                    $subj_prefix = 'Archive';
+                }
+                my ($specialmsgid,$specialresult);
+                my $course_str = &escape('['.$cnum.':'.$cdom.']');
 
-            if ($numspecial) {
-                $specialresult = &Apache::lonmsg::user_normal_msg_raw($cnum,$cdom,$subj_prefix.
-                    ' '.$course_str,$savemsg,undef,undef,undef,
-                    undef,undef,\$specialmsgid);
+                $specialresult = 
+                    &Apache::lonmsg::user_normal_msg_raw($cnum,$cdom,
+                        $subj_prefix.' '.$course_str,$savemsg,undef,undef,
+                        undef,undef,undef,\$specialmsgid,undef,undef,undef,
+                        undef,undef,1);
                 $specialmsgid = &unescape($specialmsgid);
-            }
-            if ($specialresult eq 'ok') {
-                my $record_sent;
-                my @recusers;
-                my @recudoms;
-                my ($stamp,$crssubj,$msgname,$msgdom,$msgcount,$context,$pid) =
-		    split(/\:/,&unescape($specialmsgid));
-
-                foreach my $recipient (sort(keys(%toaddr))) {
-                    if ($specialmsg_status{$recipient} eq 'ok') {
-                        my $usersubj = $subj_prefix.'['.$recipient.']';
-                        my $usermsgid = 
-			    &Apache::lonmsg::buildmsgid($stamp,$usersubj,
-							$msgname,$msgdom,
-							$msgcount,$context,
-							$pid);
-                        &Apache::lonmsg::user_normal_msg_raw($cnum,$cdom,$subj_prefix.
-                                             ' ['.$recipient.']',$msgsubj,undef,
-                        undef,undef,undef,$usermsgid,undef,undef,$specialmsgid);
-                        my ($uname,$udom) = split(/:/,$recipient);
-                        push(@recusers,$uname);
-                        push(@recudoms,$udom);
+                if ($specialresult eq 'ok') {
+                    my ($stamp,$crssubj,$msgname,$msgdom,$msgcount,$context,$pid) =
+		        split(/\:/,&unescape($specialmsgid));
+
+                    foreach my $recipient (sort(keys(%toaddr))) {
+                        if ($msg_status{$recipient} =~ /\s*(ok|con_delayed)\s*/) {
+                            my $usersubj = $subj_prefix.'['.$recipient.']';
+                            my $usermsgid = 
+			        &Apache::lonmsg::buildmsgid($stamp,$usersubj,
+							    $msgname,$msgdom,
+							    $msgcount,$context,
+							    $pid);
+                            &Apache::lonmsg::user_normal_msg_raw($cnum,$cdom,
+                                $subj_prefix.' ['.$recipient.']',$msgsubj,
+                                undef,undef,undef,undef,$usermsgid,undef,
+                                undef,$specialmsgid,undef,undef,undef,1);
+                        }
                     }
-                }
-                if (@recusers) {
-                    my $specialmessage;
-                    my $sentsubj = 
-			$subj_prefix.' ('.$numspecial.' sent) '.$msgsubj;
-                    $sentsubj = &HTML::Entities::encode($sentsubj,'<>&"');
-                    my $sentmsgid = 
-			&Apache::lonmsg::buildmsgid($stamp,$sentsubj,$msgname,
-						    $msgdom,$msgcount,$context,
-						    $pid);
-                    ($specialmsgid,$specialmessage) = &Apache::lonmsg::packagemsg($msgsubj,$savemsg,
-                            undef,undef,undef,\@recusers,\@recudoms,$sentmsgid);
-                    $record_sent = &Apache::lonmsg::store_sent_mail($specialmsgid,$specialmessage);
+                    if (($env{'form.sendmode'} ne 'upload') && (@recusers > 0)) {
+                        &Apache::lonmsg::process_sent_mail($msgsubj,
+                           $subj_prefix,$numsent,$stamp,$msgname,$msgdom,
+                           $msgcount,$context,$pid,$savemsg,\@recusers,
+                           \@recudoms);
+                    }
+                } else {
+                    &Apache::lonnet::logthis('Failed to create record of critical, broadcast or archived message in '.$env{'course.'.$env{'request.course.id'}.'.num'}.' at '.$env{'course.'.$env{'request.course.id'}.'.domain'}.' - no msgid generated');
                 }
             } else {
-                &Apache::lonnet::logthis('Failed to create record of critical message or broadcast in '.$env{'course.'.$env{'request.course.id'}.'.num'}.' at '.$env{'course.'.$env{'request.course.id'}.'.domain'}.' - no msgid generated');
+                my $stamp = time;
+                my $msgcount = &Apache::lonmsg::get_uniq();
+                my $context = &Apache::lonmsg::get_course_context();
+                &Apache::lonmsg::process_sent_mail($msgsubj,$subj_prefix,
+                       $numsent,$stamp,$env{'user.name'},
+                       $env{'user.domain'},$msgcount,$context,
+                       $$,$savemsg,\@recusers,\@recudoms);
             }
         }
-    } else {
-	&printheader($r,'','No messages sent.'); 
-    }
-    if (!$env{'form.multiforward'}) { 
-        if ($sendstatus=~/^(\s*(?:ok|con_delayed)\s*)*$/) {
-	    $r->print('<br /><span class="LC_success">'.&mt('Completed.').
-                      '</span>');
-	    if ($env{'form.displayedcrit'}) {
-	        &discrit($r);
+        if (!$env{'form.multiforward'}) { 
+            if ($sendstatus=~/^(\s*(?:ok|con_delayed)\s*)*$/) {
+	        $r->print('<br /><span class="LC_success">'.&mt('Completed.').
+                          '</span>');
+	        if ($env{'form.displayedcrit'}) {
+	            &discrit($r);
+                }
+                if ($group ne '') {
+                    $r->print(&groupmail_sent($group,$cdom,$cnum)); 
+	        } else {
+	            &Apache::loncommunicate::menu($r);
+	        }
+            } else {
+	        $r->print('<p><span class="LC_error">'.&mt('Could not deliver message').'</span> '.
+		          &mt('Please use the browser "Back" button and correct the recipient addresses '."($sendstatus)").'</p>');
             }
-            if ($group ne '') {
-                $r->print(&groupmail_sent($group,$cdom,$cnum)); 
-	    } else {
-	        &Apache::loncommunicate::menu($r);
-	    }
-        } else {
-	    $r->print('<p><span class="LC_error">'.&mt('Could not deliver message').'</span> '.
-		  &mt('Please use the browser "Back" button and correct the recipient addresses '."($sendstatus)").'</p>');
         }
     }
     return $sendstatus;
@@ -2716,6 +2751,7 @@ sub handler {
         my $delresult = &deletefolder($folder);
         if ($delresult eq 'ok') {
             $r->print(&mt('Mail folder "[_1]" deleted.',$folder).'<br />');
+            $env{'form.folder'} = '';
         } else {
             $r->print(&mt('Deletion failed.').' '.$delresult.'<br />');
             $showfolder = $folder;
@@ -2746,8 +2782,6 @@ sub handler {
 
 =pod
 
-=back
-
 =cut
 
 1;