Annotation of loncom/interface/lonmsg.pm, revision 1.227
1.1 www 1: # The LearningOnline Network with CAPA
1.26 albertel 2: # Routines for messaging
3: #
1.227 ! raeburn 4: # $Id: lonmsg.pm,v 1.226 2010/05/29 22:39:52 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:
1.215 jms 56: =head1 SUBROUTINES
1.199 raeburn 57:
1.215 jms 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
1.199 raeburn 198:
199: =cut
200:
1.1 www 201: use strict;
1.140 albertel 202: use Apache::lonnet;
1.47 albertel 203: use HTML::TokeParser();
1.180 albertel 204: use Apache::lonlocal;
1.53 www 205: use Mail::Send;
1.226 raeburn 206: use HTML::Entities;
207: use Encode;
1.187 albertel 208: use LONCAPA qw(:DEFAULT :match);
1.180 albertel 209:
210: {
211: my $uniq;
212: sub get_uniq {
213: $uniq++;
214: return $uniq;
215: }
216: }
1.65 www 217:
1.215 jms 218:
1.1 www 219:
1.3 www 220: sub packagemsg {
1.108 www 221: my ($subject,$message,$citation,$baseurl,$attachmenturl,
1.202 raeburn 222: $recuser,$recdomain,$msgid,$type,$crsmsgid,$symb,$error,$recipid)=@_;
1.96 albertel 223: $message =&HTML::Entities::encode($message,'<>&"');
224: $citation=&HTML::Entities::encode($citation,'<>&"');
225: $subject =&HTML::Entities::encode($subject,'<>&"');
1.49 albertel 226: #remove machine specification
1.218 raeburn 227: $baseurl =~ s|^https?://[^/]+/|/|;
1.96 albertel 228: $baseurl =&HTML::Entities::encode($baseurl,'<>&"');
1.51 www 229: #remove machine specification
1.218 raeburn 230: $attachmenturl =~ s|^https?://[^/]+/|/|;
1.96 albertel 231: $attachmenturl =&HTML::Entities::encode($attachmenturl,'<>&"');
1.201 raeburn 232: my $course_context = &get_course_context();
1.2 www 233: my $now=time;
1.180 albertel 234: my $msgcount = &get_uniq();
1.156 raeburn 235: unless(defined($msgid)) {
1.159 raeburn 236: $msgid = &buildmsgid($now,$subject,$env{'user.name'},$env{'user.domain'},
1.191 raeburn 237: $msgcount,$course_context,$symb,$error,$$);
1.156 raeburn 238: }
1.174 raeburn 239: my $result = '<sendername>'.$env{'user.name'}.'</sendername>'.
1.140 albertel 240: '<senderdomain>'.$env{'user.domain'}.'</senderdomain>'.
1.1 www 241: '<subject>'.$subject.'</subject>'.
1.174 raeburn 242: '<time>'.&Apache::lonlocal::locallocaltime($now).'</time>';
243: if (defined($crsmsgid)) {
244: $result.= '<courseid>'.$course_context.'</courseid>'.
245: '<coursesec>'.$env{'request.course.sec'}.'</coursesec>'.
246: '<msgid>'.$msgid.'</msgid>'.
247: '<coursemsgid>'.$crsmsgid.'</coursemsgid>'.
248: '<message>'.$message.'</message>';
249: return ($msgid,$result);
250: }
251: $result .= '<servername>'.$ENV{'SERVER_NAME'}.'</servername>'.
1.1 www 252: '<host>'.$ENV{'HTTP_HOST'}.'</host>'.
253: '<client>'.$ENV{'REMOTE_ADDR'}.'</client>'.
1.140 albertel 254: '<browsertype>'.$env{'browser.type'}.'</browsertype>'.
255: '<browseros>'.$env{'browser.os'}.'</browseros>'.
256: '<browserversion>'.$env{'browser.version'}.'</browserversion>'.
257: '<browsermathml>'.$env{'browser.mathml'}.'</browsermathml>'.
1.1 www 258: '<browserraw>'.$ENV{'HTTP_USER_AGENT'}.'</browserraw>'.
1.158 raeburn 259: '<courseid>'.$course_context.'</courseid>'.
1.140 albertel 260: '<coursesec>'.$env{'request.course.sec'}.'</coursesec>'.
261: '<role>'.$env{'request.role'}.'</role>'.
262: '<resource>'.$env{'request.filename'}.'</resource>'.
1.156 raeburn 263: '<msgid>'.$msgid.'</msgid>';
1.214 raeburn 264: if (defined($env{'form.group'})) {
265: $result .= '<group>'.$env{'form.group'}.'</group>';
266: }
1.156 raeburn 267: if (ref($recuser) eq 'ARRAY') {
268: for (my $i=0; $i<@{$recuser}; $i++) {
1.162 raeburn 269: if ($type eq 'dcmail') {
270: my ($username,$email) = split(/:/,$$recuser[$i]);
1.184 www 271: $username = &unescape($username);
272: $email = &unescape($email);
1.162 raeburn 273: $username = &HTML::Entities::encode($username,'<>&"');
274: $email = &HTML::Entities::encode($email,'<>&"');
275: $result .= '<recipient username="'.$username.'">'.
276: $email.'</recipient>';
277: } else {
278: $result .= '<recuser>'.$$recuser[$i].'</recuser>'.
279: '<recdomain>'.$$recdomain[$i].'</recdomain>';
280: }
1.156 raeburn 281: }
282: } else {
283: $result .= '<recuser>'.$recuser.'</recuser>'.
284: '<recdomain>'.$recdomain.'</recdomain>';
285: }
286: $result .= '<message>'.$message.'</message>';
1.49 albertel 287: if (defined($citation)) {
288: $result.='<citation>'.$citation.'</citation>';
289: }
290: if (defined($baseurl)) {
291: $result.= '<baseurl>'.$baseurl.'</baseurl>';
292: }
1.51 www 293: if (defined($attachmenturl)) {
1.52 www 294: $result.= '<attachmenturl>'.$attachmenturl.'</attachmenturl>';
1.51 www 295: }
1.191 raeburn 296: if (defined($symb)) {
297: $result.= '<symb>'.$symb.'</symb>';
1.201 raeburn 298: if ($course_context ne '') {
1.191 raeburn 299: if ($course_context eq $env{'request.course.id'}) {
300: my $resource_title = &Apache::lonnet::gettitle($symb);
301: if (defined($resource_title)) {
302: $result .= '<resource_title>'.$resource_title.'</resource_title>';
303: }
304: }
305: }
306: }
1.202 raeburn 307: if (defined($recipid)) {
308: $result.= '<recipid>'.$recipid.'</recipid>';
309: }
1.204 raeburn 310: if ($env{'form.can_reply'} eq 'N') {
311: $result .= '<noreplies>1</noreplies>';
312: }
313: if ($env{'form.reply_to_addr'}) {
314: my ($replytoname,$replytodom) = split(/:/,$env{'form.reply_to_addr'});
315: if (!($replytoname eq $env{'user.name'} && $replytodom eq $env{'user.domain'})) {
316: if (&Apache::lonnet::homeserver($replytoname,$replytodom) ne 'no_host') {
317: $result .= '<replytoaddr>'.$env{'form.reply_to_addr'}.'</replytoaddr>';
318: }
319: }
320: }
1.191 raeburn 321: return ($msgid,$result);
1.1 www 322: }
323:
1.201 raeburn 324: sub get_course_context {
325: my $course_context;
1.212 raeburn 326: my $msgkey;
1.201 raeburn 327: if (defined($env{'form.replyid'})) {
1.212 raeburn 328: $msgkey = $env{'form.replyid'};
329: } elsif (defined($env{'form.forwid'})) {
330: $msgkey = $env{'form.forwid'}
331: } elsif (defined($env{'form.multiforwid'})) {
332: $msgkey = $env{'form.multiforwid'};
333: }
334: if ($msgkey ne '') {
1.201 raeburn 335: my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid)=
1.212 raeburn 336: split(/\:/,&unescape($msgkey));
1.201 raeburn 337: $course_context = $origcid;
338: }
339: foreach my $key (keys(%env)) {
340: if ($key=~/^form\.(rep)?rec\_(.*)$/) {
341: my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid) =
342: split(/\:/,&unescape($2));
343: $course_context = $origcid;
344: last;
345: }
346: }
347: if ($course_context eq '') {
348: $course_context = $env{'request.course.id'};
349: }
350: return $course_context;
351: }
352:
1.2 www 353:
1.3 www 354: sub unpackagemsg {
1.212 raeburn 355: my ($message,$notoken,$noattachmentlink)=@_;
1.2 www 356: my %content=();
357: my $parser=HTML::TokeParser->new(\$message);
358: my $token;
359: while ($token=$parser->get_token) {
360: if ($token->[0] eq 'S') {
361: my $entry=$token->[1];
362: my $value=$parser->get_text('/'.$entry);
1.156 raeburn 363: if (($entry eq 'recuser') || ($entry eq 'recdomain')) {
364: push(@{$content{$entry}},$value);
1.162 raeburn 365: } elsif ($entry eq 'recipient') {
366: my $username = $token->[2]{'username'};
367: $username = &HTML::Entities::decode($username,'<>&"');
368: $content{$entry}{$username} = $value;
1.156 raeburn 369: } else {
370: $content{$entry}=$value;
371: }
1.2 www 372: }
373: }
1.168 albertel 374: if (!exists($content{'recuser'})) { $content{'recuser'} = []; }
1.212 raeburn 375: if (($content{'attachmenturl'}) && (!$noattachmentlink)) {
1.100 albertel 376: my ($fname)=($content{'attachmenturl'}=~m|/([^/]+)$|);
1.52 www 377: if ($notoken) {
1.100 albertel 378: $content{'message'}.='<p>'.&mt('Attachment').': <tt>'.$fname.'</tt>';
1.52 www 379: } else {
1.99 albertel 380: &Apache::lonnet::allowuploaded('/adm/msg',
381: $content{'attachmenturl'});
382: $content{'message'}.='<p>'.&mt('Attachment').
383: ': <a href="'.$content{'attachmenturl'}.'"><tt>'.
1.100 albertel 384: $fname.'</tt></a>';
1.52 www 385: }
386: }
1.2 www 387: return %content;
388: }
389:
1.6 www 390:
1.159 raeburn 391: sub buildmsgid {
1.191 raeburn 392: my ($now,$subject,$uname,$udom,$msgcount,$course_context,$symb,$error,$pid) = @_;
1.184 www 393: $subject=&escape($subject);
1.192 raeburn 394: $symb = &escape($symb);
1.184 www 395: return(&escape($now.':'.$subject.':'.$uname.':'.
1.191 raeburn 396: $udom.':'.$msgcount.':'.$course_context.':'.$pid.':'.$symb.':'.$error));
1.159 raeburn 397: }
398:
1.6 www 399: sub unpackmsgid {
1.169 albertel 400: my ($msgid,$folder,$skipstatus,$status_cache)=@_;
1.184 www 401: $msgid=&unescape($msgid);
1.167 raeburn 402: my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$fromcid,
1.191 raeburn 403: $processid,$symb,$error) = split(/\:/,&unescape($msgid));
1.184 www 404: $shortsubj = &unescape($shortsubj);
1.182 albertel 405: $shortsubj = &HTML::Entities::decode($shortsubj);
1.192 raeburn 406: $symb = &unescape($symb);
1.167 raeburn 407: if (!defined($processid)) { $fromcid = ''; }
1.164 raeburn 408: my %status=();
409: unless ($skipstatus) {
1.169 albertel 410: if (ref($status_cache)) {
411: $status{$msgid} = $status_cache->{$msgid};
412: } else {
413: my $suffix=&foldersuffix($folder);
414: %status=&Apache::lonnet::get('email_status'.$suffix,[$msgid]);
415: }
416: if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; }
1.164 raeburn 417: unless ($status{$msgid}) { $status{$msgid}='new'; }
418: }
1.191 raeburn 419: return ($sendtime,$shortsubj,$fromname,$fromdomain,$status{$msgid},$fromcid,$symb,$error);
1.141 raeburn 420: }
1.6 www 421:
1.53 www 422:
423: sub sendemail {
1.213 raeburn 424: my ($to,$subject,$body,$to_uname,$to_udom,$user_lh)=@_;
1.186 www 425: my $senderaddress='';
1.220 raeburn 426: my $replytoaddress='';
427: if ($env{'form.can_reply'} eq 'N') {
428: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
429: my $hostname = &Apache::lonnet::hostname($lonhost);
430: $replytoaddress = 'do-not-reply@'.$hostname;
431: } else {
432: my %senderemails;
433: my $have_sender;
434: if ($env{'form.reply_to_addr'}) {
435: my ($replytoname,$replytodom) = split(/:/,$env{'form.reply_to_addr'});
436: if (!($replytoname eq $env{'user.name'} && $replytodom eq $env{'user.domain'})) {
437: if (&Apache::lonnet::homeserver($replytoname,$replytodom) ne 'no_host') {
438: %senderemails =
439: &Apache::loncommon::getemails($replytoname,$replytodom);
440: $have_sender = 1;
441: }
442: }
443: }
444: if (!$have_sender) {
445: %senderemails=&Apache::loncommon::getemails();
446: }
447: foreach my $type ('permanentemail','critnotification','notification') {
448: if ($senderemails{$type}) {
449: ($senderaddress) = split(/,/,$senderemails{$type});
450: last if ($senderaddress);
451: }
452: }
1.186 www 453: }
1.53 www 454: $body=
1.217 schafran 455: "*** ".&mt_user($user_lh,'This is an automatic e-mail generated by the LON-CAPA system.')."\n".
456: "*** ".($senderaddress?&mt_user($user_lh,'You can reply to this e-mail'):&mt_user($user_lh,'Please do not reply to this address.')."\n*** ".
1.220 raeburn 457: &mt_user($user_lh,'A reply will not be received by the recipient!'))."\n\n".$body;
1.225 jms 458:
1.53 www 459: my $msg = new Mail::Send;
460: $msg->to($to);
461: $msg->subject('[LON-CAPA] '.$subject);
1.220 raeburn 462: if ($replytoaddress) {
463: $msg->add('Reply-to',$replytoaddress);
464: }
465: if ($senderaddress) {
466: $msg->add('From',$senderaddress);
467: }
1.97 matthew 468: if (my $fh = $msg->open()) {
1.172 albertel 469: print $fh $body;
470: $fh->close;
1.68 www 471: }
1.53 www 472: }
473:
474: # ==================================================== Send notification emails
475:
476: sub sendnotification {
1.194 raeburn 477: my ($to,$touname,$toudom,$subj,$crit,$text,$msgid)=@_;
1.140 albertel 478: my $sender=$env{'environment.firstname'}.' '.$env{'environment.lastname'};
1.131 www 479: unless ($sender=~/\w/) {
1.208 raeburn 480: $sender=$env{'user.name'}.':'.$env{'user.domain'};
1.131 www 481: }
1.53 www 482: my $critical=($crit?' critical':'');
1.208 raeburn 483:
1.131 www 484: $text=~s/\<\;/\</gs;
485: $text=~s/\>\;/\>/gs;
1.218 raeburn 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).
1.226 raeburn 490: '/adm/email?username='.$touname.'&domain='.$toudom.
491: '&display='.&escape($msgid);
1.194 raeburn 492: my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid,
493: $symb,$error) = &Apache::lonmsg::unpackmsgid($msgid);
1.208 raeburn 494: my ($coursetext,$body,$bodybegin,$bodysubj,$bodyend);
1.222 raeburn 495: my $user_lh = &Apache::loncommon::user_lang($touname,$toudom,$fromcid);
1.194 raeburn 496: if ($fromcid ne '') {
1.213 raeburn 497: $coursetext = "\n".&mt_user($user_lh,'Course').': ';
1.194 raeburn 498: if ($env{'course.'.$fromcid.'.description'} ne '') {
499: $coursetext .= $env{'course.'.$fromcid.'.description'};
500: } else {
501: my %coursehash = &Apache::lonnet::coursedescription($fromcid,);
502: if ($coursehash{'description'} ne '') {
503: $coursetext .= $coursehash{'description'};
504: }
505: }
506: $coursetext .= "\n\n";
507: }
1.206 raeburn 508: my @recipients = split(/,/,$to);
1.208 raeburn 509: $bodybegin = $coursetext.
1.213 raeburn 510: &mt_user($user_lh,
511: 'You received a'.$critical.' message from [_1] in LON-CAPA.',$sender).' ';
512: $bodysubj = &mt_user($user_lh,'The subject is
1.53 www 513:
1.195 raeburn 514: [_1]
1.53 www 515:
1.195 raeburn 516: ',$subj)."\n".
1.213 raeburn 517: '=== '.&mt_user($user_lh,'Excerpt')." ============================================================
1.206 raeburn 518: ";
519: $bodyend = "
1.131 www 520: ========================================================================
521:
1.213 raeburn 522: ".&mt_user($user_lh,'Use
1.53 www 523:
1.195 raeburn 524: [_1]
1.53 www 525:
1.195 raeburn 526: to access the full message.',$url);
1.206 raeburn 527: my %userenv = &Apache::lonnet::get('environment',['notifywithhtml'],$toudom,$touname);
1.213 raeburn 528: my $subject = &mt_user($user_lh,"'New' $critical message from ").$sender;
1.208 raeburn 529:
530: my ($blocked,$blocktext);
531: if (!$crit) {
532: my %setters;
533: my ($startblock,$endblock) =
534: &Apache::loncommon::blockcheck(\%setters,'com',$touname,$toudom);
535: if ($startblock && $endblock) {
536: $blocked = 1;
1.209 albertel 537: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
538: my $showend = &Apache::lonlocal::locallocaltime($endblock);
1.213 raeburn 539: $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);
1.208 raeburn 540: }
541: }
1.206 raeburn 542: if ($userenv{'notifywithhtml'} ne '') {
543: my @htmlexcerpt = split(/,/,$userenv{'notifywithhtml'});
1.226 raeburn 544: my $htmlfree = &make_htmlfree($text);
1.206 raeburn 545: foreach my $addr (@recipients) {
1.208 raeburn 546: if ($blocked) {
547: $body = $bodybegin."\n".$blocktext."\n".$bodyend;
548: } else {
1.226 raeburn 549: my $sendtext;
1.208 raeburn 550: if (!grep/^\Q$addr\E/,@htmlexcerpt) {
1.227 ! raeburn 551: $sendtext = $htmlfree;
1.226 raeburn 552: } else {
553: $sendtext = $text;
1.208 raeburn 554: }
555: $body = $bodybegin.$bodysubj.$sendtext.$bodyend;
1.206 raeburn 556: }
1.213 raeburn 557: &sendemail($addr,$subject,$body,$touname,$toudom,$user_lh);
1.206 raeburn 558: }
559: } else {
1.208 raeburn 560: if ($blocked) {
561: $body = $bodybegin."\n".$blocktext."\n".$bodyend;
562: } else {
1.226 raeburn 563: my $htmlfree = &make_htmlfree($text);
564: $body = $bodybegin.$bodysubj.$htmlfree.$bodyend;
1.208 raeburn 565: }
1.213 raeburn 566: &sendemail($to,$subject,$body,$touname,$toudom,$user_lh);
1.206 raeburn 567: }
1.53 www 568: }
1.215 jms 569:
1.226 raeburn 570: sub make_htmlfree {
571: my ($text) = @_;
572: $text =~ s/\<\/*[^\>]+\>//gs;
573: $text = &HTML::Entities::decode($text);
574: $text = &Encode::encode('utf8',$text);
575: return $text;
576: }
577:
1.223 kaisler 578: sub mynewmail{
579: &newmail();
1.224 kaisler 580: return $env{'user.mailcheck.lastnewmassagetime'} > $env{'user.mailcheck.lastvisit'};
1.223 kaisler 581: }
582:
1.40 www 583:
584: sub newmail {
1.140 albertel 585: if ((time-$env{'user.mailcheck.time'})>300) {
1.40 www 586: my %what=&Apache::lonnet::get('email_status',['recnewemail']);
1.211 raeburn 587: &Apache::lonnet::appenv({'user.mailcheck.time'=>time});
1.224 kaisler 588: &Apache::lonnet::appenv({'user.mailcheck.lastnewmassagetime'=> $what{'recnewemail'}});
1.40 www 589: if ($what{'recnewemail'}>0) { return 1; }
590: }
591: return 0;
592: }
593:
1.1 www 594:
1.58 bowersj2 595:
1.1 www 596: sub author_res_msg {
597: my ($filename,$message)=@_;
1.2 www 598: unless ($message) { return 'empty'; }
1.1 www 599: $filename=&Apache::lonnet::declutter($filename);
1.72 www 600: my ($domain,$author,@dummy)=split(/\//,$filename);
1.1 www 601: my $homeserver=&Apache::lonnet::homeserver($author,$domain);
602: if ($homeserver ne 'no_host') {
603: my $id=unpack("%32C*",$message);
1.181 albertel 604: $message .= " <p>This error occurred on machine ".
605: $Apache::lonnet::perlvar{'lonHostID'}."</p>";
1.2 www 606: my $msgid;
1.72 www 607: ($msgid,$message)=&packagemsg($filename,$message);
1.3 www 608: return &Apache::lonnet::reply('put:'.$domain.':'.$author.
1.72 www 609: ':nohist_res_msgs:'.
1.184 www 610: &escape($filename.'_'.$id).'='.
611: &escape($message),$homeserver);
1.1 www 612: }
1.2 www 613: return 'no_host';
1.73 www 614: }
615:
1.215 jms 616:
1.73 www 617:
618: sub retrieve_author_res_msg {
1.75 www 619: my $url=shift;
1.73 www 620: $url=&Apache::lonnet::declutter($url);
1.187 albertel 621: my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
1.76 www 622: my %errormsgs=&Apache::lonnet::dump('nohist_res_msgs',$domain,$author);
1.73 www 623: my $msgs='';
624: foreach (keys %errormsgs) {
1.80 www 625: if ($_=~/^\Q$url\E\_\d+$/) {
1.73 www 626: my %content=&unpackagemsg($errormsgs{$_});
1.74 www 627: $msgs.='<p><img src="/adm/lonMisc/bomb.gif" /><b>'.
628: $content{'time'}.'</b>: '.$content{'message'}.
629: '<br /></p>';
1.73 www 630: }
631: }
632: return $msgs;
633: }
634:
635:
1.215 jms 636:
637:
1.73 www 638:
639: sub del_url_author_res_msg {
1.75 www 640: my $url=shift;
1.73 www 641: $url=&Apache::lonnet::declutter($url);
1.187 albertel 642: my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
1.77 www 643: my @delmsgs=();
644: foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
645: if ($_=~/^\Q$url\E\_\d+$/) {
646: push (@delmsgs,$_);
647: }
648: }
649: return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
1.73 www 650: }
1.215 jms 651:
1.73 www 652:
1.152 www 653: sub clear_author_res_msg {
654: my $url=shift;
655: $url=&Apache::lonnet::declutter($url);
1.187 albertel 656: my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
1.152 www 657: my @delmsgs=();
658: foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
659: if ($_=~/^\Q$url\E/) {
660: push (@delmsgs,$_);
661: }
662: }
663: return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
664: }
1.215 jms 665:
666:
1.73 www 667:
668: sub all_url_author_res_msg {
669: my ($author,$domain)=@_;
1.75 www 670: my %returnhash=();
1.76 www 671: foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
1.75 www 672: $_=~/^(.+)\_\d+/;
673: $returnhash{$1}=1;
674: }
675: return %returnhash;
1.1 www 676: }
677:
1.185 albertel 678:
679: sub store_instructor_comment {
680: my ($msg,$uname,$udom) = @_;
681: my $cid = $env{'request.course.id'};
682: my $cnum = $env{'course.'.$cid.'.num'};
683: my $cdom = $env{'course.'.$cid.'.domain'};
684: my $subject= &mt('Record').' ['.$uname.':'.$udom.']';
685: my $result = &user_normal_msg_raw($cnum,$cdom,$subject,$msg);
1.201 raeburn 686: if ($result eq 'ok' || $result eq 'con_delayed') {
687:
688: }
1.185 albertel 689: return $result;
690: }
691:
1.1 www 692:
1.38 www 693: sub user_crit_msg_raw {
1.201 raeburn 694: my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
1.212 raeburn 695: $nosentstore,$recipid,$attachmenturl)=@_;
1.2 www 696: # Check if allowed missing
1.190 raeburn 697: my ($status,$packed_message);
1.2 www 698: my $msgid='undefined';
699: unless (($message)&&($user)&&($domain)) { $status='empty'; };
1.131 www 700: my $text=$message;
1.2 www 701: my $homeserver=&Apache::lonnet::homeserver($user,$domain);
702: if ($homeserver ne 'no_host') {
1.202 raeburn 703: ($msgid,$packed_message)=&packagemsg($subject,$message,undef,undef,
1.212 raeburn 704: $attachmenturl,undef,undef,undef,undef,undef,
705: undef,undef,$recipid);
1.190 raeburn 706: if ($sendback) { $packed_message.='<sendback>true</sendback>'; }
1.210 albertel 707: $status=&Apache::lonnet::cput('critical', {$msgid => $packed_message},
708: $domain,$user);
1.159 raeburn 709: if (defined($sentmessage)) {
1.190 raeburn 710: $$sentmessage = $packed_message;
1.159 raeburn 711: }
1.201 raeburn 712: if (!$nosentstore) {
1.193 raeburn 713: (undef,my $packed_message_no_citation) =
1.212 raeburn 714: &packagemsg($subject,$message,undef,undef,$attachmenturl,$user,
715: $domain,$msgid);
1.193 raeburn 716: if ($status eq 'ok' || $status eq 'con_delayed') {
717: &store_sent_mail($msgid,$packed_message_no_citation);
718: }
719: }
1.2 www 720: } else {
721: $status='no_host';
722: }
1.190 raeburn 723:
1.53 www 724: # Notifications
1.186 www 725: my %userenv = &Apache::loncommon::getemails($user,$domain);
1.53 www 726: if ($userenv{'critnotification'}) {
1.131 www 727: &sendnotification($userenv{'critnotification'},$user,$domain,$subject,1,
1.194 raeburn 728: $text,$msgid);
1.53 www 729: }
1.132 www 730: if ($toperm && $userenv{'permanentemail'}) {
731: &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,1,
1.194 raeburn 732: $text,$msgid);
1.132 www 733: }
1.53 www 734: # Log this
1.2 www 735: &Apache::lonnet::logthis(
1.4 www 736: 'Sending critical email '.$msgid.
1.2 www 737: ', log status: '.
1.140 albertel 738: &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
739: $env{'user.home'},
1.2 www 740: 'Sending critical '.$msgid.' to '.$user.' at '.$domain.' with status: '
1.4 www 741: .$status));
1.2 www 742: return $status;
743: }
744:
1.38 www 745:
1.58 bowersj2 746:
1.38 www 747: sub user_crit_msg {
1.201 raeburn 748: my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
1.212 raeburn 749: $nosentstore,$recipid,$attachmenturl)=@_;
1.183 albertel 750: my @status;
1.38 www 751: my %userenv = &Apache::lonnet::get('environment',['msgforward'],
752: $domain,$user);
753: my $msgforward=$userenv{'msgforward'};
754: if ($msgforward) {
1.183 albertel 755: foreach my $addr (split(/\,/,$msgforward)) {
756: my ($forwuser,$forwdomain)=split(/\:/,$addr);
757: push(@status,
758: &user_crit_msg_raw($forwuser,$forwdomain,$subject,$message,
1.202 raeburn 759: $sendback,$toperm,$sentmessage,$nosentstore,
1.212 raeburn 760: $recipid,$attachmenturl));
1.38 www 761: }
762: } else {
1.183 albertel 763: push(@status,
764: &user_crit_msg_raw($user,$domain,$subject,$message,$sendback,
1.212 raeburn 765: $toperm,$sentmessage,$nosentstore,$recipid,
766: $attachmenturl));
1.38 www 767: }
1.183 albertel 768: if (wantarray) {
769: return @status;
770: }
771: return join(' ',@status);
1.38 www 772: }
773:
1.2 www 774:
775: sub user_crit_received {
1.12 www 776: my $msgid=shift;
777: my %message=&Apache::lonnet::get('critical',[$msgid]);
1.52 www 778: my %contents=&unpackagemsg($message{$msgid},1);
1.204 raeburn 779: my $destname = $contents{'sendername'};
780: my $destdom = $contents{'senderdomain'};
781: if ($contents{'replytoaddr'}) {
782: my ($repname,$repdom) = split(/:/,$contents{'replytoaddr'});
783: if (&Apache::lonnet::homeserver($repname,$repdom) ne 'no_host') {
784: $destname = $repname;
785: $destdom = $repdom;
786: }
787: }
1.24 www 788: my $status='rec: '.($contents{'sendback'}?
1.204 raeburn 789: &user_normal_msg($destname,$destdom,&mt('Receipt').': '.$env{'user.name'}.
790: ' '.&mt('at').' '.$env{'user.domain'}.', '.
791: $contents{'subject'},&mt('User').' '.$env{'user.name'}.
792: ' '.&mt('at').' '.$env{'user.domain'}.
793: ' acknowledged receipt of message'."\n".' "'.
794: $contents{'subject'}.'"'."\n".&mt('dated').' '.
795: $contents{'time'}.".\n"
796: ):'no msg req');
1.5 www 797: $status.=' trans: '.
1.12 www 798: &Apache::lonnet::put(
799: 'nohist_email',{$contents{'msgid'} => $message{$msgid}});
1.5 www 800: $status.=' del: '.
1.9 albertel 801: &Apache::lonnet::del('critical',[$contents{'msgid'}]);
1.140 albertel 802: &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
803: $env{'user.home'},'Received critical message '.
1.5 www 804: $contents{'msgid'}.
805: ', '.$status);
1.12 www 806: return $status;
1.2 www 807: }
808:
1.215 jms 809:
810:
1.2 www 811:
1.38 www 812: sub user_normal_msg_raw {
1.132 www 813: my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
1.191 raeburn 814: $toperm,$currid,$newid,$sentmessage,$crsmsgid,$symb,$restitle,
1.202 raeburn 815: $error,$nosentstore,$recipid)=@_;
1.2 www 816: # Check if allowed missing
1.173 albertel 817: my ($status,$packed_message);
1.2 www 818: my $msgid='undefined';
1.131 www 819: my $text=$message;
1.2 www 820: unless (($message)&&($user)&&($domain)) { $status='empty'; };
821: my $homeserver=&Apache::lonnet::homeserver($user,$domain);
822: if ($homeserver ne 'no_host') {
1.173 albertel 823: ($msgid,$packed_message)=
824: &packagemsg($subject,$message,$citation,$baseurl,
1.174 raeburn 825: $attachmenturl,$user,$domain,$currid,
1.202 raeburn 826: undef,$crsmsgid,$symb,$error,$recipid);
1.174 raeburn 827:
1.108 www 828: # Store in user folder
1.210 albertel 829: $status=
830: &Apache::lonnet::cput('nohist_email',{$msgid => $packed_message},
831: $domain,$user);
1.108 www 832: # Save new message received time
1.40 www 833: &Apache::lonnet::put
834: ('email_status',{'recnewemail'=>time},$domain,$user);
1.201 raeburn 835: # Into sent-mail folder if sent mail storage required
836: if (!$nosentstore) {
1.190 raeburn 837: (undef,my $packed_message_no_citation) =
838: &packagemsg($subject,$message,undef,$baseurl,$attachmenturl,
1.191 raeburn 839: $user,$domain,$currid,undef,$crsmsgid,$symb,$error);
1.193 raeburn 840: if ($status eq 'ok' || $status eq 'con_delayed') {
841: &store_sent_mail($msgid,$packed_message_no_citation);
842: }
1.156 raeburn 843: }
1.201 raeburn 844: if (ref($newid) eq 'SCALAR') {
1.196 www 845: $$newid = $msgid;
846: }
1.201 raeburn 847: if (ref($sentmessage) eq 'SCALAR') {
1.196 www 848: $$sentmessage = $packed_message;
849: }
850: # Notifications
1.206 raeburn 851: my %userenv = &Apache::loncommon::getemails($user,$domain);
1.196 www 852: if ($userenv{'notification'}) {
853: &sendnotification($userenv{'notification'},$user,$domain,$subject,0,
854: $text,$msgid);
855: }
856: if ($toperm && $userenv{'permanentemail'}) {
1.214 raeburn 857: if ((!$userenv{'notification'}) || ($userenv{'notification'} ne $userenv{'permanentemail'})) {
858: &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,
859: $text,$msgid);
860: }
1.196 www 861: }
862: &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
863: $env{'user.home'},
864: 'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status);
865: } else {
1.2 www 866: $status='no_host';
1.196 www 867: }
1.2 www 868: return $status;
869: }
1.38 www 870:
871: sub user_normal_msg {
1.132 www 872: my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
1.202 raeburn 873: $toperm,$sentmessage,$symb,$restitle,$error,$nosentstore,$recipid)=@_;
1.199 raeburn 874: my @status;
1.38 www 875: my %userenv = &Apache::lonnet::get('environment',['msgforward'],
876: $domain,$user);
877: my $msgforward=$userenv{'msgforward'};
878: if ($msgforward) {
1.171 banghart 879: foreach (split(/\,/,$msgforward)) {
1.172 albertel 880: my ($forwuser,$forwdomain)=split(/\:/,$_);
1.199 raeburn 881: push(@status,
1.171 banghart 882: &user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,
1.172 albertel 883: $citation,$baseurl,$attachmenturl,$toperm,
1.201 raeburn 884: undef,undef,$sentmessage,undef,$symb,
1.202 raeburn 885: $restitle,$error,$nosentstore,$recipid));
1.171 banghart 886: }
1.191 raeburn 887: } else {
1.199 raeburn 888: push(@status,&user_normal_msg_raw($user,$domain,$subject,$message,
1.172 albertel 889: $citation,$baseurl,$attachmenturl,$toperm,
1.201 raeburn 890: undef,undef,$sentmessage,undef,$symb,
1.202 raeburn 891: $restitle,$error,$nosentstore,$recipid));
1.199 raeburn 892: }
893: if (wantarray) {
894: return @status;
1.38 www 895: }
1.199 raeburn 896: return join(' ',@status);
1.38 www 897: }
898:
1.201 raeburn 899: sub process_sent_mail {
1.214 raeburn 900: my ($msgsubj,$subj_prefix,$numsent,$stamp,$msgname,$msgdom,$msgcount,$context,$pid,$savemsg,$recusers,$recudoms,$baseurl,$attachmenturl,$symb,$error,$senderuname,$senderdom,$recipid) = @_;
1.201 raeburn 901: my $sentsubj;
902: if ($numsent > 1) {
903: $sentsubj = $subj_prefix.' ('.$numsent.' sent) '.$msgsubj;
1.205 raeburn 904: } else {
905: if ($subj_prefix) {
906: $sentsubj = $subj_prefix.' ';
907: }
908: $sentsubj .= $msgsubj;
1.201 raeburn 909: }
910: $sentsubj = &HTML::Entities::encode($sentsubj,'<>&"');
911: my $sentmsgid =
912: &buildmsgid($stamp,$sentsubj,$msgname,$msgdom,$msgcount,$context,$pid);
913: (undef,my $sentmessage) =
914: &packagemsg($msgsubj,$savemsg,undef,$baseurl,$attachmenturl,$recusers,
1.214 raeburn 915: $recudoms,$sentmsgid,undef,undef,$symb,$error,$recipid);
1.201 raeburn 916: my $status = &store_sent_mail($sentmsgid,$sentmessage,$senderuname,
1.210 albertel 917: $senderdom);
1.201 raeburn 918: return $status;
919: }
920:
1.156 raeburn 921: sub store_sent_mail {
1.210 albertel 922: my ($msgid,$message,$senderuname,$senderdom) = @_;
1.201 raeburn 923: if ($senderuname eq '') {
924: $senderuname = $env{'user.name'};
925: }
926: if ($senderdom eq '') {
927: $senderdom = $env{'user.domain'};
928: }
1.210 albertel 929: my $status =' '.&Apache::lonnet::cput('nohist_email_sent',
930: {$msgid => $message},
931: $senderdom,$senderuname);
1.156 raeburn 932: return $status;
933: }
1.2 www 934:
1.202 raeburn 935: sub store_recipients {
936: my ($subject,$sendername,$senderdom,$reciphash) = @_;
937: my $context = &get_course_context();
1.203 albertel 938: my $now = time();
1.202 raeburn 939: my $msgcount = &get_uniq();
940: my $recipid =
941: &buildmsgid($now,$subject,$sendername,$senderdom,$msgcount,$context,$$);
942: my %recipinfo = (
943: $recipid => $reciphash,
944: );
945: my $status = &Apache::lonnet::put('nohist_emailrecip',\%recipinfo,
946: $senderdom,$sendername);
947: if ($status eq 'ok') {
948: return ($recipid,$status);
949: } else {
950: return (undef,$status);
951: }
952: }
953:
1.106 www 954:
955: sub foldersuffix {
956: my $folder=shift;
957: unless ($folder) { return ''; }
1.189 raeburn 958: my $suffix;
959: my %folderhash = &get_user_folders($folder);
960: if (ref($folderhash{$folder}) eq 'HASH') {
961: $suffix = '_'.&escape($folderhash{$folder}{'id'});
962: } else {
963: $suffix = '_'.&escape($folder);
964: }
965: return $suffix;
966: }
967:
968:
969: sub get_user_folders {
970: my ($folder) = @_;
971: my %userfolders =
972: &Apache::lonnet::dump('email_folders',undef,undef,$folder);
973: my $lock = "\0".'lock_counter'; # locks db while counter incremented
974: my $counter = "\0".'idcount'; # used in suffix for email db files
975: if (defined($userfolders{$lock})) {
976: delete($userfolders{$lock});
977: }
978: if (defined($userfolders{$counter})) {
979: delete($userfolders{$counter});
980: }
981: return %userfolders;
1.106 www 982: }
983:
1.197 albertel 984: sub secapply {
985: my $rec=shift;
986: my $defaultflag=shift;
987: $rec=~s/\s+//g;
988: $rec=~s/\@/\:/g;
989: my ($adr,$sections_or_groups)=($rec=~/^([^\(]+)\(([^\)]+)\)/);
990: if ($sections_or_groups) {
991: foreach my $item (split(/\;/,$sections_or_groups)) {
992: if (($item eq $env{'request.course.sec'}) ||
993: ($defaultflag && ($item eq '*'))) {
994: return $adr;
995: } elsif ($env{'request.course.groups'}) {
996: my @usersgroups = split(/:/,$env{'request.course.groups'});
997: if (grep(/^\Q$item\E$/,@usersgroups)) {
998: return $adr;
999: }
1000: }
1001: }
1002: } else {
1003: return $rec;
1004: }
1005: return '';
1006: }
1007:
1008: sub decide_receiver {
1009: my ($feedurl,$author,$question,$course,$policy,$defaultflag) = @_;
1010: &Apache::lonenc::check_decrypt(\$feedurl);
1011: my $typestyle='';
1012: my %to=();
1013: if ($env{'form.discuss'} eq 'author' ||$author) {
1014: $typestyle.='Submitting as Author Feedback<br />';
1015: $feedurl=~ m{^/res/($LONCAPA::domain_re)/($LONCAPA::username_re)/};
1016: $to{$2.':'.$1}=1;
1017: }
1018: my $cid = $env{'request.course.id'};
1019: if ($env{'form.discuss'} eq 'question' ||$question) {
1020: $typestyle.=&mt('Submitting as Question').'<br />';
1021: foreach my $item (split(/\,/,$env{'course.'.$cid.'.question.email'})) {
1022: my $rec=&secapply($item,$defaultflag);
1023: if ($rec) { $to{$rec}=1; }
1024: }
1025: }
1026: if ($env{'form.discuss'} eq 'course' ||$course) {
1027: $typestyle.=&mt('Submitting as Comment').'<br />';
1028: foreach my $item (split(/\,/,$env{'course.'.$cid.'.comment.email'})) {
1029: my $rec=&secapply($item,$defaultflag);
1030: if ($rec) { $to{$rec}=1; }
1031: }
1032: }
1033: if ($env{'form.discuss'} eq 'policy' ||$policy) {
1034: $typestyle.=&mt('Submitting as Policy Feedback').'<br />';
1035: foreach my $item (split(/\,/,$env{'course.'.$cid.'.policy.email'})) {
1036: my $rec=&secapply($item,$defaultflag);
1037: if ($rec) { $to{$rec}=1; }
1038: }
1039: }
1040: if ((scalar(%to) eq '0') && (!$defaultflag)) {
1041: ($typestyle,%to)=
1042: &decide_receiver($feedurl,$author,$question,$course,$policy,1);
1043: }
1044: return ($typestyle,%to);
1045: }
1046:
1.180 albertel 1047: 1;
1.1 www 1048: __END__
1049:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonmsg.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface