[BACK]Return to lonmsg.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonmsg.pm between versions 1.56 and 1.64

version 1.56, 2003/06/23 22:25:14 version 1.64, 2003/08/18 17:37:42
Line 44 Line 44
 #  #
 package Apache::lonmsg;  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
   
   X<messages>LON-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<Critical messages>: A message the recipient B<must>
   acknowlegde receipt of before they are allowed to continue using the
   system, preventing a user from claiming they never got a message
   
   =item * B<Receipts>: 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<Context>: 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<PREF> 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 strict;
 use Apache::lonnet();  use Apache::lonnet();
 use vars qw($msgcount);  use vars qw($msgcount);
Line 192  sub newmail { Line 254  sub newmail {
   
 # =============================== Automated message to the author of a resource  # =============================== Automated message to the author of a resource
   
   =pod
   
   =item * B<author_res_msg($filename, $message)>: Sends message $message to the owner
       of the resource with the URI $filename.
   
   =cut
   
 sub author_res_msg {  sub author_res_msg {
     my ($filename,$message)=@_;      my ($filename,$message)=@_;
     unless ($message) { return 'empty'; }      unless ($message) { return 'empty'; }
Line 255  sub user_crit_msg_raw { Line 324  sub user_crit_msg_raw {
   
 # New routine that respects "forward" and calls old routine  # New routine that respects "forward" and calls old routine
   
   =pod
   
   =item * B<user_crit_msg($user, $domain, $subject, $message, $sendback)>: 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 {  sub user_crit_msg {
     my ($user,$domain,$subject,$message,$sendback)=@_;      my ($user,$domain,$subject,$message,$sendback)=@_;
     my $status='';      my $status='';
Line 335  sub user_normal_msg_raw { Line 412  sub user_normal_msg_raw {
   
 # New routine that respects "forward" and calls old routine  # New routine that respects "forward" and calls old routine
   
   =pod
   
   =item * B<user_normal_msg($user, $domain, $subject, $message,
       $citation, $baseurl, $attachmenturl)>: Sends a message to the
       $user at $domain, with subject $subject and message $message.
   
   =cut
   
 sub user_normal_msg {  sub user_normal_msg {
     my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl)=@_;      my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl)=@_;
     my $status='';      my $status='';
Line 418  sub discourse { Line 503  sub discourse {
 <input type=button onClick="uncheckall()" value="Check for None">  <input type=button onClick="uncheckall()" value="Check for None">
 <p>  <p>
 ENDDISHEADER  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(
                '<br /><input type="checkbox" name="send_to_&&&&&&_'.
                $puname.':'.$pudom.'" /> '.
        &Apache::loncommon::plainname($puname,
                             $pudom).' ('.$_.'), <i>'.$role.'</i>');
    }
       }
   
     foreach (sort keys %courselist) {      foreach (sort keys %courselist) {
         my ($end,$start)=split(/\:/,$courselist{$_});          my ($end,$start)=split(/\:/,$courselist{$_});
         my $active=1;          my $active=1;
Line 468  $content{'sendername'}.'@'. Line 566  $content{'sendername'}.'@'.
     }      }
     # Check to see if there were any messages.      # Check to see if there were any messages.
     if ($result eq '') {      if ($result eq '') {
         $result = "<h2>You have no critical messages.</h2>";          $result = "<h2>You have no critical messages.</h2>".
       '<a href="/adm/roles">Select a course</a>';
     } else {      } else {
         $r->print($header);          $r->print($header);
     }      }
Line 486  sub comprep { Line 585  sub comprep {
       $quotemsg=~s/\r/\n/g;        $quotemsg=~s/\r/\n/g;
       $quotemsg=~s/\f/\n/g;        $quotemsg=~s/\f/\n/g;
       $quotemsg=~s/\n+/\n\> /g;        $quotemsg=~s/\n+/\n\> /g;
         my $torepl=&Apache::loncommon::aboutmewrapper(
    &Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).' ('.
   $content{'sendername'}.'@'.
               $content{'senderdomain'}.')';
       my $subject='Re: '.$content{'subject'};        my $subject='Re: '.$content{'subject'};
       my $dispcrit='';        my $dispcrit='';
       if (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {        if (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
Line 499  sub comprep { Line 602  sub comprep {
       $r->print(<<"ENDREPLY");        $r->print(<<"ENDREPLY");
 <form action="/adm/email" method=post>  <form action="/adm/email" method=post>
 <input type=hidden name=sendreply value="$msgid">  <input type=hidden name=sendreply value="$msgid">
   To: $torepl<br />
 Subject: <input type=text size=50 name=subject value="$subject"><p>  Subject: <input type=text size=50 name=subject value="$subject"><p>
 <textarea name=message cols=84 rows=10 wrap=hard>  <textarea name=message cols=84 rows=10 wrap=hard>
 $quotemsg  $quotemsg
Line 534  sub disall { Line 638  sub disall {
     }      }
 </script>  </script>
 ENDDISHEADER  ENDDISHEADER
    $r->print(      $r->print('<h1>Display All Messages</h1><form method=post name=disall '.
  '<h1>Display All Messages</h1><form method=post name=disall '.        'action="/adm/email">'.
  'action="/adm/email">'.        '<table border=2><tr><th colspan=2>&nbsp</th><th>');
      '<table border=2><tr><th colspan=2>&nbsp</th><th>Date</th>'.      if ($ENV{'form.sortedby'} eq "revdate") {
      '<th>Username</th><th>Domain</th><th>Subject</th><th>Status</th></tr>');   $r->print('<a href = "?sortedby=date">Date</a></th>');
     foreach (sort split(/\&/,&Apache::lonnet::reply('keys:'.      } else {
  $ENV{'user.domain'}.':'.   $r->print('<a href = "?sortedby=revdate">Date</a></th>');
                                         $ENV{'user.name'}.':nohist_email',      }
                                         $ENV{'user.home'}))) {      $r->print('<th>');
         my ($sendtime,$shortsubj,$fromname,$fromdomain,$status)=      if ($ENV{'form.sortedby'} eq "revuser") {
    $r->print('<a href = "?sortedby=user">Username</a>');
       } else {
    $r->print('<a href = "?sortedby=revuser">Username</a>');
       }
       $r->print('</th><th>');
       if ($ENV{'form.sortedby'} eq "revdomain") {
    $r->print('<a href = "?sortedby=domain">Domain</a>');
       } else {
    $r->print('<a href = "?sortedby=revdomain">Domain</a>');
       }
       $r->print('</th><th>');
       if ($ENV{'form.sortedby'} eq "revsubject") {
    $r->print('<a href = "?sortedby=subject">Subject</a>');
       } else {
       $r->print('<a href = "?sortedby=revsubject">Subject</a>');
       }
       $r->print('</th><th>');
       if ($ENV{'form.sortedby'} eq "revstatus") {
    $r->print('<a href = "?sortedby=status">Status</th>');
       } else {
         $r->print('<a href = "?sortedby=revstatus">Status</th>');
       }
       $r->print('</tr>');
       my @messages = split(/\&/,&Apache::lonnet::reply('keys:'.$ENV{'user.domain'}.':'.$ENV{'user.name'}.':nohist_email',$ENV{'user.home'}));
       #unpack the varibles and repack into temp for sorting
       my @temp;
       foreach (@messages) {
    my ($sendtime,$shortsubj,$fromname,$fromdomain,$status)=
     &Apache::lonmsg::unpackmsgid($_);      &Apache::lonmsg::unpackmsgid($_);
    my @temp1 = ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$_);
    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;
       }
       foreach (@temp){
    my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$origID)= @$_;
  if (($status ne 'deleted') && defined($sendtime) && $sendtime!~/error/) {   if (($status ne 'deleted') && defined($sendtime) && $sendtime!~/error/) {
     if ($status eq 'new') {      if ($status eq 'new') {
  $r->print('<tr bgcolor="#FFBB77">');   $r->print('<tr bgcolor="#FFBB77">');
     } elsif ($status eq 'read') {      } elsif ($status eq 'read') {
  $r->print('<tr bgcolor="#BBBB77">');   $r->print('<tr bgcolor="#BBBB77">');
     } elsif ($status eq 'replied') {      } elsif ($status eq 'replied') {
  $r->print('<tr bgcolor="#AAAA88">');   $r->print('<tr bgcolor="#AAAA88">'); 
     } else {      } else {
  $r->print('<tr bgcolor="#99BBBB">');   $r->print('<tr bgcolor="#99BBBB">');
     }      }
     $r->print('<td><a href="/adm/email?display='.$_.      $r->print('<td><a href="/adm/email?display='.$origID. 
       '">Open</a></td><td><a href="/adm/email?markdel='.$_.        '">Open</a></td><td><a href="/adm/email?markdel='.$origID.
       '">Delete</a><input type=checkbox name="delmark_'.$_.'"></td>'.        '">Delete</a><input type=checkbox name="delmark_'.$origID.'"></td>'.
       '<td>'.localtime($sendtime).'</td><td>'.        '<td>'.localtime($sendtime).'</td><td>'.
       $fromname.'</td><td>'.$fromdomain.'</td><td>'.        $fromname.'</td><td>'.$fromdomain.'</td><td>'.
       &Apache::lonnet::unescape($shortsubj).'</td><td>'.        &Apache::lonnet::unescape($shortsubj).'</td><td>'.
                       $status.'</td></tr>');                        $status.'</td></tr>');
  }   }
     }      }   
     $r->print('</table><p>'.      $r->print('</table><p>'.
               '<a href="javascript:checkall()">Check All</a>&nbsp;'.                '<a href="javascript:checkall()">Check All</a>&nbsp;'.
               '<a href="javascript:uncheckall()">Uncheck All</a><p>'.                '<a href="javascript:uncheckall()">Uncheck All</a><p>'.
Line 784  sub handler { Line 953  sub handler {
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
         ['display','replyto','forward','markread','markdel','markunread',          ['display','replyto','forward','markread','markdel','markunread',
          'sendreply','compose','sendmail','critical','recname','recdom',           'sendreply','compose','sendmail','critical','recname','recdom',
          'recordftf']);           'recordftf','sortedby']);
   
 # ------------------------------------------------------ They checked for email  # ------------------------------------------------------ They checked for email
   &Apache::lonnet::put('email_status',{'recnewemail'=>0});    &Apache::lonnet::put('email_status',{'recnewemail'=>0});
Line 965  BEGIN { Line 1134  BEGIN {
     $msgcount=0;      $msgcount=0;
 }  }
   
 1;  =pod
   
   =back
   
   =cut
   
   1; 
   
 __END__  __END__
   
   
Removed from v.1.56  
changed lines
  Added in v.1.64

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>