1: # The LearningOnline Network with CAPA
2: # Routines for messaging
3: #
4: # $Id: lonmsg.pm,v 1.239.2.1 2016/08/04 22:53:55 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, $permresults)>:
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,$permresults)>:
152: Sends a message to the $user at $domain, with subject $subject and message $message.
153:
154: Additionally it will check if the user has a Forwarding address
155: set, and send the message to that address instead
156:
157: returns
158: - in array context a list of results for each message that was sent
159: - in scalar context a space seperated list of results for each
160: message sent
161:
162: =item store_sent_mail()
163:
164: =item store_recipients()
165:
166: =item foldersuffix()
167:
168: =item get_user_folders()
169:
170: User-defined folders
171:
172: =item secapply()
173:
174: =item B<decide_receiver($feedurl,$author,$question,$course,$policy,$defaultflag)>:
175:
176: Arguments
177: $feedurl - /res/ url of resource (only need if $author is true)
178: $author,$question,$course,$policy - all true/false parameters
179: if true will attempt to find the addresses of user that should receive
180: this type of feedback (author - feedback to author of resource $feedurl,
181: $question 'Resource Content Questions', $course 'Course Content Question',
182: $policy 'Course Policy')
183: (Additionally it also checks $env for whether the corresponding form.<name>
184: element exists, for ease of use in a html response context)
185:
186: $defaultflag - (internal should be left blank) if true gather addresses
187: that aren't for a section even if I have a section
188: (used for reccursion internally, first we look for
189: addresses for our specific section then we recurse
190: and look for non section addresses)
191:
192: Returns
193: $typestyle - string of html text, describing what addresses were found
194: %to - a hash, which keys are addresses of users to send messages to
195: the keys will look like name:domain
196:
197: =back
198:
199: =cut
200:
201: use strict;
202: use Apache::lonnet;
203: use HTML::TokeParser();
204: use Apache::lonlocal;
205: use Mail::Send;
206: use HTML::Entities;
207: use Encode;
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,$onlycid)=@_;
401: $msgid=&unescape($msgid);
402: my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$fromcid,
403: $processid,$symb,$error) = split(/\:/,&unescape($msgid));
404: if (!defined($processid)) { $fromcid = ''; }
405: if (($onlycid) && ($onlycid ne $fromcid)) {
406: return ($sendtime,'',$fromname,$fromdomain,'',$fromcid,'',$error);
407: }
408: $shortsubj = &unescape($shortsubj);
409: $shortsubj = &HTML::Entities::decode($shortsubj);
410: $symb = &unescape($symb);
411: if (!defined($processid)) { $fromcid = ''; }
412: my %status=();
413: unless ($skipstatus) {
414: if (ref($status_cache)) {
415: $status{$msgid} = $status_cache->{$msgid};
416: } else {
417: my $suffix=&foldersuffix($folder);
418: %status=&Apache::lonnet::get('email_status'.$suffix,[$msgid]);
419: }
420: if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; }
421: unless ($status{$msgid}) { $status{$msgid}='new'; }
422: }
423: return ($sendtime,$shortsubj,$fromname,$fromdomain,$status{$msgid},$fromcid,$symb,$error);
424: }
425:
426:
427: sub sendemail {
428: my ($to,$subject,$body,$to_uname,$to_udom,$user_lh)=@_;
429: my $senderaddress='';
430: my $replytoaddress='';
431: my $msgsent;
432: if ($env{'form.can_reply'} eq 'N') {
433: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
434: my $hostname = &Apache::lonnet::hostname($lonhost);
435: $replytoaddress = 'do-not-reply@'.$hostname;
436: } else {
437: my %senderemails;
438: my $have_sender;
439: if ($env{'form.reply_to_addr'}) {
440: my ($replytoname,$replytodom) = split(/:/,$env{'form.reply_to_addr'});
441: if (!($replytoname eq $env{'user.name'} && $replytodom eq $env{'user.domain'})) {
442: if (&Apache::lonnet::homeserver($replytoname,$replytodom) ne 'no_host') {
443: %senderemails =
444: &Apache::loncommon::getemails($replytoname,$replytodom);
445: $have_sender = 1;
446: }
447: }
448: }
449: if (!$have_sender) {
450: %senderemails=&Apache::loncommon::getemails();
451: }
452: foreach my $type ('permanentemail','critnotification','notification') {
453: if ($senderemails{$type}) {
454: ($senderaddress) = split(/,/,$senderemails{$type});
455: last if ($senderaddress);
456: }
457: }
458: }
459: $body=
460: "*** ".&mt_user($user_lh,'This is an automatic e-mail generated by the LON-CAPA system.')."\n".
461: "*** ".($senderaddress?&mt_user($user_lh,'You can reply to this e-mail'):&mt_user($user_lh,'Please do not reply to this address.')."\n*** ".
462: &mt_user($user_lh,'A reply will not be received by the recipient!'))."\n\n".$body;
463:
464: my $msg = new Mail::Send;
465: $msg->to($to);
466: $msg->subject('[LON-CAPA] '.$subject);
467: if ($replytoaddress) {
468: $msg->add('Reply-to',$replytoaddress);
469: }
470: if ($senderaddress) {
471: $msg->add('From',$senderaddress);
472: }
473: $msg->add('Content-type','text/plain; charset=UTF-8');
474: if (my $fh = $msg->open()) {
475: print $fh $body;
476: $fh->close;
477: $msgsent = 1;
478: }
479: return $msgsent;
480: }
481:
482: # ==================================================== Send notification emails
483:
484: sub sendnotification {
485: my ($to,$touname,$toudom,$subj,$crit,$text,$msgid)=@_;
486: my $sender=$env{'environment.firstname'}.' '.$env{'environment.lastname'};
487: unless ($sender=~/\w/) {
488: $sender=$env{'user.name'}.':'.$env{'user.domain'};
489: }
490: my $critical=($crit?' critical':'');
491: my $numsent = 0;
492:
493: $text=~s/\<\;/\</gs;
494: $text=~s/\>\;/\>/gs;
495: my $homeserver = &Apache::lonnet::homeserver($touname,$toudom);
496: my $protocol = $Apache::lonnet::protocol{$homeserver};
497: $protocol = 'http' if ($protocol ne 'https');
498: my $url = $protocol.'://'.&Apache::lonnet::hostname($homeserver).
499: '/adm/email?username='.$touname.'&domain='.$toudom.
500: '&display='.&escape($msgid);
501: my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid,
502: $symb,$error) = &Apache::lonmsg::unpackmsgid($msgid);
503: my ($coursetext,$body,$bodybegin,$bodysubj,$bodyend);
504: my $user_lh = &Apache::loncommon::user_lang($touname,$toudom,$fromcid);
505: if ($fromcid ne '') {
506: $coursetext = "\n".&mt_user($user_lh,'Course').': ';
507: if ($env{'course.'.$fromcid.'.description'} ne '') {
508: $coursetext .= $env{'course.'.$fromcid.'.description'};
509: } else {
510: my %coursehash = &Apache::lonnet::coursedescription($fromcid,);
511: if ($coursehash{'description'} ne '') {
512: $coursetext .= $coursehash{'description'};
513: }
514: }
515: $coursetext .= "\n\n";
516: }
517: my @recipients = split(/,/,$to);
518: $bodybegin = $coursetext.
519: &mt_user($user_lh,
520: 'You received a'.$critical.' message from [_1] in LON-CAPA.',$sender).' ';
521: $bodysubj = &mt_user($user_lh,'The subject is
522:
523: [_1]
524:
525: ',$subj)."\n".
526: '=== '.&mt_user($user_lh,'Excerpt')." ============================================================
527: ";
528: $bodyend = "
529: ========================================================================
530:
531: ".&mt_user($user_lh,'Use
532:
533: [_1]
534:
535: to access the full message.',$url);
536: my %userenv = &Apache::lonnet::get('environment',['notifywithhtml'],$toudom,$touname);
537: my $subject = &mt_user($user_lh,"'New'$critical message from [_1]",$sender);
538: unless ($subj eq '') {
539: $subject = $subj;
540: }
541:
542: my ($blocked,$blocktext);
543: if (!$crit) {
544: my %setters;
545: my ($startblock,$endblock) =
546: &Apache::loncommon::blockcheck(\%setters,'com',$touname,$toudom);
547: if ($startblock && $endblock) {
548: $blocked = 1;
549: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
550: my $showend = &Apache::lonlocal::locallocaltime($endblock);
551: $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);
552: }
553: }
554: if ($userenv{'notifywithhtml'} ne '') {
555: my @htmlexcerpt = split(/,/,$userenv{'notifywithhtml'});
556: my $htmlfree = &make_htmlfree($text);
557: foreach my $addr (@recipients) {
558: if ($blocked) {
559: $body = $bodybegin."\n".$blocktext."\n".$bodyend;
560: } else {
561: my $sendtext;
562: if (!grep/^\Q$addr\E/,@htmlexcerpt) {
563: $sendtext = $htmlfree;
564: } else {
565: $sendtext = $text;
566: }
567: $body = $bodybegin.$bodysubj.$sendtext.$bodyend;
568: }
569: if (&sendemail($addr,$subject,$body,$touname,$toudom,$user_lh)) {
570: $numsent ++;
571: }
572: }
573: } else {
574: if ($blocked) {
575: $body = $bodybegin."\n".$blocktext."\n".$bodyend;
576: } else {
577: my $htmlfree = &make_htmlfree($text);
578: $body = $bodybegin.$bodysubj.$htmlfree.$bodyend;
579: }
580: if (&sendemail($to,$subject,$body,$touname,$toudom,$user_lh)) {
581: $numsent ++;
582: }
583: }
584: return $numsent;
585: }
586:
587: sub make_htmlfree {
588: my ($text) = @_;
589: $text =~ s/\<\/*[^\>]+\>//gs;
590: $text = &HTML::Entities::decode($text);
591: $text = &Encode::encode('utf8',$text);
592: return $text;
593: }
594:
595: sub mynewmail{
596: &newmail();
597: return $env{'user.mailcheck.lastnewmessagetime'} > $env{'user.mailcheck.lastvisit'};
598: }
599:
600:
601: sub newmail {
602: if ((time-$env{'user.mailcheck.time'})>300) {
603: my %what=&Apache::lonnet::get('email_status',['recnewemail']);
604: &Apache::lonnet::appenv({'user.mailcheck.time'=>time});
605: &Apache::lonnet::appenv({'user.mailcheck.lastnewmessagetime'=> $what{'recnewemail'}});
606: if ($what{'recnewemail'}>0) { return 1; }
607: }
608: return 0;
609: }
610:
611:
612:
613: sub author_res_msg {
614: my ($filename,$message)=@_;
615: unless ($message) { return 'empty'; }
616: $filename=&Apache::lonnet::declutter($filename);
617: my ($domain,$author,@dummy)=split(/\//,$filename);
618: my $homeserver=&Apache::lonnet::homeserver($author,$domain);
619: if ($homeserver ne 'no_host') {
620: my $id=unpack("%32C*",$message);
621: $message .= " <p>This error occurred on machine ".
622: $Apache::lonnet::perlvar{'lonHostID'}."</p>";
623: my $msgid;
624: ($msgid,$message)=&packagemsg($filename,$message);
625: return &Apache::lonnet::reply('put:'.$domain.':'.$author.
626: ':nohist_res_msgs:'.
627: &escape($filename.'_'.$id).'='.
628: &escape($message),$homeserver);
629: }
630: return 'no_host';
631: }
632:
633:
634:
635: sub retrieve_author_res_msg {
636: my $url=shift;
637: $url=&Apache::lonnet::declutter($url);
638: my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
639: my %errormsgs=&Apache::lonnet::dump('nohist_res_msgs',$domain,$author);
640: my $msgs='';
641: foreach my $msg (keys(%errormsgs)) {
642: if ($msg =~ /^\Q$url\E\_\d+$/) {
643: my %content=&unpackagemsg($errormsgs{$msg});
644: $msgs.='<p><img src="/adm/lonMisc/bomb.gif" /><b>'.
645: $content{'time'}.'</b>: '.$content{'message'}.
646: '<br /></p>';
647: }
648: }
649: return $msgs;
650: }
651:
652:
653:
654:
655:
656: sub del_url_author_res_msg {
657: my $url=shift;
658: $url=&Apache::lonnet::declutter($url);
659: my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
660: my @delmsgs=();
661: foreach my $msg (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
662: if ($msg =~ /^\Q$url\E\_\d+$/) {
663: push (@delmsgs,$msg);
664: }
665: }
666: return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
667: }
668:
669:
670: sub clear_author_res_msg {
671: my $url=shift;
672: $url=&Apache::lonnet::declutter($url);
673: my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
674: my @delmsgs=();
675: foreach my $msg (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
676: if ($msg =~ /^\Q$url\E/) {
677: push (@delmsgs,$msg);
678: }
679: }
680: return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
681: }
682:
683:
684:
685: sub all_url_author_res_msg {
686: my ($author,$domain)=@_;
687: my %returnhash=();
688: foreach my $msg (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
689: $msg =~ /^(.+)\_\d+/;
690: $returnhash{$1}=1;
691: }
692: return %returnhash;
693: }
694:
695:
696: sub store_instructor_comment {
697: my ($msg,$uname,$udom) = @_;
698: my $cid = $env{'request.course.id'};
699: my $cnum = $env{'course.'.$cid.'.num'};
700: my $cdom = $env{'course.'.$cid.'.domain'};
701: my $subject= &mt('Record').' ['.$uname.':'.$udom.']';
702: my $result = &user_normal_msg_raw($cnum,$cdom,$subject,$msg);
703: if ($result eq 'ok' || $result eq 'con_delayed') {
704:
705: }
706: return $result;
707: }
708:
709:
710: sub user_crit_msg_raw {
711: my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
712: $nosentstore,$recipid,$attachmenturl,$permresults)=@_;
713: # Check if allowed missing
714: my ($status,$packed_message);
715: my $msgid='undefined';
716: unless (($message)&&($user)&&($domain)) { $status='empty'; };
717: my $text=$message;
718: my $homeserver=&Apache::lonnet::homeserver($user,$domain);
719: if ($homeserver ne 'no_host') {
720: ($msgid,$packed_message)=&packagemsg($subject,$message,undef,undef,
721: $attachmenturl,undef,undef,undef,undef,undef,
722: undef,undef,$recipid);
723: if ($sendback) { $packed_message.='<sendback>true</sendback>'; }
724: $status=&Apache::lonnet::cput('critical', {$msgid => $packed_message},
725: $domain,$user);
726: if (defined($sentmessage)) {
727: $$sentmessage = $packed_message;
728: }
729: if (!$nosentstore) {
730: (undef,my $packed_message_no_citation) =
731: &packagemsg($subject,$message,undef,undef,$attachmenturl,$user,
732: $domain,$msgid);
733: if ($status eq 'ok' || $status eq 'con_delayed') {
734: &store_sent_mail($msgid,$packed_message_no_citation);
735: }
736: }
737: } else {
738: $status='no_host';
739: }
740:
741: # Notifications
742: my %userenv = &Apache::loncommon::getemails($user,$domain);
743: my $critnotify = $userenv{'critnotification'};
744: my $permemail = $userenv{'permanentemail'};
745: my $numcrit = 0;
746: my $numperm = 0;
747: my $permlogmsgstatus;
748: if ($critnotify) {
749: $numcrit = &sendnotification($critnotify,$user,$domain,$subject,1,$text,$msgid);
750: }
751: if ($toperm && $permemail) {
752: if ($critnotify && $numcrit) {
753: if (grep(/^\Q$permemail\E/,split(/,/,$critnotify))) {
754: $numperm = 1;
755: }
756: }
757: unless ($numperm) {
758: $numperm = &sendnotification($permemail,$user,$domain,$subject,1,$text,$msgid);
759: }
760: }
761: if ($toperm) {
762: $permlogmsgstatus = '. Perm. email log status '.
763: &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
764: "Perm. e-mail count $numperm for $user at $domain");
765: if (ref($permresults) eq 'HASH') {
766: $permresults->{"$user:$domain"} = $numperm;
767: }
768: }
769: # Log this
770: &Apache::lonnet::logthis(
771: 'Sending critical '.$msgid.
772: ', log status: '.
773: &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
774: $env{'user.home'},
775: 'Sending critical '.$msgid.' to '.$user.' at '.$domain.' with status '
776: .$status).$permlogmsgstatus);
777: return $status;
778: }
779:
780:
781:
782: sub user_crit_msg {
783: my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
784: $nosentstore,$recipid,$attachmenturl,$permresults)=@_;
785: my @status;
786: my %userenv = &Apache::lonnet::get('environment',['msgforward'],
787: $domain,$user);
788: my $msgforward=$userenv{'msgforward'};
789: if ($msgforward) {
790: foreach my $addr (split(/\,/,$msgforward)) {
791: my ($forwuser,$forwdomain)=split(/\:/,$addr);
792: push(@status,
793: &user_crit_msg_raw($forwuser,$forwdomain,$subject,$message,
794: $sendback,$toperm,$sentmessage,$nosentstore,
795: $recipid,$attachmenturl,$permresults));
796: }
797: } else {
798: push(@status,
799: &user_crit_msg_raw($user,$domain,$subject,$message,$sendback,
800: $toperm,$sentmessage,$nosentstore,$recipid,
801: $attachmenturl,$permresults));
802: }
803: if (wantarray) {
804: return @status;
805: }
806: return join(' ',@status);
807: }
808:
809:
810: sub user_crit_received {
811: my $msgid=shift;
812: my %message=&Apache::lonnet::get('critical',[$msgid]);
813: my %contents=&unpackagemsg($message{$msgid},1);
814: my $destname = $contents{'sendername'};
815: my $destdom = $contents{'senderdomain'};
816: if ($contents{'replytoaddr'}) {
817: my ($repname,$repdom) = split(/:/,$contents{'replytoaddr'});
818: if (&Apache::lonnet::homeserver($repname,$repdom) ne 'no_host') {
819: $destname = $repname;
820: $destdom = $repdom;
821: }
822: }
823: my $status='rec: '.($contents{'sendback'}?
824: &user_normal_msg($destname,$destdom,&mt('Receipt').': '.$env{'user.name'}.
825: ' '.&mt('at').' '.$env{'user.domain'}.', '.
826: $contents{'subject'},&mt('User').' '.$env{'user.name'}.
827: ' '.&mt('at').' '.$env{'user.domain'}.
828: ' acknowledged receipt of message'."\n".' "'.
829: $contents{'subject'}.'"'."\n".&mt('dated').' '.
830: $contents{'time'}.".\n"
831: ):'no msg req');
832: $status.=' trans: '.
833: &Apache::lonnet::put(
834: 'nohist_email',{$contents{'msgid'} => $message{$msgid}});
835: $status.=' del: '.
836: &Apache::lonnet::del('critical',[$contents{'msgid'}]);
837: &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
838: $env{'user.home'},'Received critical message '.
839: $contents{'msgid'}.
840: ', '.$status);
841: return $status;
842: }
843:
844:
845:
846:
847: sub user_normal_msg_raw {
848: my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
849: $toperm,$currid,$newid,$sentmessage,$crsmsgid,$symb,$restitle,
850: $error,$nosentstore,$recipid,$permresults)=@_;
851: # Check if allowed missing
852: my ($status,$packed_message);
853: my $msgid='undefined';
854: my $text=$message;
855: unless (($message)&&($user)&&($domain)) { $status='empty'; };
856: my $homeserver=&Apache::lonnet::homeserver($user,$domain);
857: if ($homeserver ne 'no_host') {
858: ($msgid,$packed_message)=
859: &packagemsg($subject,$message,$citation,$baseurl,
860: $attachmenturl,$user,$domain,$currid,
861: undef,$crsmsgid,$symb,$error,$recipid);
862:
863: # Store in user folder
864: $status=
865: &Apache::lonnet::cput('nohist_email',{$msgid => $packed_message},
866: $domain,$user);
867: # Save new message received time
868: &Apache::lonnet::put
869: ('email_status',{'recnewemail'=>time},$domain,$user);
870: # Into sent-mail folder if sent mail storage required
871: if (!$nosentstore) {
872: (undef,my $packed_message_no_citation) =
873: &packagemsg($subject,$message,undef,$baseurl,$attachmenturl,
874: $user,$domain,$currid,undef,$crsmsgid,$symb,$error);
875: if ($status eq 'ok' || $status eq 'con_delayed') {
876: &store_sent_mail($msgid,$packed_message_no_citation);
877: }
878: }
879: if (ref($newid) eq 'SCALAR') {
880: $$newid = $msgid;
881: }
882: if (ref($sentmessage) eq 'SCALAR') {
883: $$sentmessage = $packed_message;
884: }
885: # Notifications
886: my %userenv = &Apache::loncommon::getemails($user,$domain);
887: my $notify = $userenv{'notification'};
888: my $permemail = $userenv{'permanentemail'};
889: my $numnotify = 0;
890: my $numperm = 0;
891: my $permlogmsgstatus;
892: if ($notify) {
893: $numnotify = &sendnotification($notify,$user,$domain,$subject,0,$text,$msgid);
894: }
895: if ($toperm && $permemail) {
896: if ($notify && $numnotify) {
897: if (grep(/^\Q$permemail\E/,split(/,/,$notify))) {
898: $numperm = 1;
899: }
900: }
901: unless ($numperm) {
902: $numperm = &sendnotification($permemail,$user,$domain,$subject,0,
903: $text,$msgid);
904: }
905: }
906: if ($toperm) {
907: $permlogmsgstatus = '. Perm. email log status '.
908: &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
909: "Perm. e-mail count $numperm for $user at $domain");
910: if (ref($permresults) eq 'HASH') {
911: $permresults->{"$user:$domain"} = $numperm;
912: }
913: }
914: &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
915: $env{'user.home'},
916: 'Sending '.$msgid.' to '.$user.' at '.$domain.' with status '.$status.
917: $permlogmsgstatus);
918: } else {
919: $status='no_host';
920: }
921: return $status;
922: }
923:
924: sub user_normal_msg {
925: my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
926: $toperm,$sentmessage,$symb,$restitle,$error,$nosentstore,$recipid,
927: $permresults)=@_;
928: my @status;
929: my %userenv = &Apache::lonnet::get('environment',['msgforward'],
930: $domain,$user);
931: my $msgforward=$userenv{'msgforward'};
932: if ($msgforward) {
933: foreach my $fwd (split(/\,/,$msgforward)) {
934: my ($forwuser,$forwdomain)=split(/\:/,$fwd);
935: push(@status,
936: &user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,
937: $citation,$baseurl,$attachmenturl,$toperm,
938: undef,undef,$sentmessage,undef,$symb,
939: $restitle,$error,$nosentstore,$recipid,$permresults));
940: }
941: } else {
942: push(@status,&user_normal_msg_raw($user,$domain,$subject,$message,
943: $citation,$baseurl,$attachmenturl,$toperm,
944: undef,undef,$sentmessage,undef,$symb,
945: $restitle,$error,$nosentstore,$recipid,$permresults));
946: }
947: if (wantarray) {
948: return @status;
949: }
950: return join(' ',@status);
951: }
952:
953: sub process_sent_mail {
954: my ($msgsubj,$subj_prefix,$numsent,$stamp,$msgname,$msgdom,$msgcount,
955: $context,$pid,$savemsg,$recusers,$recudoms,$baseurl,$attachmenturl,
956: $symb,$error,$senderuname,$senderdom,$recipid) = @_;
957: my $sentsubj;
958: if ($numsent > 1) {
959: $sentsubj = $subj_prefix.' ('.$numsent.' sent) '.$msgsubj;
960: } else {
961: if ($subj_prefix) {
962: $sentsubj = $subj_prefix.' ';
963: }
964: $sentsubj .= $msgsubj;
965: }
966: $sentsubj = &HTML::Entities::encode($sentsubj,'<>&"');
967: my $sentmsgid =
968: &buildmsgid($stamp,$sentsubj,$msgname,$msgdom,$msgcount,$context,$pid);
969: (undef,my $sentmessage) =
970: &packagemsg($msgsubj,$savemsg,undef,$baseurl,$attachmenturl,$recusers,
971: $recudoms,$sentmsgid,undef,undef,$symb,$error,$recipid);
972: my $status = &store_sent_mail($sentmsgid,$sentmessage,$senderuname,
973: $senderdom);
974: return $status;
975: }
976:
977: sub store_sent_mail {
978: my ($msgid,$message,$senderuname,$senderdom) = @_;
979: if ($senderuname eq '') {
980: $senderuname = $env{'user.name'};
981: }
982: if ($senderdom eq '') {
983: $senderdom = $env{'user.domain'};
984: }
985: my $status =' '.&Apache::lonnet::cput('nohist_email_sent',
986: {$msgid => $message},
987: $senderdom,$senderuname);
988: return $status;
989: }
990:
991: sub store_recipients {
992: my ($subject,$sendername,$senderdom,$reciphash) = @_;
993: my $context = &get_course_context();
994: my $now = time();
995: my $msgcount = &get_uniq();
996: my $recipid =
997: &buildmsgid($now,$subject,$sendername,$senderdom,$msgcount,$context,$$);
998: my %recipinfo = (
999: $recipid => $reciphash,
1000: );
1001: my $status = &Apache::lonnet::put('nohist_emailrecip',\%recipinfo,
1002: $senderdom,$sendername);
1003: if ($status eq 'ok') {
1004: return ($recipid,$status);
1005: } else {
1006: return (undef,$status);
1007: }
1008: }
1009:
1010:
1011: sub foldersuffix {
1012: my $folder=shift;
1013: unless ($folder) { return ''; }
1014: my $suffix;
1015: my %folderhash = &get_user_folders($folder);
1016: if (ref($folderhash{$folder}) eq 'HASH') {
1017: $suffix = '_'.&escape($folderhash{$folder}{'id'});
1018: } else {
1019: $suffix = '_'.&escape($folder);
1020: }
1021: return $suffix;
1022: }
1023:
1024:
1025: sub get_user_folders {
1026: my ($folder) = @_;
1027: my %userfolders =
1028: &Apache::lonnet::dump('email_folders',undef,undef,$folder);
1029: my $lock = "\0".'lock_counter'; # locks db while counter incremented
1030: my $counter = "\0".'idcount'; # used in suffix for email db files
1031: if (defined($userfolders{$lock})) {
1032: delete($userfolders{$lock});
1033: }
1034: if (defined($userfolders{$counter})) {
1035: delete($userfolders{$counter});
1036: }
1037: return %userfolders;
1038: }
1039:
1040: sub secapply {
1041: my $rec=shift;
1042: my $defaultflag=shift;
1043: $rec=~s/\s+//g;
1044: unless ($rec =~ /\:/) {
1045: $rec=~s/\@/\:/g;
1046: }
1047: my ($adr,$sections_or_groups)=($rec=~/^([^\(]+)\(([^\)]+)\)/);
1048: if ($sections_or_groups) {
1049: foreach my $item (split(/\;/,$sections_or_groups)) {
1050: if (($item eq $env{'request.course.sec'}) ||
1051: ($defaultflag && ($item eq '*'))) {
1052: return $adr;
1053: } elsif ($env{'request.course.groups'}) {
1054: my @usersgroups = split(/:/,$env{'request.course.groups'});
1055: if (grep(/^\Q$item\E$/,@usersgroups)) {
1056: return $adr;
1057: }
1058: }
1059: }
1060: } else {
1061: return $rec;
1062: }
1063: return '';
1064: }
1065:
1066: sub decide_receiver {
1067: my ($feedurl,$author,$question,$course,$policy,$defaultflag) = @_;
1068: &Apache::lonenc::check_decrypt(\$feedurl);
1069: my $typestyle='';
1070: my %to=();
1071: if ($env{'form.discuss'} eq 'author' ||$author) {
1072: $typestyle.='Submitting as Author Feedback<br />';
1073: $feedurl=~ m{^/res/($LONCAPA::domain_re)/($LONCAPA::username_re)/};
1074: $to{$2.':'.$1}=1;
1075: }
1076: my $cid = $env{'request.course.id'};
1077: if ($env{'form.discuss'} eq 'question' ||$question) {
1078: $typestyle.=&mt('Submitting as Question').'<br />';
1079: foreach my $item (split(/\,/,$env{'course.'.$cid.'.question.email'})) {
1080: my $rec=&secapply($item,$defaultflag);
1081: if ($rec) { $to{$rec}=1; }
1082: }
1083: }
1084: if ($env{'form.discuss'} eq 'course' ||$course) {
1085: $typestyle.=&mt('Submitting as Comment').'<br />';
1086: foreach my $item (split(/\,/,$env{'course.'.$cid.'.comment.email'})) {
1087: my $rec=&secapply($item,$defaultflag);
1088: if ($rec) { $to{$rec}=1; }
1089: }
1090: }
1091: if ($env{'form.discuss'} eq 'policy' ||$policy) {
1092: $typestyle.=&mt('Submitting as Policy Feedback').'<br />';
1093: foreach my $item (split(/\,/,$env{'course.'.$cid.'.policy.email'})) {
1094: my $rec=&secapply($item,$defaultflag);
1095: if ($rec) { $to{$rec}=1; }
1096: }
1097: }
1098: if ((scalar(%to) eq '0') && (!$defaultflag)) {
1099: ($typestyle,%to)=
1100: &decide_receiver($feedurl,$author,$question,$course,$policy,1);
1101: }
1102: return ($typestyle,%to);
1103: }
1104:
1105: 1;
1106: __END__
1107:
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