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

Diff for /loncom/interface/lonmsg.pm between versions 1.180 and 1.202

version 1.180, 2006/04/08 06:53:37 version 1.202, 2007/05/02 19:56:34
Line 28 Line 28
   
 package Apache::lonmsg;  package Apache::lonmsg;
   
   =pod
   
   =head1 NAME
   
   Apache::lonmsg: supports internal messaging
   
   =head1 SYNOPSIS
   
   lonmsg provides routines for sending messages.
   
   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 HTML::TokeParser();  use HTML::TokeParser();
 use Apache::lonlocal;  use Apache::lonlocal;
 use Mail::Send;  use Mail::Send;
   use LONCAPA qw(:DEFAULT :match);
   
 {  {
     my $uniq;      my $uniq;
Line 46  use Mail::Send; Line 78  use Mail::Send;
   
 sub packagemsg {  sub packagemsg {
     my ($subject,$message,$citation,$baseurl,$attachmenturl,      my ($subject,$message,$citation,$baseurl,$attachmenturl,
  $recuser,$recdomain,$msgid,$type,$crsmsgid)=@_;   $recuser,$recdomain,$msgid,$type,$crsmsgid,$symb,$error,$recipid)=@_;
     $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 56  sub packagemsg { Line 88  sub packagemsg {
     #remove machine specification      #remove machine specification
     $attachmenturl =~ s|^http://[^/]+/|/|;      $attachmenturl =~ s|^http://[^/]+/|/|;
     $attachmenturl =&HTML::Entities::encode($attachmenturl,'<>&"');      $attachmenturl =&HTML::Entities::encode($attachmenturl,'<>&"');
     my $course_context;      my $course_context = &get_course_context();
     if (defined($env{'form.replyid'})) {  
         my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid)=  
                    split(/\:/,&Apache::lonnet::unescape($env{'form.replyid'}));  
         $course_context = $origcid;  
     }  
     foreach my $key (keys(%env)) {  
         if ($key=~/^form\.(rep)?rec\_(.*)$/) {  
             my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid) =  
                                     split(/\:/,&Apache::lonnet::unescape($2));  
             $course_context = $origcid;  
             last;  
         }  
     }  
     unless(defined($course_context)) {  
         $course_context = $env{'request.course.id'};  
     }  
     my $now=time;      my $now=time;
     my $msgcount = &get_uniq();      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>'.
Line 108  sub packagemsg { Line 124  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 133  sub packagemsg { Line 149  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 ($course_context ne '') {
               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>';
                   }
               }
           }
       }
       if (defined($recipid)) {
           $result.= '<recipid>'.$recipid.'</recipid>';
       }
       return ($msgid,$result);
   }
   
   sub get_course_context {
       my $course_context;
       if (defined($env{'form.replyid'})) {
           my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid)=
                      split(/\:/,&unescape($env{'form.replyid'}));
           $course_context = $origcid;
       }
       foreach my $key (keys(%env)) {
           if ($key=~/^form\.(rep)?rec\_(.*)$/) {
               my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid) =
                                       split(/\:/,&unescape($2));
               $course_context = $origcid;
               last;
           }
       }
       if ($course_context eq '') {
           $course_context = $env{'request.course.id'};
       }
       return $course_context;
 }  }
   
 # ================================================== Unpack message into a hash  # ================================================== Unpack message into a hash
Line 177  sub unpackagemsg { Line 228  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 200  sub unpackmsgid { Line 255  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 221  sub sendemail { Line 285  sub sendemail {
 # ==================================================== Send notification emails  # ==================================================== Send notification emails
   
 sub sendnotification {  sub sendnotification {
     my ($to,$touname,$toudom,$subj,$crit,$text)=@_;      my ($to,$touname,$toudom,$subj,$crit,$text,$msgid)=@_;
     my $sender=$env{'environment.firstname'}.' '.$env{'environment.lastname'};      my $sender=$env{'environment.firstname'}.' '.$env{'environment.lastname'};
     unless ($sender=~/\w/) {       unless ($sender=~/\w/) { 
  $sender=$env{'user.name'}.'@'.$env{'user.domain'};   $sender=$env{'user.name'}.'@'.$env{'user.domain'};
Line 231  sub sendnotification { Line 295  sub sendnotification {
     $text=~s/\&gt\;/\>/gs;      $text=~s/\&gt\;/\>/gs;
     $text=~s/\<\/*[^\>]+\>//gs;      $text=~s/\<\/*[^\>]+\>//gs;
     my $url='http://'.      my $url='http://'.
       $Apache::lonnet::hostname{&Apache::lonnet::homeserver($touname,$toudom)}.   &Apache::lonnet::hostname(&Apache::lonnet::homeserver($touname,$toudom)).
       '/adm/email?username='.$touname.'&domain='.$toudom;        '/adm/email?username='.$touname.'&domain='.$toudom;
     my $body=(<<ENDMSG);      my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid,
 You received a$critical message from $sender in LON-CAPA. The subject is          $symb,$error) = &Apache::lonmsg::unpackmsgid($msgid);
       my $coursetext;
       if ($fromcid ne '') {
           $coursetext = "\n".&mt('Course').': ';
           if ($env{'course.'.$fromcid.'.description'} ne '') {
               $coursetext .= $env{'course.'.$fromcid.'.description'};
           } else {
               my %coursehash = &Apache::lonnet::coursedescription($fromcid,);
               if ($coursehash{'description'} ne '') {
                   $coursetext .= $coursehash{'description'};
               }
           }
           $coursetext .= "\n\n";
       }
       my $body = $coursetext. 
                  &mt('You received a'.$critical.' message from [_1] in LON-CAPA.',$sender).' '.&mt('The subject is 
   
  $subj   [_1]
   
 === Excerpt ============================================================  ',$subj)."\n".
   '=== '.&mt('Excerpt')." ============================================================
 $text  $text
 ========================================================================  ========================================================================
   
 Use  ".&mt('Use 
   
  $url   [_1]
   
 to access the full message.  to access the full message.',$url);
 ENDMSG  
     &sendemail($to,'New'.$critical.' message from '.$sender,$body);      &sendemail($to,'New'.$critical.' message from '.$sender,$body);
 }  }
 # ============================================================= Check for email  # ============================================================= Check for email
Line 278  sub author_res_msg { Line 357  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 293  sub author_res_msg { Line 374  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 313  sub retrieve_author_res_msg { Line 394  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 327  sub del_url_author_res_msg { Line 408  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 348  sub all_url_author_res_msg { Line 429  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);
       if ($result eq 'ok' || $result eq 'con_delayed') {
           
       }
       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,
           $nosentstore,$recipid)=@_;
 # 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,undef,undef,
        if ($sendback) { $message.='<sendback>true</sendback>'; }                                    undef,undef,undef,undef,undef,undef,undef,
                                     undef,$recipid);
          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 (!$nosentstore) {
               (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,$msgid);
     }      }
     if ($toperm && $userenv{'permanentemail'}) {      if ($toperm && $userenv{'permanentemail'}) {
       &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,1,        &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,1,
  $text);   $text,$msgid);
     }      }
 # Log this  # Log this
     &Apache::lonnet::logthis(      &Apache::lonnet::logthis(
Line 398  sub user_crit_msg_raw { Line 504  sub user_crit_msg_raw {
   
 =pod  =pod
   
 =item * B<user_crit_msg($user, $domain, $subject, $message, $sendback)>: Sends  =item * B<user_crit_msg($user, $domain, $subject, $message, $sendback, $nosentstore,$recipid)>: 
     a critical message $message to the $user at $domain. If $sendback is true,      Sends a critical message $message to the $user at $domain.  If $sendback
     a reciept will be sent to the current user when $user recieves the message.      is true,  a receipt will be sent to the current user when $user receives 
       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='';          $nosentstore,$recipid)=@_;
       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,$nosentstore,
                                    $recipid));
        }         }
     } 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,$nosentstore,$recipid));
     }      }
     return $status;      if (wantarray) {
    return @status;
       }
       return join(' ',@status);
 }  }
   
 # =================================================== Critical message received  # =================================================== Critical message received
Line 453  sub user_crit_received { Line 575  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,$crsmsgid)=@_;          $toperm,$currid,$newid,$sentmessage,$crsmsgid,$symb,$restitle,
           $error,$nosentstore,$recipid)=@_;
 # Check if allowed missing  # Check if allowed missing
     my ($status,$packed_message);      my ($status,$packed_message);
     my $msgid='undefined';      my $msgid='undefined';
Line 464  sub user_normal_msg_raw { Line 587  sub user_normal_msg_raw {
        ($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,$crsmsgid);                                       undef,$crsmsgid,$symb,$error,$recipid);
   
 # 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);
 # Into sent-mail folder unless a broadcast message or critical message  # Into sent-mail folder if sent mail storage required
        unless (($env{'request.course.id'}) &&          if (!$nosentstore) {
                (($env{'form.sendmode'} eq 'group')  ||              (undef,my $packed_message_no_citation) =
                (($env{'form.critmsg'}) || ($env{'form.sendbck'})) &&                 &packagemsg($subject,$message,undef,$baseurl,$attachmenturl,
                (&Apache::lonnet::allowed('srm',$env{'request.course.id'})                             $user,$domain,$currid,undef,$crsmsgid,$symb,$error);
  || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.             if ($status eq 'ok' || $status eq 'con_delayed') {
     '/'.$env{'request.course.sec'})))) {                 &store_sent_mail($msgid,$packed_message_no_citation);
            (undef, my $packed_message_no_citation)=             }
                              &packagemsg($subject,$message,undef     ,$baseurl,         }
                                           $attachmenturl,$user,$domain,$currid,         if (ref($newid) eq 'SCALAR') {
                                                               undef,$crsmsgid);     $$newid = $msgid;
          }
            $status .= &store_sent_mail($msgid,$packed_message_no_citation);         if (ref($sentmessage) eq 'SCALAR') {
      $$sentmessage = $packed_message;
        }         }
     } else {  
        $status='no_host';  
     }  
     if (defined($newid)) {  
         $$newid = $msgid;  
     }  
     if (defined($sentmessage)) {  
         $$sentmessage = $packed_message;  
     }  
   
 # Notifications  # Notifications
     my %userenv = &Apache::lonnet::get('environment',['notification',         my %userenv = &Apache::lonnet::get('environment',['notification',
                                                       'permanentemail'],   'permanentemail'],
                                        $domain,$user);    $domain,$user);
     if ($userenv{'notification'}) {         if ($userenv{'notification'}) {
  &sendnotification($userenv{'notification'},$user,$domain,$subject,0,     &sendnotification($userenv{'notification'},$user,$domain,$subject,0,
   $text);       $text,$msgid);
     }         }
     if ($toperm && $userenv{'permanentemail'}) {         if ($toperm && $userenv{'permanentemail'}) {
  &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,     &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,
   $text);       $text,$msgid);
     }         }
     &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},         &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
                          $env{'user.home'},      $env{'user.home'},
       'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status);      'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status);
      } else {
          $status='no_host';
      }
     return $status;      return $status;
 }  }
   
Line 520  sub user_normal_msg_raw { Line 637  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,
     $user at $domain, with subject $subject and message $message.         $error,$nosentstore,$recipid)>:
    Sends a message to the  $user at $domain, with subject $subject and message $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_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,$nosentstore,$recipid)=@_;
     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 (split(/\,/,$msgforward)) {
     my ($forwuser,$forwdomain)=split(/\:/,$_);      my ($forwuser,$forwdomain)=split(/\:/,$_);
     $status.=      push(@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,$nosentstore,$recipid));
         }          }
     } else {       } else {
  $status=&user_normal_msg_raw($user,$domain,$subject,$message,   push(@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,$nosentstore,$recipid));
       }
       if (wantarray) {
           return @status;
     }      }
       return join(' ',@status);
   }
   
   sub process_sent_mail {
       my ($msgsubj,$subj_prefix,$numsent,$stamp,$msgname,$msgdom,$msgcount,$context,$pid,$savemsg,$recusers,$recudoms,$baseurl,$attachmenturl,$symb,$error,$senderuname,$senderdom,$senderhome) = @_;
       my $sentsubj;
       if ($numsent > 1) {
           $sentsubj = $subj_prefix.' ('.$numsent.' sent) '.$msgsubj;
       }
       $sentsubj = &HTML::Entities::encode($sentsubj,'<>&"');
       my $sentmsgid = 
           &buildmsgid($stamp,$sentsubj,$msgname,$msgdom,$msgcount,$context,$pid);
       (undef,my $sentmessage) =
           &packagemsg($msgsubj,$savemsg,undef,$baseurl,$attachmenturl,$recusers,
                       $recudoms,$sentmsgid,undef,undef,$symb,$error);
       my $status = &store_sent_mail($sentmsgid,$sentmessage,$senderuname,
                                     $senderdom,$senderhome);
     return $status;      return $status;
 }  }
   
 sub store_sent_mail {  sub store_sent_mail {
     my ($msgid,$message) = @_;      my ($msgid,$message,$senderuname,$senderdom,$senderhome) = @_;
       if ($senderuname eq '') {
           $senderuname = $env{'user.name'};
       }
       if ($senderdom eq '') {
           $senderdom = $env{'user.domain'};
       }
       if ($senderhome eq '') {
           $senderhome = $env{'user.home'};
       }
     my $status =' '.&Apache::lonnet::critical(      my $status =' '.&Apache::lonnet::critical(
                'put:'.$env{'user.domain'}.':'.$env{'user.name'}.                 'put:'.$senderdom.':'.$senderuname.':nohist_email_sent:'.
                                           ':nohist_email_sent:'.                 &escape($msgid).'='.&escape($message),$senderhome);
                &Apache::lonnet::escape($msgid).'='.  
                &Apache::lonnet::escape($message),$env{'user.home'});  
     return $status;      return $status;
 }  }
   
   sub store_recipients {
       my ($subject,$sendername,$senderdom,$reciphash) = @_;
       my $context = &get_course_context();
       my $now = time;
       my $msgcount = &get_uniq();
       my $recipid =
           &buildmsgid($now,$subject,$sendername,$senderdom,$msgcount,$context,$$);
       my %recipinfo = (
                            $recipid => $reciphash,
                       );
       my $status = &Apache::lonnet::put('nohist_emailrecip',\%recipinfo,
                                         $senderdom,$sendername); 
       if ($status eq 'ok') {
           return ($recipid,$status);
       } else {
           return (undef,$status);
       }
   }
   
 # =============================================================== 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') {
           $suffix = '_'.&escape($folderhash{$folder}{'id'});
       } else {
           $suffix = '_'.&escape($folder);
       }
       return $suffix;
   }
   
   # ========================================================= User-defined folders 
   
   sub get_user_folders {
       my ($folder) = @_;
       my %userfolders = 
             &Apache::lonnet::dump('email_folders',undef,undef,$folder);
       my $lock = "\0".'lock_counter'; # locks db while counter incremented
       my $counter = "\0".'idcount';   # used in suffix for email db files
       if (defined($userfolders{$lock})) {
           delete($userfolders{$lock});
       }
       if (defined($userfolders{$counter})) {
           delete($userfolders{$counter});
       }
       return %userfolders;
   }
   
   sub secapply {
       my $rec=shift;
       my $defaultflag=shift;
       $rec=~s/\s+//g;
       $rec=~s/\@/\:/g;
       my ($adr,$sections_or_groups)=($rec=~/^([^\(]+)\(([^\)]+)\)/);
       if ($sections_or_groups) {
    foreach my $item (split(/\;/,$sections_or_groups)) {
               if (($item eq $env{'request.course.sec'}) ||
                   ($defaultflag && ($item eq '*'))) {
                   return $adr; 
               } elsif ($env{'request.course.groups'}) {
                   my @usersgroups = split(/:/,$env{'request.course.groups'});
                   if (grep(/^\Q$item\E$/,@usersgroups)) {
                       return $adr;
                   }
               } 
           }
       } else {
          return $rec;
       }
       return '';
   }
   
   =pod 
   
   =item * B<decide_receiver($feedurl,$author,$question,$course,$policy,$defaultflag)>:
   
   Arguments
     $feedurl - /res/ url of resource (only need if $author is true)
     $author,$question,$course,$policy - all true/false parameters
       if true will attempt to find the addresses of user that should receive
       this type of feedback (author - feedback to author of resource $feedurl,
       $question 'Resource Content Questions', $course 'Course Content Question',
       $policy 'Course Policy')
       (Additionally it also checks $env for whether the corresponding form.<name>
       element exists, for ease of use in a html response context)
      
     $defaultflag - (internal should be left blank) if true gather addresses 
                    that aren't for a section even if I have a section
                    (used for reccursion internally, first we look for
                    addresses for our specific section then we recurse
                    and look for non section addresses)
   
   Returns
     $typestyle - string of html text, describing what addresses were found
     %to - a hash, which keys are addresses of users to send messages to
           the keys will look like   name:domain
   
   =cut
   
   sub decide_receiver {
       my ($feedurl,$author,$question,$course,$policy,$defaultflag) = @_;
       &Apache::lonenc::check_decrypt(\$feedurl);
       my $typestyle='';
       my %to=();
       if ($env{'form.discuss'} eq 'author' ||$author) {
    $typestyle.='Submitting as Author Feedback<br />';
    $feedurl=~ m{^/res/($LONCAPA::domain_re)/($LONCAPA::username_re)/};
    $to{$2.':'.$1}=1;
       }
       my $cid = $env{'request.course.id'};
       if ($env{'form.discuss'} eq 'question' ||$question) {
    $typestyle.=&mt('Submitting as Question').'<br />';
    foreach my $item (split(/\,/,$env{'course.'.$cid.'.question.email'})) {
       my $rec=&secapply($item,$defaultflag);
       if ($rec) { $to{$rec}=1; }
    } 
       }
       if ($env{'form.discuss'} eq 'course' ||$course) {
    $typestyle.=&mt('Submitting as Comment').'<br />';
    foreach my $item (split(/\,/,$env{'course.'.$cid.'.comment.email'})) {
       my $rec=&secapply($item,$defaultflag);
       if ($rec) { $to{$rec}=1; }
    } 
       }
       if ($env{'form.discuss'} eq 'policy' ||$policy) {
    $typestyle.=&mt('Submitting as Policy Feedback').'<br />';
    foreach my $item (split(/\,/,$env{'course.'.$cid.'.policy.email'})) {
       my $rec=&secapply($item,$defaultflag);
       if ($rec) { $to{$rec}=1; }
    } 
       }
       if ((scalar(%to) eq '0') && (!$defaultflag)) {
    ($typestyle,%to)=
       &decide_receiver($feedurl,$author,$question,$course,$policy,1);
       }
       return ($typestyle,%to);
 }  }
   
   =pod
   
   =back
   
   =cut
   
 1;  1;
 __END__  __END__
   
Removed from v.1.180  
changed lines
  Added in v.1.202

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