File:  [LON-CAPA] / loncom / interface / lonmsg.pm
Revision 1.225: download - view: text, annotated - select for diffs
Tue Mar 2 15:10:47 2010 UTC (14 years, 3 months ago) by jms
Branches: MAIN
CVS tags: PRINT_INCOMPLETE_base, PRINT_INCOMPLETE, HEAD
Fixed bug #6233, non-breaking page space tags stripped from outgoing external messages.

    1: # The LearningOnline Network with CAPA
    2: # Routines for messaging
    3: #
    4: # $Id: lonmsg.pm,v 1.225 2010/03/02 15:10:47 jms Exp $
    5: #
    6: # Copyright Michigan State University Board of Trustees
    7: #
    8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
    9: #
   10: # LON-CAPA is free software; you can redistribute it and/or modify
   11: # it under the terms of the GNU General Public License as published by
   12: # the Free Software Foundation; either version 2 of the License, or
   13: # (at your option) any later version.
   14: #
   15: # LON-CAPA is distributed in the hope that it will be useful,
   16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   18: # GNU General Public License for more details.
   19: #
   20: # You should have received a copy of the GNU General Public License
   21: # along with LON-CAPA; if not, write to the Free Software
   22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   23: #
   24: # /home/httpd/html/adm/gpl.txt
   25: #
   26: # http://www.lon-capa.org/
   27: #
   28: 
   29: package Apache::lonmsg;
   30: 
   31: =pod
   32: 
   33: =head1 NAME
   34: 
   35: Apache::lonmsg: supports internal messaging
   36: 
   37: =head1 SYNOPSIS
   38: 
   39: lonmsg provides routines for sending messages.
   40: 
   41: Right now, this document will cover just how to send a message, since
   42: it is likely you will not need to programmatically read messages,
   43: since lonmsg already implements that functionality.
   44: 
   45: The routines used to package messages and unpackage messages are not
   46: only used by lonmsg when creating/extracting messages for LON-CAPA's
   47: internal messaging system, but also by lonnotify.pm which is available
   48: for use by Domain Coordinators to broadcast standard e-mail to specified
   49: users in their domain.  The XML packaging used in the two cases is very
   50: similar.  The differences are the use of <recuser>$uname</recuser> and
   51: <recdomain>$udom</recdomain> in stored internal messages, compared
   52: with <recipient username="$uname:$udom">$email</recipient> in stored
   53: Domain Coordinator e-mail for the storage of information about
   54: recipients of the message/e-mail.
   55: 
   56: =head1 SUBROUTINES
   57: 
   58: =over
   59: 
   60: =pod
   61: 
   62: =item packagemsg()
   63: 
   64: Package
   65: 
   66: =item get_course_context()
   67: 
   68: =item unpackagemsg()
   69: 
   70: Unpack message into a hash
   71: 
   72: =item buildmsgid()
   73: 
   74: Get info out of msgid
   75: 
   76: =item unpackmsgid()
   77: 
   78: =item sendemail()
   79: 
   80: =item sendnotification()
   81: 
   82: Send notification emails
   83: 
   84: =item newmail()
   85: 
   86: Check for email
   87: 
   88: =item author_res_msg()
   89: 
   90: Automated message to the author of a resource
   91: 
   92: =item * B<author_res_msg($filename, $message)>: Sends message $message to the owner
   93:     of the resource with the URI $filename.
   94: 
   95: =item retrieve_author_res_msg()
   96: 
   97: Retrieve author resource messages
   98: 
   99: =item del_url_author_res_msg()
  100: 
  101: Delete all author messages related to one URL
  102: 
  103: =item clear_author_res_msg()
  104: 
  105: Clear out all author messages in URL path
  106: 
  107: =item all_url_author_res_msg()
  108: 
  109: Return hash with URLs for which there is a resource message
  110: 
  111: =item store_instructor_comment()
  112: 
  113: Add a comment to the User Notes screen
  114: 
  115: =item user_crit_msg_raw()
  116: 
  117: Critical message to a user
  118: 
  119: =item user_crit_msg()
  120: 
  121: New routine that respects "forward" and calls old routine
  122: 
  123: =item * B<user_crit_msg($user, $domain, $subject, $message, $sendback, $nosentstore,$recipid,$attachmenturl)>: 
  124:     Sends a critical message $message to the $user at $domain.  If $sendback
  125:     is true,  a receipt will be sent to the current user when $user receives 
  126:     the message.
  127: 
  128:     Additionally it will check if the user has a Forwarding address
  129:     set, and send the message to that address instead
  130: 
  131:     returns 
  132:       - in array context a list of results for each message that was sent
  133:       - in scalar context a space seperated list of results for each 
  134:            message sent
  135: 
  136: 
  137: =item user_crit_received()
  138: 
  139: Critical message received
  140: 
  141: =item user_normal_msg_raw()
  142: 
  143: Normal communication
  144: 
  145: =item user_normal_msg()
  146: 
  147: New routine that respects "forward" and calls old routine
  148: 
  149: =item * B<user_normal_msg($user, $domain, $subject, $message, $citation,
  150:        $baseurl, $attachmenturl, $toperm, $sentmessage, $symb, $restitle,
  151:        $error,$nosentstore,$recipid)>:
  152:  Sends a message to the  $user at $domain, with subject $subject and message $message.
  153: 
  154:     Additionally it will check if the user has a Forwarding address
  155:     set, and send the message to that address instead
  156: 
  157:     returns
  158:       - in array context a list of results for each message that was sent
  159:       - in scalar context a space seperated list of results for each
  160:            message sent
  161: 
  162: =item store_sent_mail()
  163: 
  164: =item store_recipients()
  165: 
  166: =item foldersuffix()
  167: 
  168: =item get_user_folders()
  169: 
  170: User-defined folders 
  171: 
  172: =item secapply()
  173: 
  174: =item B<decide_receiver($feedurl,$author,$question,$course,$policy,$defaultflag)>:
  175: 
  176: Arguments
  177:   $feedurl - /res/ url of resource (only need if $author is true)
  178:   $author,$question,$course,$policy - all true/false parameters
  179:     if true will attempt to find the addresses of user that should receive
  180:     this type of feedback (author - feedback to author of resource $feedurl,
  181:     $question 'Resource Content Questions', $course 'Course Content Question',
  182:     $policy 'Course Policy')
  183:     (Additionally it also checks $env for whether the corresponding form.<name>
  184:     element exists, for ease of use in a html response context)
  185:    
  186:   $defaultflag - (internal should be left blank) if true gather addresses 
  187:                  that aren't for a section even if I have a section
  188:                  (used for reccursion internally, first we look for
  189:                  addresses for our specific section then we recurse
  190:                  and look for non section addresses)
  191: 
  192: Returns
  193:   $typestyle - string of html text, describing what addresses were found
  194:   %to - a hash, which keys are addresses of users to send messages to
  195:         the keys will look like   name:domain
  196: 
  197: =back
  198: 
  199: =cut
  200: 
  201: use strict;
  202: use Apache::lonnet;
  203: use HTML::TokeParser();
  204: use Apache::lonlocal;
  205: use Mail::Send;
  206: use LONCAPA qw(:DEFAULT :match);
  207: 
  208: {
  209:     my $uniq;
  210:     sub get_uniq {
  211: 	$uniq++;
  212: 	return $uniq;
  213:     }
  214: }
  215: 
  216: 
  217: 
  218: sub packagemsg {
  219:     my ($subject,$message,$citation,$baseurl,$attachmenturl,
  220: 	$recuser,$recdomain,$msgid,$type,$crsmsgid,$symb,$error,$recipid)=@_;
  221:     $message =&HTML::Entities::encode($message,'<>&"');
  222:     $citation=&HTML::Entities::encode($citation,'<>&"');
  223:     $subject =&HTML::Entities::encode($subject,'<>&"');
  224:     #remove machine specification
  225:     $baseurl =~ s|^https?://[^/]+/|/|;
  226:     $baseurl =&HTML::Entities::encode($baseurl,'<>&"');
  227:     #remove machine specification
  228:     $attachmenturl =~ s|^https?://[^/]+/|/|;
  229:     $attachmenturl =&HTML::Entities::encode($attachmenturl,'<>&"');
  230:     my $course_context = &get_course_context();
  231:     my $now=time;
  232:     my $msgcount = &get_uniq();
  233:     unless(defined($msgid)) {
  234:         $msgid = &buildmsgid($now,$subject,$env{'user.name'},$env{'user.domain'},
  235:                            $msgcount,$course_context,$symb,$error,$$);
  236:     }
  237:     my $result = '<sendername>'.$env{'user.name'}.'</sendername>'.
  238:            '<senderdomain>'.$env{'user.domain'}.'</senderdomain>'.
  239:            '<subject>'.$subject.'</subject>'.
  240:            '<time>'.&Apache::lonlocal::locallocaltime($now).'</time>';
  241:     if (defined($crsmsgid)) {
  242:         $result.= '<courseid>'.$course_context.'</courseid>'.
  243:                   '<coursesec>'.$env{'request.course.sec'}.'</coursesec>'.
  244:                   '<msgid>'.$msgid.'</msgid>'.
  245:                   '<coursemsgid>'.$crsmsgid.'</coursemsgid>'.
  246:                   '<message>'.$message.'</message>';
  247:         return ($msgid,$result);
  248:     }
  249:     $result .= '<servername>'.$ENV{'SERVER_NAME'}.'</servername>'.
  250:            '<host>'.$ENV{'HTTP_HOST'}.'</host>'.
  251: 	   '<client>'.$ENV{'REMOTE_ADDR'}.'</client>'.
  252: 	   '<browsertype>'.$env{'browser.type'}.'</browsertype>'.
  253: 	   '<browseros>'.$env{'browser.os'}.'</browseros>'.
  254: 	   '<browserversion>'.$env{'browser.version'}.'</browserversion>'.
  255:            '<browsermathml>'.$env{'browser.mathml'}.'</browsermathml>'.
  256: 	   '<browserraw>'.$ENV{'HTTP_USER_AGENT'}.'</browserraw>'.
  257: 	   '<courseid>'.$course_context.'</courseid>'.
  258: 	   '<coursesec>'.$env{'request.course.sec'}.'</coursesec>'.
  259: 	   '<role>'.$env{'request.role'}.'</role>'.
  260: 	   '<resource>'.$env{'request.filename'}.'</resource>'.
  261:            '<msgid>'.$msgid.'</msgid>';
  262:     if (defined($env{'form.group'})) {
  263:         $result .= '<group>'.$env{'form.group'}.'</group>';
  264:     }
  265:     if (ref($recuser) eq 'ARRAY') {
  266:         for (my $i=0; $i<@{$recuser}; $i++) {
  267:             if ($type eq 'dcmail') {
  268:                 my ($username,$email) = split(/:/,$$recuser[$i]);
  269:                 $username = &unescape($username);
  270:                 $email = &unescape($email);
  271:                 $username = &HTML::Entities::encode($username,'<>&"');
  272:                 $email = &HTML::Entities::encode($email,'<>&"');
  273:                 $result .= '<recipient username="'.$username.'">'.
  274:                                             $email.'</recipient>';
  275:             } else {
  276:                 $result .= '<recuser>'.$$recuser[$i].'</recuser>'.
  277:                            '<recdomain>'.$$recdomain[$i].'</recdomain>';
  278:             }
  279:         }
  280:     } else {
  281:         $result .= '<recuser>'.$recuser.'</recuser>'.
  282:                    '<recdomain>'.$recdomain.'</recdomain>';
  283:     }
  284:     $result .= '<message>'.$message.'</message>';
  285:     if (defined($citation)) {
  286: 	$result.='<citation>'.$citation.'</citation>';
  287:     }
  288:     if (defined($baseurl)) {
  289: 	$result.= '<baseurl>'.$baseurl.'</baseurl>';
  290:     }
  291:     if (defined($attachmenturl)) {
  292: 	$result.= '<attachmenturl>'.$attachmenturl.'</attachmenturl>';
  293:     }
  294:     if (defined($symb)) {
  295:         $result.= '<symb>'.$symb.'</symb>';
  296:         if ($course_context ne '') {
  297:             if ($course_context eq $env{'request.course.id'}) {
  298:                 my $resource_title = &Apache::lonnet::gettitle($symb);
  299:                 if (defined($resource_title)) {
  300:                     $result .= '<resource_title>'.$resource_title.'</resource_title>';
  301:                 }
  302:             }
  303:         }
  304:     }
  305:     if (defined($recipid)) {
  306:         $result.= '<recipid>'.$recipid.'</recipid>';
  307:     }
  308:     if ($env{'form.can_reply'} eq 'N') {
  309:         $result .= '<noreplies>1</noreplies>';
  310:     }
  311:     if ($env{'form.reply_to_addr'}) {
  312:         my ($replytoname,$replytodom) = split(/:/,$env{'form.reply_to_addr'});
  313:         if (!($replytoname eq $env{'user.name'} && $replytodom eq $env{'user.domain'})) {
  314:             if (&Apache::lonnet::homeserver($replytoname,$replytodom) ne 'no_host') {
  315:                 $result .= '<replytoaddr>'.$env{'form.reply_to_addr'}.'</replytoaddr>';
  316:             }
  317:         }
  318:     }
  319:     return ($msgid,$result);
  320: }
  321: 
  322: sub get_course_context {
  323:     my $course_context;
  324:     my $msgkey;
  325:     if (defined($env{'form.replyid'})) {
  326:         $msgkey = $env{'form.replyid'};
  327:     } elsif (defined($env{'form.forwid'})) {
  328:         $msgkey = $env{'form.forwid'}
  329:     } elsif (defined($env{'form.multiforwid'})) {
  330:         $msgkey = $env{'form.multiforwid'};
  331:     }
  332:     if ($msgkey ne '') {
  333:         my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid)=
  334:                    split(/\:/,&unescape($msgkey));
  335:         $course_context = $origcid;
  336:     }
  337:     foreach my $key (keys(%env)) {
  338:         if ($key=~/^form\.(rep)?rec\_(.*)$/) {
  339:             my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid) =
  340:                                     split(/\:/,&unescape($2));
  341:             $course_context = $origcid;
  342:             last;
  343:         }
  344:     }
  345:     if ($course_context eq '') {
  346:         $course_context = $env{'request.course.id'};
  347:     }
  348:     return $course_context;
  349: }
  350: 
  351: 
  352: sub unpackagemsg {
  353:     my ($message,$notoken,$noattachmentlink)=@_;
  354:     my %content=();
  355:     my $parser=HTML::TokeParser->new(\$message);
  356:     my $token;
  357:     while ($token=$parser->get_token) {
  358:        if ($token->[0] eq 'S') {
  359: 	   my $entry=$token->[1];
  360:            my $value=$parser->get_text('/'.$entry);
  361:            if (($entry eq 'recuser') || ($entry eq 'recdomain')) {
  362:                push(@{$content{$entry}},$value);
  363:            } elsif ($entry eq 'recipient') {
  364:                my $username = $token->[2]{'username'};
  365:                $username = &HTML::Entities::decode($username,'<>&"');
  366:                $content{$entry}{$username} = $value;
  367:            } else {
  368:                $content{$entry}=$value;
  369:            }
  370:        }
  371:     }
  372:     if (!exists($content{'recuser'})) { $content{'recuser'} = []; }
  373:     if (($content{'attachmenturl'}) && (!$noattachmentlink)) {
  374:        my ($fname)=($content{'attachmenturl'}=~m|/([^/]+)$|);
  375:        if ($notoken) {
  376: 	   $content{'message'}.='<p>'.&mt('Attachment').': <tt>'.$fname.'</tt>';
  377:        } else {
  378: 	   &Apache::lonnet::allowuploaded('/adm/msg',
  379: 					  $content{'attachmenturl'});
  380: 	   $content{'message'}.='<p>'.&mt('Attachment').
  381: 	       ': <a href="'.$content{'attachmenturl'}.'"><tt>'.
  382: 	       $fname.'</tt></a>';
  383:        }
  384:     }
  385:     return %content;
  386: }
  387: 
  388: 
  389: sub buildmsgid {
  390:     my ($now,$subject,$uname,$udom,$msgcount,$course_context,$symb,$error,$pid) = @_;
  391:     $subject=&escape($subject);
  392:     $symb = &escape($symb);
  393:     return(&escape($now.':'.$subject.':'.$uname.':'.
  394:            $udom.':'.$msgcount.':'.$course_context.':'.$pid.':'.$symb.':'.$error));
  395: }
  396: 
  397: sub unpackmsgid {
  398:     my ($msgid,$folder,$skipstatus,$status_cache)=@_;
  399:     $msgid=&unescape($msgid);
  400:     my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$fromcid,
  401:         $processid,$symb,$error) = split(/\:/,&unescape($msgid));
  402:     $shortsubj = &unescape($shortsubj);
  403:     $shortsubj = &HTML::Entities::decode($shortsubj);
  404:     $symb = &unescape($symb);
  405:     if (!defined($processid)) { $fromcid = ''; }
  406:     my %status=();
  407:     unless ($skipstatus) {
  408: 	if (ref($status_cache)) {
  409: 	    $status{$msgid} = $status_cache->{$msgid};
  410: 	} else {
  411: 	    my $suffix=&foldersuffix($folder);
  412: 	    %status=&Apache::lonnet::get('email_status'.$suffix,[$msgid]);
  413: 	}
  414: 	if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; }
  415:         unless ($status{$msgid}) { $status{$msgid}='new'; }
  416:     }
  417:     return ($sendtime,$shortsubj,$fromname,$fromdomain,$status{$msgid},$fromcid,$symb,$error);
  418: }
  419: 
  420: 
  421: sub sendemail {
  422:     my ($to,$subject,$body,$to_uname,$to_udom,$user_lh)=@_;
  423:     my $senderaddress='';
  424:     my $replytoaddress='';
  425:     if ($env{'form.can_reply'} eq 'N') {
  426:         my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
  427:         my $hostname = &Apache::lonnet::hostname($lonhost);
  428:         $replytoaddress = 'do-not-reply@'.$hostname;
  429:     } else {
  430:         my %senderemails;
  431:         my $have_sender;
  432:         if ($env{'form.reply_to_addr'}) {
  433:             my ($replytoname,$replytodom) = split(/:/,$env{'form.reply_to_addr'});
  434:             if (!($replytoname eq $env{'user.name'} && $replytodom eq $env{'user.domain'})) {
  435:                 if (&Apache::lonnet::homeserver($replytoname,$replytodom) ne 'no_host') {
  436:                     %senderemails = 
  437:                         &Apache::loncommon::getemails($replytoname,$replytodom);
  438:                     $have_sender = 1;
  439:                 }
  440:             }
  441:         }
  442:         if (!$have_sender) {
  443:             %senderemails=&Apache::loncommon::getemails();
  444:         }
  445:         foreach my $type ('permanentemail','critnotification','notification') {
  446:             if ($senderemails{$type}) {
  447:                 ($senderaddress) = split(/,/,$senderemails{$type});
  448:                 last if ($senderaddress);
  449:             }
  450:         }
  451:     }
  452:     $body=
  453:     "*** ".&mt_user($user_lh,'This is an automatic e-mail generated by the LON-CAPA system.')."\n".
  454:     "*** ".($senderaddress?&mt_user($user_lh,'You can reply to this e-mail'):&mt_user($user_lh,'Please do not reply to this address.')."\n*** ".
  455:     &mt_user($user_lh,'A reply will not be received by the recipient!'))."\n\n".$body;
  456:     
  457:     $body =~ s/&nbsp;/ /g;
  458:     
  459:     my $msg = new Mail::Send;
  460:     $msg->to($to);
  461:     $msg->subject('[LON-CAPA] '.$subject);
  462:     if ($replytoaddress) {
  463:         $msg->add('Reply-to',$replytoaddress);
  464:     }
  465:     if ($senderaddress) {
  466:         $msg->add('From',$senderaddress);
  467:     }
  468:     if (my $fh = $msg->open()) {
  469: 	print $fh $body;
  470: 	$fh->close;
  471:     }
  472: }
  473: 
  474: # ==================================================== Send notification emails
  475: 
  476: sub sendnotification {
  477:     my ($to,$touname,$toudom,$subj,$crit,$text,$msgid)=@_;
  478:     my $sender=$env{'environment.firstname'}.' '.$env{'environment.lastname'};
  479:     unless ($sender=~/\w/) { 
  480: 	$sender=$env{'user.name'}.':'.$env{'user.domain'};
  481:     }
  482:     my $critical=($crit?' critical':'');
  483: 
  484:     $text=~s/\&lt\;/\</gs;
  485:     $text=~s/\&gt\;/\>/gs;
  486:     my $homeserver = &Apache::lonnet::homeserver($touname,$toudom);
  487:     my $protocol = $Apache::lonnet::protocol{$homeserver};
  488:     $protocol = 'http' if ($protocol ne 'https');
  489:     my $url = $protocol.'://'.&Apache::lonnet::hostname($homeserver).
  490:               '/adm/email?username='.$touname.'&domain='.$toudom;
  491:     my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid,
  492:         $symb,$error) = &Apache::lonmsg::unpackmsgid($msgid);
  493:     my ($coursetext,$body,$bodybegin,$bodysubj,$bodyend);
  494:     my $user_lh = &Apache::loncommon::user_lang($touname,$toudom,$fromcid);
  495:     if ($fromcid ne '') {
  496:         $coursetext = "\n".&mt_user($user_lh,'Course').': ';
  497:         if ($env{'course.'.$fromcid.'.description'} ne '') {
  498:             $coursetext .= $env{'course.'.$fromcid.'.description'};
  499:         } else {
  500:             my %coursehash = &Apache::lonnet::coursedescription($fromcid,);
  501:             if ($coursehash{'description'} ne '') {
  502:                 $coursetext .= $coursehash{'description'};
  503:             }
  504:         }
  505:         $coursetext .= "\n\n";
  506:     }
  507:     my @recipients = split(/,/,$to);
  508:     $bodybegin = $coursetext. 
  509:                &mt_user($user_lh,
  510:                          'You received a'.$critical.' message from [_1] in LON-CAPA.',$sender).' ';
  511:     $bodysubj = &mt_user($user_lh,'The subject is 
  512: 
  513:  [_1]
  514: 
  515: ',$subj)."\n".
  516: '=== '.&mt_user($user_lh,'Excerpt')." ============================================================
  517: ";
  518:     $bodyend = "
  519: ========================================================================
  520: 
  521: ".&mt_user($user_lh,'Use 
  522: 
  523:  [_1]
  524: 
  525: to access the full message.',$url);
  526:     my %userenv = &Apache::lonnet::get('environment',['notifywithhtml'],$toudom,$touname);
  527:     my $subject = &mt_user($user_lh,"'New' $critical message from ").$sender;
  528:  
  529:     my ($blocked,$blocktext);
  530:     if (!$crit) {
  531:         my %setters;
  532:         my ($startblock,$endblock) = 
  533:             &Apache::loncommon::blockcheck(\%setters,'com',$touname,$toudom);
  534:         if ($startblock && $endblock) {
  535:             $blocked = 1;
  536:             my $showstart = &Apache::lonlocal::locallocaltime($startblock);
  537:             my $showend = &Apache::lonlocal::locallocaltime($endblock);
  538:             $blocktext = &mt_user($user_lh,'LON-CAPA messages sent to you between [_1] and [_2] will be inaccessible until the end of this time period, because you are a student in a course with an active communications block.',$showstart,$showend);
  539:         }
  540:     }
  541:     if ($userenv{'notifywithhtml'} ne '') {
  542:         my @htmlexcerpt = split(/,/,$userenv{'notifywithhtml'});
  543:         foreach my $addr (@recipients) {
  544:             if ($blocked) {
  545:                 $body = $bodybegin."\n".$blocktext."\n".$bodyend;
  546:             } else {
  547:                 my $sendtext = $text;
  548:                 if (!grep/^\Q$addr\E/,@htmlexcerpt) {
  549:                     $sendtext =~ s/\<\/*[^\>]+\>//gs;
  550:                 }
  551:                 $body = $bodybegin.$bodysubj.$sendtext.$bodyend;
  552:             }
  553:             &sendemail($addr,$subject,$body,$touname,$toudom,$user_lh);
  554:         }
  555:     } else {
  556:         if ($blocked) {
  557:             $body = $bodybegin."\n".$blocktext."\n".$bodyend;
  558:         } else {
  559:             $text =~ s/\<\/*[^\>]+\>//gs;
  560:             $body = $bodybegin.$bodysubj.$text.$bodyend;
  561:         }
  562:         &sendemail($to,$subject,$body,$touname,$toudom,$user_lh);
  563:     }
  564: }
  565: 
  566: sub mynewmail{
  567: 	&newmail();
  568: 	return $env{'user.mailcheck.lastnewmassagetime'} > $env{'user.mailcheck.lastvisit'};
  569: }
  570: 
  571: 
  572: sub newmail {
  573:     if ((time-$env{'user.mailcheck.time'})>300) {
  574:         my %what=&Apache::lonnet::get('email_status',['recnewemail']);
  575:         &Apache::lonnet::appenv({'user.mailcheck.time'=>time});
  576: 		&Apache::lonnet::appenv({'user.mailcheck.lastnewmassagetime'=> $what{'recnewemail'}});
  577:         if ($what{'recnewemail'}>0) { return 1; }
  578:     }
  579:     return 0;
  580: }
  581: 
  582: 
  583: 
  584: sub author_res_msg {
  585:     my ($filename,$message)=@_;
  586:     unless ($message) { return 'empty'; }
  587:     $filename=&Apache::lonnet::declutter($filename);
  588:     my ($domain,$author,@dummy)=split(/\//,$filename);
  589:     my $homeserver=&Apache::lonnet::homeserver($author,$domain);
  590:     if ($homeserver ne 'no_host') {
  591:        my $id=unpack("%32C*",$message);
  592:        $message .= " <p>This error occurred on machine ".
  593: 	   $Apache::lonnet::perlvar{'lonHostID'}."</p>";
  594:        my $msgid;
  595:        ($msgid,$message)=&packagemsg($filename,$message);
  596:        return &Apache::lonnet::reply('put:'.$domain.':'.$author.
  597:          ':nohist_res_msgs:'.
  598:           &escape($filename.'_'.$id).'='.
  599:           &escape($message),$homeserver);
  600:     }
  601:     return 'no_host';
  602: }
  603: 
  604: 
  605: 
  606: sub retrieve_author_res_msg {
  607:     my $url=shift;
  608:     $url=&Apache::lonnet::declutter($url);
  609:     my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
  610:     my %errormsgs=&Apache::lonnet::dump('nohist_res_msgs',$domain,$author);
  611:     my $msgs='';
  612:     foreach (keys %errormsgs) {
  613: 	if ($_=~/^\Q$url\E\_\d+$/) {
  614: 	    my %content=&unpackagemsg($errormsgs{$_});
  615: 	    $msgs.='<p><img src="/adm/lonMisc/bomb.gif" /><b>'.
  616: 		$content{'time'}.'</b>: '.$content{'message'}.
  617: 		'<br /></p>';
  618: 	}
  619:     } 
  620:     return $msgs;     
  621: }
  622: 
  623: 
  624: 
  625: 
  626: 
  627: sub del_url_author_res_msg {
  628:     my $url=shift;
  629:     $url=&Apache::lonnet::declutter($url);
  630:     my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
  631:     my @delmsgs=();
  632:     foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
  633: 	if ($_=~/^\Q$url\E\_\d+$/) {
  634: 	    push (@delmsgs,$_);
  635: 	}
  636:     }
  637:     return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
  638: }
  639: 
  640: 
  641: sub clear_author_res_msg {
  642:     my $url=shift;
  643:     $url=&Apache::lonnet::declutter($url);
  644:     my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
  645:     my @delmsgs=();
  646:     foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
  647: 	if ($_=~/^\Q$url\E/) {
  648: 	    push (@delmsgs,$_);
  649: 	}
  650:     }
  651:     return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
  652: }
  653: 
  654: 
  655: 
  656: sub all_url_author_res_msg {
  657:     my ($author,$domain)=@_;
  658:     my %returnhash=();
  659:     foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
  660: 	$_=~/^(.+)\_\d+/;
  661: 	$returnhash{$1}=1;
  662:     }
  663:     return %returnhash;
  664: }
  665: 
  666: 
  667: sub store_instructor_comment {
  668:     my ($msg,$uname,$udom) = @_;
  669:     my $cid  = $env{'request.course.id'};
  670:     my $cnum = $env{'course.'.$cid.'.num'};
  671:     my $cdom = $env{'course.'.$cid.'.domain'};
  672:     my $subject= &mt('Record').' ['.$uname.':'.$udom.']';
  673:     my $result = &user_normal_msg_raw($cnum,$cdom,$subject,$msg);
  674:     if ($result eq 'ok' || $result eq 'con_delayed') {
  675:         
  676:     }
  677:     return $result;
  678: }
  679: 
  680: 
  681: sub user_crit_msg_raw {
  682:     my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
  683:         $nosentstore,$recipid,$attachmenturl)=@_;
  684: # Check if allowed missing
  685:     my ($status,$packed_message);
  686:     my $msgid='undefined';
  687:     unless (($message)&&($user)&&($domain)) { $status='empty'; };
  688:     my $text=$message;
  689:     my $homeserver=&Apache::lonnet::homeserver($user,$domain);
  690:     if ($homeserver ne 'no_host') {
  691:        ($msgid,$packed_message)=&packagemsg($subject,$message,undef,undef,
  692:                                   $attachmenturl,undef,undef,undef,undef,undef,
  693:                                   undef,undef,$recipid);
  694:        if ($sendback) { $packed_message.='<sendback>true</sendback>'; }
  695:        $status=&Apache::lonnet::cput('critical', {$msgid => $packed_message},
  696: 				     $domain,$user);
  697:         if (defined($sentmessage)) {
  698:             $$sentmessage = $packed_message;
  699:         }
  700:         if (!$nosentstore) {
  701:             (undef,my $packed_message_no_citation) =
  702:             &packagemsg($subject,$message,undef,undef,$attachmenturl,$user,
  703:                         $domain,$msgid);
  704:             if ($status eq 'ok' || $status eq 'con_delayed') {
  705:                 &store_sent_mail($msgid,$packed_message_no_citation);
  706:             }
  707:         }
  708:     } else {
  709:        $status='no_host';
  710:     }
  711: 
  712: # Notifications
  713:     my %userenv = &Apache::loncommon::getemails($user,$domain);
  714:     if ($userenv{'critnotification'}) {
  715:       &sendnotification($userenv{'critnotification'},$user,$domain,$subject,1,
  716: 			$text,$msgid);
  717:     }
  718:     if ($toperm && $userenv{'permanentemail'}) {
  719:       &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,1,
  720: 			$text,$msgid);
  721:     }
  722: # Log this
  723:     &Apache::lonnet::logthis(
  724:       'Sending critical email '.$msgid.
  725:       ', log status: '.
  726:       &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
  727:                          $env{'user.home'},
  728:       'Sending critical '.$msgid.' to '.$user.' at '.$domain.' with status: '
  729:       .$status));
  730:     return $status;
  731: }
  732: 
  733: 
  734: 
  735: sub user_crit_msg {
  736:     my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
  737:         $nosentstore,$recipid,$attachmenturl)=@_;
  738:     my @status;
  739:     my %userenv = &Apache::lonnet::get('environment',['msgforward'],
  740:                                        $domain,$user);
  741:     my $msgforward=$userenv{'msgforward'};
  742:     if ($msgforward) {
  743:        foreach my $addr (split(/\,/,$msgforward)) {
  744: 	 my ($forwuser,$forwdomain)=split(/\:/,$addr);
  745:          push(@status,
  746: 	      &user_crit_msg_raw($forwuser,$forwdomain,$subject,$message,
  747: 				 $sendback,$toperm,$sentmessage,$nosentstore,
  748:                                  $recipid,$attachmenturl));
  749:        }
  750:     } else { 
  751: 	push(@status,
  752: 	     &user_crit_msg_raw($user,$domain,$subject,$message,$sendback,
  753: 				$toperm,$sentmessage,$nosentstore,$recipid,
  754:                                 $attachmenturl));
  755:     }
  756:     if (wantarray) {
  757: 	return @status;
  758:     }
  759:     return join(' ',@status);
  760: }
  761: 
  762: 
  763: sub user_crit_received {
  764:     my $msgid=shift;
  765:     my %message=&Apache::lonnet::get('critical',[$msgid]);
  766:     my %contents=&unpackagemsg($message{$msgid},1);
  767:     my $destname = $contents{'sendername'};
  768:     my $destdom = $contents{'senderdomain'};
  769:     if ($contents{'replytoaddr'}) {
  770:         my ($repname,$repdom) = split(/:/,$contents{'replytoaddr'});
  771:         if (&Apache::lonnet::homeserver($repname,$repdom) ne 'no_host') {
  772:             $destname = $repname;
  773:             $destdom = $repdom;    
  774:         }
  775:     }
  776:     my $status='rec: '.($contents{'sendback'}?
  777:      &user_normal_msg($destname,$destdom,&mt('Receipt').': '.$env{'user.name'}.
  778:                       ' '.&mt('at').' '.$env{'user.domain'}.', '.
  779:                       $contents{'subject'},&mt('User').' '.$env{'user.name'}.
  780:                       ' '.&mt('at').' '.$env{'user.domain'}.
  781:                       ' acknowledged receipt of message'."\n".'   "'.
  782:                       $contents{'subject'}.'"'."\n".&mt('dated').' '.
  783:                       $contents{'time'}.".\n"
  784:                       ):'no msg req');
  785:     $status.=' trans: '.
  786:      &Apache::lonnet::put(
  787:      'nohist_email',{$contents{'msgid'} => $message{$msgid}});
  788:     $status.=' del: '.
  789:      &Apache::lonnet::del('critical',[$contents{'msgid'}]);
  790:     &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
  791:                          $env{'user.home'},'Received critical message '.
  792:                          $contents{'msgid'}.
  793:                          ', '.$status);
  794:     return $status;
  795: }
  796: 
  797: 
  798: 
  799: 
  800: sub user_normal_msg_raw {
  801:     my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
  802:         $toperm,$currid,$newid,$sentmessage,$crsmsgid,$symb,$restitle,
  803:         $error,$nosentstore,$recipid)=@_;
  804: # Check if allowed missing
  805:     my ($status,$packed_message);
  806:     my $msgid='undefined';
  807:     my $text=$message;
  808:     unless (($message)&&($user)&&($domain)) { $status='empty'; };
  809:     my $homeserver=&Apache::lonnet::homeserver($user,$domain);
  810:     if ($homeserver ne 'no_host') {
  811:        ($msgid,$packed_message)=
  812: 	                 &packagemsg($subject,$message,$citation,$baseurl,
  813:                                      $attachmenturl,$user,$domain,$currid,
  814:                                      undef,$crsmsgid,$symb,$error,$recipid);
  815: 
  816: # Store in user folder
  817:        $status=
  818: 	   &Apache::lonnet::cput('nohist_email',{$msgid => $packed_message},
  819: 				 $domain,$user);
  820: # Save new message received time
  821:        &Apache::lonnet::put
  822:                          ('email_status',{'recnewemail'=>time},$domain,$user);
  823: # Into sent-mail folder if sent mail storage required
  824:        if (!$nosentstore) {
  825:            (undef,my $packed_message_no_citation) =
  826:                &packagemsg($subject,$message,undef,$baseurl,$attachmenturl,
  827:                            $user,$domain,$currid,undef,$crsmsgid,$symb,$error);
  828:            if ($status eq 'ok' || $status eq 'con_delayed') {
  829:                &store_sent_mail($msgid,$packed_message_no_citation);
  830:            }
  831:        }
  832:        if (ref($newid) eq 'SCALAR') {
  833: 	   $$newid = $msgid;
  834:        }
  835:        if (ref($sentmessage) eq 'SCALAR') {
  836: 	   $$sentmessage = $packed_message;
  837:        }
  838: # Notifications
  839:        my %userenv = &Apache::loncommon::getemails($user,$domain);
  840:        if ($userenv{'notification'}) {
  841: 	   &sendnotification($userenv{'notification'},$user,$domain,$subject,0,
  842: 			     $text,$msgid);
  843:        }
  844:        if ($toperm && $userenv{'permanentemail'}) {
  845:            if ((!$userenv{'notification'}) || ($userenv{'notification'} ne $userenv{'permanentemail'})) {
  846: 	       &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,
  847: 	  		         $text,$msgid);
  848:            }
  849:        }
  850:        &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
  851: 			    $env{'user.home'},
  852: 			    'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status);
  853:    } else {
  854:        $status='no_host';
  855:    }
  856:     return $status;
  857: }
  858: 
  859: sub user_normal_msg {
  860:     my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
  861: 	$toperm,$sentmessage,$symb,$restitle,$error,$nosentstore,$recipid)=@_;
  862:     my @status;
  863:     my %userenv = &Apache::lonnet::get('environment',['msgforward'],
  864:                                        $domain,$user);
  865:     my $msgforward=$userenv{'msgforward'};
  866:     if ($msgforward) {
  867:         foreach (split(/\,/,$msgforward)) {
  868: 	    my ($forwuser,$forwdomain)=split(/\:/,$_);
  869: 	    push(@status,
  870: 	        &user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,
  871: 				     $citation,$baseurl,$attachmenturl,$toperm,
  872: 				     undef,undef,$sentmessage,undef,$symb,
  873:                                      $restitle,$error,$nosentstore,$recipid));
  874:         }
  875:     } else {
  876: 	push(@status,&user_normal_msg_raw($user,$domain,$subject,$message,
  877: 				     $citation,$baseurl,$attachmenturl,$toperm,
  878: 				     undef,undef,$sentmessage,undef,$symb,
  879:                                      $restitle,$error,$nosentstore,$recipid));
  880:     }
  881:     if (wantarray) {
  882:         return @status;
  883:     }
  884:     return join(' ',@status);
  885: }
  886: 
  887: sub process_sent_mail {
  888:     my ($msgsubj,$subj_prefix,$numsent,$stamp,$msgname,$msgdom,$msgcount,$context,$pid,$savemsg,$recusers,$recudoms,$baseurl,$attachmenturl,$symb,$error,$senderuname,$senderdom,$recipid) = @_;
  889:     my $sentsubj;
  890:     if ($numsent > 1) {
  891:         $sentsubj = $subj_prefix.' ('.$numsent.' sent) '.$msgsubj;
  892:     } else {
  893:         if ($subj_prefix) {
  894:             $sentsubj = $subj_prefix.' ';
  895:         }
  896:         $sentsubj .= $msgsubj;
  897:     }
  898:     $sentsubj = &HTML::Entities::encode($sentsubj,'<>&"');
  899:     my $sentmsgid = 
  900:         &buildmsgid($stamp,$sentsubj,$msgname,$msgdom,$msgcount,$context,$pid);
  901:     (undef,my $sentmessage) =
  902:         &packagemsg($msgsubj,$savemsg,undef,$baseurl,$attachmenturl,$recusers,
  903:                     $recudoms,$sentmsgid,undef,undef,$symb,$error,$recipid);
  904:     my $status = &store_sent_mail($sentmsgid,$sentmessage,$senderuname,
  905:                                   $senderdom);
  906:     return $status;
  907: }
  908: 
  909: sub store_sent_mail {
  910:     my ($msgid,$message,$senderuname,$senderdom) = @_;
  911:     if ($senderuname eq '') {
  912:         $senderuname = $env{'user.name'};
  913:     }
  914:     if ($senderdom eq '') {
  915:         $senderdom = $env{'user.domain'};
  916:     }
  917:     my $status =' '.&Apache::lonnet::cput('nohist_email_sent',
  918: 					  {$msgid => $message},
  919: 					  $senderdom,$senderuname);
  920:     return $status;
  921: }
  922: 
  923: sub store_recipients {
  924:     my ($subject,$sendername,$senderdom,$reciphash) = @_;
  925:     my $context = &get_course_context();
  926:     my $now = time();
  927:     my $msgcount = &get_uniq();
  928:     my $recipid =
  929:         &buildmsgid($now,$subject,$sendername,$senderdom,$msgcount,$context,$$);
  930:     my %recipinfo = (
  931:                          $recipid => $reciphash,
  932:                     );
  933:     my $status = &Apache::lonnet::put('nohist_emailrecip',\%recipinfo,
  934:                                       $senderdom,$sendername); 
  935:     if ($status eq 'ok') {
  936:         return ($recipid,$status);
  937:     } else {
  938:         return (undef,$status);
  939:     }
  940: }
  941: 
  942: 
  943: sub foldersuffix {
  944:     my $folder=shift;
  945:     unless ($folder) { return ''; }
  946:     my $suffix;
  947:     my %folderhash = &get_user_folders($folder);
  948:     if (ref($folderhash{$folder}) eq 'HASH') {
  949:         $suffix = '_'.&escape($folderhash{$folder}{'id'});
  950:     } else {
  951:         $suffix = '_'.&escape($folder);
  952:     }
  953:     return $suffix;
  954: }
  955: 
  956: 
  957: sub get_user_folders {
  958:     my ($folder) = @_;
  959:     my %userfolders = 
  960:           &Apache::lonnet::dump('email_folders',undef,undef,$folder);
  961:     my $lock = "\0".'lock_counter'; # locks db while counter incremented
  962:     my $counter = "\0".'idcount';   # used in suffix for email db files
  963:     if (defined($userfolders{$lock})) {
  964:         delete($userfolders{$lock});
  965:     }
  966:     if (defined($userfolders{$counter})) {
  967:         delete($userfolders{$counter});
  968:     }
  969:     return %userfolders;
  970: }
  971: 
  972: sub secapply {
  973:     my $rec=shift;
  974:     my $defaultflag=shift;
  975:     $rec=~s/\s+//g;
  976:     $rec=~s/\@/\:/g;
  977:     my ($adr,$sections_or_groups)=($rec=~/^([^\(]+)\(([^\)]+)\)/);
  978:     if ($sections_or_groups) {
  979: 	foreach my $item (split(/\;/,$sections_or_groups)) {
  980:             if (($item eq $env{'request.course.sec'}) ||
  981:                 ($defaultflag && ($item eq '*'))) {
  982:                 return $adr; 
  983:             } elsif ($env{'request.course.groups'}) {
  984:                 my @usersgroups = split(/:/,$env{'request.course.groups'});
  985:                 if (grep(/^\Q$item\E$/,@usersgroups)) {
  986:                     return $adr;
  987:                 }
  988:             } 
  989:         }
  990:     } else {
  991:        return $rec;
  992:     }
  993:     return '';
  994: }
  995: 
  996: sub decide_receiver {
  997:     my ($feedurl,$author,$question,$course,$policy,$defaultflag) = @_;
  998:     &Apache::lonenc::check_decrypt(\$feedurl);
  999:     my $typestyle='';
 1000:     my %to=();
 1001:     if ($env{'form.discuss'} eq 'author' ||$author) {
 1002: 	$typestyle.='Submitting as Author Feedback<br />';
 1003: 	$feedurl=~ m{^/res/($LONCAPA::domain_re)/($LONCAPA::username_re)/};
 1004: 	$to{$2.':'.$1}=1;
 1005:     }
 1006:     my $cid = $env{'request.course.id'};
 1007:     if ($env{'form.discuss'} eq 'question' ||$question) {
 1008: 	$typestyle.=&mt('Submitting as Question').'<br />';
 1009: 	foreach my $item (split(/\,/,$env{'course.'.$cid.'.question.email'})) {
 1010: 	    my $rec=&secapply($item,$defaultflag);
 1011: 	    if ($rec) { $to{$rec}=1; }
 1012: 	} 
 1013:     }
 1014:     if ($env{'form.discuss'} eq 'course' ||$course) {
 1015: 	$typestyle.=&mt('Submitting as Comment').'<br />';
 1016: 	foreach my $item (split(/\,/,$env{'course.'.$cid.'.comment.email'})) {
 1017: 	    my $rec=&secapply($item,$defaultflag);
 1018: 	    if ($rec) { $to{$rec}=1; }
 1019: 	} 
 1020:     }
 1021:     if ($env{'form.discuss'} eq 'policy' ||$policy) {
 1022: 	$typestyle.=&mt('Submitting as Policy Feedback').'<br />';
 1023: 	foreach my $item (split(/\,/,$env{'course.'.$cid.'.policy.email'})) {
 1024: 	    my $rec=&secapply($item,$defaultflag);
 1025: 	    if ($rec) { $to{$rec}=1; }
 1026: 	} 
 1027:     }
 1028:     if ((scalar(%to) eq '0') && (!$defaultflag)) {
 1029: 	($typestyle,%to)=
 1030: 	    &decide_receiver($feedurl,$author,$question,$course,$policy,1);
 1031:     }
 1032:     return ($typestyle,%to);
 1033: }
 1034: 
 1035: 1;
 1036: __END__
 1037: 

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