--- loncom/interface/lonmsg.pm 2005/02/17 04:39:58 1.137
+++ loncom/interface/lonmsg.pm 2005/12/10 00:46:34 1.164
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Routines for messaging
#
-# $Id: lonmsg.pm,v 1.137 2005/02/17 04:39:58 albertel Exp $
+# $Id: lonmsg.pm,v 1.164 2005/12/10 00:46:34 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -97,6 +97,17 @@ Right now, this document will cover just
it is likely you will not need to programmatically read messages,
since lonmsg already implements that functionality.
+The routines used to package messages and unpackage messages are not
+only used by lonmsg when creating/extracting messages for LON-CAPA's
+internal messaging system, but also by lonnotify.pm which is available
+for use by Domain Coordinators to broadcast standard e-mail to specified
+users in their domain. The XML packaging used in the two cases is very
+similar. The differences are the use of $uname and
+$udom in stored internal messages, compared
+with $email in stored
+Domain Coordinator e-mail for the storage of information about
+recipients of the message/e-mail.
+
=head1 FUNCTIONS
=over 4
@@ -104,7 +115,7 @@ since lonmsg already implements that fun
=cut
use strict;
-use Apache::lonnet();
+use Apache::lonnet;
use vars qw($msgcount);
use HTML::TokeParser();
use Apache::Constants qw(:common);
@@ -114,6 +125,8 @@ use HTML::Entities();
use Mail::Send;
use Apache::lonlocal;
use Apache::loncommunicate;
+use Apache::lonfeedback;
+use Apache::lonrss();
# Querystring component with sorting type
my $sqs;
@@ -124,7 +137,7 @@ my $interdis;
sub packagemsg {
my ($subject,$message,$citation,$baseurl,$attachmenturl,
- $recuser,$recdomain)=@_;
+ $recuser,$recdomain,$msgid,$type)=@_;
$message =&HTML::Entities::encode($message,'<>&"');
$citation=&HTML::Entities::encode($citation,'<>&"');
$subject =&HTML::Entities::encode($subject,'<>&"');
@@ -134,34 +147,66 @@ sub packagemsg {
#remove machine specification
$attachmenturl =~ s|^http://[^/]+/|/|;
$attachmenturl =&HTML::Entities::encode($attachmenturl,'<>&"');
-
+ my $course_context;
+ if (defined($env{'form.replyid'})) {
+ my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid)=
+ split(/\:/,&Apache::lonnet::unescape($env{'form.replyid'}));
+ $course_context = $origcid;
+ }
+ foreach my $key (keys(%env)) {
+ if ($key=~/^form\.(rep)?rec\_(.*)$/) {
+ my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid) =
+ split(/\:/,&Apache::lonnet::unescape($2));
+ $course_context = $origcid;
+ last;
+ }
+ }
+ unless(defined($course_context)) {
+ $course_context = $env{'request.course.id'};
+ }
my $now=time;
$msgcount++;
- my $partsubj=$subject;
- $partsubj=&Apache::lonnet::escape($partsubj);
- my $msgid=&Apache::lonnet::escape(
- $now.':'.$partsubj.':'.$ENV{'user.name'}.':'.
- $ENV{'user.domain'}.':'.$msgcount.':'.$$);
- my $result=''.$ENV{'user.name'}.''.
- ''.$ENV{'user.domain'}.''.
+ unless(defined($msgid)) {
+ $msgid = &buildmsgid($now,$subject,$env{'user.name'},$env{'user.domain'},
+ $msgcount,$course_context,$$);
+ }
+ my $result=''.$env{'user.name'}.''.
+ ''.$env{'user.domain'}.''.
''.$subject.''.
''.
''.$ENV{'SERVER_NAME'}.''.
''.$ENV{'HTTP_HOST'}.''.
''.$ENV{'REMOTE_ADDR'}.''.
- ''.$ENV{'browser.type'}.''.
- ''.$ENV{'browser.os'}.''.
- ''.$ENV{'browser.version'}.''.
- ''.$ENV{'browser.mathml'}.''.
+ ''.$env{'browser.type'}.''.
+ ''.$env{'browser.os'}.''.
+ ''.$env{'browser.version'}.''.
+ ''.$env{'browser.mathml'}.''.
''.$ENV{'HTTP_USER_AGENT'}.''.
- ''.$ENV{'request.course.id'}.''.
- ''.$ENV{'request.course.sec'}.''.
- ''.$ENV{'request.role'}.''.
- ''.$ENV{'request.filename'}.''.
- ''.$msgid.''.
- ''.$recuser.''.
- ''.$recdomain.''.
- ''.$message.'';
+ ''.$course_context.''.
+ ''.$env{'request.course.sec'}.''.
+ ''.$env{'request.role'}.''.
+ ''.$env{'request.filename'}.''.
+ ''.$msgid.'';
+ if (ref($recuser) eq 'ARRAY') {
+ for (my $i=0; $i<@{$recuser}; $i++) {
+ if ($type eq 'dcmail') {
+ my ($username,$email) = split(/:/,$$recuser[$i]);
+ $username = &Apache::lonnet::unescape($username);
+ $email = &Apache::lonnet::unescape($email);
+ $username = &HTML::Entities::encode($username,'<>&"');
+ $email = &HTML::Entities::encode($email,'<>&"');
+ $result .= ''.
+ $email.'';
+ } else {
+ $result .= ''.$$recuser[$i].''.
+ ''.$$recdomain[$i].'';
+ }
+ }
+ } else {
+ $result .= ''.$recuser.''.
+ ''.$recdomain.'';
+ }
+ $result .= ''.$message.'';
if (defined($citation)) {
$result.=''.$citation.'';
}
@@ -185,7 +230,15 @@ sub unpackagemsg {
if ($token->[0] eq 'S') {
my $entry=$token->[1];
my $value=$parser->get_text('/'.$entry);
- $content{$entry}=$value;
+ if (($entry eq 'recuser') || ($entry eq 'recdomain')) {
+ push(@{$content{$entry}},$value);
+ } elsif ($entry eq 'recipient') {
+ my $username = $token->[2]{'username'};
+ $username = &HTML::Entities::decode($username,'<>&"');
+ $content{$entry}{$username} = $value;
+ } else {
+ $content{$entry}=$value;
+ }
}
}
if ($content{'attachmenturl'}) {
@@ -205,17 +258,27 @@ sub unpackagemsg {
# ======================================================= Get info out of msgid
+sub buildmsgid {
+ my ($now,$subject,$uname,$udom,$msgcount,$course_context,$pid) = @_;
+ $subject=&Apache::lonnet::escape($subject);
+ return(&Apache::lonnet::escape($now.':'.$subject.':'.$uname.':'.
+ $udom.':'.$msgcount.':'.$course_context.':'.$pid));
+}
+
sub unpackmsgid {
- my ($msgid,$folder)=@_;
+ my ($msgid,$folder,$skipstatus)=@_;
$msgid=&Apache::lonnet::unescape($msgid);
- my $suffix=&foldersuffix($folder);
- my ($sendtime,$shortsubj,$fromname,$fromdomain)=split(/\:/,
+ my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$fromcid)=split(/\:/,
&Apache::lonnet::unescape($msgid));
- my %status=&Apache::lonnet::get('email_status'.$suffix,[$msgid]);
- if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; }
- unless ($status{$msgid}) { $status{$msgid}='new'; }
- return ($sendtime,$shortsubj,$fromname,$fromdomain,$status{$msgid});
-}
+ my %status=();
+ unless ($skipstatus) {
+ my $suffix=&foldersuffix($folder);
+ &Apache::lonnet::get('email_status'.$suffix,[$msgid]);
+ if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; }
+ unless ($status{$msgid}) { $status{$msgid}='new'; }
+ }
+ return ($sendtime,$shortsubj,$fromname,$fromdomain,$status{$msgid},$fromcid);
+}
sub sendemail {
@@ -226,23 +289,19 @@ sub sendemail {
my $msg = new Mail::Send;
$msg->to($to);
$msg->subject('[LON-CAPA] '.$subject);
- my %oldENV=%ENV;
- undef(%ENV);
if (my $fh = $msg->open()) {
print $fh $body;
$fh->close;
}
- %ENV=%oldENV;
- undef(%oldENV);
}
# ==================================================== Send notification emails
sub sendnotification {
my ($to,$touname,$toudom,$subj,$crit,$text)=@_;
- my $sender=$ENV{'environment.firstname'}.' '.$ENV{'environment.lastname'};
+ my $sender=$env{'environment.firstname'}.' '.$env{'environment.lastname'};
unless ($sender=~/\w/) {
- $sender=$ENV{'user.name'}.'@'.$ENV{'user.domain'};
+ $sender=$env{'user.name'}.'@'.$env{'user.domain'};
}
my $critical=($crit?' critical':'');
$text=~s/\<\;/\300) {
+ if ((time-$env{'user.mailcheck.time'})>300) {
my %what=&Apache::lonnet::get('email_status',['recnewemail']);
&Apache::lonnet::appenv('user.mailcheck.time'=>time);
if ($what{'recnewemail'}>0) { return 1; }
@@ -340,7 +399,20 @@ sub del_url_author_res_msg {
}
return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
}
+# =================================== Clear out all author messages in URL path
+sub clear_author_res_msg {
+ my $url=shift;
+ $url=&Apache::lonnet::declutter($url);
+ my ($domain,$author)=($url=~/^(\w+)\/(\w+)\//);
+ my @delmsgs=();
+ foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
+ if ($_=~/^\Q$url\E/) {
+ push (@delmsgs,$_);
+ }
+ }
+ return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
+}
# ================= Return hash with URLs for which there is a resource message
sub all_url_author_res_msg {
@@ -356,7 +428,7 @@ sub all_url_author_res_msg {
# ================================================== Critical message to a user
sub user_crit_msg_raw {
- my ($user,$domain,$subject,$message,$sendback,$toperm)=@_;
+ my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage)=@_;
# Check if allowed missing
my $status='';
my $msgid='undefined';
@@ -370,13 +442,9 @@ sub user_crit_msg_raw {
'put:'.$domain.':'.$user.':critical:'.
&Apache::lonnet::escape($msgid).'='.
&Apache::lonnet::escape($message),$homeserver);
- if ($ENV{'request.course.id'}) {
- &user_normal_msg_raw(
- $ENV{'course.'.$ENV{'request.course.id'}.'.num'},
- $ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
- 'Critical ['.$user.':'.$domain.']',
- $message);
- }
+ if (defined($sentmessage)) {
+ $$sentmessage = $message;
+ }
} else {
$status='no_host';
}
@@ -396,8 +464,8 @@ sub user_crit_msg_raw {
&Apache::lonnet::logthis(
'Sending critical email '.$msgid.
', log status: '.
- &Apache::lonnet::log($ENV{'user.domain'},$ENV{'user.name'},
- $ENV{'user.home'},
+ &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
+ $env{'user.home'},
'Sending critical '.$msgid.' to '.$user.' at '.$domain.' with status: '
.$status));
return $status;
@@ -414,7 +482,7 @@ sub user_crit_msg_raw {
=cut
sub user_crit_msg {
- my ($user,$domain,$subject,$message,$sendback,$toperm)=@_;
+ my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage)=@_;
my $status='';
my %userenv = &Apache::lonnet::get('environment',['msgforward'],
$domain,$user);
@@ -424,10 +492,10 @@ sub user_crit_msg {
my ($forwuser,$forwdomain)=split(/\:/,$_);
$status.=
&user_crit_msg_raw($forwuser,$forwdomain,$subject,$message,
- $sendback,$toperm).' ';
+ $sendback,$toperm,$sentmessage).' ';
}
} else {
- $status=&user_crit_msg_raw($user,$domain,$subject,$message,$sendback,$toperm);
+ $status=&user_crit_msg_raw($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage);
}
return $status;
}
@@ -440,8 +508,8 @@ sub user_crit_received {
my %contents=&unpackagemsg($message{$msgid},1);
my $status='rec: '.($contents{'sendback'}?
&user_normal_msg($contents{'sendername'},$contents{'senderdomain'},
- &mt('Receipt').': '.$ENV{'user.name'}.' '.&mt('at').' '.$ENV{'user.domain'}.', '.$contents{'subject'},
- &mt('User').' '.$ENV{'user.name'}.' '.&mt('at').' '.$ENV{'user.domain'}.
+ &mt('Receipt').': '.$env{'user.name'}.' '.&mt('at').' '.$env{'user.domain'}.', '.$contents{'subject'},
+ &mt('User').' '.$env{'user.name'}.' '.&mt('at').' '.$env{'user.domain'}.
' acknowledged receipt of message'."\n".' "'.
$contents{'subject'}.'"'."\n".&mt('dated').' '.
$contents{'time'}.".\n"
@@ -451,8 +519,8 @@ sub user_crit_received {
'nohist_email',{$contents{'msgid'} => $message{$msgid}});
$status.=' del: '.
&Apache::lonnet::del('critical',[$contents{'msgid'}]);
- &Apache::lonnet::log($ENV{'user.domain'},$ENV{'user.name'},
- $ENV{'user.home'},'Received critical message '.
+ &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
+ $env{'user.home'},'Received critical message '.
$contents{'msgid'}.
', '.$status);
return $status;
@@ -462,7 +530,7 @@ sub user_crit_received {
sub user_normal_msg_raw {
my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
- $toperm)=@_;
+ $toperm,$currid,$newid,$sentmessage)=@_;
# Check if allowed missing
my $status='';
my $msgid='undefined';
@@ -471,7 +539,7 @@ sub user_normal_msg_raw {
my $homeserver=&Apache::lonnet::homeserver($user,$domain);
if ($homeserver ne 'no_host') {
($msgid,$message)=&packagemsg($subject,$message,$citation,$baseurl,
- $attachmenturl,$user,$domain);
+ $attachmenturl,$user,$domain,$currid);
# Store in user folder
$status=&Apache::lonnet::critical(
'put:'.$domain.':'.$user.':nohist_email:'.
@@ -480,15 +548,23 @@ sub user_normal_msg_raw {
# Save new message received time
&Apache::lonnet::put
('email_status',{'recnewemail'=>time},$domain,$user);
-# Into sent-mail folder
- $status.=' '.&Apache::lonnet::critical(
- 'put:'.$ENV{'user.domain'}.':'.$ENV{'user.name'}.
- ':nohist_email_sent:'.
- &Apache::lonnet::escape($msgid).'='.
- &Apache::lonnet::escape($message),$ENV{'user.home'});
+# Into sent-mail folder unless a broadcast message or critical message
+ unless (($env{'request.course.id'}) &&
+ (($env{'form.sendmode'} eq 'group') ||
+ (($env{'form.critmsg'}) || ($env{'form.sendbck'})) &&
+ (&Apache::lonnet::allowed('srm',$env{'request.course.id'})))) {
+ $status .= &store_sent_mail($msgid,$message);
+ }
} else {
$status='no_host';
}
+ if (defined($newid)) {
+ $$newid = $msgid;
+ }
+ if (defined($sentmessage)) {
+ $$sentmessage = $message;
+ }
+
# Notifications
my %userenv = &Apache::lonnet::get('environment',['notification',
'permanentemail'],
@@ -501,8 +577,8 @@ sub user_normal_msg_raw {
&sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,
$text);
}
- &Apache::lonnet::log($ENV{'user.domain'},$ENV{'user.name'},
- $ENV{'user.home'},
+ &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
+ $env{'user.home'},
'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status);
return $status;
}
@@ -519,7 +595,7 @@ sub user_normal_msg_raw {
sub user_normal_msg {
my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
- $toperm)=@_;
+ $toperm,$sentmessage)=@_;
my $status='';
my %userenv = &Apache::lonnet::get('environment',['msgforward'],
$domain,$user);
@@ -529,15 +605,24 @@ sub user_normal_msg {
my ($forwuser,$forwdomain)=split(/\:/,$_);
$status.=
&user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,
- $citation,$baseurl,$attachmenturl,$toperm).' ';
+ $citation,$baseurl,$attachmenturl,$toperm,undef,undef,$sentmessage).' ';
}
} else {
$status=&user_normal_msg_raw($user,$domain,$subject,$message,
- $citation,$baseurl,$attachmenturl,$toperm);
+ $citation,$baseurl,$attachmenturl,$toperm,undef,undef,$sentmessage);
}
return $status;
}
+sub store_sent_mail {
+ my ($msgid,$message) = @_;
+ my $status =' '.&Apache::lonnet::critical(
+ 'put:'.$env{'user.domain'}.':'.$env{'user.name'}.
+ ':nohist_email_sent:'.
+ &Apache::lonnet::escape($msgid).'='.
+ &Apache::lonnet::escape($message),$env{'user.home'});
+ return $status;
+}
# ============================================================ List all folders
@@ -559,7 +644,7 @@ sub folderlist {
($_==$interdis?' selected="selected"':'').'>'.$_.'' }
(10,20,50,100,200)).''.
'
'.
- ''.
+ ''.
($folder=~/^(new|critical)/?'':'');
}
@@ -567,13 +652,14 @@ sub scrollbuttons {
my ($start,$maxdis,$first,$finish,$total)=@_;
unless ($total>0) { return ''; }
$start++; $maxdis++;$first++;$finish++;
- return
+ return
+ &mt('Page').': '.
''.
''.
' of '.$maxdis.
''.
'
'.
- &mt('Messages [_1] through [_2] of [_3]',$first,$finish,$total).'';
+ &mt('Showing messages [_1] through [_2] of [_3]',$first,$finish,$total).'';
}
# =============================================================== Folder suffix
@@ -599,6 +685,9 @@ sub statuschange {
if (($newstatus eq 'deleted') || ($newstatus eq 'new')) {
&Apache::lonnet::put('email_status'.$suffix,{$msgid => $newstatus});
}
+ if ($newstatus eq 'deleted') {
+ &movemsg(&Apache::lonnet::unescape($msgid),$folder,'trash');
+ }
}
# ============================================================= Make new folder
@@ -616,6 +705,7 @@ sub makefolder {
sub movemsg {
my ($msgid,$srcfolder,$trgfolder)=@_;
+ if ($srcfolder eq 'new') { $srcfolder=''; }
my $srcsuffix=&foldersuffix($srcfolder);
my $trgsuffix=&foldersuffix($trgfolder);
@@ -639,9 +729,9 @@ sub discourse {
my $r=shift;
my $classlist = &Apache::loncoursedata::get_classlist();
my $now=time;
- my %lt=&Apache::lonlocal::texthash('cfa' => 'Check for All',
- 'cfs' => 'Check for Section/Group',
- 'cfn' => 'Check for None');
+ my %lt=&Apache::lonlocal::texthash('cfa' => 'Check All',
+ 'cfs' => 'Check Section/Group',
+ 'cfn' => 'Uncheck All');
$r->print(<