Annotation of loncom/interface/lonmsg.pm, revision 1.15
1.1 www 1: # The LearningOnline Network with CAPA
2: #
3: # Routines for messaging
4: #
5: # (Routines to control the menu
6: #
7: # (TeX Conversion Module
8: #
9: # 05/29/00,05/30 Gerd Kortemeyer)
10: #
11: # 10/05 Gerd Kortemeyer)
12: #
1.6 www 13: # 10/19,10/20,10/30,
14: # 02/06/01 Gerd Kortemeyer
1.11 www 15: # 07/27 Guy Albertelli
1.12 www 16: # 07/27,07/28,07/30,08/03 Gerd Kortemeyer
1.1 www 17:
18: package Apache::lonmsg;
19:
20: use strict;
21: use Apache::lonnet();
1.2 www 22: use vars qw($msgcount);
23: use HTML::TokeParser;
1.5 www 24: use Apache::Constants qw(:common);
1.1 www 25:
26: # ===================================================================== Package
27:
1.3 www 28: sub packagemsg {
1.7 www 29: my ($subject,$message,$citation)=@_;
1.1 www 30: $message=~s/\</\<\;/g;
31: $message=~s/\>/\>\;/g;
1.7 www 32: $citation=~s/\</\<\;/g;
33: $citation=~s/\>/\>\;/g;
1.1 www 34: $subject=~s/\</\<\;/g;
35: $subject=~s/\>/\>\;/g;
1.2 www 36: my $now=time;
37: $msgcount++;
1.6 www 38: my $partsubj=$subject;
39: $partsubj=&Apache::lonnet::escape($partsubj);
40: $partsubj=substr($partsubj,0,50);
41: my $msgid=&Apache::lonnet::escape(
42: $now.':'.$partsubj.':'.$ENV{'user.name'}.':'.
43: $ENV{'user.domain'}.':'.$msgcount.':'.$$);
1.2 www 44: return $msgid,
45: '<sendername>'.$ENV{'user.name'}.'</sendername>'.
1.1 www 46: '<senderdomain>'.$ENV{'user.domain'}.'</senderdomain>'.
47: '<subject>'.$subject.'</subject>'.
1.2 www 48: '<time>'.localtime($now).'</time>'.
1.1 www 49: '<servername>'.$ENV{'SERVER_NAME'}.'</servername>'.
50: '<host>'.$ENV{'HTTP_HOST'}.'</host>'.
51: '<client>'.$ENV{'REMOTE_ADDR'}.'</client>'.
52: '<browsertype>'.$ENV{'browser.type'}.'</browsertype>'.
53: '<browseros>'.$ENV{'browser.os'}.'</browseros>'.
54: '<browserversion>'.$ENV{'browser.version'}.'</browserversion>'.
55: '<browsermathml>'.$ENV{'browser.mathml'}.'</browsermathml>'.
56: '<browserraw>'.$ENV{'HTTP_USER_AGENT'}.'</browserraw>'.
57: '<courseid>'.$ENV{'request.course.id'}.'</courseid>'.
58: '<role>'.$ENV{'request.role'}.'</role>'.
59: '<resource>'.$ENV{'request.filename'}.'</resource>'.
1.2 www 60: '<msgid>'.$msgid.'</msgid>'.
1.7 www 61: '<message>'.$message.'</message>'.
62: '<citation>'.$citation.'</citation>';
1.1 www 63: }
64:
1.2 www 65: # ================================================== Unpack message into a hash
66:
1.3 www 67: sub unpackagemsg {
1.2 www 68: my $message=shift;
69: my %content=();
70: my $parser=HTML::TokeParser->new(\$message);
71: my $token;
72: while ($token=$parser->get_token) {
73: if ($token->[0] eq 'S') {
74: my $entry=$token->[1];
75: my $value=$parser->get_text('/'.$entry);
76: $content{$entry}=$value;
77: }
78: }
79: return %content;
80: }
81:
1.6 www 82: # ======================================================= Get info out of msgid
83:
84: sub unpackmsgid {
1.7 www 85: my $msgid=&Apache::lonnet::unescape(shift);
1.6 www 86: my ($sendtime,$shortsubj,$fromname,$fromdomain)=split(/\:/,
1.7 www 87: &Apache::lonnet::unescape($msgid));
1.8 albertel 88: my %status=&Apache::lonnet::get('email_status',[$msgid]);
1.6 www 89: if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; }
90: unless ($status{$msgid}) { $status{$msgid}='new'; }
91: return ($sendtime,$shortsubj,$fromname,$fromdomain,$status{$msgid});
92: }
93:
1.1 www 94: # =============================== Automated message to the author of a resource
95:
96: sub author_res_msg {
97: my ($filename,$message)=@_;
1.2 www 98: unless ($message) { return 'empty'; }
1.1 www 99: $filename=&Apache::lonnet::declutter($filename);
100: my ($domain,$author,@dummy)=split(/\//,$filename);
101: my $homeserver=&Apache::lonnet::homeserver($author,$domain);
102: if ($homeserver ne 'no_host') {
103: my $id=unpack("%32C*",$message);
1.2 www 104: my $msgid;
1.3 www 105: ($msgid,$message)=&packagemsg($filename,$message);
106: return &Apache::lonnet::reply('put:'.$domain.':'.$author.
107: ':nohist_res_msgs:'.
108: &Apache::lonnet::escape($filename.'_'.$id).'='.
109: &Apache::lonnet::escape($message),$homeserver);
1.1 www 110: }
1.2 www 111: return 'no_host';
1.1 www 112: }
113:
114: # ================================================== Critical message to a user
115:
116: sub user_crit_msg {
117: my ($user,$domain,$subject,$message)=@_;
1.2 www 118: # Check if allowed missing
119: my $status='';
120: my $msgid='undefined';
121: unless (($message)&&($user)&&($domain)) { $status='empty'; };
122: my $homeserver=&Apache::lonnet::homeserver($user,$domain);
123: if ($homeserver ne 'no_host') {
124: my $msgid;
1.3 www 125: ($msgid,$message)=&packagemsg($subject,$message);
1.4 www 126: $status=&Apache::lonnet::critical(
127: 'put:'.$domain.':'.$user.':critical:'.
128: &Apache::lonnet::escape($msgid).'='.
129: &Apache::lonnet::escape($message),$homeserver);
1.2 www 130: } else {
131: $status='no_host';
132: }
133: &Apache::lonnet::logthis(
1.4 www 134: 'Sending critical email '.$msgid.
1.2 www 135: ', log status: '.
136: &Apache::lonnet::log($ENV{'user.domain'},$ENV{'user.name'},
137: $ENV{'user.home'},
138: 'Sending critical '.$msgid.' to '.$user.' at '.$domain.' with status: '
1.4 www 139: .$status));
1.2 www 140: return $status;
141: }
142:
143: # =================================================== Critical message received
144:
145: sub user_crit_received {
1.12 www 146: my $msgid=shift;
147: my %message=&Apache::lonnet::get('critical',[$msgid]);
148: my %contents=&unpackagemsg($message{$msgid});
1.5 www 149: my $status='rec: '.
150: &user_normal_msg($contents{'sendername'},$contents{'senderdomain'},
1.4 www 151: 'Receipt: '.$ENV{'user.name'}.' at '.$ENV{'user.domain'},
152: 'User '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
153: ' acknowledged receipt of message "'.
154: $contents{'subject'}.'" dated '.$contents{'time'}.".\n\n"
155: .'Message ID: '.$contents{'msgid'});
1.5 www 156: $status.=' trans: '.
1.12 www 157: &Apache::lonnet::put(
158: 'nohist_email',{$contents{'msgid'} => $message{$msgid}});
1.5 www 159: $status.=' del: '.
1.9 albertel 160: &Apache::lonnet::del('critical',[$contents{'msgid'}]);
1.5 www 161: &Apache::lonnet::log($ENV{'user.domain'},$ENV{'user.name'},
162: $ENV{'user.home'},'Received critical message '.
163: $contents{'msgid'}.
164: ', '.$status);
1.12 www 165: return $status;
1.2 www 166: }
167:
168: # ======================================================== Normal communication
169:
170: sub user_normal_msg {
1.7 www 171: my ($user,$domain,$subject,$message,$citation)=@_;
1.2 www 172: # Check if allowed missing
173: my $status='';
174: my $msgid='undefined';
175: unless (($message)&&($user)&&($domain)) { $status='empty'; };
176: my $homeserver=&Apache::lonnet::homeserver($user,$domain);
177: if ($homeserver ne 'no_host') {
178: my $msgid;
1.7 www 179: ($msgid,$message)=&packagemsg($subject,$message,$citation);
1.4 www 180: $status=&Apache::lonnet::critical(
181: 'put:'.$domain.':'.$user.':nohist_email:'.
182: &Apache::lonnet::escape($msgid).'='.
183: &Apache::lonnet::escape($message),$homeserver);
1.2 www 184: } else {
185: $status='no_host';
186: }
187: &Apache::lonnet::log($ENV{'user.domain'},$ENV{'user.name'},
188: $ENV{'user.home'},
189: 'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status);
190: return $status;
191: }
192:
1.7 www 193: # =============================================================== Status Change
194:
195: sub statuschange {
196: my ($msgid,$newstatus)=@_;
1.8 albertel 197: my %status=&Apache::lonnet::get('email_status',[$msgid]);
1.7 www 198: if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; }
199: unless ($status{$msgid}) { $status{$msgid}='new'; }
200: unless (($status{$msgid} eq 'replied') ||
201: ($status{$msgid} eq 'forwarded')) {
1.10 albertel 202: &Apache::lonnet::put('email_status',{$msgid => $newstatus});
1.7 www 203: }
1.14 www 204: if (($newstatus eq 'deleted') || ($newstatus eq 'new')) {
205: &Apache::lonnet::put('email_status',{$msgid => $newstatus});
206: }
1.7 www 207: }
1.14 www 208:
1.13 www 209: # ==================================================== Display Critical Message
1.5 www 210:
1.12 www 211: sub discrit {
212: my $r=shift;
213: $r->print('<h1><font color=red>Critical Messages</font></h1>'.
214: '<form action=/adm/email method=post>'.
215: '<input type=hidden name=confirm value=true>');
216: my %what=&Apache::lonnet::dump('critical');
217: map {
218: my %content=&unpackagemsg($what{$_});
219: $content{'message'}=~s/\n/\<br\>/g;
220: $r->print('<hr>From: <b>'.$content{'sendername'}.'@'.
221: $content{'senderdomain'}.'</b> ('.$content{'time'}.
222: ')<br><blockquote>'.$content{'message'}.'</blockquote>'.
1.13 www 223: '<input type=submit name="rec_'.$_.'" value="Confirm Receipt">'.
224: '<input type=submit name="reprec_'.$_.'" value="Confirm Receipt and Reply">');
1.12 www 225: } sort keys %what;
226: $r->print('</form>');
227: }
228:
1.13 www 229: # =============================================================== Compose reply
230:
231: sub comprep {
232: my ($r,$msgid)=@_;
233: my %message=&Apache::lonnet::get('nohist_email',[$msgid]);
234: my %content=&unpackagemsg($message{$msgid});
235: my $quotemsg='> '.$content{'message'};
236: $quotemsg=~s/\r/\n/g;
237: $quotemsg=~s/\f/\n/g;
238: $quotemsg=~s/\n+/\n\> /g;
239: my $subject='Re: '.$content{'subject'};
240: my $dispcrit='';
241: if (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
242: $dispcrit=
243: '<input type=checkbox name=critmsg> Send as critical message<p>';
244: }
245: $r->print(<<"ENDREPLY");
246: <form action="/adm/email" method=post>
247: <input type=hidden name=sendreply value="$msgid">
248: Subject: <input type=text size=50 name=subject value="$subject"><p>
249: <textarea name=message cols=60 rows=10>
250: $quotemsg
251: </textarea><p>
252: $dispcrit
253: <input type=submit value="Send Reply">
254: </form>
255: ENDREPLY
256: }
257:
1.15 ! www 258: # ======================================================== Display all messages
! 259:
1.14 www 260: sub disall {
261: my $r=shift;
262: $r->print('<h1>Display All Messages</h1>'.
263: '<table border=2><tr><th colspan=2> </th><th>Date</th>'.
264: '<th>Username</th><th>Domain</th><th>Subject</th><th>Status</th></tr>');
265: map {
266: my ($sendtime,$shortsubj,$fromname,$fromdomain,$status)=
267: &Apache::lonmsg::unpackmsgid($_);
268: unless ($status eq 'deleted') {
269: if ($status eq 'new') {
270: $r->print('<tr bgcolor="#FFBB77">');
271: } elsif ($status eq 'read') {
272: $r->print('<tr bgcolor="#BBBB77">');
273: } elsif ($status eq 'replied') {
274: $r->print('<tr bgcolor="#AAAA88">');
275: } else {
276: $r->print('<tr bgcolor="#99BBBB">');
277: }
278: $r->print('<td><a href="/adm/email?display='.$_.
279: '">Open</a></td><td><a href="/adm/email?markdel='.$_.
280: '">Delete</a></td><td>'.localtime($sendtime).'</td><td>'.
281: $fromname.'</td><td>'.$fromdomain.'</td><td>'.
282: &Apache::lonnet::unescape($shortsubj).'</td><td>'.
283: $status.'</td></tr>');
284: }
285: } sort split(/\&/,&Apache::lonnet::reply('keys:'.
286: $ENV{'user.domain'}.':'.
287: $ENV{'user.name'}.':nohist_email',
288: $ENV{'user.home'}));
289: $r->print('</table></body></html>');
290: }
291:
1.15 ! www 292: # ============================================================== Compose output
! 293:
! 294: sub compout {
! 295: my ($r,$forwarding)=@_;
! 296: my $dispcrit='';
! 297: my $dissub='';
! 298: my $dismsg='';
! 299: my $func='Send New';
! 300: if (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
! 301: $dispcrit=
! 302: '<input type=checkbox name=critmsg> Send as critical message<p>';
! 303: }
! 304: if ($forwarding) {
! 305: $dispcrit.='<input type=hidden name=forwid value="'.
! 306: $forwarding.'">';
! 307: $func='Forward';
! 308: my %message=&Apache::lonnet::get('nohist_email',[$forwarding]);
! 309: my %content=&unpackagemsg($message{$forwarding});
! 310:
! 311: $dissub='Forwarding: '.$content{'subject'};
! 312: $dismsg='Forwarded message from '.
! 313: $content{'sendername'}.' at '.$content{'senderdomain'};
! 314: }
! 315: my $defdom=$ENV{'user.domain'};
! 316: $r->print(<<"ENDCOMP");
! 317: <form action="/adm/email" method=post>
! 318: <input type=hidden name=sendmail value=on>
! 319: <table>
! 320: <tr><td>Username:</td><td><input type=text size=12 name=recuname></td></tr>
! 321: <tr><td>Domain:</td>
! 322: <td><input type=text size=12 name=recdomain value="$defdom"></td></tr>
! 323: <tr><td>Subject:</td><td><input type=text size=50 name=subject value="$dissub">
! 324: </td></tr></table>
! 325: <textarea name=message cols=60 rows=10>$dismsg
! 326: </textarea><p>
! 327: $dispcrit
! 328: <input type=submit value="$func Mail">
! 329: </form>
! 330: ENDCOMP
! 331: }
! 332:
1.13 www 333: # ===================================================================== Handler
334:
1.5 www 335: sub handler {
336: my $r=shift;
337:
338: # ----------------------------------------------------------- Set document type
339:
340: $r->content_type('text/html');
341: $r->send_http_header;
342:
343: return OK if $r->header_only;
344:
1.6 www 345: # --------------------------- Get query string for limited number of parameters
346:
347: map {
348: my ($name, $value) = split(/=/,$_);
349: $value =~ tr/+/ /;
350: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
351: if (($name eq 'display') || ($name eq 'replyto') ||
1.14 www 352: ($name eq 'forward') || ($name eq 'markread') ||
353: ($name eq 'markdel') || ($name eq 'markunread') ||
1.12 www 354: ($name eq 'sendreply') || ($name eq 'compose') ||
355: ($name eq 'sendmail') || ($name eq 'critical')) {
1.6 www 356: unless ($ENV{'form.'.$name}) {
357: $ENV{'form.'.$name}=$value;
358: }
359: }
360: } (split(/&/,$ENV{'QUERY_STRING'}));
361:
1.5 www 362: # --------------------------------------------------------------- Render Output
363:
364: $r->print('<html><head><title>EMail and Messaging</title></head>');
1.7 www 365: $r->print(
366: '<body bgcolor="#FFFFFF"><img align=right src=/adm/lonIcons/lonlogos.gif>');
1.5 www 367: $r->print('<h1>EMail</h1>');
1.6 www 368: if ($ENV{'form.display'}) {
1.7 www 369: my $msgid=$ENV{'form.display'};
370: &statuschange($msgid,'read');
1.8 albertel 371: my %message=&Apache::lonnet::get('nohist_email',[$msgid]);
1.7 www 372: my %content=&unpackagemsg($message{$msgid});
373: $r->print('<b>Subject:</b> '.$content{'subject'}.
374: '<br><b>From:</b> '.$content{'sendername'}.' at '.
375: $content{'senderdomain'}.
1.14 www 376: '<br><b>Time:</b> '.$content{'time'}.'<p>'.
377: '<table border=2><tr bgcolor="#FFFFAA"><td>Functions:</td>'.
378: '<td><a href="/adm/email?replyto='.&Apache::lonnet::escape($msgid).
379: '"><b>Reply</b></a></td>'.
1.15 ! www 380: '<td><a href="/adm/email?forward='.&Apache::lonnet::escape($msgid).
1.14 www 381: '"><b>Forward</b></a></td>'.
1.15 ! www 382: '<td><a href="/adm/email?markunread='.&Apache::lonnet::escape($msgid).
! 383: '"><b>Mark Unread</b></a></td>'.
! 384: '<td><a href="/adm/email"><b>Display all Messages</b></a></td>'.
1.14 www 385: '</tr></table><p><pre>'.
1.7 www 386: $content{'message'}.'</pre><hr>'.$content{'citation'});
1.6 www 387: } elsif ($ENV{'form.replyto'}) {
1.13 www 388: &comprep($r,$ENV{'form.replyto'});
1.7 www 389: } elsif ($ENV{'form.sendreply'}) {
390: my $msgid=$ENV{'form.sendreply'};
1.8 albertel 391: my %message=&Apache::lonnet::get('nohist_email',[$msgid]);
1.7 www 392: my %content=&unpackagemsg($message{$msgid});
393: &statuschange($msgid,'replied');
1.12 www 394: if (($ENV{'form.critmsg'}) &&
395: (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'}))) {
396: $r->print('Sending critical: '.
397: &user_crit_msg($content{'sendername'},
1.7 www 398: $content{'senderdomain'},
399: $ENV{'form.subject'},
400: $ENV{'form.message'}));
1.12 www 401: } else {
402: $r->print('Sending: '.&user_normal_msg($content{'sendername'},
403: $content{'senderdomain'},
404: $ENV{'form.subject'},
405: $ENV{'form.message'}));
406: }
1.14 www 407: if ($ENV{'form.displayedcrit'}) {
408: &discrit($r);
409: } else {
410: &disall($r);
411: }
1.12 www 412: } elsif ($ENV{'form.confirm'}) {
413: map {
414: if ($_=~/^form\.rec\_(.*)$/) {
415: $r->print('<b>Confirming Receipt:</b> '.
416: &user_crit_received($1).'<br>');
1.13 www 417: }
418: if ($_=~/^form\.reprec\_(.*)$/) {
419: my $msgid=$1;
420: $r->print('<b>Confirming Receipt:</b> '.
421: &user_crit_received($msgid).'<br>');
422: &comprep($r,$msgid);
1.12 www 423: }
424: } keys %ENV;
425: &discrit($r);
426: } elsif ($ENV{'form.critical'}) {
427: &discrit($r);
1.6 www 428: } elsif ($ENV{'form.forward'}) {
1.15 ! www 429: &compout($r,$ENV{'form.forward'});
1.14 www 430: } elsif ($ENV{'form.markread'}) {
431: } elsif ($ENV{'form.markdel'}) {
432: &statuschange($ENV{'form.markdel'},'deleted');
433: &disall($r);
434: } elsif ($ENV{'form.markunread'}) {
1.15 ! www 435: &statuschange($ENV{'form.markunread'},'new');
! 436: &disall($r);
1.11 www 437: } elsif ($ENV{'form.compose'}) {
1.15 ! www 438: &compout($r);
1.11 www 439: } elsif ($ENV{'form.sendmail'}) {
1.6 www 440: } else {
1.14 www 441: &disall($r);
1.6 www 442: }
1.5 www 443: $r->print('</body></html>');
444: return OK;
445:
446: }
1.2 www 447: # ================================================= Main program, reset counter
448:
449: sub BEGIN {
450: $msgcount=0;
1.1 www 451: }
452:
453: 1;
454: __END__
455:
456:
457:
458:
459:
460:
461:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>