--- loncom/interface/lonmsg.pm 2005/07/08 10:39:49 1.152
+++ loncom/interface/lonmsg.pm 2010/05/29 22:39:52 1.226
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Routines for messaging
#
-# $Id: lonmsg.pm,v 1.152 2005/07/08 10:39:49 www Exp $
+# $Id: lonmsg.pm,v 1.226 2010/05/29 22:39:52 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,7 +26,6 @@
# http://www.lon-capa.org/
#
-
package Apache::lonmsg;
=pod
@@ -37,117 +36,219 @@ Apache::lonmsg: supports internal messag
=head1 SYNOPSIS
-lonmsg provides routines for sending messages, receiving messages, and
-a handler to allow users to read, send, and delete messages.
+lonmsg provides routines for sending messages.
-=head1 OVERVIEW
+Right now, this document will cover just how to send a message, since
+it is likely you will not need to programmatically read messages,
+since lonmsg already implements that functionality.
-=head2 Messaging Overview
+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.
-XLON-CAPA provides an internal messaging system similar to
-email, but customized for LON-CAPA's usage. LON-CAPA implements its
-own messaging system, rather then building on top of email, because of
-the features LON-CAPA messages can offer that conventional e-mail can
-not:
-
-=over 4
-
-=item * B: A message the recipient B
-acknowlegde receipt of before they are allowed to continue using the
-system, preventing a user from claiming they never got a message
-
-=item * B: LON-CAPA can reliably send reciepts informing the
-sender that it has been read; again, useful for preventing students
-from claiming they did not see a message. (While conventional e-mail
-has some reciept support, it's sporadic, e-mail client-specific, and
-generally the receiver can opt to not send one, making it useless in
-this case.)
-
-=item * B: LON-CAPA knows about the sender, such as where
-they are in a course. When a student mails an instructor asking for
-help on the problem, the instructor receives not just the student's
-question, but all submissions the student has made up to that point,
-the user's rendering of the problem, and the complete view the student
-saw of the resource, including discussion up to that point. Finally,
-the instructor is reading all of this inside of LON-CAPA, not their
-email program, so they have full access to LON-CAPA's grading
-interface, or other features they may wish to use in response to the
-student's query.
-
-=item * B: LON-CAPA can block display of e-mails that are
-sent to a student during an online exam. A course coordinator or
-instructor can set an open and close date/time for scheduled online
-exams in a course. If a user uses the LON-CAPA internal messaging
-system to display e-mails during the scheduled blocking event,
-display of all e-mail sent during the blocking period will be
-suppressed, and a message of explanation, including details of the
-currently active blocking periods will be displayed instead. A user
-who has a course coordinator or instructor role in a course will be
-unaffected by any blocking periods for the course, unless the user
-also has a student role in the course, AND has selected the student role.
+=head1 SUBROUTINES
-=back
+=over
-Users can ask LON-CAPA to forward messages to conventional e-mail
-addresses on their B screen, but generally, LON-CAPA messages
-are much more useful than traditional email can be made to be, even
-with HTML support.
+=pod
-Right now, this document will cover just how to send a message, since
-it is likely you will not need to programmatically read messages,
-since lonmsg already implements that functionality.
+=item packagemsg()
+
+Package
+
+=item get_course_context()
+
+=item unpackagemsg()
+
+Unpack message into a hash
+
+=item buildmsgid()
+
+Get info out of msgid
+
+=item unpackmsgid()
+
+=item sendemail()
+
+=item sendnotification()
+
+Send notification emails
+
+=item newmail()
+
+Check for email
+
+=item author_res_msg()
+
+Automated message to the author of a resource
+
+=item * B: Sends message $message to the owner
+ of the resource with the URI $filename.
+
+=item retrieve_author_res_msg()
+
+Retrieve author resource messages
+
+=item del_url_author_res_msg()
+
+Delete all author messages related to one URL
+
+=item clear_author_res_msg()
+
+Clear out all author messages in URL path
+
+=item all_url_author_res_msg()
+
+Return hash with URLs for which there is a resource message
+
+=item store_instructor_comment()
+
+Add a comment to the User Notes screen
+
+=item user_crit_msg_raw()
+
+Critical message to a user
+
+=item user_crit_msg()
+
+New routine that respects "forward" and calls old routine
+
+=item * B:
+ Sends a critical message $message to the $user at $domain. If $sendback
+ is true, a receipt will be sent to the current user when $user receives
+ the message.
+
+ Additionally it will check if the user has a Forwarding address
+ set, and send the message to that address instead
+
+ returns
+ - in array context a list of results for each message that was sent
+ - in scalar context a space seperated list of results for each
+ message sent
+
+
+=item user_crit_received()
+
+Critical message received
+
+=item user_normal_msg_raw()
+
+Normal communication
+
+=item user_normal_msg()
+
+New routine that respects "forward" and calls old routine
-=head1 FUNCTIONS
+=item * B:
+ Sends a message to the $user at $domain, with subject $subject and message $message.
-=over 4
+ Additionally it will check if the user has a Forwarding address
+ set, and send the message to that address instead
+
+ returns
+ - in array context a list of results for each message that was sent
+ - in scalar context a space seperated list of results for each
+ message sent
+
+=item store_sent_mail()
+
+=item store_recipients()
+
+=item foldersuffix()
+
+=item get_user_folders()
+
+User-defined folders
+
+=item secapply()
+
+=item B:
+
+Arguments
+ $feedurl - /res/ url of resource (only need if $author is true)
+ $author,$question,$course,$policy - all true/false parameters
+ if true will attempt to find the addresses of user that should receive
+ this type of feedback (author - feedback to author of resource $feedurl,
+ $question 'Resource Content Questions', $course 'Course Content Question',
+ $policy 'Course Policy')
+ (Additionally it also checks $env for whether the corresponding form.
+ element exists, for ease of use in a html response context)
+
+ $defaultflag - (internal should be left blank) if true gather addresses
+ that aren't for a section even if I have a section
+ (used for reccursion internally, first we look for
+ addresses for our specific section then we recurse
+ and look for non section addresses)
+
+Returns
+ $typestyle - string of html text, describing what addresses were found
+ %to - a hash, which keys are addresses of users to send messages to
+ the keys will look like name:domain
+
+=back
=cut
use strict;
use Apache::lonnet;
-use vars qw($msgcount);
use HTML::TokeParser();
-use Apache::Constants qw(:common);
-use Apache::loncommon();
-use Apache::lontexconvert();
-use HTML::Entities();
-use Mail::Send;
use Apache::lonlocal;
-use Apache::loncommunicate;
+use Mail::Send;
+use HTML::Entities;
+use Encode;
+use LONCAPA qw(:DEFAULT :match);
+
+{
+ my $uniq;
+ sub get_uniq {
+ $uniq++;
+ return $uniq;
+ }
+}
-# Querystring component with sorting type
-my $sqs;
-my $startdis;
-my $interdis;
-# ===================================================================== Package
sub packagemsg {
my ($subject,$message,$citation,$baseurl,$attachmenturl,
- $recuser,$recdomain)=@_;
+ $recuser,$recdomain,$msgid,$type,$crsmsgid,$symb,$error,$recipid)=@_;
$message =&HTML::Entities::encode($message,'<>&"');
$citation=&HTML::Entities::encode($citation,'<>&"');
$subject =&HTML::Entities::encode($subject,'<>&"');
#remove machine specification
- $baseurl =~ s|^http://[^/]+/|/|;
+ $baseurl =~ s|^https?://[^/]+/|/|;
$baseurl =&HTML::Entities::encode($baseurl,'<>&"');
#remove machine specification
- $attachmenturl =~ s|^http://[^/]+/|/|;
+ $attachmenturl =~ s|^https?://[^/]+/|/|;
$attachmenturl =&HTML::Entities::encode($attachmenturl,'<>&"');
-
+ my $course_context = &get_course_context();
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.':'.
- $env{'request.course.id'}.':'.$$);
- my $result=''.$env{'user.name'}.''.
+ my $msgcount = &get_uniq();
+ unless(defined($msgid)) {
+ $msgid = &buildmsgid($now,$subject,$env{'user.name'},$env{'user.domain'},
+ $msgcount,$course_context,$symb,$error,$$);
+ }
+ my $result = ''.$env{'user.name'}.''.
''.$env{'user.domain'}.''.
''.$subject.''.
- ''.
- ''.$ENV{'SERVER_NAME'}.''.
+ '';
+ if (defined($crsmsgid)) {
+ $result.= ''.$course_context.''.
+ ''.$env{'request.course.sec'}.''.
+ ''.$msgid.''.
+ ''.$crsmsgid.''.
+ ''.$message.'';
+ return ($msgid,$result);
+ }
+ $result .= ''.$ENV{'SERVER_NAME'}.''.
''.$ENV{'HTTP_HOST'}.''.
''.$ENV{'REMOTE_ADDR'}.''.
''.$env{'browser.type'}.''.
@@ -155,14 +256,34 @@ sub packagemsg {
''.$env{'browser.version'}.''.
''.$env{'browser.mathml'}.''.
''.$ENV{'HTTP_USER_AGENT'}.''.
- ''.$env{'request.course.id'}.''.
+ ''.$course_context.''.
''.$env{'request.course.sec'}.''.
''.$env{'request.role'}.''.
''.$env{'request.filename'}.''.
- ''.$msgid.''.
- ''.$recuser.''.
- ''.$recdomain.''.
- ''.$message.'';
+ ''.$msgid.'';
+ if (defined($env{'form.group'})) {
+ $result .= ''.$env{'form.group'}.'';
+ }
+ if (ref($recuser) eq 'ARRAY') {
+ for (my $i=0; $i<@{$recuser}; $i++) {
+ if ($type eq 'dcmail') {
+ my ($username,$email) = split(/:/,$$recuser[$i]);
+ $username = &unescape($username);
+ $email = &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.'';
}
@@ -172,13 +293,66 @@ sub packagemsg {
if (defined($attachmenturl)) {
$result.= ''.$attachmenturl.'';
}
- return $msgid,$result;
+ if (defined($symb)) {
+ $result.= ''.$symb.'';
+ if ($course_context ne '') {
+ if ($course_context eq $env{'request.course.id'}) {
+ my $resource_title = &Apache::lonnet::gettitle($symb);
+ if (defined($resource_title)) {
+ $result .= ''.$resource_title.'';
+ }
+ }
+ }
+ }
+ if (defined($recipid)) {
+ $result.= ''.$recipid.'';
+ }
+ if ($env{'form.can_reply'} eq 'N') {
+ $result .= '1';
+ }
+ if ($env{'form.reply_to_addr'}) {
+ my ($replytoname,$replytodom) = split(/:/,$env{'form.reply_to_addr'});
+ if (!($replytoname eq $env{'user.name'} && $replytodom eq $env{'user.domain'})) {
+ if (&Apache::lonnet::homeserver($replytoname,$replytodom) ne 'no_host') {
+ $result .= ''.$env{'form.reply_to_addr'}.'';
+ }
+ }
+ }
+ return ($msgid,$result);
+}
+
+sub get_course_context {
+ my $course_context;
+ my $msgkey;
+ if (defined($env{'form.replyid'})) {
+ $msgkey = $env{'form.replyid'};
+ } elsif (defined($env{'form.forwid'})) {
+ $msgkey = $env{'form.forwid'}
+ } elsif (defined($env{'form.multiforwid'})) {
+ $msgkey = $env{'form.multiforwid'};
+ }
+ if ($msgkey ne '') {
+ my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid)=
+ split(/\:/,&unescape($msgkey));
+ $course_context = $origcid;
+ }
+ foreach my $key (keys(%env)) {
+ if ($key=~/^form\.(rep)?rec\_(.*)$/) {
+ my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid) =
+ split(/\:/,&unescape($2));
+ $course_context = $origcid;
+ last;
+ }
+ }
+ if ($course_context eq '') {
+ $course_context = $env{'request.course.id'};
+ }
+ return $course_context;
}
-# ================================================== Unpack message into a hash
sub unpackagemsg {
- my ($message,$notoken)=@_;
+ my ($message,$notoken,$noattachmentlink)=@_;
my %content=();
my $parser=HTML::TokeParser->new(\$message);
my $token;
@@ -186,10 +360,19 @@ 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'}) {
+ if (!exists($content{'recuser'})) { $content{'recuser'} = []; }
+ if (($content{'attachmenturl'}) && (!$noattachmentlink)) {
my ($fname)=($content{'attachmenturl'}=~m|/([^/]+)$|);
if ($notoken) {
$content{'message'}.='
'.&mt('Attachment').': '.$fname.'';
@@ -204,29 +387,84 @@ sub unpackagemsg {
return %content;
}
-# ======================================================= Get info out of msgid
+
+sub buildmsgid {
+ my ($now,$subject,$uname,$udom,$msgcount,$course_context,$symb,$error,$pid) = @_;
+ $subject=&escape($subject);
+ $symb = &escape($symb);
+ return(&escape($now.':'.$subject.':'.$uname.':'.
+ $udom.':'.$msgcount.':'.$course_context.':'.$pid.':'.$symb.':'.$error));
+}
sub unpackmsgid {
- my ($msgid,$folder)=@_;
- $msgid=&Apache::lonnet::unescape($msgid);
- my $suffix=&foldersuffix($folder);
- 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},$fromcid);
+ my ($msgid,$folder,$skipstatus,$status_cache)=@_;
+ $msgid=&unescape($msgid);
+ my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$fromcid,
+ $processid,$symb,$error) = split(/\:/,&unescape($msgid));
+ $shortsubj = &unescape($shortsubj);
+ $shortsubj = &HTML::Entities::decode($shortsubj);
+ $symb = &unescape($symb);
+ if (!defined($processid)) { $fromcid = ''; }
+ my %status=();
+ unless ($skipstatus) {
+ if (ref($status_cache)) {
+ $status{$msgid} = $status_cache->{$msgid};
+ } else {
+ my $suffix=&foldersuffix($folder);
+ %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},$fromcid,$symb,$error);
}
sub sendemail {
- my ($to,$subject,$body)=@_;
+ my ($to,$subject,$body,$to_uname,$to_udom,$user_lh)=@_;
+ my $senderaddress='';
+ my $replytoaddress='';
+ if ($env{'form.can_reply'} eq 'N') {
+ my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
+ my $hostname = &Apache::lonnet::hostname($lonhost);
+ $replytoaddress = 'do-not-reply@'.$hostname;
+ } else {
+ my %senderemails;
+ my $have_sender;
+ if ($env{'form.reply_to_addr'}) {
+ my ($replytoname,$replytodom) = split(/:/,$env{'form.reply_to_addr'});
+ if (!($replytoname eq $env{'user.name'} && $replytodom eq $env{'user.domain'})) {
+ if (&Apache::lonnet::homeserver($replytoname,$replytodom) ne 'no_host') {
+ %senderemails =
+ &Apache::loncommon::getemails($replytoname,$replytodom);
+ $have_sender = 1;
+ }
+ }
+ }
+ if (!$have_sender) {
+ %senderemails=&Apache::loncommon::getemails();
+ }
+ foreach my $type ('permanentemail','critnotification','notification') {
+ if ($senderemails{$type}) {
+ ($senderaddress) = split(/,/,$senderemails{$type});
+ last if ($senderaddress);
+ }
+ }
+ }
$body=
- "*** ".&mt('This is an automatic message generated by the LON-CAPA system.')."\n".
- "*** ".&mt('Please do not reply to this address.')."\n\n".$body;
+ "*** ".&mt_user($user_lh,'This is an automatic e-mail generated by the LON-CAPA system.')."\n".
+ "*** ".($senderaddress?&mt_user($user_lh,'You can reply to this e-mail'):&mt_user($user_lh,'Please do not reply to this address.')."\n*** ".
+ &mt_user($user_lh,'A reply will not be received by the recipient!'))."\n\n".$body;
+
my $msg = new Mail::Send;
$msg->to($to);
$msg->subject('[LON-CAPA] '.$subject);
+ if ($replytoaddress) {
+ $msg->add('Reply-to',$replytoaddress);
+ }
+ if ($senderaddress) {
+ $msg->add('From',$senderaddress);
+ }
if (my $fh = $msg->open()) {
print $fh $body;
$fh->close;
@@ -236,54 +474,124 @@ sub sendemail {
# ==================================================== Send notification emails
sub sendnotification {
- my ($to,$touname,$toudom,$subj,$crit,$text)=@_;
+ my ($to,$touname,$toudom,$subj,$crit,$text,$msgid)=@_;
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/\<\;/\/gs;
- $text=~s/\<\/*[^\>]+\>//gs;
- my $url='http://'.
- $Apache::lonnet::hostname{&Apache::lonnet::homeserver($touname,$toudom)}.
- '/adm/email?username='.$touname.'&domain='.$toudom;
- my $body=(<]+\>//gs;
+ $text = &HTML::Entities::decode($text);
+ $text = &Encode::encode('utf8',$text);
+ return $text;
+}
-to access the full message.
-ENDMSG
- &sendemail($to,'New'.$critical.' message from '.$sender,$body);
+sub mynewmail{
+ &newmail();
+ return $env{'user.mailcheck.lastnewmassagetime'} > $env{'user.mailcheck.lastvisit'};
}
-# ============================================================= Check for email
+
sub newmail {
if ((time-$env{'user.mailcheck.time'})>300) {
my %what=&Apache::lonnet::get('email_status',['recnewemail']);
- &Apache::lonnet::appenv('user.mailcheck.time'=>time);
+ &Apache::lonnet::appenv({'user.mailcheck.time'=>time});
+ &Apache::lonnet::appenv({'user.mailcheck.lastnewmassagetime'=> $what{'recnewemail'}});
if ($what{'recnewemail'}>0) { return 1; }
}
return 0;
}
-# =============================== Automated message to the author of a resource
-=pod
-
-=item * B: Sends message $message to the owner
- of the resource with the URI $filename.
-
-=cut
sub author_res_msg {
my ($filename,$message)=@_;
@@ -293,22 +601,24 @@ sub author_res_msg {
my $homeserver=&Apache::lonnet::homeserver($author,$domain);
if ($homeserver ne 'no_host') {
my $id=unpack("%32C*",$message);
+ $message .= "
This error occurred on machine ".
+ $Apache::lonnet::perlvar{'lonHostID'}."
";
my $msgid;
($msgid,$message)=&packagemsg($filename,$message);
return &Apache::lonnet::reply('put:'.$domain.':'.$author.
':nohist_res_msgs:'.
- &Apache::lonnet::escape($filename.'_'.$id).'='.
- &Apache::lonnet::escape($message),$homeserver);
+ &escape($filename.'_'.$id).'='.
+ &escape($message),$homeserver);
}
return 'no_host';
}
-# =========================================== Retrieve author resource messages
+
sub retrieve_author_res_msg {
my $url=shift;
$url=&Apache::lonnet::declutter($url);
- my ($domain,$author)=($url=~/^(\w+)\/(\w+)\//);
+ my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
my %errormsgs=&Apache::lonnet::dump('nohist_res_msgs',$domain,$author);
my $msgs='';
foreach (keys %errormsgs) {
@@ -323,12 +633,13 @@ sub retrieve_author_res_msg {
}
-# =============================== Delete all author messages related to one URL
+
+
sub del_url_author_res_msg {
my $url=shift;
$url=&Apache::lonnet::declutter($url);
- my ($domain,$author)=($url=~/^(\w+)\/(\w+)\//);
+ my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
my @delmsgs=();
foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
if ($_=~/^\Q$url\E\_\d+$/) {
@@ -337,12 +648,12 @@ 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 ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
my @delmsgs=();
foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
if ($_=~/^\Q$url\E/) {
@@ -351,7 +662,8 @@ sub clear_author_res_msg {
}
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 {
my ($author,$domain)=@_;
@@ -363,44 +675,61 @@ sub all_url_author_res_msg {
return %returnhash;
}
-# ================================================== Critical message to a user
+
+sub store_instructor_comment {
+ my ($msg,$uname,$udom) = @_;
+ my $cid = $env{'request.course.id'};
+ my $cnum = $env{'course.'.$cid.'.num'};
+ my $cdom = $env{'course.'.$cid.'.domain'};
+ my $subject= &mt('Record').' ['.$uname.':'.$udom.']';
+ my $result = &user_normal_msg_raw($cnum,$cdom,$subject,$msg);
+ if ($result eq 'ok' || $result eq 'con_delayed') {
+
+ }
+ return $result;
+}
+
sub user_crit_msg_raw {
- my ($user,$domain,$subject,$message,$sendback,$toperm)=@_;
+ my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
+ $nosentstore,$recipid,$attachmenturl)=@_;
# Check if allowed missing
- my $status='';
+ my ($status,$packed_message);
my $msgid='undefined';
unless (($message)&&($user)&&($domain)) { $status='empty'; };
my $text=$message;
my $homeserver=&Apache::lonnet::homeserver($user,$domain);
if ($homeserver ne 'no_host') {
- ($msgid,$message)=&packagemsg($subject,$message);
- if ($sendback) { $message.='true'; }
- $status=&Apache::lonnet::critical(
- '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);
- }
+ ($msgid,$packed_message)=&packagemsg($subject,$message,undef,undef,
+ $attachmenturl,undef,undef,undef,undef,undef,
+ undef,undef,$recipid);
+ if ($sendback) { $packed_message.='true'; }
+ $status=&Apache::lonnet::cput('critical', {$msgid => $packed_message},
+ $domain,$user);
+ if (defined($sentmessage)) {
+ $$sentmessage = $packed_message;
+ }
+ if (!$nosentstore) {
+ (undef,my $packed_message_no_citation) =
+ &packagemsg($subject,$message,undef,undef,$attachmenturl,$user,
+ $domain,$msgid);
+ if ($status eq 'ok' || $status eq 'con_delayed') {
+ &store_sent_mail($msgid,$packed_message_no_citation);
+ }
+ }
} else {
$status='no_host';
}
+
# Notifications
- my %userenv = &Apache::lonnet::get('environment',['critnotification',
- 'permanentemail'],
- $domain,$user);
+ my %userenv = &Apache::loncommon::getemails($user,$domain);
if ($userenv{'critnotification'}) {
&sendnotification($userenv{'critnotification'},$user,$domain,$subject,1,
- $text);
+ $text,$msgid);
}
if ($toperm && $userenv{'permanentemail'}) {
&sendnotification($userenv{'permanentemail'},$user,$domain,$subject,1,
- $text);
+ $text,$msgid);
}
# Log this
&Apache::lonnet::logthis(
@@ -413,49 +742,58 @@ sub user_crit_msg_raw {
return $status;
}
-# New routine that respects "forward" and calls old routine
-=pod
-
-=item * B: Sends
- a critical message $message to the $user at $domain. If $sendback is true,
- a reciept will be sent to the current user when $user recieves the message.
-
-=cut
sub user_crit_msg {
- my ($user,$domain,$subject,$message,$sendback,$toperm)=@_;
- my $status='';
+ my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
+ $nosentstore,$recipid,$attachmenturl)=@_;
+ my @status;
my %userenv = &Apache::lonnet::get('environment',['msgforward'],
$domain,$user);
my $msgforward=$userenv{'msgforward'};
if ($msgforward) {
- foreach (split(/\,/,$msgforward)) {
- my ($forwuser,$forwdomain)=split(/\:/,$_);
- $status.=
- &user_crit_msg_raw($forwuser,$forwdomain,$subject,$message,
- $sendback,$toperm).' ';
+ foreach my $addr (split(/\,/,$msgforward)) {
+ my ($forwuser,$forwdomain)=split(/\:/,$addr);
+ push(@status,
+ &user_crit_msg_raw($forwuser,$forwdomain,$subject,$message,
+ $sendback,$toperm,$sentmessage,$nosentstore,
+ $recipid,$attachmenturl));
}
} else {
- $status=&user_crit_msg_raw($user,$domain,$subject,$message,$sendback,$toperm);
+ push(@status,
+ &user_crit_msg_raw($user,$domain,$subject,$message,$sendback,
+ $toperm,$sentmessage,$nosentstore,$recipid,
+ $attachmenturl));
}
- return $status;
+ if (wantarray) {
+ return @status;
+ }
+ return join(' ',@status);
}
-# =================================================== Critical message received
sub user_crit_received {
my $msgid=shift;
my %message=&Apache::lonnet::get('critical',[$msgid]);
my %contents=&unpackagemsg($message{$msgid},1);
+ my $destname = $contents{'sendername'};
+ my $destdom = $contents{'senderdomain'};
+ if ($contents{'replytoaddr'}) {
+ my ($repname,$repdom) = split(/:/,$contents{'replytoaddr'});
+ if (&Apache::lonnet::homeserver($repname,$repdom) ne 'no_host') {
+ $destname = $repname;
+ $destdom = $repdom;
+ }
+ }
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'}.
- ' acknowledged receipt of message'."\n".' "'.
- $contents{'subject'}.'"'."\n".&mt('dated').' '.
- $contents{'time'}.".\n"
- ):'no msg req');
+ &user_normal_msg($destname,$destdom,&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"
+ ):'no msg req');
$status.=' trans: '.
&Apache::lonnet::put(
'nohist_email',{$contents{'msgid'} => $message{$msgid}});
@@ -468,1766 +806,244 @@ sub user_crit_received {
return $status;
}
-# ======================================================== Normal communication
+
+
sub user_normal_msg_raw {
my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
- $toperm)=@_;
+ $toperm,$currid,$newid,$sentmessage,$crsmsgid,$symb,$restitle,
+ $error,$nosentstore,$recipid)=@_;
# Check if allowed missing
- my $status='';
+ my ($status,$packed_message);
my $msgid='undefined';
my $text=$message;
unless (($message)&&($user)&&($domain)) { $status='empty'; };
my $homeserver=&Apache::lonnet::homeserver($user,$domain);
if ($homeserver ne 'no_host') {
- ($msgid,$message)=&packagemsg($subject,$message,$citation,$baseurl,
- $attachmenturl,$user,$domain);
+ ($msgid,$packed_message)=
+ &packagemsg($subject,$message,$citation,$baseurl,
+ $attachmenturl,$user,$domain,$currid,
+ undef,$crsmsgid,$symb,$error,$recipid);
+
# Store in user folder
- $status=&Apache::lonnet::critical(
- 'put:'.$domain.':'.$user.':nohist_email:'.
- &Apache::lonnet::escape($msgid).'='.
- &Apache::lonnet::escape($message),$homeserver);
+ $status=
+ &Apache::lonnet::cput('nohist_email',{$msgid => $packed_message},
+ $domain,$user);
# 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'});
- } else {
- $status='no_host';
- }
+# Into sent-mail folder if sent mail storage required
+ if (!$nosentstore) {
+ (undef,my $packed_message_no_citation) =
+ &packagemsg($subject,$message,undef,$baseurl,$attachmenturl,
+ $user,$domain,$currid,undef,$crsmsgid,$symb,$error);
+ if ($status eq 'ok' || $status eq 'con_delayed') {
+ &store_sent_mail($msgid,$packed_message_no_citation);
+ }
+ }
+ if (ref($newid) eq 'SCALAR') {
+ $$newid = $msgid;
+ }
+ if (ref($sentmessage) eq 'SCALAR') {
+ $$sentmessage = $packed_message;
+ }
# Notifications
- my %userenv = &Apache::lonnet::get('environment',['notification',
- 'permanentemail'],
- $domain,$user);
- if ($userenv{'notification'}) {
- &sendnotification($userenv{'notification'},$user,$domain,$subject,0,
- $text);
- }
- if ($toperm && $userenv{'permanentemail'}) {
- &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,
- $text);
- }
- &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
- $env{'user.home'},
- 'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status);
+ my %userenv = &Apache::loncommon::getemails($user,$domain);
+ if ($userenv{'notification'}) {
+ &sendnotification($userenv{'notification'},$user,$domain,$subject,0,
+ $text,$msgid);
+ }
+ if ($toperm && $userenv{'permanentemail'}) {
+ if ((!$userenv{'notification'}) || ($userenv{'notification'} ne $userenv{'permanentemail'})) {
+ &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,0,
+ $text,$msgid);
+ }
+ }
+ &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
+ $env{'user.home'},
+ 'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status);
+ } else {
+ $status='no_host';
+ }
return $status;
}
-# New routine that respects "forward" and calls old routine
-
-=pod
-
-=item * B: Sends a message to the
- $user at $domain, with subject $subject and message $message.
-
-=cut
-
sub user_normal_msg {
my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
- $toperm)=@_;
- my $status='';
+ $toperm,$sentmessage,$symb,$restitle,$error,$nosentstore,$recipid)=@_;
+ my @status;
my %userenv = &Apache::lonnet::get('environment',['msgforward'],
$domain,$user);
my $msgforward=$userenv{'msgforward'};
if ($msgforward) {
- foreach (split(/\,/,$msgforward)) {
- my ($forwuser,$forwdomain)=split(/\:/,$_);
- $status.=
- &user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,
- $citation,$baseurl,$attachmenturl,$toperm).' ';
- }
- } else {
- $status=&user_normal_msg_raw($user,$domain,$subject,$message,
- $citation,$baseurl,$attachmenturl,$toperm);
- }
- return $status;
-}
-
-
-# ============================================================ List all folders
-
-sub folderlist {
- my $folder=shift;
- my @allfolders=&Apache::lonnet::getkeys('email_folders');
- if ($allfolders[0]=~/^error:/) { @allfolders=(); }
- return '':'');
-}
-
-sub scrollbuttons {
- my ($start,$maxdis,$first,$finish,$total)=@_;
- unless ($total>0) { return ''; }
- $start++; $maxdis++;$first++;$finish++;
- return
- &mt('Page').': '.
- ''.
- ''.
- ' of '.$maxdis.
- ''.
- ' '.
- &mt('Showing messages [_1] through [_2] of [_3]',$first,$finish,$total).'';
-}
-
-# =============================================================== Folder suffix
-
-sub foldersuffix {
- my $folder=shift;
- unless ($folder) { return ''; }
- return '_'.&Apache::lonnet::escape($folder);
-}
-
-# =============================================================== Status Change
-
-sub statuschange {
- my ($msgid,$newstatus,$folder)=@_;
- my $suffix=&foldersuffix($folder);
- my %status=&Apache::lonnet::get('email_status'.$suffix,[$msgid]);
- if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; }
- unless ($status{$msgid}) { $status{$msgid}='new'; }
- unless (($status{$msgid} eq 'replied') ||
- ($status{$msgid} eq 'forwarded')) {
- &Apache::lonnet::put('email_status'.$suffix,{$msgid => $newstatus});
- }
- 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
-
-sub makefolder {
- my ($newfolder)=@_;
- if (($newfolder eq 'sent')
- || ($newfolder eq 'critical')
- || ($newfolder eq 'trash')
- || ($newfolder eq 'new')) { return; }
- &Apache::lonnet::put('email_folders',{$newfolder => time});
-}
-
-# ======================================================== Move between folders
-
-sub movemsg {
- my ($msgid,$srcfolder,$trgfolder)=@_;
- if ($srcfolder eq 'new') { $srcfolder=''; }
- my $srcsuffix=&foldersuffix($srcfolder);
- my $trgsuffix=&foldersuffix($trgfolder);
-
-# Copy message
- my %message=&Apache::lonnet::get('nohist_email'.$srcsuffix,[$msgid]);
- &Apache::lonnet::put('nohist_email'.$trgsuffix,{$msgid => $message{$msgid}});
-
-# Copy status
- unless ($trgfolder eq 'trash') {
- my %status=&Apache::lonnet::get('email_status'.$srcsuffix,[$msgid]);
- &Apache::lonnet::put('email_status'.$trgsuffix,{$msgid => $status{$msgid}});
- }
-# Delete orginals
- &Apache::lonnet::del('nohist_email'.$srcsuffix,[$msgid]);
- &Apache::lonnet::del('email_status'.$srcsuffix,[$msgid]);
-}
-
-# ======================================================= Display a course list
-
-sub discourse {
- my $r=shift;
- my $classlist = &Apache::loncoursedata::get_classlist();
- my $now=time;
- my %lt=&Apache::lonlocal::texthash('cfa' => 'Check All',
- 'cfs' => 'Check Section/Group',
- 'cfn' => 'Uncheck All');
- $r->print(<
-
-
-
-
-
-
-ENDDISHEADER
- my %coursepersonnel=&Apache::lonnet::get_course_adv_roles();
- $r->print('
');
- foreach my $role (sort keys %coursepersonnel) {
- foreach (split(/\,/,$coursepersonnel{$role})) {
- my ($puname,$pudom)=split(/\:/,$_);
- $r->print('