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