Diff for /loncom/interface/lonmsg.pm between versions 1.173.2.1 and 1.193

version 1.173.2.1, 2006/04/23 05:47:33 version 1.193, 2006/12/27 20:42:12
Line 26 Line 26
 # http://www.lon-capa.org/  # http://www.lon-capa.org/
 #  #
   
   
 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.  
   
 =item * B<Blocking>: LON-CAPA can block display of e-mails that are   
 sent to a student during an online exam. A course coordinator or  
 instructor can set an open and close date/time for scheduled online  
 exams in a course. If a user uses the LON-CAPA internal messaging   
 system to display e-mails during the scheduled blocking event,    
 display of all e-mail sent during the blocking period will be   
 suppressed, and a message of explanation, including details of the   
 currently active blocking periods will be displayed instead. A user   
 who has a course coordinator or instructor role in a course will be  
 unaffected by any blocking periods for the course, unless the user  
 also has a student role in the course, AND has selected the student role.  
   
 =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 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;  use strict;
 use Apache::lonnet;  use Apache::lonnet;
 use vars qw($msgcount);  
 use HTML::TokeParser();  use HTML::TokeParser();
 use Apache::Constants qw(:common);  
 use Apache::loncommon();  
 use Apache::lontexconvert();  
 use HTML::Entities();  
 use Mail::Send;  
 use Apache::lonlocal;  use Apache::lonlocal;
 use Apache::loncommunicate;  use Mail::Send;
 use Apache::lonfeedback;  use LONCAPA qw(:DEFAULT :match);
 use Apache::lonrss();  
   {
 # Querystring component with sorting type      my $uniq;
 my $sqs;      sub get_uniq {
 my $startdis;   $uniq++;
 my $interdis;   return $uniq;
       }
   }
   
 # ===================================================================== Package  # ===================================================================== Package
   
 sub packagemsg {  sub packagemsg {
     my ($subject,$message,$citation,$baseurl,$attachmenturl,      my ($subject,$message,$citation,$baseurl,$attachmenturl,
  $recuser,$recdomain,$msgid,$type)=@_;   $recuser,$recdomain,$msgid,$type,$crsmsgid,$symb,$error)=@_;
     $message =&HTML::Entities::encode($message,'<>&"');      $message =&HTML::Entities::encode($message,'<>&"');
     $citation=&HTML::Entities::encode($citation,'<>&"');      $citation=&HTML::Entities::encode($citation,'<>&"');
     $subject =&HTML::Entities::encode($subject,'<>&"');      $subject =&HTML::Entities::encode($subject,'<>&"');
Line 150  sub packagemsg { Line 60  sub packagemsg {
     my $course_context;      my $course_context;
     if (defined($env{'form.replyid'})) {      if (defined($env{'form.replyid'})) {
         my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid)=          my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid)=
                    split(/\:/,&Apache::lonnet::unescape($env{'form.replyid'}));                     split(/\:/,&unescape($env{'form.replyid'}));
         $course_context = $origcid;          $course_context = $origcid;
     }      }
     foreach my $key (keys(%env)) {      foreach my $key (keys(%env)) {
         if ($key=~/^form\.(rep)?rec\_(.*)$/) {          if ($key=~/^form\.(rep)?rec\_(.*)$/) {
             my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid) =              my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid) =
                                     split(/\:/,&Apache::lonnet::unescape($2));                                      split(/\:/,&unescape($2));
             $course_context = $origcid;              $course_context = $origcid;
             last;              last;
         }          }
Line 165  sub packagemsg { Line 75  sub packagemsg {
         $course_context = $env{'request.course.id'};          $course_context = $env{'request.course.id'};
     }      }
     my $now=time;      my $now=time;
     $msgcount++;      my $msgcount = &get_uniq();
     unless(defined($msgid)) {      unless(defined($msgid)) {
         $msgid = &buildmsgid($now,$subject,$env{'user.name'},$env{'user.domain'},          $msgid = &buildmsgid($now,$subject,$env{'user.name'},$env{'user.domain'},
                             $msgcount,$course_context,$$);                             $msgcount,$course_context,$symb,$error,$$);
     }      }
     my $result='<sendername>'.$env{'user.name'}.'</sendername>'.      my $result = '<sendername>'.$env{'user.name'}.'</sendername>'.
            '<senderdomain>'.$env{'user.domain'}.'</senderdomain>'.             '<senderdomain>'.$env{'user.domain'}.'</senderdomain>'.
            '<subject>'.$subject.'</subject>'.             '<subject>'.$subject.'</subject>'.
    '<time>'.&Apache::lonlocal::locallocaltime($now).'</time>'.             '<time>'.&Apache::lonlocal::locallocaltime($now).'</time>';
    '<servername>'.$ENV{'SERVER_NAME'}.'</servername>'.      if (defined($crsmsgid)) {
           $result.= '<courseid>'.$course_context.'</courseid>'.
                     '<coursesec>'.$env{'request.course.sec'}.'</coursesec>'.
                     '<msgid>'.$msgid.'</msgid>'.
                     '<coursemsgid>'.$crsmsgid.'</coursemsgid>'.
                     '<message>'.$message.'</message>';
           return ($msgid,$result);
       }
       $result .= '<servername>'.$ENV{'SERVER_NAME'}.'</servername>'.
            '<host>'.$ENV{'HTTP_HOST'}.'</host>'.             '<host>'.$ENV{'HTTP_HOST'}.'</host>'.
    '<client>'.$ENV{'REMOTE_ADDR'}.'</client>'.     '<client>'.$ENV{'REMOTE_ADDR'}.'</client>'.
    '<browsertype>'.$env{'browser.type'}.'</browsertype>'.     '<browsertype>'.$env{'browser.type'}.'</browsertype>'.
Line 191  sub packagemsg { Line 109  sub packagemsg {
         for (my $i=0; $i<@{$recuser}; $i++) {          for (my $i=0; $i<@{$recuser}; $i++) {
             if ($type eq 'dcmail') {              if ($type eq 'dcmail') {
                 my ($username,$email) = split(/:/,$$recuser[$i]);                  my ($username,$email) = split(/:/,$$recuser[$i]);
                 $username = &Apache::lonnet::unescape($username);                  $username = &unescape($username);
                 $email = &Apache::lonnet::unescape($email);                  $email = &unescape($email);
                 $username = &HTML::Entities::encode($username,'<>&"');                  $username = &HTML::Entities::encode($username,'<>&"');
                 $email = &HTML::Entities::encode($email,'<>&"');                  $email = &HTML::Entities::encode($email,'<>&"');
                 $result .= '<recipient username="'.$username.'">'.                  $result .= '<recipient username="'.$username.'">'.
Line 216  sub packagemsg { Line 134  sub packagemsg {
     if (defined($attachmenturl)) {      if (defined($attachmenturl)) {
  $result.= '<attachmenturl>'.$attachmenturl.'</attachmenturl>';   $result.= '<attachmenturl>'.$attachmenturl.'</attachmenturl>';
     }      }
     return $msgid,$result;      if (defined($symb)) {
           $result.= '<symb>'.$symb.'</symb>';
           if (defined($course_context)) {
               if ($course_context eq $env{'request.course.id'}) {
                   my $resource_title = &Apache::lonnet::gettitle($symb);
                   if (defined($resource_title)) {
                       $result .= '<resource_title>'.$resource_title.'</resource_title>';
                   }
               }
           }
       }
       return ($msgid,$result);
 }  }
   
 # ================================================== Unpack message into a hash  # ================================================== Unpack message into a hash
Line 260  sub unpackagemsg { Line 189  sub unpackagemsg {
 # ======================================================= Get info out of msgid  # ======================================================= Get info out of msgid
   
 sub buildmsgid {  sub buildmsgid {
     my ($now,$subject,$uname,$udom,$msgcount,$course_context,$pid) = @_;      my ($now,$subject,$uname,$udom,$msgcount,$course_context,$symb,$error,$pid) = @_;
     $subject=&Apache::lonnet::escape($subject);      $subject=&escape($subject);
     return(&Apache::lonnet::escape($now.':'.$subject.':'.$uname.':'.      $symb = &escape($symb);
            $udom.':'.$msgcount.':'.$course_context.':'.$pid));      return(&escape($now.':'.$subject.':'.$uname.':'.
              $udom.':'.$msgcount.':'.$course_context.':'.$pid.':'.$symb.':'.$error));
 }  }
   
 sub unpackmsgid {  sub unpackmsgid {
     my ($msgid,$folder,$skipstatus,$status_cache)=@_;      my ($msgid,$folder,$skipstatus,$status_cache)=@_;
     $msgid=&Apache::lonnet::unescape($msgid);      $msgid=&unescape($msgid);
     my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$fromcid,      my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$fromcid,
                      $processid)=split(/\:/,&Apache::lonnet::unescape($msgid));          $processid,$symb,$error) = split(/\:/,&unescape($msgid));
       $shortsubj = &unescape($shortsubj);
       $shortsubj = &HTML::Entities::decode($shortsubj);
       $symb = &unescape($symb);
     if (!defined($processid)) { $fromcid = ''; }      if (!defined($processid)) { $fromcid = ''; }
     my %status=();      my %status=();
     unless ($skipstatus) {      unless ($skipstatus) {
Line 283  sub unpackmsgid { Line 216  sub unpackmsgid {
  if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; }   if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; }
         unless ($status{$msgid}) { $status{$msgid}='new'; }          unless ($status{$msgid}) { $status{$msgid}='new'; }
     }      }
     return ($sendtime,$shortsubj,$fromname,$fromdomain,$status{$msgid},$fromcid);      return ($sendtime,$shortsubj,$fromname,$fromdomain,$status{$msgid},$fromcid,$symb,$error);
 }  }
   
   
 sub sendemail {  sub sendemail {
     my ($to,$subject,$body)=@_;      my ($to,$subject,$body)=@_;
       my %senderemails=&Apache::loncommon::getemails();
       my $senderaddress='';
       foreach my $type ('notification','permanentemail','critnotification') {
    if ($senderemails{$type}) {
       $senderaddress=$senderemails{$type};
    }
       }
     $body=      $body=
     "*** ".&mt('This is an automatic message generated by the LON-CAPA system.')."\n".      "*** ".&mt('This is an automatic message generated by the LON-CAPA system.')."\n".
     "*** ".&mt('Please do not reply to this address.')."\n\n".$body;      "*** ".($senderaddress?&mt('You can reply to this message'):&mt('Please do not reply to this address.')."\n*** ".
       &mt('A reply will not be received by the recipient!'))."\n\n".$body;
     my $msg = new Mail::Send;      my $msg = new Mail::Send;
     $msg->to($to);      $msg->to($to);
     $msg->subject('[LON-CAPA] '.$subject);      $msg->subject('[LON-CAPA] '.$subject);
       if ($senderaddress) { $msg->add('Reply-to',$senderaddress); $msg->add('From',$senderaddress); }
     if (my $fh = $msg->open()) {      if (my $fh = $msg->open()) {
  print $fh $body;   print $fh $body;
  $fh->close;   $fh->close;
Line 361  sub author_res_msg { Line 303  sub author_res_msg {
     my $homeserver=&Apache::lonnet::homeserver($author,$domain);      my $homeserver=&Apache::lonnet::homeserver($author,$domain);
     if ($homeserver ne 'no_host') {      if ($homeserver ne 'no_host') {
        my $id=unpack("%32C*",$message);         my $id=unpack("%32C*",$message);
          $message .= " <p>This error occurred on machine ".
      $Apache::lonnet::perlvar{'lonHostID'}."</p>";
        my $msgid;         my $msgid;
        ($msgid,$message)=&packagemsg($filename,$message);         ($msgid,$message)=&packagemsg($filename,$message);
        return &Apache::lonnet::reply('put:'.$domain.':'.$author.         return &Apache::lonnet::reply('put:'.$domain.':'.$author.
          ':nohist_res_msgs:'.           ':nohist_res_msgs:'.
           &Apache::lonnet::escape($filename.'_'.$id).'='.            &escape($filename.'_'.$id).'='.
           &Apache::lonnet::escape($message),$homeserver);            &escape($message),$homeserver);
     }      }
     return 'no_host';      return 'no_host';
 }  }
Line 376  sub author_res_msg { Line 320  sub author_res_msg {
 sub retrieve_author_res_msg {  sub retrieve_author_res_msg {
     my $url=shift;      my $url=shift;
     $url=&Apache::lonnet::declutter($url);      $url=&Apache::lonnet::declutter($url);
     my ($domain,$author)=($url=~/^(\w+)\/(\w+)\//);      my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
     my %errormsgs=&Apache::lonnet::dump('nohist_res_msgs',$domain,$author);      my %errormsgs=&Apache::lonnet::dump('nohist_res_msgs',$domain,$author);
     my $msgs='';      my $msgs='';
     foreach (keys %errormsgs) {      foreach (keys %errormsgs) {
Line 396  sub retrieve_author_res_msg { Line 340  sub retrieve_author_res_msg {
 sub del_url_author_res_msg {  sub del_url_author_res_msg {
     my $url=shift;      my $url=shift;
     $url=&Apache::lonnet::declutter($url);      $url=&Apache::lonnet::declutter($url);
     my ($domain,$author)=($url=~/^(\w+)\/(\w+)\//);      my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
     my @delmsgs=();      my @delmsgs=();
     foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {      foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
  if ($_=~/^\Q$url\E\_\d+$/) {   if ($_=~/^\Q$url\E\_\d+$/) {
Line 410  sub del_url_author_res_msg { Line 354  sub del_url_author_res_msg {
 sub clear_author_res_msg {  sub clear_author_res_msg {
     my $url=shift;      my $url=shift;
     $url=&Apache::lonnet::declutter($url);      $url=&Apache::lonnet::declutter($url);
     my ($domain,$author)=($url=~/^(\w+)\/(\w+)\//);      my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
     my @delmsgs=();      my @delmsgs=();
     foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {      foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
  if ($_=~/^\Q$url\E/) {   if ($_=~/^\Q$url\E/) {
Line 431  sub all_url_author_res_msg { Line 375  sub all_url_author_res_msg {
     return %returnhash;      return %returnhash;
 }  }
   
   # ====================================== Add a comment to the User Notes screen
   
   sub store_instructor_comment {
       my ($msg,$uname,$udom) = @_;
       my $cid  = $env{'request.course.id'};
       my $cnum = $env{'course.'.$cid.'.num'};
       my $cdom = $env{'course.'.$cid.'.domain'};
       my $subject= &mt('Record').' ['.$uname.':'.$udom.']';
       my $result = &user_normal_msg_raw($cnum,$cdom,$subject,$msg);
       return $result;
   }
   
 # ================================================== Critical message to a user  # ================================================== Critical message to a user
   
 sub user_crit_msg_raw {  sub user_crit_msg_raw {
     my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage)=@_;      my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage)=@_;
 # Check if allowed missing  # Check if allowed missing
     my $status='';      my ($status,$packed_message);
     my $msgid='undefined';      my $msgid='undefined';
     unless (($message)&&($user)&&($domain)) { $status='empty'; };      unless (($message)&&($user)&&($domain)) { $status='empty'; };
     my $text=$message;      my $text=$message;
     my $homeserver=&Apache::lonnet::homeserver($user,$domain);      my $homeserver=&Apache::lonnet::homeserver($user,$domain);
     if ($homeserver ne 'no_host') {      if ($homeserver ne 'no_host') {
        ($msgid,$message)=&packagemsg($subject,$message);         ($msgid,$packed_message)=&packagemsg($subject,$message);
        if ($sendback) { $message.='<sendback>true</sendback>'; }         if ($sendback) { $packed_message.='<sendback>true</sendback>'; }
        $status=&Apache::lonnet::critical(         $status=&Apache::lonnet::critical(
            'put:'.$domain.':'.$user.':critical:'.             'put:'.$domain.':'.$user.':critical:'.
            &Apache::lonnet::escape($msgid).'='.             &escape($msgid).'='.
            &Apache::lonnet::escape($message),$homeserver);             &escape($packed_message),$homeserver);
         if (defined($sentmessage)) {          if (defined($sentmessage)) {
             $$sentmessage = $message;              $$sentmessage = $packed_message;
           }
           if ($env{'request.course.id'} eq '') {
               (undef,my $packed_message_no_citation) =
               &packagemsg($subject,$message,undef,undef,undef,$user,$domain,
                           $msgid);
               if ($status eq 'ok' || $status eq 'con_delayed') {
                   &store_sent_mail($msgid,$packed_message_no_citation);
               }
         }          }
     } else {      } else {
        $status='no_host';         $status='no_host';
     }      }
   
 # Notifications  # Notifications
     my %userenv = &Apache::lonnet::get('environment',['critnotification',      my %userenv = &Apache::loncommon::getemails($user,$domain);
                                                       'permanentemail'],  
                                        $domain,$user);  
     if ($userenv{'critnotification'}) {      if ($userenv{'critnotification'}) {
       &sendnotification($userenv{'critnotification'},$user,$domain,$subject,1,        &sendnotification($userenv{'critnotification'},$user,$domain,$subject,1,
  $text);   $text);
Line 485  sub user_crit_msg_raw { Line 448  sub user_crit_msg_raw {
     a critical message $message to the $user at $domain. If $sendback is true,      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.      a reciept will be sent to the current user when $user recieves the message.
   
       Additionally it will check if the user has a Forwarding address
       set, and send the message to that address instead
   
       returns 
         - in array context a list of results for each message that was sent
         - in scalar context a space seperated list of results for each 
              message sent
   
 =cut  =cut
   
 sub user_crit_msg {  sub user_crit_msg {
     my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage)=@_;      my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage)=@_;
     my $status='';      my @status;
     my %userenv = &Apache::lonnet::get('environment',['msgforward'],      my %userenv = &Apache::lonnet::get('environment',['msgforward'],
                                        $domain,$user);                                         $domain,$user);
     my $msgforward=$userenv{'msgforward'};      my $msgforward=$userenv{'msgforward'};
     if ($msgforward) {      if ($msgforward) {
        foreach (split(/\,/,$msgforward)) {         foreach my $addr (split(/\,/,$msgforward)) {
  my ($forwuser,$forwdomain)=split(/\:/,$_);   my ($forwuser,$forwdomain)=split(/\:/,$addr);
          $status.=           push(@status,
    &user_crit_msg_raw($forwuser,$forwdomain,$subject,$message,        &user_crit_msg_raw($forwuser,$forwdomain,$subject,$message,
                 $sendback,$toperm,$sentmessage).' ';   $sendback,$toperm,$sentmessage));
        }         }
     } else {       } else { 
  $status=&user_crit_msg_raw($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage);   push(@status,
        &user_crit_msg_raw($user,$domain,$subject,$message,$sendback,
    $toperm,$sentmessage));
     }      }
     return $status;      if (wantarray) {
    return @status;
       }
       return join(' ',@status);
 }  }
   
 # =================================================== Critical message received  # =================================================== Critical message received
Line 536  sub user_crit_received { Line 512  sub user_crit_received {
   
 sub user_normal_msg_raw {  sub user_normal_msg_raw {
     my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,      my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
  $toperm,$currid,$newid,$sentmessage)=@_;          $toperm,$currid,$newid,$sentmessage,$crsmsgid,$symb,$restitle,
           $error)=@_;
 # Check if allowed missing  # Check if allowed missing
     my ($status,$packed_message);      my ($status,$packed_message);
     my $msgid='undefined';      my $msgid='undefined';
Line 546  sub user_normal_msg_raw { Line 523  sub user_normal_msg_raw {
     if ($homeserver ne 'no_host') {      if ($homeserver ne 'no_host') {
        ($msgid,$packed_message)=         ($msgid,$packed_message)=
                  &packagemsg($subject,$message,$citation,$baseurl,                   &packagemsg($subject,$message,$citation,$baseurl,
                                      $attachmenturl,$user,$domain,$currid);                                       $attachmenturl,$user,$domain,$currid,
        (undef, my $packed_message_no_citation)=                                       undef,$crsmsgid,$symb,$error);
                          &packagemsg($subject,$message,undef     ,$baseurl,  
                                      $attachmenturl,$user,$domain,$currid);  
 # Store in user folder  # Store in user folder
        $status=&Apache::lonnet::critical(         $status=&Apache::lonnet::critical(
            'put:'.$domain.':'.$user.':nohist_email:'.             'put:'.$domain.':'.$user.':nohist_email:'.
            &Apache::lonnet::escape($msgid).'='.             &escape($msgid).'='.
            &Apache::lonnet::escape($packed_message),$homeserver);             &escape($packed_message),$homeserver);
 # Save new message received time  # Save new message received time
        &Apache::lonnet::put         &Apache::lonnet::put
                          ('email_status',{'recnewemail'=>time},$domain,$user);                           ('email_status',{'recnewemail'=>time},$domain,$user);
Line 565  sub user_normal_msg_raw { Line 541  sub user_normal_msg_raw {
                (&Apache::lonnet::allowed('srm',$env{'request.course.id'})                 (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
  || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.   || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
     '/'.$env{'request.course.sec'})))) {      '/'.$env{'request.course.sec'})))) {
            $status .= &store_sent_mail($msgid,$packed_message_no_citation);             (undef,my $packed_message_no_citation) =
                  &packagemsg($subject,$message,undef,$baseurl,$attachmenturl,
                              $user,$domain,$currid,undef,$crsmsgid,$symb,$error);
              if ($status eq 'ok' || $status eq 'con_delayed') {
                  &store_sent_mail($msgid,$packed_message_no_citation);
              }
        }         }
     } else {      } else {
        $status='no_host';         $status='no_host';
Line 586  sub user_normal_msg_raw { Line 567  sub user_normal_msg_raw {
   $text);    $text);
     }      }
     if ($toperm && $userenv{'permanentemail'}) {      if ($toperm && $userenv{'permanentemail'}) {
       &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,   &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,
  $text);    $text);
     }      }
     &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},      &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
                          $env{'user.home'},                           $env{'user.home'},
Line 599  sub user_normal_msg_raw { Line 580  sub user_normal_msg_raw {
   
 =pod  =pod
   
 =item * B<user_normal_msg($user, $domain, $subject, $message,  =item * B<user_normal_msg($user, $domain, $subject, $message, $citation,
     $citation, $baseurl, $attachmenturl)>: Sends a message to the         $baseurl, $attachmenturl, $toperm, $sentmessage, $symb, $restitle, $error)>:
     $user at $domain, with subject $subject and message $message.   Sends a message to the  $user at $domain, with subject $subject and message $message.
   
 =cut  =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,
  $toperm,$sentmessage)=@_;   $toperm,$sentmessage,$symb,$restitle,$error)=@_;
     my $status='';      my $status='';
     my %userenv = &Apache::lonnet::get('environment',['msgforward'],      my %userenv = &Apache::lonnet::get('environment',['msgforward'],
                                        $domain,$user);                                         $domain,$user);
Line 618  sub user_normal_msg { Line 599  sub user_normal_msg {
     $status.=      $status.=
         &user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,          &user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,
      $citation,$baseurl,$attachmenturl,$toperm,       $citation,$baseurl,$attachmenturl,$toperm,
      undef,undef,$sentmessage).' ';       undef,undef,$sentmessage,undef,$symb,$restitle,$error).' ';
         }          }
     } else {       } else {
  $status=&user_normal_msg_raw($user,$domain,$subject,$message,   $status=&user_normal_msg_raw($user,$domain,$subject,$message,
      $citation,$baseurl,$attachmenturl,$toperm,       $citation,$baseurl,$attachmenturl,$toperm,
      undef,undef,$sentmessage);       undef,undef,$sentmessage,undef,$symb,$restitle,$error);
     }      }
     return $status;      return $status;
 }  }
Line 633  sub store_sent_mail { Line 614  sub store_sent_mail {
     my $status =' '.&Apache::lonnet::critical(      my $status =' '.&Apache::lonnet::critical(
                'put:'.$env{'user.domain'}.':'.$env{'user.name'}.                 'put:'.$env{'user.domain'}.':'.$env{'user.name'}.
                                           ':nohist_email_sent:'.                                            ':nohist_email_sent:'.
                &Apache::lonnet::escape($msgid).'='.                 &escape($msgid).'='.
                &Apache::lonnet::escape($message),$env{'user.home'});                 &escape($message),$env{'user.home'});
     return $status;      return $status;
 }  }
   
 # ============================================================ List all folders  
   
 sub folderlist {  
     my $folder=shift;  
     my @allfolders=&Apache::lonnet::getkeys('email_folders');  
     if ($allfolders[0]=~/^error:/) { @allfolders=(); }  
     return '<form method="post" action="/adm/email">'.  
  &mt('Folder').': '.  
  &Apache::loncommon::select_form($folder,'folder',  
      ('' => &mt('INBOX'),'trash' => &mt('TRASH'),  
       'new' => &mt('New Messages Only'),  
                               'critical' => &mt('Critical'),  
       'sent' => &mt('Sent Messages'),  
       map { $_ => $_ } @allfolders)).  
       ' '.&mt('Show').  
       '<select name="interdis">'.  
       join("\n",map { '<option value="'.$_.'"'.  
  ($_==$interdis?' selected="selected"':'').'>'.$_.'</option>' }  
    (10,20,50,100,200)).'</select>'.  
    '<input type="submit" value="'.&mt('View Folder').'" /><br />'.  
     '<input type="hidden" name="sortedby" value="'.$env{'form.sortedby'}.'" />'.  
       ($folder=~/^(new|critical)/?'</form>':'');  
 }  
   
 sub scrollbuttons {  
     my ($start,$maxdis,$first,$finish,$total)=@_;  
     unless ($total>0) { return ''; }  
     $start++; $maxdis++;$first++;$finish++;  
     return  
    &mt('Page').': '.   
    '<input type="submit" name="firstview" value="'.&mt('First').'" />'.  
    '<input type="submit" name="prevview" value="'.&mt('Previous').'" />'.  
    '<input type="text" size="5" name="startdis" value="'.$start.'" onChange="this.form.submit()" /> of '.$maxdis.  
    '<input type="submit" name="nextview" value="'.&mt('Next').'" />'.  
    '<input type="submit" name="lastview" value="'.&mt('Last').'" /><br />'.  
    &mt('Showing messages [_1] through [_2] of [_3]',$first,$finish,$total).'</form>';  
 }  
   
 # =============================================================== Folder suffix  # =============================================================== Folder suffix
   
 sub foldersuffix {  sub foldersuffix {
     my $folder=shift;      my $folder=shift;
     unless ($folder) { return ''; }      unless ($folder) { return ''; }
     return '_'.&Apache::lonnet::escape($folder);      my $suffix;
 }      my %folderhash = &get_user_folders($folder);
       if (ref($folderhash{$folder}) eq 'HASH') {
 # =============================================================== Status Change          $suffix = '_'.&escape($folderhash{$folder}{'id'});
   
 sub statuschange {  
     my ($msgid,$newstatus,$folder)=@_;  
     my $suffix=&foldersuffix($folder);  
     my %status=&Apache::lonnet::get('email_status'.$suffix,[$msgid]);  
     if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; }  
     unless ($status{$msgid}) { $status{$msgid}='new'; }  
     unless (($status{$msgid} eq 'replied') ||   
             ($status{$msgid} eq 'forwarded')) {  
  &Apache::lonnet::put('email_status'.$suffix,{$msgid => $newstatus});  
     }  
     if (($newstatus eq 'deleted') || ($newstatus eq 'new')) {  
  &Apache::lonnet::put('email_status'.$suffix,{$msgid => $newstatus});  
     }  
     if ($newstatus eq 'deleted') {  
  return &movemsg($msgid,$folder,'trash');  
     }  
     return ;  
 }  
   
 # ============================================================= Make new folder  
   
 sub makefolder {  
     my ($newfolder)=@_;  
     if (($newfolder eq 'sent')  
      || ($newfolder eq 'critical')  
      || ($newfolder eq 'trash')  
      || ($newfolder eq 'new')) { return; }  
     &Apache::lonnet::put('email_folders',{$newfolder => time});  
 }  
   
 # ======================================================== Move between folders  
   
 sub movemsg {  
     my ($msgid,$srcfolder,$trgfolder)=@_;  
     if ($srcfolder eq 'new') { $srcfolder=''; }  
     my $srcsuffix=&foldersuffix($srcfolder);  
     my $trgsuffix=&foldersuffix($trgfolder);  
     if ($srcsuffix eq $trgsuffix) {  
  return (0,&mt('Message not moved, Attempted to move message to the same folder as it already is in.'));  
     }  
   
 # Copy message  
     my %message=&Apache::lonnet::get('nohist_email'.$srcsuffix,[$msgid]);  
     if (!exists($message{$msgid}) || $message{$msgid} eq '') {  
  if (&Apache::slotrequest::network_error(%message)) {  
     return (0,&mt('Message not moved, A network error occurred.'));  
  } else {  
     return (0,&mt('Message not moved as the message is no longer in the source folder.'));  
  }  
     }  
   
     my $result =&Apache::lonnet::put('nohist_email'.$trgsuffix,  
      {$msgid => $message{$msgid}});  
     if (&Apache::slotrequest::network_error($result)) {  
  return (0,&mt('Message not moved, A network error occurred.'));  
     }  
   
 # Copy status  
     unless ($trgfolder eq 'trash') {  
         my %status=&Apache::lonnet::get('email_status'.$srcsuffix,[$msgid]);  
  # a non-existant status is the mark of an unread msg  
  if (&Apache::slotrequest::network_error(%status)) {  
     return (0,&mt('Message copied to new folder but status was not, A network error occurred.'));  
  }  
  my $result=&Apache::lonnet::put('email_status'.$trgsuffix,  
  {$msgid => $status{$msgid}});  
  if (&Apache::slotrequest::network_error($result)) {  
     return (0,&mt('Message copied to new folder but status was not, A network error occurred.'));  
  }  
     }  
   
 # Delete orginals  
     my $result_del_msg =   
  &Apache::lonnet::del('nohist_email'.$srcsuffix,[$msgid]);  
     my $result_del_stat =  
  &Apache::lonnet::del('email_status'.$srcsuffix,[$msgid]);  
     if (&Apache::slotrequest::network_error($result_del_msg)) {  
  return (0,&mt('Message copied, but unable to delete the original from the source folder.'));  
     }  
     if (&Apache::slotrequest::network_error($result_del_stat)) {  
  return (0,&mt('Message copied, but unable to delete the original status from the source folder.'));  
     }  
   
     return (1);  
 }  
   
 # ======================================================= Display a course list  
   
 sub discourse {  
     my $r=shift;  
     my $classlist = &Apache::loncoursedata::get_classlist();  
     my $now=time;  
     my %lt=&Apache::lonlocal::texthash('cfa' => 'Check All',  
             'cfs' => 'Check Section/Group',  
             'cfn' => 'Uncheck All');  
     $r->print(<<ENDDISHEADER);  
 <input type="hidden" name="sendmode" value="group" />  
 <script>  
     function checkall() {  
  for (i=0; i<document.forms.compemail.elements.length; i++) {  
             if   
           (document.forms.compemail.elements[i].name.indexOf('send_to_')==0) {  
       document.forms.compemail.elements[i].checked=true;  
             }  
         }  
     }  
   
     function checksec() {  
  for (i=0; i<document.forms.compemail.elements.length; i++) {  
             if   
           (document.forms.compemail.elements[i].name.indexOf  
            ('send_to_&&&'+document.forms.compemail.chksec.value)==0) {  
       document.forms.compemail.elements[i].checked=true;  
             }  
         }  
     }  
   
     function uncheckall() {  
  for (i=0; i<document.forms.compemail.elements.length; i++) {  
             if   
           (document.forms.compemail.elements[i].name.indexOf('send_to_')==0) {  
       document.forms.compemail.elements[i].checked=false;  
             }  
         }  
     }  
 </script>  
 <input type="button" onClick="checkall()" value="$lt{'cfa'}" />&nbsp;  
 <input type="button" onClick="checksec()" value="$lt{'cfs'}" />  
 <input type="text" size="5" name="chksec" />&nbsp;  
 <input type="button" onClick="uncheckall()" value="$lt{'cfn'}" />  
 <p>  
 ENDDISHEADER  
     my %coursepersonnel=&Apache::lonnet::get_course_adv_roles();  
     $r->print('<table>');  
     foreach my $role (sort keys %coursepersonnel) {  
         foreach (split(/\,/,$coursepersonnel{$role})) {  
             my ($puname,$pudom)=split(/\:/,$_);  
             $r->print('<tr><td><label>'.  
                       '<input type="checkbox" name="send_to_&&&&&&_'.  
                       $puname.':'.$pudom.'" /> '.  
                       &Apache::loncommon::plainname($puname,$pudom).  
                       '</label></td>'.  
                       '<td>('.$_.'),</td><td><i>'.$role.'</i></td></tr>');  
         }  
     }  
     $r->print('</table><table>');  
     my $sort = sub {  
  my $aname=lc($classlist->{$a}[&Apache::loncoursedata::CL_FULLNAME()]);  
  if (!$aname) { $aname=$a; }  
  my $bname=lc($classlist->{$b}[&Apache::loncoursedata::CL_FULLNAME()]);  
  if (!$bname) { $bname=$b; }  
  return $aname cmp $bname;  
     };  
     foreach my $student (sort $sort (keys(%{$classlist}))) {  
  my $info=$classlist->{$student};  
         my ($sname,$sdom,$status,$fullname,$section) =  
             (@{$info}[&Apache::loncoursedata::CL_SNAME(),  
                       &Apache::loncoursedata::CL_SDOM(),  
                       &Apache::loncoursedata::CL_STATUS(),  
                       &Apache::loncoursedata::CL_FULLNAME(),  
                       &Apache::loncoursedata::CL_SECTION()]);  
         next if ($status ne 'Active');  
  next if ($env{'request.course.sec'} &&  
  $section ne $env{'request.course.sec'});  
         my $key = 'send_to_&&&'.$section.'&&&_'.$student;  
         if (! defined($fullname) || $fullname eq '') { $fullname = $sname; }  
         $r->print('<tr><td><label>'.  
                   qq{<input type="checkbox" name="$key" />}.('&nbsp;'x2).  
                   $fullname.'</label></td><td>'.$sname.'@'.$sdom.'</td><td>'.$section.  
                   '</td></tr>');  
     }  
     $r->print('</table>');  
 }  
   
 # ==================================================== Display Critical Message  
   
 sub discrit {  
     my $r=shift;  
     my $header = '<h1><font color=red>'.&mt('Critical Messages').'</font></h1>'.  
         '<form action="/adm/email" method="POST">'.  
         '<input type="hidden" name="confirm" value="true" />';  
     my %what=&Apache::lonnet::dump('critical');  
     my $result = '';  
     foreach (sort keys %what) {  
         my %content=&unpackagemsg($what{$_});  
         next if ($content{'senderdomain'} eq '');  
         $result.='<hr />'.&mt('From').': <b>'.  
 &Apache::loncommon::aboutmewrapper(  
  &Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).'</b> ('.  
 $content{'sendername'}.'@'.  
             $content{'senderdomain'}.') '.$content{'time'}.  
             '<br />'.&mt('Subject').': '.$content{'subject'}.  
             '<br /><pre>'.  
               &Apache::lontexconvert::msgtexconverted($content{'message'}).  
             '</pre><small>'.  
 &mt('You have to confirm that you received this message. After confirmation, this message will be moved to your regular inbox').  
             '</small><br />'.  
             '<input type="submit" name="rec_'.$_.'" value="'.&mt('Confirm Receipt').'" />'.  
             '<input type="submit" name="reprec_'.$_.'" '.  
                   'value="'.&mt('Confirm Receipt and Reply').'" />';  
     }  
     # Check to see if there were any messages.  
     if ($result eq '') {  
         $result = "<h2>".&mt('You have no critical messages.')."</h2>".  
     '<a href="/adm/roles">'.&mt('Select a course').'</a><br />'.  
             '<a href="/adm/email">'.&mt('Communicate').'</a>';  
     } else {  
         $r->print($header);  
     }  
     $r->print($result);  
     $r->print('<input type="hidden" name="displayedcrit" value="true" /></form>');  
 }  
   
 sub sortedmessages {  
     my ($blocked,$startblock,$endblock,$numblocked,$folder) = @_;  
     my $suffix=&foldersuffix($folder);  
     my @messages = &Apache::lonnet::getkeys('nohist_email'.$suffix);  
     #unpack the varibles and repack into temp for sorting  
     my @temp;  
     my %descriptions;  
     my %status_cache =   
  &Apache::lonnet::get('email_status'.&foldersuffix($folder),\@messages);  
     foreach (@messages) {  
  my $msgid=&Apache::lonnet::escape($_);  
  my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid)=  
     &Apache::lonmsg::unpackmsgid($msgid,$folder,undef,  
  \%status_cache);  
         my $description = &get_course_desc($fromcid,\%descriptions);  
  my @temp1 = ($sendtime,$shortsubj,$fromname,$fromdomain,$status,  
      $msgid,$description);  
         # Check whether message was sent during blocking period.  
         if ($sendtime >= $startblock && ($sendtime <= $endblock && $endblock > 0) ) {  
             my $escid = &Apache::lonnet::unescape($msgid);  
             $$blocked{$escid} = 'ON';  
             $$numblocked ++;  
         } else {   
             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 "course"){  
         @temp = sort  {lc($a->[6]) cmp lc($b->[6])} @temp;  
     }  
     if ($env{'form.sortedby'} eq "revcourse"){  
         @temp = sort  {lc($b->[6]) cmp lc($a->[6])} @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;  
 }  
   
 sub get_course_desc {  
     my ($fromcid,$descriptions) = @_;  
     my $description;  
     if (!$fromcid) {  
         return $description;  
     } else {  
         if (defined($$descriptions{$fromcid})) {  
             $description = $$descriptions{$fromcid};  
         } else {  
             if (defined($env{'course.'.$fromcid.'.description'})) {  
                 $description = $env{'course.'.$fromcid.'.description'};  
             } else {  
                 my %courseinfo=&Apache::lonnet::coursedescription($fromcid);                $description = $courseinfo{'description'};  
                 $description = $courseinfo{'description'};  
             }  
             $$descriptions{$fromcid} = $description;  
         }  
         return $description;  
     }  
 }  
   
 # ======================================================== Display new messages  
   
   
 sub disnew {  
     my $r=shift;  
     my %lt=&Apache::lonlocal::texthash(  
        'nm' => 'New Messages',  
        'su' => 'Subject',  
                                        'co' => 'Course',  
        'da' => 'Date',  
        'us' => 'Username',  
        'op' => 'Open',  
        'do' => 'Domain'  
        );  
     my @msgids = sort(&Apache::lonnet::getkeys('nohist_email'));  
     my @newmsgs;  
     my %setters = ();  
     my $startblock = 0;  
     my $endblock = 0;  
     my %blocked = ();  
     my $numblocked = 0;  
     # Check for blocking of display because of scheduled online exams.  
     &blockcheck(\%setters,\$startblock,\$endblock);  
     my %status_cache =   
  &Apache::lonnet::get('email_status',\@msgids);  
     my %descriptions;  
     foreach (@msgids) {  
  my $msgid=&Apache::lonnet::escape($_);  
         my ($sendtime,$shortsubj,$fromname,$fromdom,$status,$fromcid)=  
     &Apache::lonmsg::unpackmsgid($msgid,undef,undef,\%status_cache);  
         if (defined($sendtime) && $sendtime!~/error/) {  
             my $description = &get_course_desc($fromcid,\%descriptions);  
             my $numsendtime = $sendtime;  
             $sendtime = &Apache::lonlocal::locallocaltime($sendtime);  
             if ($status eq 'new') {  
                 if ($numsendtime >= $startblock && ($numsendtime <= $endblock && $endblock > 0) ) {  
                     $blocked{$_} = 'ON';  
                     $numblocked ++;  
                 } else {  
                     push @newmsgs, {   
                         msgid    => $msgid,  
                         sendtime => $sendtime,  
                         shortsub => &Apache::lonnet::unescape($shortsubj),  
                         from     => $fromname,  
                         fromdom  => $fromdom,  
                         course   => $description   
                         }  
                 }  
             }  
         }  
     }  
     if ($#newmsgs >= 0) {  
         $r->print(<<TABLEHEAD);  
 <h2>$lt{'nm'}</h2>  
 <table border=2><tr><th>&nbsp</th>  
 <th>$lt{'da'}</th><th>$lt{'us'}</th><th>$lt{'do'}</th><th>$lt{'su'}</th><th>$lt{'co'}</th></tr>  
 TABLEHEAD  
         foreach my $msg (@newmsgs) {  
             $r->print(<<"ENDLINK");  
 <tr class="new" bgcolor="#FFBB77" onMouseOver="javascript:style.backgroundColor='#DD9955'"   
 onMouseOut="javascript:style.backgroundColor='#FFBB77'">  
 <td><a href="/adm/email?dismode=new&display=$msg->{'msgid'}">$lt{'op'}</a></td>  
 ENDLINK  
             foreach ('sendtime','from','fromdom','shortsub','course') {  
                 $r->print("<td>$msg->{$_}</td>");  
             }  
             $r->print("</td></tr>");  
         }  
         $r->print('</table>'.&Apache::loncommon::endbodytag().'</html>');  
     } elsif ($numblocked == 0) {  
         $r->print("<h3>".&mt('You have no unread messages')."</h3>");  
     }  
     if ($numblocked > 0) {  
         my $beginblock = &Apache::lonlocal::locallocaltime($startblock);  
         my $finishblock = &Apache::lonlocal::locallocaltime($endblock);  
         if ($numblocked == 1) {  
             $r->print("<h3>".&mt('You have').' '.$numblocked.' '.&mt('blocked unread message').".</h3>");  
             $r->print(&mt('This message is not viewable because').' ');  
         } else {  
             $r->print("<h3>".&mt('You have').' '.$numblocked.' '.&mt('blocked unread messages').".</h3>");  
             $r->print(&mt('These').' '.$numblocked.' '.&mt('messages are not viewable because '));  
         }  
         $r->print(  
 &mt('display of LON-CAPA messages sent to you by other students between').' '.$beginblock.' '.&mt('and').' '.$finishblock.' '.&mt('is currently being blocked because of online exams').'.');  
         &build_block_table($r,$startblock,$endblock,\%setters);  
     }  
 }  
   
   
 # ======================================================== Display all messages  
   
 sub disall {  
     my ($r,$folder)=@_;  
     $r->print(&folderlist($folder));  
     if ($folder eq 'new') {  
  &disnew($r);  
     } elsif ($folder eq 'critical') {  
  &discrit($r);  
     } else {  
  &disfolder($r,$folder);  
     }  
 }  
   
 # ============================================================ Display a folder  
   
 sub disfolder {  
     my ($r,$folder)=@_;  
     my %blocked = ();  
     my %setters = ();  
     my $startblock;  
     my $endblock;  
     my $numblocked = 0;  
     &blockcheck(\%setters,\$startblock,\$endblock);  
     $r->print(<<ENDDISHEADER);  
 <script>  
     function checkall() {  
  for (i=0; i<document.forms.disall.elements.length; i++) {  
             if   
           (document.forms.disall.elements[i].name.indexOf('delmark_')==0) {  
       document.forms.disall.elements[i].checked=true;  
             }  
         }  
     }  
   
     function uncheckall() {  
  for (i=0; i<document.forms.disall.elements.length; i++) {  
             if   
           (document.forms.disall.elements[i].name.indexOf('delmark_')==0) {  
       document.forms.disall.elements[i].checked=false;  
             }  
         }  
     }  
 </script>  
 ENDDISHEADER  
     my $fsqs='&folder='.$folder;  
     my @temp=sortedmessages(\%blocked,$startblock,$endblock,\$numblocked,$folder);  
     my $totalnumber=$#temp+1;  
     unless ($totalnumber>0) {  
  $r->print('<h2>'.&mt('Empty Folder').'</h2>');  
  return;  
     }  
     unless ($interdis) {  
  $interdis=20;  
     }  
     my $number=int($totalnumber/$interdis);  
     if (($startdis<0) || ($startdis>$number)) { $startdis=$number; }  
     my $firstdis=$interdis*$startdis;  
     if ($firstdis>$#temp) { $firstdis=$#temp-$interdis+1; }  
     my $lastdis=$firstdis+$interdis-1;  
     if ($lastdis>$#temp) { $lastdis=$#temp; }  
     $r->print(&scrollbuttons($startdis,$number,$firstdis,$lastdis,$totalnumber));  
     $r->print('<form method="post" name="disall" action="/adm/email">'.  
       '<table border=2><tr><th colspan="3">&nbsp</th><th>');  
     if ($env{'form.sortedby'} eq "revdate") {  
  $r->print('<a href = "?sortedby=date'.$fsqs.'">'.&mt('Date').'</a></th>');  
     } else {  
  $r->print('<a href = "?sortedby=revdate'.$fsqs.'">'.&mt('Date').'</a></th>');  
     }  
     $r->print('<th>');  
     if ($env{'form.sortedby'} eq "revuser") {  
  $r->print('<a href = "?sortedby=user'.$fsqs.'">'.&mt('Username').'</a>');  
     } else {  
  $r->print('<a href = "?sortedby=revuser'.$fsqs.'">'.&mt('Username').'</a>');  
     }  
     $r->print('</th><th>');  
     if ($env{'form.sortedby'} eq "revdomain") {  
  $r->print('<a href = "?sortedby=domain'.$fsqs.'">'.&mt('Domain').'</a>');  
     } else {  
  $r->print('<a href = "?sortedby=revdomain'.$fsqs.'">'.&mt('Domain').'</a>');  
     }  
     $r->print('</th><th>');  
     if ($env{'form.sortedby'} eq "revsubject") {  
  $r->print('<a href = "?sortedby=subject'.$fsqs.'">'.&mt('Subject').'</a>');  
     } else {  
     $r->print('<a href = "?sortedby=revsubject'.$fsqs.'">'.&mt('Subject').'</a>');  
     }  
     $r->print('</th><th>');  
     if ($env{'form.sortedby'} eq "revcourse") {  
         $r->print('<a href = "?sortedby=course'.$fsqs.'">'.&mt('Course').'</a>');  
     } else {  
         $r->print('<a href = "?sortedby=revcourse'.$fsqs.'">'.&mt('Course').'</a>');  
     }  
     $r->print('</th><th>');  
     if ($env{'form.sortedby'} eq "revstatus") {  
  $r->print('<a href = "?sortedby=status'.$fsqs.'">'.&mt('Status').'</a></th>');  
     } else {  
       $r->print('<a href = "?sortedby=revstatus'.$fsqs.'">'.&mt('Status').'</a></th>');  
     }  
     $r->print("</tr>\n");  
     for (my $n=$firstdis;$n<=$lastdis;$n++) {  
  my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$origID,$description)= @{$temp[$n]};  
  if (($status ne 'deleted') && defined($sendtime) && $sendtime!~/error/) {  
     if ($status eq 'new') {  
  $r->print('<tr bgcolor="#FFBB77" onMouseOver="javascript:style.backgroundColor=\'#DD9955\'"  onMouseOut="javascript:style.backgroundColor=\'#FFBB77\'">');  
     } elsif ($status eq 'read') {  
  $r->print('<tr bgcolor="#BBBB77" onMouseOver="javascript:style.backgroundColor=\'#999944\'"  onMouseOut="javascript:style.backgroundColor=\'#BBBB77\'">');  
     } elsif ($status eq 'replied') {  
  $r->print('<tr bgcolor="#AAAA88" onMouseOver="javascript:style.backgroundColor=\'#888855\'"  onMouseOut="javascript:style.backgroundColor=\'#AAAA88\'">');   
     } else {  
  $r->print('<tr bgcolor="#99BBBB" onMouseOver="javascript:style.backgroundColor=\'#669999\'"  onMouseOut="javascript:style.backgroundColor=\'#99BBBB\'">');  
     }  
     $r->print('<td><input type="checkbox" name="delmark_'.$origID.'" /></td><td><a href="/adm/email?display='.$origID.$sqs.   
       '">'.&mt('Open').'</a></td><td>'.  
       ($folder ne 'trash'?'<a href="/adm/email?markdel='.$origID.$sqs.  
       '">'.&mt('Delete'):'&nbsp').'</a></td>'.  
       '<td>'.&Apache::lonlocal::locallocaltime($sendtime).'</td><td>'.  
       $fromname.'</td><td>'.$fromdomain.'</td><td>'.  
       &Apache::lonnet::unescape($shortsubj).'</td><td>'.  
                       $description.'</td><td>'.$status.'</td></tr>'."\n");  
  } elsif ($status eq 'deleted') {  
 # purge  
     my ($result,$msg) =   
  &movemsg(&Apache::lonnet::unescape($origID),$folder,'trash');  
       
  }  
     }     
     $r->print("</table>\n<p>".  
   '<a href="javascript:checkall()">'.&mt('Check All').'</a>&nbsp;'.  
   '<a href="javascript:uncheckall()">'.&mt('Uncheck All').'</a></p>'.  
   '<input type="hidden" name="sortedby" value="'.$env{'form.sortedby'}.'" />');  
     if ($folder ne 'trash') {  
  $r->print(  
       '<p><input type="submit" name="markeddel" value="'.&mt('Delete Checked').'" /></p>');  
     }  
     $r->print('<p><input type="submit" name="markedmove" value="'.&mt('Move Checked to Folder').'" />');  
     my @allfolders=&Apache::lonnet::getkeys('email_folders');  
     if ($allfolders[0]=~/^error:/) { @allfolders=(); }  
     $r->print(  
  &Apache::loncommon::select_form('','movetofolder',  
      ( map { $_ => $_ } @allfolders))  
       );  
     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'}.'" /></form>');  
     if ($numblocked > 0) {  
         my $beginblock = &Apache::lonlocal::locallocaltime($startblock);  
         my $finishblock = &Apache::lonlocal::locallocaltime($endblock);  
         $r->print('<br /><br />'.  
                   $numblocked.' '.&mt('message(s) is/are not viewable because display of LON-CAPA messages sent to you by other students between').' '.$beginblock.' '.&mt('and').' '.$finishblock.' '.&mt('is currently being blocked because of online exams.'));  
         &build_block_table($r,$startblock,$endblock,\%setters);  
     }  
 }  
   
 # ============================================================== Compose output  
   
 sub compout {  
     my ($r,$forwarding,$replying,$broadcast,$replycrit,$folder,$dismode)=@_;  
     my $suffix=&foldersuffix($folder);  
   
     if ($broadcast eq 'individual') {  
  &printheader($r,'/adm/email?compose=individual',  
      'Send a Message');  
     } elsif ($broadcast) {  
  &printheader($r,'/adm/email?compose=group',  
      'Broadcast Message');  
     } elsif ($forwarding) {  
  &Apache::lonhtmlcommon::add_breadcrumb  
         ({href=>"/adm/email?display=".&Apache::lonnet::escape($forwarding),  
           text=>"Display Message"});  
  &printheader($r,'/adm/email?forward='.&Apache::lonnet::escape($forwarding),  
      'Forwarding a Message');  
     } elsif ($replying) {  
  &Apache::lonhtmlcommon::add_breadcrumb  
         ({href=>"/adm/email?display=".&Apache::lonnet::escape($replying),  
           text=>"Display Message"});  
  &printheader($r,'/adm/email?replyto='.&Apache::lonnet::escape($replying),  
      'Replying to a Message');  
     } elsif ($replycrit) {  
  $r->print('<h3>'.&mt('Replying to a Critical Message').'</h3>');  
  $replying=$replycrit;  
     } else {  
  &printheader($r,'/adm/email?compose=upload',  
      'Distribute from Uploaded File');  
     }  
   
     my $dispcrit='';  
     my $dissub='';  
     my $dismsg='';  
     my $disbase='';  
     my $func=&mt('Send New');  
     my %lt=&Apache::lonlocal::texthash('us' => 'Username',  
        'do' => 'Domain',  
        'ad' => 'Additional Recipients',  
        'sb' => 'Subject',  
        'ca' => 'Cancel',  
        'ma' => 'Mail');  
   
     if (&Apache::lonnet::allowed('srm',$env{'request.course.id'})  
  || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.  
     '/'.$env{'request.course.sec'})) {  
  my $crithelp = Apache::loncommon::help_open_topic("Course_Critical_Message");  
          $dispcrit=  
  '<p><label><input type="checkbox" name="critmsg" /> '.&mt('Send as critical message').'</label> ' . $crithelp .   
  '</p><p>'.  
  '<label><input type="checkbox" name="sendbck" /> '.&mt('Send as critical message').'  ' .  
  &mt('and return receipt') . '</label>' . $crithelp .   
  '</p><p><label><input type="checkbox" name="permanent" /> '.  
 &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>-->';      }  
     my %message;  
     my %content;  
     my $defdom=$env{'user.domain'};  
     if ($forwarding) {  
  %message=&Apache::lonnet::get('nohist_email'.$suffix,[$forwarding]);  
  %content=&unpackagemsg($message{$forwarding},$folder);  
  $dispcrit.='<input type="hidden" name="forwid" value="'.  
     $forwarding.'" />';  
  $func=&mt('Forward');  
   
  $dissub=&mt('Forwarding').': '.$content{'subject'};  
  $dismsg=&mt('Forwarded message from').' '.  
     $content{'sendername'}.' '.&mt('at').' '.$content{'senderdomain'};  
  if ($content{'baseurl'}) {  
     $disbase='<input type="hidden" name="baseurl" value="'.&Apache::lonnet::escape($content{'baseurl'}).'" />';  
  }  
     }  
     if ($replying) {  
  %message=&Apache::lonnet::get('nohist_email'.$suffix,[$replying]);  
  %content=&unpackagemsg($message{$replying},$folder);  
  $dispcrit.='<input type="hidden" name="replyid" value="'.  
     $replying.'" />';  
  $func=&mt('Send Reply to');  
   
  $dissub=&mt('Reply').': '.$content{'subject'};         
  $dismsg='> '.$content{'message'};  
  $dismsg=~s/\r/\n/g;  
  $dismsg=~s/\f/\n/g;  
  $dismsg=~s/\n+/\n\> /g;  
  if ($content{'baseurl'}) {  
     $disbase='<input type="hidden" name="baseurl" value="'.&Apache::lonnet::escape($content{'baseurl'}).'" />';  
     if ($env{'user.adv'}) {  
  $disbase.='<label><input type="checkbox" name="storebasecomment" />'.&mt('Store message for re-use').  
     '</label> <a href="/adm/email?showcommentbaseurl='.  
     &Apache::lonnet::escape($content{'baseurl'}).'" target="comments">'.  
     &mt('Show re-usable messages').'</a><br />';  
     }  
  }  
     }  
     my $citation=&displayresource(%content);  
     if ($env{'form.recdom'}) { $defdom=$env{'form.recdom'}; }  
       $r->print(  
                 '<form action="/adm/email"  name="compemail" method="post"'.  
                 ' enctype="multipart/form-data">'."\n".  
                 '<input type="hidden" name="sendmail" value="on" />'."\n".  
                 '<table>');  
     unless (($broadcast eq 'group') || ($broadcast eq 'upload')) {  
  if ($replying) {  
     $r->print('<tr><td colspan="2">'.&mt('Replying to').' '.  
       &Apache::loncommon::aboutmewrapper(  
  &Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).' ('.  
       $content{'sendername'}.'@'.  
       $content{'senderdomain'}.')'.  
       '<input type="hidden" name="recuname" value="'.$content{'sendername'}.'" />'.  
       '<input type="hidden" name="recdomain" value="'.$content{'senderdomain'}.'" />'.  
       '</td></tr>');  
  } else {  
     my $domform = &Apache::loncommon::select_dom_form($defdom,'recdomain');  
     my $selectlink=&Apache::loncommon::selectstudent_link  
     ('compemail','recuname','recdomain');  
     $r->print(<<"ENDREC");  
 <tr><td>$lt{'us'}:</td><td><input type="text" size="12" name="recuname" value="$env{'form.recname'}" /></td><td rowspan="2">$selectlink</td></tr>  
 <tr><td>$lt{'do'}:</td>  
 <td>$domform</td></tr>  
 ENDREC  
         }  
     }  
     my $latexHelp = Apache::loncommon::helpLatexCheatsheet();  
     if ($broadcast ne 'upload') {  
        $r->print(<<"ENDCOMP");  
 <tr><td>$lt{'ad'}<br /><tt>username\@domain,username\@domain, ...  
 </tt></td><td>  
 <input type="text" size="50" name="additionalrec" /></td></tr>  
 <tr><td>$lt{'sb'}:</td><td><input type="text" size="50" name="subject" value="$dissub" />  
 </td></tr></table>  
 $latexHelp  
 <textarea name="message" id="message" cols="80" rows="15" wrap="hard">$dismsg  
 </textarea></p><br />  
 $dispcrit  
 $disbase  
 <input type="hidden" name="folder" value="$folder" />  
 <input type="hidden" name="dismode" value="$dismode" />  
 <input type="submit" name="send" value="$func $lt{'ma'}" />  
 <input type="submit" name="cancel" value="$lt{'ca'}" /><hr />  
 $citation  
 ENDCOMP  
     } else { # $broadcast is 'upload'  
  $r->print(<<ENDUPLOAD);  
 <input type="hidden" name="sendmode" value="upload" />  
 <input type="hidden" name="send" value="on" />  
 <h3>Generate messages from a file</h3>  
 <p>  
 Subject: <input type="text" size="50" name="subject" />  
 </p>  
 <p>General message text<br />  
 <textarea name="message" id="message" cols="60" rows="10" wrap="hard">$dismsg  
 </textarea></p>  
 <p>  
 The file format for the uploaded portion of the message is:  
 <pre>  
 username1\@domain1: text  
 username2\@domain2: text  
 username3\@domain1: text  
 </pre>  
 </p>  
 <p>  
 The messages will be assembled from all lines with the respective   
 <tt>username\@domain</tt>, and appended to the general message text.</p>  
 <p>  
 <input type="file" name="upfile" size="40" /></p><p>  
 $dispcrit  
 <input type="submit" value="Upload and Send" /></p>  
 ENDUPLOAD  
     }  
     if ($broadcast eq 'group') {  
        &discourse($r);  
     }  
     $r->print('</form>'.  
       &Apache::lonfeedback::generate_preview_button('compemail','message').  
       &Apache::lonhtmlcommon::htmlareaselectactive('message'));  
 }  
   
 # ---------------------------------------------------- Display all face to face  
   
 sub retrieve_instructor_comments {  
     my ($user,$domain)=@_;  
     my $target=$env{'form.grade_target'};  
     if (! $env{'request.course.id'}) { return; }  
     if (! &Apache::lonnet::allowed('srm',$env{'request.course.id'})  
  && ! &Apache::lonnet::allowed('srm',$env{'request.course.id'}.  
       '/'.$env{'request.course.sec'})) {  
  return;  
     }  
     my %records=&Apache::lonnet::dump('nohist_email',  
  $env{'course.'.$env{'request.course.id'}.'.domain'},  
  $env{'course.'.$env{'request.course.id'}.'.num'},  
                          '%255b'.$user.'%253a'.$domain.'%255d');  
     my $result='';  
     foreach (sort(keys(%records))) {  
         my %content=&unpackagemsg($records{$_});  
         next if ($content{'senderdomain'} eq '');  
         next if ($content{'subject'} !~ /^Record/);  
  # &Apache::lonfeedback::newline_to_br(\$content{'message'});  
  $result.='Recorded by '.  
             $content{'sendername'}.'@'.$content{'senderdomain'}."\n";  
         $result.=  
             &Apache::lontexconvert::msgtexconverted($content{'message'})."\n";  
      }  
     return $result;  
 }  
   
 sub disfacetoface {  
     my ($r,$user,$domain)=@_;  
     my $target=$env{'form.grade_target'};  
     unless ($env{'request.course.id'}) { return; }  
     if  (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})  
  && ! &Apache::lonnet::allowed('srm',$env{'request.course.id'}.  
        '/'.$env{'request.course.sec'})) {  
  $r->print('Not allowed');  
  return;  
     }  
     my %records=&Apache::lonnet::dump('nohist_email',  
  $env{'course.'.$env{'request.course.id'}.'.domain'},  
  $env{'course.'.$env{'request.course.id'}.'.num'},  
                          '%255b'.$user.'%253a'.$domain.'%255d');  
     my $result='';  
     foreach (sort keys %records) {  
         my %content=&unpackagemsg($records{$_});  
         next if ($content{'senderdomain'} eq '');  
  &Apache::lonfeedback::newline_to_br(\$content{'message'});  
         if ($content{'subject'}=~/^Record/) {  
     $result.='<h3>'.&mt('Record').'</h3>';  
         } elsif ($content{'subject'}=~/^Broadcast/) {  
             $result .='<h3>'.&mt('Broadcast Message').'</h3>';  
             if ($content{'subject'}=~/^Broadcast\./) {  
                 %content=&unpackagemsg($content{'message'});  
                 $content{'message'}=  
                     '<b>'.&mt('Subject').': '.$content{'subject'}.'</b><br />'.  
                     $content{'message'};  
             }      
         } else {  
             $result.='<h3>'.&mt('Critical Message').'</h3>';  
             %content=&unpackagemsg($content{'message'});  
             $content{'message'}=  
                 '<b>'.&mt('Subject').': '.$content{'subject'}.'</b><br />'.  
  $content{'message'};  
         }  
         $result.=&mt('By').': <b>'.  
 &Apache::loncommon::aboutmewrapper(  
  &Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).'</b> ('.  
 $content{'sendername'}.'@'.  
             $content{'senderdomain'}.') '.$content{'time'}.  
             '<br /><pre>'.  
               &Apache::lontexconvert::msgtexconverted($content{'message'}).  
       '</pre>';  
      }  
     # Check to see if there were any messages.  
     if ($result eq '') {  
  if ($target ne 'tex') {   
     $r->print("<p><b>".&mt("No notes, face-to-face discussion records, critical messages, or broadcast messages in this course.")."</b></p>");  
  } else {  
     $r->print('\textbf{'.&mt("No notes, face-to-face discussion records, critical messages or broadcast messages in this course.").'}\\\\');  
  }  
     } else {  
        $r->print($result);  
     }  
 }  
   
 # ---------------------------------------------------------------- Face to face  
   
 sub facetoface {  
     my ($r,$stage)=@_;  
     if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})  
  && ! &Apache::lonnet::allowed('srm',$env{'request.course.id'}.  
       '/'.$env{'request.course.sec'})) {  
  $r->print('Not allowed');  
  return;  
     }  
     &printheader($r,  
  '/adm/email?recordftf=query',  
  "User Notes, Face-to-Face, Critical Messages, Broadcast Messages");  
 # from query string  
   
     if ($env{'form.recname'}) { $env{'form.recuname'}=$env{'form.recname'}; }  
     if ($env{'form.recdom'}) { $env{'form.recdomain'}=$env{'form.recdom'}; }  
   
     my $defdom=$env{'user.domain'};  
 # already filled in  
     if ($env{'form.recdomain'}) { $defdom=$env{'form.recdomain'}; }  
 # generate output  
     my $domform = &Apache::loncommon::select_dom_form($defdom,'recdomain');  
     my $stdbrws = &Apache::loncommon::selectstudent_link  
  ('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 Course',  
        'subm' => 'Retrieve discussion and message records',  
        'newr' => 'New Record (record is visible to course faculty and staff)',  
        'post' => 'Post this Record');  
     $r->print(<<"ENDTREC");  
 <h3>$lt{'head'}</h3>  
 <form method="post" action="/adm/email" name="stdselect">  
 <input type="hidden" name="recordftf" value="retrieve" />  
 <table>  
 <tr><td>$lt{'user'}:</td><td><input type="text" size="12" name="recuname" value="$env{'form.recuname'}" /></td>  
 <td rowspan="2">  
 $stdbrws  
 <input type="submit" value="$lt{'subm'}" /></td>  
 </tr>  
 <tr><td>$lt{'dom'}:</td>  
 <td>$domform</td></tr>  
 </table>  
 </form>  
 ENDTREC  
     if (($stage ne 'query') &&  
         ($env{'form.recdomain'}) && ($env{'form.recuname'})) {  
         chomp($env{'form.newrecord'});  
         if ($env{'form.newrecord'}) {  
            my $recordtxt = $env{'form.newrecord'};  
            &user_normal_msg_raw(  
             $env{'course.'.$env{'request.course.id'}.'.num'},  
             $env{'course.'.$env{'request.course.id'}.'.domain'},  
             &mt('Record').  
      ' ['.$env{'form.recuname'}.':'.$env{'form.recdomain'}.']',  
     $recordtxt);  
         }  
         $r->print('<h3>'.&Apache::loncommon::plainname($env{'form.recuname'},  
      $env{'form.recdomain'}).'</h3>');  
         &disfacetoface($r,$env{'form.recuname'},$env{'form.recdomain'});  
  $r->print(<<ENDRHEAD);  
 <form method="post" action="/adm/email">  
 <input name="recdomain" value="$env{'form.recdomain'}" type="hidden" />  
 <input name="recuname" value="$env{'form.recuname'}" type="hidden" />  
 ENDRHEAD  
         $r->print(<<ENDBFORM);  
 <hr />$lt{'newr'}<br />  
 <textarea name="newrecord" cols="80" rows="10" wrap="hard"></textarea>  
 <br />  
 <input type="hidden" name="recordftf" value="post" />  
 <input type="submit" value="$lt{'post'}" />  
 </form>  
 ENDBFORM  
     }  
 }  
   
 # ----------------------------------------------------------- Blocking during exams  
   
 sub examblock {  
     my ($r,$action) = @_;  
     unless ($env{'request.course.id'}) { return;}  
     if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})  
  && ! &Apache::lonnet::allowed('srm',$env{'request.course.id'}.  
       '/'.$env{'request.course.sec'})) {  
  $r->print('Not allowed');  
  return;  
     }  
     my %lt=&Apache::lonlocal::texthash(  
             'comb' => 'Communication Blocking',  
             'cbds' => 'Communication blocking during scheduled exams',  
             'desc' => 'You can use communication blocking to prevent students enrolled in this course from displaying LON-CAPA messages sent by other students during an online exam. As blocking of communication could potentially interrupt legitimate communication between students 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'  
     );  
   
     my %ltext = &Apache::lonlocal::texthash(  
             'dura' => 'Duration',  
             'setb' => 'Set by',  
             'even' => 'Event',  
             'actn' => 'Action',  
             'star' => 'Start',  
             'endd' => 'End'  
     );  
   
     &printheader($r,'/adm/email?block=display',$lt{'comb'});  
     $r->print('<h3>'.$lt{'cbds'}.'</h3>');  
   
     if ($action eq 'store') {  
         &blockstore($r);  
     }  
   
     $r->print($lt{'desc'}.'<br /><br />  
                <form name="blockform" method="post" action="/adm/email?block=store">  
              ');  
   
     $r->print('<h4>'.$lt{'mecb'}.'</h4>');  
     my %records = ();  
     my $blockcount = 0;  
     my $parmcount = 0;  
     &get_blockdates(\%records,\$blockcount);  
     if ($blockcount > 0) {  
         $parmcount = &display_blocker_status($r,\%records,\%ltext);  
     } else {  
         $r->print($lt{'ncbc'}.'<br /><br />');  
     }  
     &display_addblocker_table($r,$parmcount,\%ltext);  
     my $endbody=&Apache::loncommon::endbodytag();  
     $r->print(<<"END");  
 <br />  
 <input type="hidden" name="blocktotal" value="$blockcount" />  
 <input type ="submit" value="Save Changes" />  
 </form>  
 $endbody  
 </html>  
 END  
     return;  
 }  
   
 sub blockstore {  
     my $r = shift;  
     my %lt=&Apache::lonlocal::texthash(  
             'tfcm' => 'The following changes were made',  
             'cbps' => 'communication blocking period(s)',  
             'werm' => 'was/were removed',  
             'wemo' => 'was/were modified',  
             'wead' => 'was/were added',  
             'ncwm' => 'No changes were made.'   
     );  
     my %adds = ();  
     my %removals = ();  
     my %cancels = ();  
     my $modtotal = 0;  
     my $canceltotal = 0;  
     my $addtotal = 0;  
     my %blocking = ();  
     $r->print('<h3>'.$lt{'head'}.'</h3>');  
     foreach (keys %env) {  
         if ($_ =~ m/^form\.modify_(\w+)$/) {  
             $adds{$1} = $1;  
             $removals{$1} = $1;  
             $modtotal ++;  
         } elsif ($_ =~ m/^form\.cancel_(\d+)$/) {  
             $cancels{$1} = $1;  
             unless ( defined($removals{$1}) ) {  
                 $removals{$1} = $1;  
                 $canceltotal ++;  
             }  
         } elsif ($_ =~ m/^form\.add_(\d+)$/) {  
             $adds{$1} = $1;  
             $addtotal ++;  
         }  
     }  
   
     foreach (keys %removals) {  
         my $hashkey = $env{'form.key_'.$_};  
         &Apache::lonnet::del('comm_block',["$hashkey"],  
                          $env{'course.'.$env{'request.course.id'}.'.domain'},  
                          $env{'course.'.$env{'request.course.id'}.'.num'}  
                          );  
     }  
     foreach (keys %adds) {  
         unless ( defined($cancels{$_}) ) {  
             my ($newstart,$newend) = &get_dates_from_form($_);  
             my $newkey = $newstart.'____'.$newend;  
             $blocking{$newkey} = $env{'user.name'}.'@'.$env{'user.domain'}.':'.$env{'form.title_'.$_};  
         }  
     }  
     if ($addtotal + $modtotal > 0) {  
         &Apache::lonnet::put('comm_block',\%blocking,  
                      $env{'course.'.$env{'request.course.id'}.'.domain'},  
                      $env{'course.'.$env{'request.course.id'}.'.num'}  
                      );  
     }  
     my $chgestotal = $canceltotal + $modtotal + $addtotal;  
     if ($chgestotal > 0) {  
         $r->print($lt{'tfcm'}.'<ul>');  
         if ($canceltotal > 0) {  
             $r->print('<li>'.$canceltotal.' '.$lt{'cbps'},' '.$lt{'werm'}.'</li>');  
         }  
         if ($modtotal > 0) {  
             $r->print('<li>'.$modtotal.' '.$lt{'cbps'},' '.$lt{'wemo'}.'</li>');  
         }  
         if ($addtotal > 0) {  
             $r->print('<li>'.$addtotal.' '.$lt{'cbps'},' '.$lt{'wead'}.'</li>');  
         }  
         $r->print('</ul>');  
     } else {  
         $r->print($lt{'ncwm'});  
     }  
     $r->print('<br />');  
     return;  
 }  
   
 sub get_dates_from_form {  
     my $item = shift;  
     my $startdate = &Apache::lonhtmlcommon::get_date_from_form('startdate_'.$item);  
     my $enddate   = &Apache::lonhtmlcommon::get_date_from_form('enddate_'.$item);  
     return ($startdate,$enddate);  
 }  
   
 sub get_blockdates {  
     my ($records,$blockcount) = @_;  
     $$blockcount = 0;  
     %{$records} = &Apache::lonnet::dump('comm_block',  
                          $env{'course.'.$env{'request.course.id'}.'.domain'},  
                          $env{'course.'.$env{'request.course.id'}.'.num'}  
                          );  
     $$blockcount = keys %{$records};  
                                                                                                                
     foreach (keys %{$records}) {  
         if ($_ eq 'error: 2 tie(GDBM) Failed while attempting dump') {  
             $$blockcount = 0;  
             last;  
         }  
     }  
 }  
   
 sub display_blocker_status {  
     my ($r,$records,$ltext) = @_;  
     my $parmcount = 0;  
     my @bgcols = ("#eeeeee","#dddddd");  
     my $function = &Apache::loncommon::get_users_function();  
     my $color = &Apache::loncommon::designparm($function.'.tabbg',  
                                                     $env{'user.domain'});  
     my %lt = &Apache::lonlocal::texthash(  
         'modi' => 'Modify',  
         'canc' => 'Cancel',  
     );  
     $r->print(<<"END");  
 <table border="0" cellpadding="0" cellspacing="0">  
  <tr>  
   <td width="100%" bgcolor="#000000">  
    <table width="100%" border="0" cellpadding="1" cellspacing="0">  
     <tr>  
      <td width="100%" bgcolor="#000000">  
       <table border="0" cellpadding="3" cellspacing="3" bgcolor="#FFFFFF">  
        <tr bgcolor="$color">  
         <td><b>$$ltext{'dura'}</b></td>  
         <td><b>$$ltext{'setb'}</b></td>  
         <td><b>$$ltext{'even'}</b></td>  
         <td><b>$$ltext{'actn'}?</b></td>  
        </tr>  
 END  
     foreach (sort keys %{$records}) {  
         my $iter = $parmcount%2;  
         my $onchange = 'onFocus="javascript:window.document.forms['.  
                        "'blockform'].elements['modify_".$parmcount."'].".  
                        'checked=true;"';  
         my ($start,$end) = split/____/,$_;  
         my $startform = &Apache::lonhtmlcommon::date_setter('blockform','startdate_'.$parmcount,$start,$onchange);  
         my $endform = &Apache::lonhtmlcommon::date_setter('blockform','enddate_'.$parmcount,$end,$onchange);  
         my ($setter,$title) = split/:/,$$records{$_};  
         my ($setuname,$setudom) = split/@/,$setter;  
         my $settername = &Apache::loncommon::plainname($setuname,$setudom);  
         $r->print(<<"END");  
        <tr bgcolor="$bgcols[$iter]">  
         <td>$$ltext{'star'}:&nbsp;$startform<br/>$$ltext{'endd'}:&nbsp;&nbsp;$endform</td>  
         <td>$settername</td>  
         <td><input type="text" name="title_$parmcount" size="15" value="$title" /><input type="hidden" name="key_$parmcount" value="$_" /></td>  
         <td><label>$lt{'modi'}?&nbsp;<input type="checkbox" name="modify_$parmcount" /></label><br /><label>$lt{'canc'}?&nbsp;&nbsp;<input type="checkbox" name="cancel_$parmcount" /></label>  
        </tr>  
 END  
         $parmcount ++;  
     }  
     $r->print(<<"END");  
       </table>  
      </td>  
     </tr>  
    </table>  
   </td>  
  </tr>  
 </table>  
 <br />  
 <br />  
 END  
     return $parmcount;  
 }  
   
 sub display_addblocker_table {  
     my ($r,$parmcount,$ltext) = @_;  
     my $start = time;  
     my $end = $start + (60 * 60 * 2); #Default is an exam of 2 hours duration.  
     my $onchange = 'onFocus="javascript:window.document.forms['.  
                    "'blockform'].elements['add_".$parmcount."'].".  
                    'checked=true;"';  
     my $startform = &Apache::lonhtmlcommon::date_setter('blockform','startdate_'.$parmcount,$start,$onchange);  
     my $endform = &Apache::lonhtmlcommon::date_setter('blockform','enddate_'.$parmcount,$end,$onchange);  
     my $function = &Apache::loncommon::get_users_function();  
     my $color = &Apache::loncommon::designparm($function.'.tabbg',  
                                                     $env{'user.domain'});  
     my %lt = &Apache::lonlocal::texthash(  
         'addb' => 'Add block',  
         'exam' => 'e.g., Exam 1',  
         'addn' => 'Add new communication blocking periods'  
     );  
     $r->print(<<"END");  
 <h4>$lt{'addn'}</h4>   
 <table border="0" cellpadding="0" cellspacing="0">  
  <tr>  
   <td width="100%" bgcolor="#000000">  
    <table width="100%" border="0" cellpadding="1" cellspacing="0">  
     <tr>  
      <td width="100%" bgcolor="#000000">  
       <table border="0" cellpadding="3" cellspacing="3" bgcolor="#FFFFFF">  
        <tr bgcolor="#CCCCFF">  
         <td><b>$$ltext{'dura'}</b></td>  
         <td><b>$$ltext{'even'} $lt{'exam'}</b></td>  
         <td><b>$$ltext{'actn'}?</b></td>  
        </tr>  
        <tr bgcolor="#eeeeee">  
         <td>$$ltext{'star'}:&nbsp;$startform<br />$$ltext{'endd'}:&nbsp;&nbsp;$endform</td>  
         <td><input type="text" name="title_$parmcount" size="15" value="" /></td>  
         <td><label>$lt{'addb'}?&nbsp;<input type="checkbox" name="add_$parmcount" value="1" /></label></td>  
        </tr>  
       </table>  
      </td>  
     </tr>  
    </table>  
   </td>  
  </tr>  
 </table>  
 END  
     return;  
 }  
   
 sub blockcheck {  
     my ($setters,$startblock,$endblock) = @_;  
     # Retrieve active student roles and active course coordinator/instructor roles  
     my @livecses = ();  
     my @staffcses = ();  
     $$startblock = 0;  
     $$endblock = 0;  
     foreach (keys %env) {  
         if ($_ =~ m-^user\.role\.(st|cc|in)\./(.+)$-) {  
             my $role = $1;  
             my $cse = $2;  
             $cse =~ s|/|_|;  
             if ($env{$_} =~ m/^(\d*)\.(\d*)$/) {  
                 unless (($2 > 0 && $2 < time) || ($1 > time)) {  
                     if ($role eq 'st') {  
                         push @livecses, $cse;  
                     } else {  
                         unless (grep/^$cse$/,@staffcses) {  
                             push @staffcses, $cse;  
                         }  
                     }  
                 }  
             }  
         } elsif ($_ =~ m-user\.role\.cr/(\w+)/(\w+)/([^/]+)\./(.+)$- ) {   
             my $rolepriv = $env{'user.role..rolesdef_'.$3};  
         }  
     }  
     # Retrieve blocking times and identity of blocker for active courses for students.  
     if (@livecses > 0) {  
         foreach my $cse (@livecses) {  
             my ($cdom,$crs) = split/_/,$cse;  
             if ( (grep/^$cse$/,@staffcses) && ($env{'request.role'} !~ m-^st\./$cdom/$crs$-) ) {  
                 next;  
             } else {  
                 %{$$setters{$cse}} = ();  
                 @{$$setters{$cse}{'staff'}} = ();  
                 @{$$setters{$cse}{'times'}} = ();  
                 my %records = &Apache::lonnet::dump('comm_block',$cdom,$crs);  
                 foreach (keys %records) {  
                     if ($_ =~ m/^(\d+)____(\d+)$/) {  
                         if ($1 <= time && $2 >= time) {  
                             my ($staff,$title) = split/:/,$records{$_};  
                             push @{$$setters{$cse}{'staff'}}, $staff;  
                             push @{$$setters{$cse}{'times'}}, $_;  
                             if ( ($$startblock == 0) || ($$startblock > $1) ) {  
                                 $$startblock = $1;  
                             }  
                             if ( ($$endblock == 0) || ($$endblock < $2) ) {  
                                 $$endblock = $2;  
                             }  
                         }  
                     }  
                 }  
             }  
         }  
     }  
 }  
   
 sub build_block_table {  
     my ($r,$startblock,$endblock,$setters) = @_;  
     my $function = &Apache::loncommon::get_users_function();  
     my $color = &Apache::loncommon::designparm($function.'.tabbg',  
                                                     $env{'user.domain'});  
     my %lt = &Apache::lonlocal::texthash(  
         'cacb' => 'Currently active communication blocks',  
         'cour' => 'Course',  
         'dura' => 'Duration',  
         'blse' => 'Block set by'  
     );   
     $r->print(<<"END");  
 <br /<br />$lt{'cacb'}:<br /><br />  
 <table border="0" cellpadding="0" cellspacing="0">  
  <tr>  
   <td width="100%" bgcolor="#000000">  
    <table width="100%" border="0" cellpadding="1" cellspacing="0">  
     <tr>  
      <td width="100%" bgcolor="#000000">  
       <table border="0" cellpadding="3" cellspacing="3" bgcolor="#FFFFFF">  
        <tr bgcolor="$color">  
         <td><b>$lt{'cour'}</b></td>  
         <td><b>$lt{'dura'}</b></td>  
         <td><b>$lt{'blse'}</b></td>  
        </tr>  
 END  
     foreach (keys %{$setters}) {  
         my %courseinfo=&Apache::lonnet::coursedescription($_);  
         for (my $i=0; $i<@{$$setters{$_}{staff}}; $i++) {  
             my ($uname,$udom) = split/\@/,$$setters{$_}{staff}[$i];  
             my $fullname = &Apache::loncommon::plainname($uname,$udom);  
             my ($openblock,$closeblock) = split/____/,$$setters{$_}{times}[$i];  
             $openblock = &Apache::lonlocal::locallocaltime($openblock);  
             $closeblock= &Apache::lonlocal::locallocaltime($closeblock);  
             $r->print('<tr><td>'.$courseinfo{'description'}.'</td>'.  
                       '<td>'.$openblock.' to '.$closeblock.'</td>'.  
                       '<td>'.$fullname.' ('.$uname.'@'.$udom.  
                       ')</td></tr>');  
         }  
     }  
     $r->print('</table></td></tr></table></td></tr></table>');  
 }  
   
 # ----------------------------------------------------------- Display a message  
   
 sub displaymessage {  
     my ($r,$msgid,$folder)=@_;  
     my $suffix=&foldersuffix($folder);  
     my %blocked = ();  
     my %setters = ();  
     my $startblock = 0;  
     my $endblock = 0;  
     my $numblocked = 0;  
 # info to generate "next" and "previous" buttons and check if message is blocked  
     &blockcheck(\%setters,\$startblock,\$endblock);  
     my @messages=&sortedmessages(\%blocked,$startblock,$endblock,\$numblocked,$folder);  
     if ( $blocked{$msgid} eq 'ON' ) {  
         &printheader($r,'/adm/email',&mt('Display a Message'));  
         $r->print(&mt('You attempted to display a message that is currently blocked because you are enrolled in one or more courses for which there is an ongoing online exam.'));  
         &build_block_table($r,$startblock,$endblock,\%setters);  
         return;  
     }  
     &statuschange($msgid,'read',$folder);  
     my %message=&Apache::lonnet::get('nohist_email'.$suffix,[$msgid]);  
     my %content=&unpackagemsg($message{$msgid});  
   
     my $counter=0;  
     $r->print('<pre>');  
     my $escmsgid=&Apache::lonnet::escape($msgid);  
     foreach (@messages) {  
  if ($_->[5] eq $escmsgid){  
     last;  
  }  
  $counter++;  
     }  
     $r->print('</pre>');  
     my $number_of_messages = scalar(@messages); #subtract 1 for last index  
 # start output  
     &printheader($r,'/adm/email?display='.&Apache::lonnet::escape($msgid),'Display a Message','',$content{'baseurl'});  
     my %courseinfo=&Apache::lonnet::coursedescription($content{'courseid'});  
 # Functions  
     $r->print('<table border="2" width="100%"><tr bgcolor="#FFFFAA"><td>'.&mt('Functions').':</td>'.  
       '<td><a href="/adm/email?replyto='.&Apache::lonnet::escape($msgid).$sqs.  
       '"><b>'.&mt('Reply').'</b></a></td>'.  
       '<td><a href="/adm/email?forward='.&Apache::lonnet::escape($msgid).$sqs.  
       '"><b>'.&mt('Forward').'</b></a></td>'.  
       '<td><a href="/adm/email?markunread='.&Apache::lonnet::escape($msgid).$sqs.  
       '"><b>'.&mt('Mark Unread').'</b></a></td>'.  
       '<td><a href="/adm/email?markdel='.&Apache::lonnet::escape($msgid).$sqs.  
       '"><b>'.&mt('Delete').'</b></a></td>'.  
       '<td><a href="/adm/email?'.$sqs.  
       ($env{'form.dismode'} eq 'new'?'&folder=new':'').  
       '"><b>'.&mt('Back to Folder Display').'</b></a></td>');  
     if ($counter > 0){  
  $r->print('<td><a href="/adm/email?display='.$messages[$counter-1]->[5].$sqs.  
   '"><b>'.&mt('Previous').'</b></a></td>');  
     }  
     if ($counter < $number_of_messages - 1){  
  $r->print('<td><a href="/adm/email?display='.$messages[$counter+1]->[5].$sqs.  
   '"><b>'.&mt('Next').'</b></a></td>');  
     }  
     $r->print('</tr></table>');  
     if ($env{'user.adv'}) {  
  $r->print('<table border="2" width="100%"><tr bgcolor="#FFAAAA"><td>'.&mt('Currently available actions (will open extra window)').':</td>');  
  my $symb=&Apache::lonnet::symbread($content{'baseurl'});        
  if (&Apache::lonnet::allowed('vgr',$env{'request.course.id'})) {  
  $r->print('<td><b>'.&Apache::loncommon::track_student_link(&mt('View recent activity'),$content{'sendername'},$content{'senderdomain'},'check').'</b></td>');  
     }  
  if (&Apache::lonnet::allowed('opa',$env{'request.course.id'}) && $symb) {  
     $r->print('<td><b>'.&Apache::loncommon::pprmlink(&mt('Set/Change parameters'),$content{'sendername'},$content{'senderdomain'},$symb,'check').'</b></td>');  
  }  
  if (&Apache::lonnet::allowed('mgr',$env{'request.course.id'}) && $symb) {  
     $r->print('<td><b>'.&Apache::loncommon::pgrdlink(&mt('Set/Change grades'),$content{'sendername'},$content{'senderdomain'},$symb,'check').'</b></td>');  
  }  
  $r->print('</tr></table>');  
     }  
     my $tolist;  
     my @recipients = ();  
     for (my $i=0; $i<@{$content{'recuser'}}; $i++) {  
         $recipients[$i] =  &Apache::loncommon::aboutmewrapper(  
            &Apache::loncommon::plainname($content{'recuser'}[$i],  
                                       $content{'recdomain'}[$i]),  
               $content{'recuser'}[$i],$content{'recdomain'}[$i]).  
        ' ('.$content{'recuser'}[$i].' at '.$content{'recdomain'}[$i].') ';  
     }  
     $tolist = join(', ',@recipients);  
     $r->print('<br /><b>'.&mt('Subject').':</b> '.$content{'subject'}.  
       ($folder ne 'sent'?'<br /><b>'.&mt('From').':</b> '.  
       &Apache::loncommon::aboutmewrapper(  
  &Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),  
  $content{'sendername'},$content{'senderdomain'}).' ('.  
       $content{'sendername'}.' at '.  
       $content{'senderdomain'}.') ':'<br /><b>'.&mt('To').':</b> '.  
               $tolist).  
       ($content{'courseid'}?'<br /><b>'.&mt('Course').':</b> '.$courseinfo{'description'}.  
        ($content{'coursesec'}?' ('.&mt('Group/Section').': '.$content{'coursesec'}.')':''):'').  
       '<br /><b>'.&mt('Time').':</b> '.$content{'time'}.  
       ($content{'baseurl'}?'<br /><b>'.&mt('Refers to').':</b> <a href="'.$content{'baseurl'}.'">'.  
        $content{'baseurl'}.' ('.&Apache::lonnet::gettitle($content{'baseurl'}).')</a>':'').  
       '<p><pre>'.  
       &Apache::lontexconvert::msgtexconverted($content{'message'},1).  
       '</pre><hr />'.&displayresource(%content).'</p>');  
     return;     
 }  
   
 # =========================================================== Show the citation  
   
 sub displayresource {  
     my %content=@_;  
 #  
 # If the recipient is in the same course that the message was sent from and  
 # has sufficient privileges, show "all details," else show citation  
 #  
     if (($env{'request.course.id'} eq $content{'courseid'})  
      && (&Apache::lonnet::allowed('vgr',$content{'courseid'}))) {  
  my $symb=&Apache::lonnet::symbread($content{'baseurl'});  
 # Could not get a symb, give up  
  unless ($symb) { return $content{'citation'}; }  
 # Have a symb, can render  
  return '<h2>'.&mt('Current attempts of student (if applicable)').'</h2>'.  
     &Apache::loncommon::get_previous_attempt($symb,  
      $content{'sendername'},  
      $content{'senderdomain'},  
      $content{'courseid'}).  
     '<hr /><h2>'.&mt('Current screen output (if applicable)').'</h2>'.  
     &Apache::loncommon::get_student_view($symb,  
  $content{'sendername'},  
  $content{'senderdomain'},  
  $content{'courseid'}).  
     '<h2>'.&mt('Correct Answer(s) (if applicable)').'</h2>'.  
     &Apache::loncommon::get_student_answers($symb,  
     $content{'sendername'},  
     $content{'senderdomain'},  
     $content{'courseid'});  
     } elsif ($env{'user.adv'}) {  
  return $content{'citation'};  
     }  
     return '';  
 }  
   
 # ================================================================== The Header  
   
 sub header {  
     my ($r,$title,$baseurl)=@_;  
     $r->print(&Apache::lonxml::xmlbegin().  
       '<head>'.&Apache::lonxml::fontsettings().  
       '<title>Communication and Messages</title>'.  
       &Apache::lonhtmlcommon::htmlareaheaders());  
     if ($baseurl) {  
  $r->print("<base href=\"http://$ENV{'SERVER_NAME'}/$baseurl\" />");  
     }  
     $r->print(&Apache::loncommon::studentbrowser_javascript().'</head>'.  
       &Apache::loncommon::bodytag('Communication and Messages'));  
         $r->print(&Apache::lonhtmlcommon::breadcrumbs  
                   (undef,($title?$title:'Communication and Messages')));  
   
 }  
   
 # ---------------------------------------------------------------- Print header  
   
 sub printheader {  
     my ($r,$url,$desc,$title,$baseurl)=@_;  
     &Apache::lonhtmlcommon::add_breadcrumb  
  ({href=>$url,  
   text=>$desc});  
     &header($r,$title,$baseurl);  
 }  
   
 # ------------------------------------------------------------ Store the comment  
   
 sub storecomment {  
     my ($r)=@_;  
     my $msgtxt=&Apache::lonfeedback::clear_out_html($env{'form.message'});  
     my $cleanmsgtxt='';  
     foreach (split(/[\n\r]/,$msgtxt)) {  
  unless ($_=~/^\s*(\>|\&gt\;)/) {  
     $cleanmsgtxt.=$_."\n";  
  }  
     }  
     my $key=&Apache::lonnet::escape($env{'form.baseurl'}).'___'.time;  
     &Apache::lonnet::put('nohist_stored_comments',{ $key => $cleanmsgtxt });  
 }  
   
 sub storedcommentlisting {  
     my ($r)=@_;  
     my %msgs=&Apache::lonnet::dump('nohist_stored_comments',undef,undef,  
        '^'.&Apache::lonnet::escape(&Apache::lonnet::escape($env{'form.showcommentbaseurl'})));  
     $r->print(&Apache::lonxml::xmlbegin().'<head>'.  
       &Apache::lonxml::fontsettings().'</head><body>');  
     if ((keys %msgs)[0]=~/^error\:/) {  
  $r->print(&mt('No stored comments yet.'));  
     } else {      } else {
  my $found=0;          $suffix = '_'.&escape($folder);
  foreach (sort keys %msgs) {  
     $r->print("\n".$msgs{$_}."<hr />");  
     $found=1;  
  }  
  unless ($found) {  
     $r->print(&mt('No stored comments yet for this resource.'));  
  }  
     }      }
       return $suffix;
 }  }
   
 # ---------------------------------------------------------------- Send an email  # ========================================================= User-defined folders 
   
 sub sendoffmail {  sub get_user_folders {
     my ($r,$folder)=@_;      my ($folder) = @_;
     my $suffix=&foldersuffix($folder);      my %userfolders = 
     my $sendstatus='';            &Apache::lonnet::dump('email_folders',undef,undef,$folder);
     my %specialmsg_status;      my $lock = "\0".'lock_counter'; # locks db while counter incremented
     my $numspecial = 0;      my $counter = "\0".'idcount';   # used in suffix for email db files
     if ($env{'form.send'}) {      if (defined($userfolders{$lock})) {
  &printheader($r,'','Messages being sent.');          delete($userfolders{$lock});
  $r->rflush();  
  my %content=();  
  undef %content;  
  if ($env{'form.forwid'}) {  
     my $msgid=$env{'form.forwid'};  
     my %message=&Apache::lonnet::get('nohist_email'.$suffix,[$msgid]);  
     %content=&unpackagemsg($message{$msgid},1);  
     &statuschange($msgid,'forwarded',$folder);  
     $env{'form.message'}.="\n\n-- Forwarded message --\n\n".  
  $content{'message'};  
  }  
  if ($env{'form.replyid'}) {  
     my $msgid=$env{'form.replyid'};  
     my %message=&Apache::lonnet::get('nohist_email'.$suffix,[$msgid]);  
     %content=&unpackagemsg($message{$msgid},1);  
     &statuschange($msgid,'replied',$folder);  
  }  
  my %toaddr=();  
  undef %toaddr;  
  if ($env{'form.sendmode'} eq 'group') {  
     foreach (keys %env) {  
  if ($_=~/^form\.send\_to\_\&\&\&[^\&]*\&\&\&\_(.+)$/) {  
     $toaddr{$1}='';  
  }  
     }  
  } elsif ($env{'form.sendmode'} eq 'upload') {  
     foreach (split(/[\n\r\f]+/,$env{'form.upfile'})) {  
  my ($rec,$txt)=split(/\s*\:\s*/,$_);  
  if ($txt) {  
     $rec=~s/\@/\:/;  
     $toaddr{$rec}.=$txt."\n";  
  }  
     }  
  } else {  
     $toaddr{$env{'form.recuname'}.':'.$env{'form.recdomain'}}='';  
  }  
  if ($env{'form.additionalrec'}) {  
     foreach (split(/\,/,$env{'form.additionalrec'})) {  
  my ($auname,$audom)=split(/\@/,$_);  
  $toaddr{$auname.':'.$audom}='';  
     }  
  }  
   
         my $savemsg;  
         my $msgtype;  
         my %sentmessage;  
         if ((($env{'form.critmsg'}) || ($env{'form.sendbck'})) &&  
             (&Apache::lonnet::allowed('srm',$env{'request.course.id'})  
      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.  
  '/'.$env{'request.course.sec'})  
      )) {  
             $savemsg=&Apache::lonfeedback::clear_out_html($env{'form.message'},1);  
             $msgtype = 'critical';  
         } else {  
             $savemsg=&Apache::lonfeedback::clear_out_html($env{'form.message'});  
         }  
   
  foreach (keys %toaddr) {  
     my ($recuname,$recdomain)=split(/\:/,$_);  
             my $msgtxt = $savemsg;  
     if ($toaddr{$_}) { $msgtxt.='<hr />'.$toaddr{$_}; }  
     my $thismsg;  
     if ((($env{'form.critmsg'}) || ($env{'form.sendbck'})) &&   
  (&Apache::lonnet::allowed('srm',$env{'request.course.id'})  
  || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.  
      '/'.$env{'request.course.sec'}))) {  
  $r->print(&mt('Sending critical message').' '.$recuname.'@'.$recdomain.': ');  
  $thismsg=&user_crit_msg($recuname,$recdomain,  
  &Apache::lonfeedback::clear_out_html($env{'form.subject'}),  
  $msgtxt,  
  $env{'form.sendbck'},$env{'form.permanent'},\$sentmessage{$_});  
     } else {  
  $r->print(&mt('Sending').' '.$recuname.'@'.$recdomain.': ');  
  $thismsg=&user_normal_msg($recuname,$recdomain,  
   &Apache::lonfeedback::clear_out_html($env{'form.subject'}),  
   $msgtxt,  
   $content{'citation'},undef,undef,$env{'form.permanent'},\$sentmessage{$_});  
             }  
     if (($env{'request.course.id'}) && (($msgtype eq 'critical') ||   
                                          ($env{'form.sendmode'} eq 'group'))) {  
         $specialmsg_status{$recuname.':'.$recdomain}  = $thismsg;  
                 if ($thismsg eq 'ok') {  
                     $numspecial ++;  
                 }  
     }  
     $r->print($thismsg.'<br />');  
     $sendstatus.=' '.$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 $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};  
             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};  
             my $course_str = &Apache::lonnet::escape('['.$cnum.':'.$cdom.']');  
   
             if ($numspecial) {  
                 $specialresult = &user_normal_msg_raw($cnum,$cdom,$subj_prefix.  
                     ' '.$course_str,$savemsg,undef,undef,undef,  
                     undef,undef,\$specialmsgid);  
                 $specialmsgid = &Apache::lonnet::unescape($specialmsgid);  
             }  
             if ($specialresult eq 'ok') {  
                 my $record_sent;  
                 my @recusers = ();  
                 my @recudoms = ();  
                 my ($stamp,$msgsubj,$msgname,$msgdom,$msgcount,$context,$pid) =   
                             split(/\:/,&Apache::lonnet::unescape($specialmsgid));  
                 foreach my $recipient (sort(keys(%toaddr))) {  
                     if ($specialmsg_status{$recipient} eq 'ok') {  
                         my $usersubj = $subj_prefix.'['.$recipient.']';  
                         my $usermsgid = &buildmsgid($stamp,$usersubj,$msgname,  
                                               $msgdom,$msgcount,$context,$pid);  
                         &user_normal_msg_raw($cnum,$cdom,$subj_prefix.  
                         ' ['.$recipient.']',$sentmessage{$recipient},  
                         undef,undef,undef,undef,$usermsgid);  
                         my ($uname,$udom) = split/:/,$recipient;  
                         push(@recusers,$uname);  
                         push(@recudoms,$udom);  
                     }  
                 }  
                 if (@recusers) {  
                     my $specialmessage;  
                     my $sentsubj = $subj_prefix.' ('.$numspecial.' sent) '.  
                     &Apache::lonfeedback::clear_out_html($env{'form.subject'});  
                     $sentsubj = &HTML::Entities::encode($sentsubj,'<>&"');  
                     my $sentmsgid = &buildmsgid($stamp,$sentsubj,$msgname,  
                                               $msgdom,$msgcount,$context,$pid);  
                     ($specialmsgid,$specialmessage) =  
                          &packagemsg(&Apache::lonfeedback::clear_out_html(  
                              $env{'form.subject'}),$savemsg,undef,undef,undef,  
                                             \@recusers,\@recudoms,$sentmsgid);  
                     $record_sent = &store_sent_mail($specialmsgid,$specialmessage);  
                 }  
             } 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');  
             }  
         }  
     } else {  
  &printheader($r,'','No messages sent.');   
     }      }
     if ($sendstatus=~/^(\s*(?:ok|con_delayed)\s*)*$/) {      if (defined($userfolders{$counter})) {
  $r->print('<br /><font color="green">'.&mt('Completed.').'</font>');          delete($userfolders{$counter});
  if ($env{'form.displayedcrit'}) {  
     &discrit($r);  
  } else {  
     &Apache::loncommunicate::menu($r);  
  }  
     } else {  
  $r->print(  
   '<h2><font color="red">'.&mt('Could not deliver message').'</font></h2>'.  
   &mt('Please use the browser "Back" button and correct the recipient addresses')  
   );  
     }  
 }  
   
 # ===================================================================== Handler  
   
 sub handler {  
     my $r=shift;  
   
 # ----------------------------------------------------------- Set document type  
       
     &Apache::loncommon::content_type($r,'text/html');  
     $r->send_http_header;  
       
     return OK if $r->header_only;  
       
 # --------------------------- Get query string for limited number of parameters  
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},  
         ['display','replyto','forward','markread','markdel','markunread',  
          'sendreply','compose','sendmail','critical','recname','recdom',  
          'recordftf','sortedby','block','folder','startdis','interdis',  
  'showcommentbaseurl','dismode']);  
     $sqs='&sortedby='.$env{'form.sortedby'};  
   
 # ------------------------------------------------------ They checked for email  
     unless ($env{'form.block'}) {  
         &Apache::lonnet::put('email_status',{'recnewemail'=>0});  
     }  
   
 # ----------------------------------------------------------------- Breadcrumbs  
   
     &Apache::lonhtmlcommon::clear_breadcrumbs();  
     &Apache::lonhtmlcommon::add_breadcrumb  
         ({href=>"/adm/communicate",  
           text=>"Communication/Messages",  
           faq=>12,bug=>'Communication Tools',});  
   
 # ------------------------------------------------------------------ Get Folder  
   
     my $folder=$env{'form.folder'};  
     unless ($folder) {   
  $folder='';   
     } else {  
  $sqs.='&folder='.&Apache::lonnet::escape($folder);  
     }  
 # ------------------------------------------------------------ Get Display Mode  
   
     my $dismode=$env{'form.dismode'};  
     unless ($dismode) {   
  $dismode='';   
     } else {  
  $sqs.='&dismode='.&Apache::lonnet::escape($dismode);  
     }  
   
 # --------------------------------------------------------------------- Display  
   
     $startdis=$env{'form.startdis'};  
     $startdis--;  
     unless ($startdis) { $startdis=0; }  
   
     $interdis=$env{'form.interdis'};  
     unless ($interdis) { $interdis=20; }  
     $sqs.='&interdis='.$interdis;  
   
     if ($env{'form.firstview'}) {  
  $startdis=0;  
     }  
     if ($env{'form.lastview'}) {  
  $startdis=-1;  
     }  
     if ($env{'form.prevview'}) {  
  $startdis--;  
     }  
     if ($env{'form.nextview'}) {  
  $startdis++;  
     }  
     my $postedstartdis=$startdis+1;  
     $sqs.='&startdis='.$postedstartdis;  
   
 # --------------------------------------------------------------- Render Output  
   
     if ($env{'form.display'}) {  
  &displaymessage($r,$env{'form.display'},$folder);  
     } elsif ($env{'form.replyto'}) {  
  &compout($r,'',$env{'form.replyto'},undef,undef,$folder,$dismode);  
     } elsif ($env{'form.confirm'}) {  
  &printheader($r,'','Confirmed Receipt');  
  foreach (keys %env) {  
     if ($_=~/^form\.rec\_(.*)$/) {  
  $r->print('<b>'.&mt('Confirming Receipt').':</b> '.  
   &user_crit_received($1).'<br>');  
     }  
     if ($_=~/^form\.reprec\_(.*)$/) {  
  my $msgid=$1;  
  $r->print('<b>'.&mt('Confirming Receipt').':</b> '.  
   &user_crit_received($msgid).'<br>');  
  &compout($r,'','','',$msgid);  
     }  
  }  
  &discrit($r);  
     } elsif ($env{'form.critical'}) {  
  &printheader($r,'','Displaying Critical Messages');  
  &discrit($r);  
     } elsif ($env{'form.forward'}) {  
  &compout($r,$env{'form.forward'},undef,undef,undef,$folder);  
     } elsif ($env{'form.markdel'}) {  
  &printheader($r,'','Deleted Message');  
  my ($result,$msg) =   
     &statuschange($env{'form.markdel'},'deleted',$folder);  
  if (!$result) {  
     $r->print('<p style="color: red">Failed to delete the message.</p>'.  
       '<p style="color: red">'.$msg."</p>\n");  
  }  
  &Apache::loncommunicate::menu($r);  
  &disall($r,($folder?$folder:$dismode));  
     } elsif ($env{'form.markedmove'}) {  
  my ($total,$failed,@failed_msg)=(0,0);  
  foreach my $key (keys(%env)) {  
     if ($key=~/^form\.delmark_(.*)$/) {  
  my ($result,$msg) =  
     &movemsg(&Apache::lonnet::unescape($1),$folder,  
      $env{'form.movetofolder'});  
  if ($result) {  
     $total++;  
  } else {  
     $failed++;  
     push(@failed_msg,$msg);  
  }  
     }  
  }  
  &printheader($r,'','Moved Messages');  
  if ($failed) {  
     $r->print('<p style="color: red;">  
                           Failed to move '.$failed.' message(s)</p>');  
     $r->print('<p style="color: red;">'.  
       join("</p>\n<p style=\"color: red;\">",@failed_msg).  
       "</p>\n");  
  }  
  $r->print('Moved '.$total.' message(s)<p>');  
  &Apache::loncommunicate::menu($r);  
  &disall($r,($folder?$folder:$dismode));  
     } elsif ($env{'form.markeddel'}) {  
  my ($total,$failed,@failed_msg)=(0,0);  
  foreach my $key (keys(%env)) {  
     if ($key=~/^form\.delmark_(.*)$/) {  
  my ($result,$msg) =   
     &statuschange(&Apache::lonnet::unescape($1),'deleted',  
   $folder);  
  if ($result) {  
     $total++;  
  } else {  
     $failed++;  
     push(@failed_msg,$msg);  
  }  
     }  
  }  
  &printheader($r,'','Deleted Messages');  
  if ($failed) {  
     $r->print('<p style="color: red;">  
                           Failed to delete '.$failed.' message(s)</p>');  
     $r->print('<p style="color: red;">'.  
       join("</p>\n<p style=\"color: red;\">",@failed_msg).  
       "</p>\n");  
  }  
  $r->print('Deleted '.$total.' message(s)<p>');  
  &Apache::loncommunicate::menu($r);  
  &disall($r,($folder?$folder:$dismode));  
     } elsif ($env{'form.markunread'}) {  
  &printheader($r,'','Marked Message as Unread');  
  &statuschange($env{'form.markunread'},'new');  
  &Apache::loncommunicate::menu($r);  
  &disall($r,($folder?$folder:$dismode));  
     } elsif ($env{'form.compose'}) {  
  &compout($r,'','',$env{'form.compose'});  
     } elsif ($env{'form.recordftf'}) {  
  &facetoface($r,$env{'form.recordftf'});  
     } elsif ($env{'form.block'}) {  
         &examblock($r,$env{'form.block'});  
     } elsif ($env{'form.sendmail'}) {  
  &sendoffmail($r,$folder);  
  if ($env{'form.storebasecomment'}) {  
     &storecomment($r);  
  }  
  if (($env{'form.rsspost'}) && ($env{'request.course.id'})) {  
     &Apache::lonrss::addentry($env{'course.'.$env{'request.course.id'}.'.num'},  
       $env{'course.'.$env{'request.course.id'}.'.domain'},  
       'Course_Announcements',  
       $env{'form.subject'},  
       $env{'form.message'},'/adm/communicate','public');  
  }  
  &disall($r,($folder?$folder:$dismode));  
     } elsif ($env{'form.newfolder'}) {  
  &printheader($r,'','New Folder');  
  &makefolder($env{'form.newfolder'});  
  &Apache::loncommunicate::menu($r);  
  &disall($r,$env{'form.newfolder'});  
     } elsif ($env{'form.showcommentbaseurl'}) {  
  &storedcommentlisting($r);  
     } else {  
  &printheader($r,'','Display All Messages');  
  &Apache::loncommunicate::menu($r);   
  &disall($r,($folder?$folder:$dismode));  
     }      }
     $r->print(&Apache::loncommon::endbodytag().'</html>');      return %userfolders;
     return OK;  
 }  }
 # ================================================= Main program, reset counter  
   
 BEGIN {  
     $msgcount=0;  
 }  
   
 =pod  
   
 =back  
   
 =cut  
   
 1;   
   
   1;
 __END__  __END__
   
   
   
   
   
   
   

Removed from v.1.173.2.1  
changed lines
  Added in v.1.193


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