Annotation of loncom/interface/lonmsg.pm, revision 1.205

1.1       www         1: # The LearningOnline Network with CAPA
1.26      albertel    2: # Routines for messaging
                      3: #
1.205   ! raeburn     4: # $Id: lonmsg.pm,v 1.204 2007/05/05 03:14:21 raeburn Exp $
1.26      albertel    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/
1.1       www        27: #
1.75      www        28: 
1.1       www        29: package Apache::lonmsg;
                     30: 
1.199     raeburn    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 FUNCTIONS
                     57: 
                     58: =over 4
                     59: 
                     60: =cut
                     61: 
1.1       www        62: use strict;
1.140     albertel   63: use Apache::lonnet;
1.47      albertel   64: use HTML::TokeParser();
1.180     albertel   65: use Apache::lonlocal;
1.53      www        66: use Mail::Send;
1.187     albertel   67: use LONCAPA qw(:DEFAULT :match);
1.180     albertel   68: 
                     69: {
                     70:     my $uniq;
                     71:     sub get_uniq {
                     72: 	$uniq++;
                     73: 	return $uniq;
                     74:     }
                     75: }
1.65      www        76: 
1.1       www        77: # ===================================================================== Package
                     78: 
1.3       www        79: sub packagemsg {
1.108     www        80:     my ($subject,$message,$citation,$baseurl,$attachmenturl,
1.202     raeburn    81: 	$recuser,$recdomain,$msgid,$type,$crsmsgid,$symb,$error,$recipid)=@_;
1.96      albertel   82:     $message =&HTML::Entities::encode($message,'<>&"');
                     83:     $citation=&HTML::Entities::encode($citation,'<>&"');
                     84:     $subject =&HTML::Entities::encode($subject,'<>&"');
1.49      albertel   85:     #remove machine specification
                     86:     $baseurl =~ s|^http://[^/]+/|/|;
1.96      albertel   87:     $baseurl =&HTML::Entities::encode($baseurl,'<>&"');
1.51      www        88:     #remove machine specification
                     89:     $attachmenturl =~ s|^http://[^/]+/|/|;
1.96      albertel   90:     $attachmenturl =&HTML::Entities::encode($attachmenturl,'<>&"');
1.201     raeburn    91:     my $course_context = &get_course_context();
1.2       www        92:     my $now=time;
1.180     albertel   93:     my $msgcount = &get_uniq();
1.156     raeburn    94:     unless(defined($msgid)) {
1.159     raeburn    95:         $msgid = &buildmsgid($now,$subject,$env{'user.name'},$env{'user.domain'},
1.191     raeburn    96:                            $msgcount,$course_context,$symb,$error,$$);
1.156     raeburn    97:     }
1.174     raeburn    98:     my $result = '<sendername>'.$env{'user.name'}.'</sendername>'.
1.140     albertel   99:            '<senderdomain>'.$env{'user.domain'}.'</senderdomain>'.
1.1       www       100:            '<subject>'.$subject.'</subject>'.
1.174     raeburn   101:            '<time>'.&Apache::lonlocal::locallocaltime($now).'</time>';
                    102:     if (defined($crsmsgid)) {
                    103:         $result.= '<courseid>'.$course_context.'</courseid>'.
                    104:                   '<coursesec>'.$env{'request.course.sec'}.'</coursesec>'.
                    105:                   '<msgid>'.$msgid.'</msgid>'.
                    106:                   '<coursemsgid>'.$crsmsgid.'</coursemsgid>'.
                    107:                   '<message>'.$message.'</message>';
                    108:         return ($msgid,$result);
                    109:     }
                    110:     $result .= '<servername>'.$ENV{'SERVER_NAME'}.'</servername>'.
1.1       www       111:            '<host>'.$ENV{'HTTP_HOST'}.'</host>'.
                    112: 	   '<client>'.$ENV{'REMOTE_ADDR'}.'</client>'.
1.140     albertel  113: 	   '<browsertype>'.$env{'browser.type'}.'</browsertype>'.
                    114: 	   '<browseros>'.$env{'browser.os'}.'</browseros>'.
                    115: 	   '<browserversion>'.$env{'browser.version'}.'</browserversion>'.
                    116:            '<browsermathml>'.$env{'browser.mathml'}.'</browsermathml>'.
1.1       www       117: 	   '<browserraw>'.$ENV{'HTTP_USER_AGENT'}.'</browserraw>'.
1.158     raeburn   118: 	   '<courseid>'.$course_context.'</courseid>'.
1.140     albertel  119: 	   '<coursesec>'.$env{'request.course.sec'}.'</coursesec>'.
                    120: 	   '<role>'.$env{'request.role'}.'</role>'.
                    121: 	   '<resource>'.$env{'request.filename'}.'</resource>'.
1.156     raeburn   122:            '<msgid>'.$msgid.'</msgid>';
                    123:     if (ref($recuser) eq 'ARRAY') {
                    124:         for (my $i=0; $i<@{$recuser}; $i++) {
1.162     raeburn   125:             if ($type eq 'dcmail') {
                    126:                 my ($username,$email) = split(/:/,$$recuser[$i]);
1.184     www       127:                 $username = &unescape($username);
                    128:                 $email = &unescape($email);
1.162     raeburn   129:                 $username = &HTML::Entities::encode($username,'<>&"');
                    130:                 $email = &HTML::Entities::encode($email,'<>&"');
                    131:                 $result .= '<recipient username="'.$username.'">'.
                    132:                                             $email.'</recipient>';
                    133:             } else {
                    134:                 $result .= '<recuser>'.$$recuser[$i].'</recuser>'.
                    135:                            '<recdomain>'.$$recdomain[$i].'</recdomain>';
                    136:             }
1.156     raeburn   137:         }
                    138:     } else {
                    139:         $result .= '<recuser>'.$recuser.'</recuser>'.
                    140:                    '<recdomain>'.$recdomain.'</recdomain>';
                    141:     }
                    142:     $result .= '<message>'.$message.'</message>';
1.49      albertel  143:     if (defined($citation)) {
                    144: 	$result.='<citation>'.$citation.'</citation>';
                    145:     }
                    146:     if (defined($baseurl)) {
                    147: 	$result.= '<baseurl>'.$baseurl.'</baseurl>';
                    148:     }
1.51      www       149:     if (defined($attachmenturl)) {
1.52      www       150: 	$result.= '<attachmenturl>'.$attachmenturl.'</attachmenturl>';
1.51      www       151:     }
1.191     raeburn   152:     if (defined($symb)) {
                    153:         $result.= '<symb>'.$symb.'</symb>';
1.201     raeburn   154:         if ($course_context ne '') {
1.191     raeburn   155:             if ($course_context eq $env{'request.course.id'}) {
                    156:                 my $resource_title = &Apache::lonnet::gettitle($symb);
                    157:                 if (defined($resource_title)) {
                    158:                     $result .= '<resource_title>'.$resource_title.'</resource_title>';
                    159:                 }
                    160:             }
                    161:         }
                    162:     }
1.202     raeburn   163:     if (defined($recipid)) {
                    164:         $result.= '<recipid>'.$recipid.'</recipid>';
                    165:     }
1.204     raeburn   166:     if ($env{'form.can_reply'} eq 'N') {
                    167:         $result .= '<noreplies>1</noreplies>';
                    168:     }
                    169:     if ($env{'form.reply_to_addr'}) {
                    170:         my ($replytoname,$replytodom) = split(/:/,$env{'form.reply_to_addr'});
                    171:         if (!($replytoname eq $env{'user.name'} && $replytodom eq $env{'user.domain'})) {
                    172:             if (&Apache::lonnet::homeserver($replytoname,$replytodom) ne 'no_host') {
                    173:                 $result .= '<replytoaddr>'.$env{'form.reply_to_addr'}.'</replytoaddr>';
                    174:             }
                    175:         }
                    176:     }
1.191     raeburn   177:     return ($msgid,$result);
1.1       www       178: }
                    179: 
1.201     raeburn   180: sub get_course_context {
                    181:     my $course_context;
                    182:     if (defined($env{'form.replyid'})) {
                    183:         my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid)=
                    184:                    split(/\:/,&unescape($env{'form.replyid'}));
                    185:         $course_context = $origcid;
                    186:     }
                    187:     foreach my $key (keys(%env)) {
                    188:         if ($key=~/^form\.(rep)?rec\_(.*)$/) {
                    189:             my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid) =
                    190:                                     split(/\:/,&unescape($2));
                    191:             $course_context = $origcid;
                    192:             last;
                    193:         }
                    194:     }
                    195:     if ($course_context eq '') {
                    196:         $course_context = $env{'request.course.id'};
                    197:     }
                    198:     return $course_context;
                    199: }
                    200: 
1.2       www       201: # ================================================== Unpack message into a hash
                    202: 
1.3       www       203: sub unpackagemsg {
1.52      www       204:     my ($message,$notoken)=@_;
1.2       www       205:     my %content=();
                    206:     my $parser=HTML::TokeParser->new(\$message);
                    207:     my $token;
                    208:     while ($token=$parser->get_token) {
                    209:        if ($token->[0] eq 'S') {
                    210: 	   my $entry=$token->[1];
                    211:            my $value=$parser->get_text('/'.$entry);
1.156     raeburn   212:            if (($entry eq 'recuser') || ($entry eq 'recdomain')) {
                    213:                push(@{$content{$entry}},$value);
1.162     raeburn   214:            } elsif ($entry eq 'recipient') {
                    215:                my $username = $token->[2]{'username'};
                    216:                $username = &HTML::Entities::decode($username,'<>&"');
                    217:                $content{$entry}{$username} = $value;
1.156     raeburn   218:            } else {
                    219:                $content{$entry}=$value;
                    220:            }
1.2       www       221:        }
                    222:     }
1.168     albertel  223:     if (!exists($content{'recuser'})) { $content{'recuser'} = []; }
1.52      www       224:     if ($content{'attachmenturl'}) {
1.100     albertel  225:        my ($fname)=($content{'attachmenturl'}=~m|/([^/]+)$|);
1.52      www       226:        if ($notoken) {
1.100     albertel  227: 	   $content{'message'}.='<p>'.&mt('Attachment').': <tt>'.$fname.'</tt>';
1.52      www       228:        } else {
1.99      albertel  229: 	   &Apache::lonnet::allowuploaded('/adm/msg',
                    230: 					  $content{'attachmenturl'});
                    231: 	   $content{'message'}.='<p>'.&mt('Attachment').
                    232: 	       ': <a href="'.$content{'attachmenturl'}.'"><tt>'.
1.100     albertel  233: 	       $fname.'</tt></a>';
1.52      www       234:        }
                    235:     }
1.2       www       236:     return %content;
                    237: }
                    238: 
1.6       www       239: # ======================================================= Get info out of msgid
                    240: 
1.159     raeburn   241: sub buildmsgid {
1.191     raeburn   242:     my ($now,$subject,$uname,$udom,$msgcount,$course_context,$symb,$error,$pid) = @_;
1.184     www       243:     $subject=&escape($subject);
1.192     raeburn   244:     $symb = &escape($symb);
1.184     www       245:     return(&escape($now.':'.$subject.':'.$uname.':'.
1.191     raeburn   246:            $udom.':'.$msgcount.':'.$course_context.':'.$pid.':'.$symb.':'.$error));
1.159     raeburn   247: }
                    248: 
1.6       www       249: sub unpackmsgid {
1.169     albertel  250:     my ($msgid,$folder,$skipstatus,$status_cache)=@_;
1.184     www       251:     $msgid=&unescape($msgid);
1.167     raeburn   252:     my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$fromcid,
1.191     raeburn   253:         $processid,$symb,$error) = split(/\:/,&unescape($msgid));
1.184     www       254:     $shortsubj = &unescape($shortsubj);
1.182     albertel  255:     $shortsubj = &HTML::Entities::decode($shortsubj);
1.192     raeburn   256:     $symb = &unescape($symb);
1.167     raeburn   257:     if (!defined($processid)) { $fromcid = ''; }
1.164     raeburn   258:     my %status=();
                    259:     unless ($skipstatus) {
1.169     albertel  260: 	if (ref($status_cache)) {
                    261: 	    $status{$msgid} = $status_cache->{$msgid};
                    262: 	} else {
                    263: 	    my $suffix=&foldersuffix($folder);
                    264: 	    %status=&Apache::lonnet::get('email_status'.$suffix,[$msgid]);
                    265: 	}
                    266: 	if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; }
1.164     raeburn   267:         unless ($status{$msgid}) { $status{$msgid}='new'; }
                    268:     }
1.191     raeburn   269:     return ($sendtime,$shortsubj,$fromname,$fromdomain,$status{$msgid},$fromcid,$symb,$error);
1.141     raeburn   270: }
1.6       www       271: 
1.53      www       272: 
                    273: sub sendemail {
                    274:     my ($to,$subject,$body)=@_;
1.186     www       275:     my %senderemails=&Apache::loncommon::getemails();
                    276:     my $senderaddress='';
                    277:     foreach my $type ('notification','permanentemail','critnotification') {
                    278: 	if ($senderemails{$type}) {
                    279: 	    $senderaddress=$senderemails{$type};
                    280: 	}
                    281:     }
1.53      www       282:     $body=
1.67      www       283:     "*** ".&mt('This is an automatic message generated by the LON-CAPA system.')."\n".
1.186     www       284:     "*** ".($senderaddress?&mt('You can reply to this message'):&mt('Please do not reply to this address.')."\n*** ".
                    285: 	    &mt('A reply will not be received by the recipient!'))."\n\n".$body;
1.53      www       286:     my $msg = new Mail::Send;
                    287:     $msg->to($to);
                    288:     $msg->subject('[LON-CAPA] '.$subject);
1.188     www       289:     if ($senderaddress) { $msg->add('Reply-to',$senderaddress); $msg->add('From',$senderaddress); }
1.97      matthew   290:     if (my $fh = $msg->open()) {
1.172     albertel  291: 	print $fh $body;
                    292: 	$fh->close;
1.68      www       293:     }
1.53      www       294: }
                    295: 
                    296: # ==================================================== Send notification emails
                    297: 
                    298: sub sendnotification {
1.194     raeburn   299:     my ($to,$touname,$toudom,$subj,$crit,$text,$msgid)=@_;
1.140     albertel  300:     my $sender=$env{'environment.firstname'}.' '.$env{'environment.lastname'};
1.131     www       301:     unless ($sender=~/\w/) { 
1.172     albertel  302: 	$sender=$env{'user.name'}.'@'.$env{'user.domain'};
1.131     www       303:     }
1.53      www       304:     my $critical=($crit?' critical':'');
1.131     www       305:     $text=~s/\&lt\;/\</gs;
                    306:     $text=~s/\&gt\;/\>/gs;
                    307:     $text=~s/\<\/*[^\>]+\>//gs;
1.53      www       308:     my $url='http://'.
1.198     albertel  309: 	&Apache::lonnet::hostname(&Apache::lonnet::homeserver($touname,$toudom)).
1.54      www       310:       '/adm/email?username='.$touname.'&domain='.$toudom;
1.194     raeburn   311:     my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid,
                    312:         $symb,$error) = &Apache::lonmsg::unpackmsgid($msgid);
                    313:     my $coursetext;
                    314:     if ($fromcid ne '') {
                    315:         $coursetext = "\n".&mt('Course').': ';
                    316:         if ($env{'course.'.$fromcid.'.description'} ne '') {
                    317:             $coursetext .= $env{'course.'.$fromcid.'.description'};
                    318:         } else {
                    319:             my %coursehash = &Apache::lonnet::coursedescription($fromcid,);
                    320:             if ($coursehash{'description'} ne '') {
                    321:                 $coursetext .= $coursehash{'description'};
                    322:             }
                    323:         }
                    324:         $coursetext .= "\n\n";
                    325:     }
                    326:     my $body = $coursetext. 
1.195     raeburn   327:                &mt('You received a'.$critical.' message from [_1] in LON-CAPA.',$sender).' '.&mt('The subject is 
1.53      www       328: 
1.195     raeburn   329:  [_1]
1.53      www       330: 
1.195     raeburn   331: ',$subj)."\n".
1.194     raeburn   332: '=== '.&mt('Excerpt')." ============================================================
1.131     www       333: $text
                    334: ========================================================================
                    335: 
1.195     raeburn   336: ".&mt('Use 
1.53      www       337: 
1.195     raeburn   338:  [_1]
1.53      www       339: 
1.195     raeburn   340: to access the full message.',$url);
1.53      www       341:     &sendemail($to,'New'.$critical.' message from '.$sender,$body);
                    342: }
1.40      www       343: # ============================================================= Check for email
                    344: 
                    345: sub newmail {
1.140     albertel  346:     if ((time-$env{'user.mailcheck.time'})>300) {
1.40      www       347:         my %what=&Apache::lonnet::get('email_status',['recnewemail']);
                    348:         &Apache::lonnet::appenv('user.mailcheck.time'=>time);
                    349:         if ($what{'recnewemail'}>0) { return 1; }
                    350:     }
                    351:     return 0;
                    352: }
                    353: 
1.1       www       354: # =============================== Automated message to the author of a resource
                    355: 
1.58      bowersj2  356: =pod
                    357: 
                    358: =item * B<author_res_msg($filename, $message)>: Sends message $message to the owner
                    359:     of the resource with the URI $filename.
                    360: 
                    361: =cut
                    362: 
1.1       www       363: sub author_res_msg {
                    364:     my ($filename,$message)=@_;
1.2       www       365:     unless ($message) { return 'empty'; }
1.1       www       366:     $filename=&Apache::lonnet::declutter($filename);
1.72      www       367:     my ($domain,$author,@dummy)=split(/\//,$filename);
1.1       www       368:     my $homeserver=&Apache::lonnet::homeserver($author,$domain);
                    369:     if ($homeserver ne 'no_host') {
                    370:        my $id=unpack("%32C*",$message);
1.181     albertel  371:        $message .= " <p>This error occurred on machine ".
                    372: 	   $Apache::lonnet::perlvar{'lonHostID'}."</p>";
1.2       www       373:        my $msgid;
1.72      www       374:        ($msgid,$message)=&packagemsg($filename,$message);
1.3       www       375:        return &Apache::lonnet::reply('put:'.$domain.':'.$author.
1.72      www       376:          ':nohist_res_msgs:'.
1.184     www       377:           &escape($filename.'_'.$id).'='.
                    378:           &escape($message),$homeserver);
1.1       www       379:     }
1.2       www       380:     return 'no_host';
1.73      www       381: }
                    382: 
                    383: # =========================================== Retrieve author resource messages
                    384: 
                    385: sub retrieve_author_res_msg {
1.75      www       386:     my $url=shift;
1.73      www       387:     $url=&Apache::lonnet::declutter($url);
1.187     albertel  388:     my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
1.76      www       389:     my %errormsgs=&Apache::lonnet::dump('nohist_res_msgs',$domain,$author);
1.73      www       390:     my $msgs='';
                    391:     foreach (keys %errormsgs) {
1.80      www       392: 	if ($_=~/^\Q$url\E\_\d+$/) {
1.73      www       393: 	    my %content=&unpackagemsg($errormsgs{$_});
1.74      www       394: 	    $msgs.='<p><img src="/adm/lonMisc/bomb.gif" /><b>'.
                    395: 		$content{'time'}.'</b>: '.$content{'message'}.
                    396: 		'<br /></p>';
1.73      www       397: 	}
                    398:     } 
                    399:     return $msgs;     
                    400: }
                    401: 
                    402: 
                    403: # =============================== Delete all author messages related to one URL
                    404: 
                    405: sub del_url_author_res_msg {
1.75      www       406:     my $url=shift;
1.73      www       407:     $url=&Apache::lonnet::declutter($url);
1.187     albertel  408:     my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
1.77      www       409:     my @delmsgs=();
                    410:     foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
                    411: 	if ($_=~/^\Q$url\E\_\d+$/) {
                    412: 	    push (@delmsgs,$_);
                    413: 	}
                    414:     }
                    415:     return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
1.73      www       416: }
1.152     www       417: # =================================== Clear out all author messages in URL path
1.73      www       418: 
1.152     www       419: sub clear_author_res_msg {
                    420:     my $url=shift;
                    421:     $url=&Apache::lonnet::declutter($url);
1.187     albertel  422:     my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
1.152     www       423:     my @delmsgs=();
                    424:     foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
                    425: 	if ($_=~/^\Q$url\E/) {
                    426: 	    push (@delmsgs,$_);
                    427: 	}
                    428:     }
                    429:     return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
                    430: }
1.73      www       431: # ================= Return hash with URLs for which there is a resource message
                    432: 
                    433: sub all_url_author_res_msg {
                    434:     my ($author,$domain)=@_;
1.75      www       435:     my %returnhash=();
1.76      www       436:     foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
1.75      www       437: 	$_=~/^(.+)\_\d+/;
                    438: 	$returnhash{$1}=1;
                    439:     }
                    440:     return %returnhash;
1.1       www       441: }
                    442: 
1.185     albertel  443: # ====================================== Add a comment to the User Notes screen
                    444: 
                    445: sub store_instructor_comment {
                    446:     my ($msg,$uname,$udom) = @_;
                    447:     my $cid  = $env{'request.course.id'};
                    448:     my $cnum = $env{'course.'.$cid.'.num'};
                    449:     my $cdom = $env{'course.'.$cid.'.domain'};
                    450:     my $subject= &mt('Record').' ['.$uname.':'.$udom.']';
                    451:     my $result = &user_normal_msg_raw($cnum,$cdom,$subject,$msg);
1.201     raeburn   452:     if ($result eq 'ok' || $result eq 'con_delayed') {
                    453:         
                    454:     }
1.185     albertel  455:     return $result;
                    456: }
                    457: 
1.1       www       458: # ================================================== Critical message to a user
                    459: 
1.38      www       460: sub user_crit_msg_raw {
1.201     raeburn   461:     my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
1.202     raeburn   462:         $nosentstore,$recipid)=@_;
1.2       www       463: # Check if allowed missing
1.190     raeburn   464:     my ($status,$packed_message);
1.2       www       465:     my $msgid='undefined';
                    466:     unless (($message)&&($user)&&($domain)) { $status='empty'; };
1.131     www       467:     my $text=$message;
1.2       www       468:     my $homeserver=&Apache::lonnet::homeserver($user,$domain);
                    469:     if ($homeserver ne 'no_host') {
1.202     raeburn   470:        ($msgid,$packed_message)=&packagemsg($subject,$message,undef,undef,
                    471:                                   undef,undef,undef,undef,undef,undef,undef,
                    472:                                   undef,$recipid);
1.190     raeburn   473:        if ($sendback) { $packed_message.='<sendback>true</sendback>'; }
1.4       www       474:        $status=&Apache::lonnet::critical(
                    475:            'put:'.$domain.':'.$user.':critical:'.
1.184     www       476:            &escape($msgid).'='.
1.190     raeburn   477:            &escape($packed_message),$homeserver);
1.159     raeburn   478:         if (defined($sentmessage)) {
1.190     raeburn   479:             $$sentmessage = $packed_message;
1.159     raeburn   480:         }
1.201     raeburn   481:         if (!$nosentstore) {
1.193     raeburn   482:             (undef,my $packed_message_no_citation) =
1.190     raeburn   483:             &packagemsg($subject,$message,undef,undef,undef,$user,$domain,
                    484:                         $msgid);
1.193     raeburn   485:             if ($status eq 'ok' || $status eq 'con_delayed') {
                    486:                 &store_sent_mail($msgid,$packed_message_no_citation);
                    487:             }
                    488:         }
1.2       www       489:     } else {
                    490:        $status='no_host';
                    491:     }
1.190     raeburn   492: 
1.53      www       493: # Notifications
1.186     www       494:     my %userenv = &Apache::loncommon::getemails($user,$domain);
1.53      www       495:     if ($userenv{'critnotification'}) {
1.131     www       496:       &sendnotification($userenv{'critnotification'},$user,$domain,$subject,1,
1.194     raeburn   497: 			$text,$msgid);
1.53      www       498:     }
1.132     www       499:     if ($toperm && $userenv{'permanentemail'}) {
                    500:       &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,1,
1.194     raeburn   501: 			$text,$msgid);
1.132     www       502:     }
1.53      www       503: # Log this
1.2       www       504:     &Apache::lonnet::logthis(
1.4       www       505:       'Sending critical email '.$msgid.
1.2       www       506:       ', log status: '.
1.140     albertel  507:       &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
                    508:                          $env{'user.home'},
1.2       www       509:       'Sending critical '.$msgid.' to '.$user.' at '.$domain.' with status: '
1.4       www       510:       .$status));
1.2       www       511:     return $status;
                    512: }
                    513: 
1.38      www       514: # New routine that respects "forward" and calls old routine
                    515: 
1.58      bowersj2  516: =pod
                    517: 
1.202     raeburn   518: =item * B<user_crit_msg($user, $domain, $subject, $message, $sendback, $nosentstore,$recipid)>: 
1.201     raeburn   519:     Sends a critical message $message to the $user at $domain.  If $sendback
                    520:     is true,  a receipt will be sent to the current user when $user receives 
                    521:     the message.
1.58      bowersj2  522: 
1.183     albertel  523:     Additionally it will check if the user has a Forwarding address
                    524:     set, and send the message to that address instead
                    525: 
                    526:     returns 
                    527:       - in array context a list of results for each message that was sent
                    528:       - in scalar context a space seperated list of results for each 
                    529:            message sent
                    530: 
1.58      bowersj2  531: =cut
                    532: 
1.38      www       533: sub user_crit_msg {
1.201     raeburn   534:     my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
1.202     raeburn   535:         $nosentstore,$recipid)=@_;
1.183     albertel  536:     my @status;
1.38      www       537:     my %userenv = &Apache::lonnet::get('environment',['msgforward'],
                    538:                                        $domain,$user);
                    539:     my $msgforward=$userenv{'msgforward'};
                    540:     if ($msgforward) {
1.183     albertel  541:        foreach my $addr (split(/\,/,$msgforward)) {
                    542: 	 my ($forwuser,$forwdomain)=split(/\:/,$addr);
                    543:          push(@status,
                    544: 	      &user_crit_msg_raw($forwuser,$forwdomain,$subject,$message,
1.202     raeburn   545: 				 $sendback,$toperm,$sentmessage,$nosentstore,
                    546:                                  $recipid));
1.38      www       547:        }
                    548:     } else { 
1.183     albertel  549: 	push(@status,
                    550: 	     &user_crit_msg_raw($user,$domain,$subject,$message,$sendback,
1.202     raeburn   551: 				$toperm,$sentmessage,$nosentstore,$recipid));
1.38      www       552:     }
1.183     albertel  553:     if (wantarray) {
                    554: 	return @status;
                    555:     }
                    556:     return join(' ',@status);
1.38      www       557: }
                    558: 
1.2       www       559: # =================================================== Critical message received
                    560: 
                    561: sub user_crit_received {
1.12      www       562:     my $msgid=shift;
                    563:     my %message=&Apache::lonnet::get('critical',[$msgid]);
1.52      www       564:     my %contents=&unpackagemsg($message{$msgid},1);
1.204     raeburn   565:     my $destname = $contents{'sendername'};
                    566:     my $destdom = $contents{'senderdomain'};
                    567:     if ($contents{'replytoaddr'}) {
                    568:         my ($repname,$repdom) = split(/:/,$contents{'replytoaddr'});
                    569:         if (&Apache::lonnet::homeserver($repname,$repdom) ne 'no_host') {
                    570:             $destname = $repname;
                    571:             $destdom = $repdom;    
                    572:         }
                    573:     }
1.24      www       574:     my $status='rec: '.($contents{'sendback'}?
1.204     raeburn   575:      &user_normal_msg($destname,$destdom,&mt('Receipt').': '.$env{'user.name'}.
                    576:                       ' '.&mt('at').' '.$env{'user.domain'}.', '.
                    577:                       $contents{'subject'},&mt('User').' '.$env{'user.name'}.
                    578:                       ' '.&mt('at').' '.$env{'user.domain'}.
                    579:                       ' acknowledged receipt of message'."\n".'   "'.
                    580:                       $contents{'subject'}.'"'."\n".&mt('dated').' '.
                    581:                       $contents{'time'}.".\n"
                    582:                       ):'no msg req');
1.5       www       583:     $status.=' trans: '.
1.12      www       584:      &Apache::lonnet::put(
                    585:      'nohist_email',{$contents{'msgid'} => $message{$msgid}});
1.5       www       586:     $status.=' del: '.
1.9       albertel  587:      &Apache::lonnet::del('critical',[$contents{'msgid'}]);
1.140     albertel  588:     &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
                    589:                          $env{'user.home'},'Received critical message '.
1.5       www       590:                          $contents{'msgid'}.
                    591:                          ', '.$status);
1.12      www       592:     return $status;
1.2       www       593: }
                    594: 
                    595: # ======================================================== Normal communication
                    596: 
1.38      www       597: sub user_normal_msg_raw {
1.132     www       598:     my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
1.191     raeburn   599:         $toperm,$currid,$newid,$sentmessage,$crsmsgid,$symb,$restitle,
1.202     raeburn   600:         $error,$nosentstore,$recipid)=@_;
1.2       www       601: # Check if allowed missing
1.173     albertel  602:     my ($status,$packed_message);
1.2       www       603:     my $msgid='undefined';
1.131     www       604:     my $text=$message;
1.2       www       605:     unless (($message)&&($user)&&($domain)) { $status='empty'; };
                    606:     my $homeserver=&Apache::lonnet::homeserver($user,$domain);
                    607:     if ($homeserver ne 'no_host') {
1.173     albertel  608:        ($msgid,$packed_message)=
                    609: 	                 &packagemsg($subject,$message,$citation,$baseurl,
1.174     raeburn   610:                                      $attachmenturl,$user,$domain,$currid,
1.202     raeburn   611:                                      undef,$crsmsgid,$symb,$error,$recipid);
1.174     raeburn   612: 
1.108     www       613: # Store in user folder
1.4       www       614:        $status=&Apache::lonnet::critical(
                    615:            'put:'.$domain.':'.$user.':nohist_email:'.
1.184     www       616:            &escape($msgid).'='.
                    617:            &escape($packed_message),$homeserver);
1.108     www       618: # Save new message received time
1.40      www       619:        &Apache::lonnet::put
                    620:                          ('email_status',{'recnewemail'=>time},$domain,$user);
1.201     raeburn   621: # Into sent-mail folder if sent mail storage required
                    622:        if (!$nosentstore) {
1.190     raeburn   623:            (undef,my $packed_message_no_citation) =
                    624:                &packagemsg($subject,$message,undef,$baseurl,$attachmenturl,
1.191     raeburn   625:                            $user,$domain,$currid,undef,$crsmsgid,$symb,$error);
1.193     raeburn   626:            if ($status eq 'ok' || $status eq 'con_delayed') {
                    627:                &store_sent_mail($msgid,$packed_message_no_citation);
                    628:            }
1.156     raeburn   629:        }
1.201     raeburn   630:        if (ref($newid) eq 'SCALAR') {
1.196     www       631: 	   $$newid = $msgid;
                    632:        }
1.201     raeburn   633:        if (ref($sentmessage) eq 'SCALAR') {
1.196     www       634: 	   $$sentmessage = $packed_message;
                    635:        }
                    636: # Notifications
                    637:        my %userenv = &Apache::lonnet::get('environment',['notification',
                    638: 							 'permanentemail'],
                    639: 					  $domain,$user);
                    640:        if ($userenv{'notification'}) {
                    641: 	   &sendnotification($userenv{'notification'},$user,$domain,$subject,0,
                    642: 			     $text,$msgid);
                    643:        }
                    644:        if ($toperm && $userenv{'permanentemail'}) {
                    645: 	   &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,
                    646: 			     $text,$msgid);
                    647:        }
                    648:        &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
                    649: 			    $env{'user.home'},
                    650: 			    'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status);
                    651:    } else {
1.2       www       652:        $status='no_host';
1.196     www       653:    }
1.2       www       654:     return $status;
                    655: }
1.38      www       656: 
                    657: # New routine that respects "forward" and calls old routine
                    658: 
1.58      bowersj2  659: =pod
                    660: 
1.191     raeburn   661: =item * B<user_normal_msg($user, $domain, $subject, $message, $citation,
1.201     raeburn   662:        $baseurl, $attachmenturl, $toperm, $sentmessage, $symb, $restitle,
1.202     raeburn   663:        $error,$nosentstore,$recipid)>:
1.191     raeburn   664:  Sends a message to the  $user at $domain, with subject $subject and message $message.
1.58      bowersj2  665: 
1.199     raeburn   666:     Additionally it will check if the user has a Forwarding address
                    667:     set, and send the message to that address instead
                    668: 
                    669:     returns
                    670:       - in array context a list of results for each message that was sent
                    671:       - in scalar context a space seperated list of results for each
                    672:            message sent
                    673: 
1.58      bowersj2  674: =cut
                    675: 
1.38      www       676: sub user_normal_msg {
1.132     www       677:     my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
1.202     raeburn   678: 	$toperm,$sentmessage,$symb,$restitle,$error,$nosentstore,$recipid)=@_;
1.199     raeburn   679:     my @status;
1.38      www       680:     my %userenv = &Apache::lonnet::get('environment',['msgforward'],
                    681:                                        $domain,$user);
                    682:     my $msgforward=$userenv{'msgforward'};
                    683:     if ($msgforward) {
1.171     banghart  684:         foreach (split(/\,/,$msgforward)) {
1.172     albertel  685: 	    my ($forwuser,$forwdomain)=split(/\:/,$_);
1.199     raeburn   686: 	    push(@status,
1.171     banghart  687: 	        &user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,
1.172     albertel  688: 				     $citation,$baseurl,$attachmenturl,$toperm,
1.201     raeburn   689: 				     undef,undef,$sentmessage,undef,$symb,
1.202     raeburn   690:                                      $restitle,$error,$nosentstore,$recipid));
1.171     banghart  691:         }
1.191     raeburn   692:     } else {
1.199     raeburn   693: 	push(@status,&user_normal_msg_raw($user,$domain,$subject,$message,
1.172     albertel  694: 				     $citation,$baseurl,$attachmenturl,$toperm,
1.201     raeburn   695: 				     undef,undef,$sentmessage,undef,$symb,
1.202     raeburn   696:                                      $restitle,$error,$nosentstore,$recipid));
1.199     raeburn   697:     }
                    698:     if (wantarray) {
                    699:         return @status;
1.38      www       700:     }
1.199     raeburn   701:     return join(' ',@status);
1.38      www       702: }
                    703: 
1.201     raeburn   704: sub process_sent_mail {
                    705:     my ($msgsubj,$subj_prefix,$numsent,$stamp,$msgname,$msgdom,$msgcount,$context,$pid,$savemsg,$recusers,$recudoms,$baseurl,$attachmenturl,$symb,$error,$senderuname,$senderdom,$senderhome) = @_;
                    706:     my $sentsubj;
                    707:     if ($numsent > 1) {
                    708:         $sentsubj = $subj_prefix.' ('.$numsent.' sent) '.$msgsubj;
1.205   ! raeburn   709:     } else {
        !           710:         if ($subj_prefix) {
        !           711:             $sentsubj = $subj_prefix.' ';
        !           712:         }
        !           713:         $sentsubj .= $msgsubj;
1.201     raeburn   714:     }
                    715:     $sentsubj = &HTML::Entities::encode($sentsubj,'<>&"');
                    716:     my $sentmsgid = 
                    717:         &buildmsgid($stamp,$sentsubj,$msgname,$msgdom,$msgcount,$context,$pid);
                    718:     (undef,my $sentmessage) =
                    719:         &packagemsg($msgsubj,$savemsg,undef,$baseurl,$attachmenturl,$recusers,
                    720:                     $recudoms,$sentmsgid,undef,undef,$symb,$error);
                    721:     my $status = &store_sent_mail($sentmsgid,$sentmessage,$senderuname,
                    722:                                   $senderdom,$senderhome);
                    723:     return $status;
                    724: }
                    725: 
1.156     raeburn   726: sub store_sent_mail {
1.201     raeburn   727:     my ($msgid,$message,$senderuname,$senderdom,$senderhome) = @_;
                    728:     if ($senderuname eq '') {
                    729:         $senderuname = $env{'user.name'};
                    730:     }
                    731:     if ($senderdom eq '') {
                    732:         $senderdom = $env{'user.domain'};
                    733:     }
                    734:     if ($senderhome eq '') {
                    735:         $senderhome = $env{'user.home'};
                    736:     }
1.171     banghart  737:     my $status =' '.&Apache::lonnet::critical(
1.201     raeburn   738:                'put:'.$senderdom.':'.$senderuname.':nohist_email_sent:'.
                    739:                &escape($msgid).'='.&escape($message),$senderhome);
1.156     raeburn   740:     return $status;
                    741: }
1.2       www       742: 
1.202     raeburn   743: sub store_recipients {
                    744:     my ($subject,$sendername,$senderdom,$reciphash) = @_;
                    745:     my $context = &get_course_context();
1.203     albertel  746:     my $now = time();
1.202     raeburn   747:     my $msgcount = &get_uniq();
                    748:     my $recipid =
                    749:         &buildmsgid($now,$subject,$sendername,$senderdom,$msgcount,$context,$$);
                    750:     my %recipinfo = (
                    751:                          $recipid => $reciphash,
                    752:                     );
                    753:     my $status = &Apache::lonnet::put('nohist_emailrecip',\%recipinfo,
                    754:                                       $senderdom,$sendername); 
                    755:     if ($status eq 'ok') {
                    756:         return ($recipid,$status);
                    757:     } else {
                    758:         return (undef,$status);
                    759:     }
                    760: }
                    761: 
1.106     www       762: # =============================================================== Folder suffix
                    763: 
                    764: sub foldersuffix {
                    765:     my $folder=shift;
                    766:     unless ($folder) { return ''; }
1.189     raeburn   767:     my $suffix;
                    768:     my %folderhash = &get_user_folders($folder);
                    769:     if (ref($folderhash{$folder}) eq 'HASH') {
                    770:         $suffix = '_'.&escape($folderhash{$folder}{'id'});
                    771:     } else {
                    772:         $suffix = '_'.&escape($folder);
                    773:     }
                    774:     return $suffix;
                    775: }
                    776: 
                    777: # ========================================================= User-defined folders 
                    778: 
                    779: sub get_user_folders {
                    780:     my ($folder) = @_;
                    781:     my %userfolders = 
                    782:           &Apache::lonnet::dump('email_folders',undef,undef,$folder);
                    783:     my $lock = "\0".'lock_counter'; # locks db while counter incremented
                    784:     my $counter = "\0".'idcount';   # used in suffix for email db files
                    785:     if (defined($userfolders{$lock})) {
                    786:         delete($userfolders{$lock});
                    787:     }
                    788:     if (defined($userfolders{$counter})) {
                    789:         delete($userfolders{$counter});
                    790:     }
                    791:     return %userfolders;
1.106     www       792: }
                    793: 
1.197     albertel  794: sub secapply {
                    795:     my $rec=shift;
                    796:     my $defaultflag=shift;
                    797:     $rec=~s/\s+//g;
                    798:     $rec=~s/\@/\:/g;
                    799:     my ($adr,$sections_or_groups)=($rec=~/^([^\(]+)\(([^\)]+)\)/);
                    800:     if ($sections_or_groups) {
                    801: 	foreach my $item (split(/\;/,$sections_or_groups)) {
                    802:             if (($item eq $env{'request.course.sec'}) ||
                    803:                 ($defaultflag && ($item eq '*'))) {
                    804:                 return $adr; 
                    805:             } elsif ($env{'request.course.groups'}) {
                    806:                 my @usersgroups = split(/:/,$env{'request.course.groups'});
                    807:                 if (grep(/^\Q$item\E$/,@usersgroups)) {
                    808:                     return $adr;
                    809:                 }
                    810:             } 
                    811:         }
                    812:     } else {
                    813:        return $rec;
                    814:     }
                    815:     return '';
                    816: }
                    817: 
                    818: =pod 
                    819: 
1.199     raeburn   820: =item * B<decide_receiver($feedurl,$author,$question,$course,$policy,$defaultflag)>:
1.197     albertel  821: 
                    822: Arguments
                    823:   $feedurl - /res/ url of resource (only need if $author is true)
                    824:   $author,$question,$course,$policy - all true/false parameters
                    825:     if true will attempt to find the addresses of user that should receive
                    826:     this type of feedback (author - feedback to author of resource $feedurl,
                    827:     $question 'Resource Content Questions', $course 'Course Content Question',
                    828:     $policy 'Course Policy')
                    829:     (Additionally it also checks $env for whether the corresponding form.<name>
                    830:     element exists, for ease of use in a html response context)
                    831:    
                    832:   $defaultflag - (internal should be left blank) if true gather addresses 
                    833:                  that aren't for a section even if I have a section
                    834:                  (used for reccursion internally, first we look for
                    835:                  addresses for our specific section then we recurse
                    836:                  and look for non section addresses)
                    837: 
                    838: Returns
                    839:   $typestyle - string of html text, describing what addresses were found
                    840:   %to - a hash, which keys are addresses of users to send messages to
                    841:         the keys will look like   name:domain
                    842: 
                    843: =cut
                    844: 
                    845: sub decide_receiver {
                    846:     my ($feedurl,$author,$question,$course,$policy,$defaultflag) = @_;
                    847:     &Apache::lonenc::check_decrypt(\$feedurl);
                    848:     my $typestyle='';
                    849:     my %to=();
                    850:     if ($env{'form.discuss'} eq 'author' ||$author) {
                    851: 	$typestyle.='Submitting as Author Feedback<br />';
                    852: 	$feedurl=~ m{^/res/($LONCAPA::domain_re)/($LONCAPA::username_re)/};
                    853: 	$to{$2.':'.$1}=1;
                    854:     }
                    855:     my $cid = $env{'request.course.id'};
                    856:     if ($env{'form.discuss'} eq 'question' ||$question) {
                    857: 	$typestyle.=&mt('Submitting as Question').'<br />';
                    858: 	foreach my $item (split(/\,/,$env{'course.'.$cid.'.question.email'})) {
                    859: 	    my $rec=&secapply($item,$defaultflag);
                    860: 	    if ($rec) { $to{$rec}=1; }
                    861: 	} 
                    862:     }
                    863:     if ($env{'form.discuss'} eq 'course' ||$course) {
                    864: 	$typestyle.=&mt('Submitting as Comment').'<br />';
                    865: 	foreach my $item (split(/\,/,$env{'course.'.$cid.'.comment.email'})) {
                    866: 	    my $rec=&secapply($item,$defaultflag);
                    867: 	    if ($rec) { $to{$rec}=1; }
                    868: 	} 
                    869:     }
                    870:     if ($env{'form.discuss'} eq 'policy' ||$policy) {
                    871: 	$typestyle.=&mt('Submitting as Policy Feedback').'<br />';
                    872: 	foreach my $item (split(/\,/,$env{'course.'.$cid.'.policy.email'})) {
                    873: 	    my $rec=&secapply($item,$defaultflag);
                    874: 	    if ($rec) { $to{$rec}=1; }
                    875: 	} 
                    876:     }
                    877:     if ((scalar(%to) eq '0') && (!$defaultflag)) {
                    878: 	($typestyle,%to)=
                    879: 	    &decide_receiver($feedurl,$author,$question,$course,$policy,1);
                    880:     }
                    881:     return ($typestyle,%to);
                    882: }
                    883: 
1.199     raeburn   884: =pod
                    885: 
                    886: =back
                    887: 
                    888: =cut
                    889: 
1.180     albertel  890: 1;
1.1       www       891: __END__
                    892: 

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