--- loncom/interface/lonmsg.pm 2003/07/05 10:07:11 1.57 +++ loncom/interface/lonmsg.pm 2003/08/29 20:38:12 1.65 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Routines for messaging # -# $Id: lonmsg.pm,v 1.57 2003/07/05 10:07:11 www Exp $ +# $Id: lonmsg.pm,v 1.65 2003/08/29 20:38:12 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -44,6 +44,68 @@ # package Apache::lonmsg; +=pod + +=head1 NAME + +Apache::lonmsg: 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. + +=head1 OVERVIEW + +=head2 Messaging Overview + +XLON-CAPA provides an internal messaging system similar to +email, but customized for LON-CAPA's usage. LON-CAPA implements its +own messaging system, rather then building on top of email, because of +the features LON-CAPA messages can offer that conventional e-mail can +not: + +=over 4 + +=item * B: A message the recipient B +acknowlegde receipt of before they are allowed to continue using the +system, preventing a user from claiming they never got a message + +=item * B: LON-CAPA can reliably send reciepts informing the +sender that it has been read; again, useful for preventing students +from claiming they did not see a message. (While conventional e-mail +has some reciept support, it's sporadic, e-mail client-specific, and +generally the receiver can opt to not send one, making it useless in +this case.) + +=item * B: LON-CAPA knows about the sender, such as where +they are in a course. When a student mails an instructor asking for +help on the problem, the instructor receives not just the student's +question, but all submissions the student has made up to that point, +the user's rendering of the problem, and the complete view the student +saw of the resource, including discussion up to that point. Finally, +the instructor is reading all of this inside of LON-CAPA, not their +email program, so they have full access to LON-CAPA's grading +interface, or other features they may wish to use in response to the +student's query. + +=back + +Users can ask LON-CAPA to forward messages to conventional e-mail +addresses on their B screen, but generally, LON-CAPA messages +are much more useful then 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. + +=head1 FUNCTIONS + +=over 4 + +=cut + use strict; use Apache::lonnet(); use vars qw($msgcount); @@ -54,6 +116,9 @@ use Apache::lontexconvert(); use HTML::Entities(); use Mail::Send; +# Querystring component with sorting type +my $sqs; + # ===================================================================== Package sub packagemsg { @@ -192,6 +257,13 @@ sub newmail { # =============================== Automated message to the author of a resource +=pod + +=item * B: Sends message $message to the owner + of the resource with the URI $filename. + +=cut + sub author_res_msg { my ($filename,$message)=@_; unless ($message) { return 'empty'; } @@ -255,6 +327,14 @@ sub user_crit_msg_raw { # New routine that respects "forward" and calls old routine +=pod + +=item * B: Sends + a critical message $message to the $user at $domain. If $sendback is true, + a reciept will be sent to the current user when $user recieves the message. + +=cut + sub user_crit_msg { my ($user,$domain,$subject,$message,$sendback)=@_; my $status=''; @@ -335,6 +415,14 @@ sub user_normal_msg_raw { # New routine that respects "forward" and calls old routine +=pod + +=item * B: Sends a message to the + $user at $domain, with subject $subject and message $message. + +=cut + sub user_normal_msg { my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl)=@_; my $status=''; @@ -418,6 +506,19 @@ sub discourse {

ENDDISHEADER + my %coursepersonnel= + &Apache::lonnet::get_course_adv_roles(); + foreach my $role (sort keys %coursepersonnel) { + foreach (split(/\,/,$coursepersonnel{$role})) { + my ($puname,$pudom)=split(/\:/,$_); + $r->print( + '
'. + &Apache::loncommon::plainname($puname, + $pudom).' ('.$_.'), '.$role.''); + } + } + foreach (sort keys %courselist) { my ($end,$start)=split(/\:/,$courselist{$_}); my $active=1; @@ -468,7 +569,8 @@ $content{'sendername'}.'@'. } # Check to see if there were any messages. if ($result eq '') { - $result = "

You have no critical messages.

"; + $result = "

You have no critical messages.

". + 'Select a course'; } else { $r->print($header); } @@ -514,6 +616,53 @@ $dispcrit ENDREPLY } +sub sortedmessages { + my @messages = &Apache::lonnet::getkeys('nohist_email'); + #unpack the varibles and repack into temp for sorting + my @temp; + foreach (@messages) { + my $msgid=&Apache::lonnet::escape($_); + my ($sendtime,$shortsubj,$fromname,$fromdomain,$status)= + &Apache::lonmsg::unpackmsgid($msgid); + my @temp1 = ($sendtime,$shortsubj,$fromname,$fromdomain,$status, + $msgid); + push @temp ,\@temp1; + } + #default sort + @temp = sort {$a->[0] <=> $b->[0]} @temp; + if ($ENV{'form.sortedby'} eq "date"){ + @temp = sort {$a->[0] <=> $b->[0]} @temp; + } + if ($ENV{'form.sortedby'} eq "revdate"){ + @temp = sort {$b->[0] <=> $a->[0]} @temp; + } + if ($ENV{'form.sortedby'} eq "user"){ + @temp = sort {lc($a->[2]) cmp lc($b->[2])} @temp; + } + if ($ENV{'form.sortedby'} eq "revuser"){ + @temp = sort {lc($b->[2]) cmp lc($a->[2])} @temp; + } + if ($ENV{'form.sortedby'} eq "domain"){ + @temp = sort {$a->[3] cmp $b->[3]} @temp; + } + if ($ENV{'form.sortedby'} eq "revdomain"){ + @temp = sort {$b->[3] cmp $a->[3]} @temp; + } + if ($ENV{'form.sortedby'} eq "subject"){ + @temp = sort {lc($a->[1]) cmp lc($b->[1])} @temp; + } + if ($ENV{'form.sortedby'} eq "revsubject"){ + @temp = sort {lc($b->[1]) cmp lc($a->[1])} @temp; + } + if ($ENV{'form.sortedby'} eq "status"){ + @temp = sort {$a->[4] cmp $b->[4]} @temp; + } + if ($ENV{'form.sortedby'} eq "revstatus"){ + @temp = sort {$b->[4] cmp $a->[4]} @temp; + } + return @temp; +} + # ======================================================== Display all messages sub disall { @@ -539,39 +688,65 @@ sub disall { } ENDDISHEADER - $r->print( - '

Display All Messages

'. - ''. - ''); - foreach (sort split(/\&/,&Apache::lonnet::reply('keys:'. - $ENV{'user.domain'}.':'. - $ENV{'user.name'}.':nohist_email', - $ENV{'user.home'}))) { - my ($sendtime,$shortsubj,$fromname,$fromdomain,$status)= - &Apache::lonmsg::unpackmsgid($_); + $r->print('

Display All Messages

'. + '
 DateUsernameDomainSubjectStatus
'); + } else { + $r->print('Date'); + } + $r->print(''); + } else { + $r->print('Status'); + } + $r->print(''); + my @temp=sortedmessages(); + foreach (@temp){ + my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$origID)= @$_; if (($status ne 'deleted') && defined($sendtime) && $sendtime!~/error/) { if ($status eq 'new') { $r->print(''); } elsif ($status eq 'read') { $r->print(''); } elsif ($status eq 'replied') { - $r->print(''); + $r->print(''); } else { $r->print(''); } - $r->print(''. + $r->print(''. ''); } - } + } $r->print('
 '); + if ($ENV{'form.sortedby'} eq "revdate") { + $r->print('Date'); + if ($ENV{'form.sortedby'} eq "revuser") { + $r->print('Username'); + } else { + $r->print('Username'); + } + $r->print(''); + if ($ENV{'form.sortedby'} eq "revdomain") { + $r->print('Domain'); + } else { + $r->print('Domain'); + } + $r->print(''); + if ($ENV{'form.sortedby'} eq "revsubject") { + $r->print('Subject'); + } else { + $r->print('Subject'); + } + $r->print(''); + if ($ENV{'form.sortedby'} eq "revstatus") { + $r->print('Status
OpenDeleteOpenDelete'.localtime($sendtime).''. $fromname.''.$fromdomain.''. &Apache::lonnet::unescape($shortsubj).''. $status.'

'. 'Check All '. 'Uncheck All

'. + ''. ''. '

'); } @@ -789,8 +964,8 @@ sub handler { &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['display','replyto','forward','markread','markdel','markunread', 'sendreply','compose','sendmail','critical','recname','recdom', - 'recordftf']); - + 'recordftf','sortedby']); + $sqs='&sortedby='.$ENV{'form.sortedby'}; # ------------------------------------------------------ They checked for email &Apache::lonnet::put('email_status',{'recnewemail'=>0}); # --------------------------------------------------------------- Render Output @@ -804,6 +979,20 @@ sub handler { &statuschange($msgid,'read'); my %message=&Apache::lonnet::get('nohist_email',[$msgid]); my %content=&unpackagemsg($message{$msgid}); +# info to generate "next" and "previous" buttons + my @messages=&sortedmessages(); + my $counter=0; + $r->print('
');
+      my $escmsgid=&Apache::lonnet::escape($msgid);
+      foreach (@messages) {
+ 	  if ($_->[5] eq $escmsgid){
+ 	      last;
+ 	  }
+ 	  $counter++;
+      }
+      $r->print('
'); + my $number_of_messages = scalar(@messages); #subtract 1 for last index +# start output $r->print('EMail and Messaging'); if (defined($content{'baseurl'})) { $r->print(""); @@ -820,16 +1009,25 @@ $content{'sendername'},$content{'senderd $content{'senderdomain'}.') '. '
Time: '.$content{'time'}.'

'. ''. - ''. - ''. - ''. - ''. - ''. - '
Functions:ReplyForwardMark UnreadDeleteDisplay all Messages

'.
+		'Display all Messages');
+      if ($counter > 0){
+ 	  $r->print('Previous');
+       }
+       if ($counter < $number_of_messages - 1){
+ 	  $r->print('Next');
+       }
+       $r->print('
'.
              &Apache::lontexconvert::msgtexconverted($content{'message'}).
              '
'.$content{'citation'});
   } elsif ($ENV{'form.replyto'}) {
@@ -970,7 +1168,14 @@ BEGIN {
     $msgcount=0;
 }
 
-1;
+=pod
+
+=back
+
+=cut
+
+1; 
+
 __END__