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