Annotation of loncom/interface/lonmsg.pm, revision 1.217
1.1 www 1: # The LearningOnline Network with CAPA
1.26 albertel 2: # Routines for messaging
3: #
1.217 ! schafran 4: # $Id: lonmsg.pm,v 1.216 2008/11/28 14:36:50 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: =item user_lang()
198:
199: =back
1.199 raeburn 200:
201: =cut
202:
1.1 www 203: use strict;
1.140 albertel 204: use Apache::lonnet;
1.47 albertel 205: use HTML::TokeParser();
1.180 albertel 206: use Apache::lonlocal;
1.53 www 207: use Mail::Send;
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
227: $baseurl =~ s|^http://[^/]+/|/|;
1.96 albertel 228: $baseurl =&HTML::Entities::encode($baseurl,'<>&"');
1.51 www 229: #remove machine specification
230: $attachmenturl =~ s|^http://[^/]+/|/|;
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 %senderemails=&Apache::loncommon::getemails();
426: my $senderaddress='';
427: foreach my $type ('notification','permanentemail','critnotification') {
428: if ($senderemails{$type}) {
429: $senderaddress=$senderemails{$type};
430: }
431: }
1.53 www 432: $body=
1.217 ! schafran 433: "*** ".&mt_user($user_lh,'This is an automatic e-mail generated by the LON-CAPA system.')."\n".
! 434: "*** ".($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.213 raeburn 435: &mt_user($user_lh,'A reply will not be received by the recipient!'))."\n\n".$body;
1.53 www 436: my $msg = new Mail::Send;
437: $msg->to($to);
438: $msg->subject('[LON-CAPA] '.$subject);
1.188 www 439: if ($senderaddress) { $msg->add('Reply-to',$senderaddress); $msg->add('From',$senderaddress); }
1.97 matthew 440: if (my $fh = $msg->open()) {
1.172 albertel 441: print $fh $body;
442: $fh->close;
1.68 www 443: }
1.53 www 444: }
445:
446: # ==================================================== Send notification emails
447:
448: sub sendnotification {
1.194 raeburn 449: my ($to,$touname,$toudom,$subj,$crit,$text,$msgid)=@_;
1.140 albertel 450: my $sender=$env{'environment.firstname'}.' '.$env{'environment.lastname'};
1.131 www 451: unless ($sender=~/\w/) {
1.208 raeburn 452: $sender=$env{'user.name'}.':'.$env{'user.domain'};
1.131 www 453: }
1.53 www 454: my $critical=($crit?' critical':'');
1.208 raeburn 455:
1.131 www 456: $text=~s/\<\;/\</gs;
457: $text=~s/\>\;/\>/gs;
1.53 www 458: my $url='http://'.
1.198 albertel 459: &Apache::lonnet::hostname(&Apache::lonnet::homeserver($touname,$toudom)).
1.54 www 460: '/adm/email?username='.$touname.'&domain='.$toudom;
1.194 raeburn 461: my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid,
462: $symb,$error) = &Apache::lonmsg::unpackmsgid($msgid);
1.208 raeburn 463: my ($coursetext,$body,$bodybegin,$bodysubj,$bodyend);
1.213 raeburn 464: my $user_lh = &user_lang($touname,$toudom,$fromcid);
1.194 raeburn 465: if ($fromcid ne '') {
1.213 raeburn 466: $coursetext = "\n".&mt_user($user_lh,'Course').': ';
1.194 raeburn 467: if ($env{'course.'.$fromcid.'.description'} ne '') {
468: $coursetext .= $env{'course.'.$fromcid.'.description'};
469: } else {
470: my %coursehash = &Apache::lonnet::coursedescription($fromcid,);
471: if ($coursehash{'description'} ne '') {
472: $coursetext .= $coursehash{'description'};
473: }
474: }
475: $coursetext .= "\n\n";
476: }
1.206 raeburn 477: my @recipients = split(/,/,$to);
1.208 raeburn 478: $bodybegin = $coursetext.
1.213 raeburn 479: &mt_user($user_lh,
480: 'You received a'.$critical.' message from [_1] in LON-CAPA.',$sender).' ';
481: $bodysubj = &mt_user($user_lh,'The subject is
1.53 www 482:
1.195 raeburn 483: [_1]
1.53 www 484:
1.195 raeburn 485: ',$subj)."\n".
1.213 raeburn 486: '=== '.&mt_user($user_lh,'Excerpt')." ============================================================
1.206 raeburn 487: ";
488: $bodyend = "
1.131 www 489: ========================================================================
490:
1.213 raeburn 491: ".&mt_user($user_lh,'Use
1.53 www 492:
1.195 raeburn 493: [_1]
1.53 www 494:
1.195 raeburn 495: to access the full message.',$url);
1.206 raeburn 496: my %userenv = &Apache::lonnet::get('environment',['notifywithhtml'],$toudom,$touname);
1.213 raeburn 497: my $subject = &mt_user($user_lh,"'New' $critical message from ").$sender;
1.208 raeburn 498:
499: my ($blocked,$blocktext);
500: if (!$crit) {
501: my %setters;
502: my ($startblock,$endblock) =
503: &Apache::loncommon::blockcheck(\%setters,'com',$touname,$toudom);
504: if ($startblock && $endblock) {
505: $blocked = 1;
1.209 albertel 506: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
507: my $showend = &Apache::lonlocal::locallocaltime($endblock);
1.213 raeburn 508: $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 509: }
510: }
1.206 raeburn 511: if ($userenv{'notifywithhtml'} ne '') {
512: my @htmlexcerpt = split(/,/,$userenv{'notifywithhtml'});
513: foreach my $addr (@recipients) {
1.208 raeburn 514: if ($blocked) {
515: $body = $bodybegin."\n".$blocktext."\n".$bodyend;
516: } else {
517: my $sendtext = $text;
518: if (!grep/^\Q$addr\E/,@htmlexcerpt) {
519: $sendtext =~ s/\<\/*[^\>]+\>//gs;
520: }
521: $body = $bodybegin.$bodysubj.$sendtext.$bodyend;
1.206 raeburn 522: }
1.213 raeburn 523: &sendemail($addr,$subject,$body,$touname,$toudom,$user_lh);
1.206 raeburn 524: }
525: } else {
1.208 raeburn 526: if ($blocked) {
527: $body = $bodybegin."\n".$blocktext."\n".$bodyend;
528: } else {
529: $text =~ s/\<\/*[^\>]+\>//gs;
530: $body = $bodybegin.$bodysubj.$text.$bodyend;
531: }
1.213 raeburn 532: &sendemail($to,$subject,$body,$touname,$toudom,$user_lh);
1.206 raeburn 533: }
1.53 www 534: }
1.215 jms 535:
1.40 www 536:
537: sub newmail {
1.140 albertel 538: if ((time-$env{'user.mailcheck.time'})>300) {
1.40 www 539: my %what=&Apache::lonnet::get('email_status',['recnewemail']);
1.211 raeburn 540: &Apache::lonnet::appenv({'user.mailcheck.time'=>time});
1.40 www 541: if ($what{'recnewemail'}>0) { return 1; }
542: }
543: return 0;
544: }
545:
1.1 www 546:
1.58 bowersj2 547:
1.1 www 548: sub author_res_msg {
549: my ($filename,$message)=@_;
1.2 www 550: unless ($message) { return 'empty'; }
1.1 www 551: $filename=&Apache::lonnet::declutter($filename);
1.72 www 552: my ($domain,$author,@dummy)=split(/\//,$filename);
1.1 www 553: my $homeserver=&Apache::lonnet::homeserver($author,$domain);
554: if ($homeserver ne 'no_host') {
555: my $id=unpack("%32C*",$message);
1.181 albertel 556: $message .= " <p>This error occurred on machine ".
557: $Apache::lonnet::perlvar{'lonHostID'}."</p>";
1.2 www 558: my $msgid;
1.72 www 559: ($msgid,$message)=&packagemsg($filename,$message);
1.3 www 560: return &Apache::lonnet::reply('put:'.$domain.':'.$author.
1.72 www 561: ':nohist_res_msgs:'.
1.184 www 562: &escape($filename.'_'.$id).'='.
563: &escape($message),$homeserver);
1.1 www 564: }
1.2 www 565: return 'no_host';
1.73 www 566: }
567:
1.215 jms 568:
1.73 www 569:
570: sub retrieve_author_res_msg {
1.75 www 571: my $url=shift;
1.73 www 572: $url=&Apache::lonnet::declutter($url);
1.187 albertel 573: my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
1.76 www 574: my %errormsgs=&Apache::lonnet::dump('nohist_res_msgs',$domain,$author);
1.73 www 575: my $msgs='';
576: foreach (keys %errormsgs) {
1.80 www 577: if ($_=~/^\Q$url\E\_\d+$/) {
1.73 www 578: my %content=&unpackagemsg($errormsgs{$_});
1.74 www 579: $msgs.='<p><img src="/adm/lonMisc/bomb.gif" /><b>'.
580: $content{'time'}.'</b>: '.$content{'message'}.
581: '<br /></p>';
1.73 www 582: }
583: }
584: return $msgs;
585: }
586:
587:
1.215 jms 588:
589:
1.73 www 590:
591: sub del_url_author_res_msg {
1.75 www 592: my $url=shift;
1.73 www 593: $url=&Apache::lonnet::declutter($url);
1.187 albertel 594: my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
1.77 www 595: my @delmsgs=();
596: foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
597: if ($_=~/^\Q$url\E\_\d+$/) {
598: push (@delmsgs,$_);
599: }
600: }
601: return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
1.73 www 602: }
1.215 jms 603:
1.73 www 604:
1.152 www 605: sub clear_author_res_msg {
606: my $url=shift;
607: $url=&Apache::lonnet::declutter($url);
1.187 albertel 608: my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
1.152 www 609: my @delmsgs=();
610: foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
611: if ($_=~/^\Q$url\E/) {
612: push (@delmsgs,$_);
613: }
614: }
615: return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
616: }
1.215 jms 617:
618:
1.73 www 619:
620: sub all_url_author_res_msg {
621: my ($author,$domain)=@_;
1.75 www 622: my %returnhash=();
1.76 www 623: foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
1.75 www 624: $_=~/^(.+)\_\d+/;
625: $returnhash{$1}=1;
626: }
627: return %returnhash;
1.1 www 628: }
629:
1.185 albertel 630:
631: sub store_instructor_comment {
632: my ($msg,$uname,$udom) = @_;
633: my $cid = $env{'request.course.id'};
634: my $cnum = $env{'course.'.$cid.'.num'};
635: my $cdom = $env{'course.'.$cid.'.domain'};
636: my $subject= &mt('Record').' ['.$uname.':'.$udom.']';
637: my $result = &user_normal_msg_raw($cnum,$cdom,$subject,$msg);
1.201 raeburn 638: if ($result eq 'ok' || $result eq 'con_delayed') {
639:
640: }
1.185 albertel 641: return $result;
642: }
643:
1.1 www 644:
1.38 www 645: sub user_crit_msg_raw {
1.201 raeburn 646: my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
1.212 raeburn 647: $nosentstore,$recipid,$attachmenturl)=@_;
1.2 www 648: # Check if allowed missing
1.190 raeburn 649: my ($status,$packed_message);
1.2 www 650: my $msgid='undefined';
651: unless (($message)&&($user)&&($domain)) { $status='empty'; };
1.131 www 652: my $text=$message;
1.2 www 653: my $homeserver=&Apache::lonnet::homeserver($user,$domain);
654: if ($homeserver ne 'no_host') {
1.202 raeburn 655: ($msgid,$packed_message)=&packagemsg($subject,$message,undef,undef,
1.212 raeburn 656: $attachmenturl,undef,undef,undef,undef,undef,
657: undef,undef,$recipid);
1.190 raeburn 658: if ($sendback) { $packed_message.='<sendback>true</sendback>'; }
1.210 albertel 659: $status=&Apache::lonnet::cput('critical', {$msgid => $packed_message},
660: $domain,$user);
1.159 raeburn 661: if (defined($sentmessage)) {
1.190 raeburn 662: $$sentmessage = $packed_message;
1.159 raeburn 663: }
1.201 raeburn 664: if (!$nosentstore) {
1.193 raeburn 665: (undef,my $packed_message_no_citation) =
1.212 raeburn 666: &packagemsg($subject,$message,undef,undef,$attachmenturl,$user,
667: $domain,$msgid);
1.193 raeburn 668: if ($status eq 'ok' || $status eq 'con_delayed') {
669: &store_sent_mail($msgid,$packed_message_no_citation);
670: }
671: }
1.2 www 672: } else {
673: $status='no_host';
674: }
1.190 raeburn 675:
1.53 www 676: # Notifications
1.186 www 677: my %userenv = &Apache::loncommon::getemails($user,$domain);
1.53 www 678: if ($userenv{'critnotification'}) {
1.131 www 679: &sendnotification($userenv{'critnotification'},$user,$domain,$subject,1,
1.194 raeburn 680: $text,$msgid);
1.53 www 681: }
1.132 www 682: if ($toperm && $userenv{'permanentemail'}) {
683: &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,1,
1.194 raeburn 684: $text,$msgid);
1.132 www 685: }
1.53 www 686: # Log this
1.2 www 687: &Apache::lonnet::logthis(
1.4 www 688: 'Sending critical email '.$msgid.
1.2 www 689: ', log status: '.
1.140 albertel 690: &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
691: $env{'user.home'},
1.2 www 692: 'Sending critical '.$msgid.' to '.$user.' at '.$domain.' with status: '
1.4 www 693: .$status));
1.2 www 694: return $status;
695: }
696:
1.38 www 697:
1.58 bowersj2 698:
1.38 www 699: sub user_crit_msg {
1.201 raeburn 700: my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
1.212 raeburn 701: $nosentstore,$recipid,$attachmenturl)=@_;
1.183 albertel 702: my @status;
1.38 www 703: my %userenv = &Apache::lonnet::get('environment',['msgforward'],
704: $domain,$user);
705: my $msgforward=$userenv{'msgforward'};
706: if ($msgforward) {
1.183 albertel 707: foreach my $addr (split(/\,/,$msgforward)) {
708: my ($forwuser,$forwdomain)=split(/\:/,$addr);
709: push(@status,
710: &user_crit_msg_raw($forwuser,$forwdomain,$subject,$message,
1.202 raeburn 711: $sendback,$toperm,$sentmessage,$nosentstore,
1.212 raeburn 712: $recipid,$attachmenturl));
1.38 www 713: }
714: } else {
1.183 albertel 715: push(@status,
716: &user_crit_msg_raw($user,$domain,$subject,$message,$sendback,
1.212 raeburn 717: $toperm,$sentmessage,$nosentstore,$recipid,
718: $attachmenturl));
1.38 www 719: }
1.183 albertel 720: if (wantarray) {
721: return @status;
722: }
723: return join(' ',@status);
1.38 www 724: }
725:
1.2 www 726:
727: sub user_crit_received {
1.12 www 728: my $msgid=shift;
729: my %message=&Apache::lonnet::get('critical',[$msgid]);
1.52 www 730: my %contents=&unpackagemsg($message{$msgid},1);
1.204 raeburn 731: my $destname = $contents{'sendername'};
732: my $destdom = $contents{'senderdomain'};
733: if ($contents{'replytoaddr'}) {
734: my ($repname,$repdom) = split(/:/,$contents{'replytoaddr'});
735: if (&Apache::lonnet::homeserver($repname,$repdom) ne 'no_host') {
736: $destname = $repname;
737: $destdom = $repdom;
738: }
739: }
1.24 www 740: my $status='rec: '.($contents{'sendback'}?
1.204 raeburn 741: &user_normal_msg($destname,$destdom,&mt('Receipt').': '.$env{'user.name'}.
742: ' '.&mt('at').' '.$env{'user.domain'}.', '.
743: $contents{'subject'},&mt('User').' '.$env{'user.name'}.
744: ' '.&mt('at').' '.$env{'user.domain'}.
745: ' acknowledged receipt of message'."\n".' "'.
746: $contents{'subject'}.'"'."\n".&mt('dated').' '.
747: $contents{'time'}.".\n"
748: ):'no msg req');
1.5 www 749: $status.=' trans: '.
1.12 www 750: &Apache::lonnet::put(
751: 'nohist_email',{$contents{'msgid'} => $message{$msgid}});
1.5 www 752: $status.=' del: '.
1.9 albertel 753: &Apache::lonnet::del('critical',[$contents{'msgid'}]);
1.140 albertel 754: &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
755: $env{'user.home'},'Received critical message '.
1.5 www 756: $contents{'msgid'}.
757: ', '.$status);
1.12 www 758: return $status;
1.2 www 759: }
760:
1.215 jms 761:
762:
1.2 www 763:
1.38 www 764: sub user_normal_msg_raw {
1.132 www 765: my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
1.191 raeburn 766: $toperm,$currid,$newid,$sentmessage,$crsmsgid,$symb,$restitle,
1.202 raeburn 767: $error,$nosentstore,$recipid)=@_;
1.2 www 768: # Check if allowed missing
1.173 albertel 769: my ($status,$packed_message);
1.2 www 770: my $msgid='undefined';
1.131 www 771: my $text=$message;
1.2 www 772: unless (($message)&&($user)&&($domain)) { $status='empty'; };
773: my $homeserver=&Apache::lonnet::homeserver($user,$domain);
774: if ($homeserver ne 'no_host') {
1.173 albertel 775: ($msgid,$packed_message)=
776: &packagemsg($subject,$message,$citation,$baseurl,
1.174 raeburn 777: $attachmenturl,$user,$domain,$currid,
1.202 raeburn 778: undef,$crsmsgid,$symb,$error,$recipid);
1.174 raeburn 779:
1.108 www 780: # Store in user folder
1.210 albertel 781: $status=
782: &Apache::lonnet::cput('nohist_email',{$msgid => $packed_message},
783: $domain,$user);
1.108 www 784: # Save new message received time
1.40 www 785: &Apache::lonnet::put
786: ('email_status',{'recnewemail'=>time},$domain,$user);
1.201 raeburn 787: # Into sent-mail folder if sent mail storage required
788: if (!$nosentstore) {
1.190 raeburn 789: (undef,my $packed_message_no_citation) =
790: &packagemsg($subject,$message,undef,$baseurl,$attachmenturl,
1.191 raeburn 791: $user,$domain,$currid,undef,$crsmsgid,$symb,$error);
1.193 raeburn 792: if ($status eq 'ok' || $status eq 'con_delayed') {
793: &store_sent_mail($msgid,$packed_message_no_citation);
794: }
1.156 raeburn 795: }
1.201 raeburn 796: if (ref($newid) eq 'SCALAR') {
1.196 www 797: $$newid = $msgid;
798: }
1.201 raeburn 799: if (ref($sentmessage) eq 'SCALAR') {
1.196 www 800: $$sentmessage = $packed_message;
801: }
802: # Notifications
1.206 raeburn 803: my %userenv = &Apache::loncommon::getemails($user,$domain);
1.196 www 804: if ($userenv{'notification'}) {
805: &sendnotification($userenv{'notification'},$user,$domain,$subject,0,
806: $text,$msgid);
807: }
808: if ($toperm && $userenv{'permanentemail'}) {
1.214 raeburn 809: if ((!$userenv{'notification'}) || ($userenv{'notification'} ne $userenv{'permanentemail'})) {
810: &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,
811: $text,$msgid);
812: }
1.196 www 813: }
814: &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
815: $env{'user.home'},
816: 'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status);
817: } else {
1.2 www 818: $status='no_host';
1.196 www 819: }
1.2 www 820: return $status;
821: }
1.38 www 822:
823: sub user_normal_msg {
1.132 www 824: my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
1.202 raeburn 825: $toperm,$sentmessage,$symb,$restitle,$error,$nosentstore,$recipid)=@_;
1.199 raeburn 826: my @status;
1.38 www 827: my %userenv = &Apache::lonnet::get('environment',['msgforward'],
828: $domain,$user);
829: my $msgforward=$userenv{'msgforward'};
830: if ($msgforward) {
1.171 banghart 831: foreach (split(/\,/,$msgforward)) {
1.172 albertel 832: my ($forwuser,$forwdomain)=split(/\:/,$_);
1.199 raeburn 833: push(@status,
1.171 banghart 834: &user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,
1.172 albertel 835: $citation,$baseurl,$attachmenturl,$toperm,
1.201 raeburn 836: undef,undef,$sentmessage,undef,$symb,
1.202 raeburn 837: $restitle,$error,$nosentstore,$recipid));
1.171 banghart 838: }
1.191 raeburn 839: } else {
1.199 raeburn 840: push(@status,&user_normal_msg_raw($user,$domain,$subject,$message,
1.172 albertel 841: $citation,$baseurl,$attachmenturl,$toperm,
1.201 raeburn 842: undef,undef,$sentmessage,undef,$symb,
1.202 raeburn 843: $restitle,$error,$nosentstore,$recipid));
1.199 raeburn 844: }
845: if (wantarray) {
846: return @status;
1.38 www 847: }
1.199 raeburn 848: return join(' ',@status);
1.38 www 849: }
850:
1.201 raeburn 851: sub process_sent_mail {
1.214 raeburn 852: my ($msgsubj,$subj_prefix,$numsent,$stamp,$msgname,$msgdom,$msgcount,$context,$pid,$savemsg,$recusers,$recudoms,$baseurl,$attachmenturl,$symb,$error,$senderuname,$senderdom,$recipid) = @_;
1.201 raeburn 853: my $sentsubj;
854: if ($numsent > 1) {
855: $sentsubj = $subj_prefix.' ('.$numsent.' sent) '.$msgsubj;
1.205 raeburn 856: } else {
857: if ($subj_prefix) {
858: $sentsubj = $subj_prefix.' ';
859: }
860: $sentsubj .= $msgsubj;
1.201 raeburn 861: }
862: $sentsubj = &HTML::Entities::encode($sentsubj,'<>&"');
863: my $sentmsgid =
864: &buildmsgid($stamp,$sentsubj,$msgname,$msgdom,$msgcount,$context,$pid);
865: (undef,my $sentmessage) =
866: &packagemsg($msgsubj,$savemsg,undef,$baseurl,$attachmenturl,$recusers,
1.214 raeburn 867: $recudoms,$sentmsgid,undef,undef,$symb,$error,$recipid);
1.201 raeburn 868: my $status = &store_sent_mail($sentmsgid,$sentmessage,$senderuname,
1.210 albertel 869: $senderdom);
1.201 raeburn 870: return $status;
871: }
872:
1.156 raeburn 873: sub store_sent_mail {
1.210 albertel 874: my ($msgid,$message,$senderuname,$senderdom) = @_;
1.201 raeburn 875: if ($senderuname eq '') {
876: $senderuname = $env{'user.name'};
877: }
878: if ($senderdom eq '') {
879: $senderdom = $env{'user.domain'};
880: }
1.210 albertel 881: my $status =' '.&Apache::lonnet::cput('nohist_email_sent',
882: {$msgid => $message},
883: $senderdom,$senderuname);
1.156 raeburn 884: return $status;
885: }
1.2 www 886:
1.202 raeburn 887: sub store_recipients {
888: my ($subject,$sendername,$senderdom,$reciphash) = @_;
889: my $context = &get_course_context();
1.203 albertel 890: my $now = time();
1.202 raeburn 891: my $msgcount = &get_uniq();
892: my $recipid =
893: &buildmsgid($now,$subject,$sendername,$senderdom,$msgcount,$context,$$);
894: my %recipinfo = (
895: $recipid => $reciphash,
896: );
897: my $status = &Apache::lonnet::put('nohist_emailrecip',\%recipinfo,
898: $senderdom,$sendername);
899: if ($status eq 'ok') {
900: return ($recipid,$status);
901: } else {
902: return (undef,$status);
903: }
904: }
905:
1.106 www 906:
907: sub foldersuffix {
908: my $folder=shift;
909: unless ($folder) { return ''; }
1.189 raeburn 910: my $suffix;
911: my %folderhash = &get_user_folders($folder);
912: if (ref($folderhash{$folder}) eq 'HASH') {
913: $suffix = '_'.&escape($folderhash{$folder}{'id'});
914: } else {
915: $suffix = '_'.&escape($folder);
916: }
917: return $suffix;
918: }
919:
920:
921: sub get_user_folders {
922: my ($folder) = @_;
923: my %userfolders =
924: &Apache::lonnet::dump('email_folders',undef,undef,$folder);
925: my $lock = "\0".'lock_counter'; # locks db while counter incremented
926: my $counter = "\0".'idcount'; # used in suffix for email db files
927: if (defined($userfolders{$lock})) {
928: delete($userfolders{$lock});
929: }
930: if (defined($userfolders{$counter})) {
931: delete($userfolders{$counter});
932: }
933: return %userfolders;
1.106 www 934: }
935:
1.197 albertel 936: sub secapply {
937: my $rec=shift;
938: my $defaultflag=shift;
939: $rec=~s/\s+//g;
940: $rec=~s/\@/\:/g;
941: my ($adr,$sections_or_groups)=($rec=~/^([^\(]+)\(([^\)]+)\)/);
942: if ($sections_or_groups) {
943: foreach my $item (split(/\;/,$sections_or_groups)) {
944: if (($item eq $env{'request.course.sec'}) ||
945: ($defaultflag && ($item eq '*'))) {
946: return $adr;
947: } elsif ($env{'request.course.groups'}) {
948: my @usersgroups = split(/:/,$env{'request.course.groups'});
949: if (grep(/^\Q$item\E$/,@usersgroups)) {
950: return $adr;
951: }
952: }
953: }
954: } else {
955: return $rec;
956: }
957: return '';
958: }
959:
960: sub decide_receiver {
961: my ($feedurl,$author,$question,$course,$policy,$defaultflag) = @_;
962: &Apache::lonenc::check_decrypt(\$feedurl);
963: my $typestyle='';
964: my %to=();
965: if ($env{'form.discuss'} eq 'author' ||$author) {
966: $typestyle.='Submitting as Author Feedback<br />';
967: $feedurl=~ m{^/res/($LONCAPA::domain_re)/($LONCAPA::username_re)/};
968: $to{$2.':'.$1}=1;
969: }
970: my $cid = $env{'request.course.id'};
971: if ($env{'form.discuss'} eq 'question' ||$question) {
972: $typestyle.=&mt('Submitting as Question').'<br />';
973: foreach my $item (split(/\,/,$env{'course.'.$cid.'.question.email'})) {
974: my $rec=&secapply($item,$defaultflag);
975: if ($rec) { $to{$rec}=1; }
976: }
977: }
978: if ($env{'form.discuss'} eq 'course' ||$course) {
979: $typestyle.=&mt('Submitting as Comment').'<br />';
980: foreach my $item (split(/\,/,$env{'course.'.$cid.'.comment.email'})) {
981: my $rec=&secapply($item,$defaultflag);
982: if ($rec) { $to{$rec}=1; }
983: }
984: }
985: if ($env{'form.discuss'} eq 'policy' ||$policy) {
986: $typestyle.=&mt('Submitting as Policy Feedback').'<br />';
987: foreach my $item (split(/\,/,$env{'course.'.$cid.'.policy.email'})) {
988: my $rec=&secapply($item,$defaultflag);
989: if ($rec) { $to{$rec}=1; }
990: }
991: }
992: if ((scalar(%to) eq '0') && (!$defaultflag)) {
993: ($typestyle,%to)=
994: &decide_receiver($feedurl,$author,$question,$course,$policy,1);
995: }
996: return ($typestyle,%to);
997: }
998:
1.213 raeburn 999: sub user_lang {
1000: my ($touname,$toudom,$fromcid) = @_;
1001: my @userlangs;
1002: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
1003: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
1004: $env{'course.'.$fromcid.'.languages'}));
1005: } else {
1006: my %langhash = &Apache::lonnet::get('environment',['languages'],$toudom,$touname);
1007: if ($langhash{'languages'} ne '') {
1008: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
1009: } else {
1010: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
1011: if ($domdefs{'lang_def'} ne '') {
1012: @userlangs = ($domdefs{'lang_def'});
1013: }
1014: }
1015: }
1.216 raeburn 1016: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
1.213 raeburn 1017: my $user_lh = Apache::localize->get_handle(@languages);
1018: return $user_lh;
1019: }
1020:
1.180 albertel 1021: 1;
1.1 www 1022: __END__
1023:
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