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