# The LearningOnline Network with CAPA
# Routines for messaging
#
# $Id: lonmsg.pm,v 1.251 2024/02/08 03:02:12 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
package Apache::lonmsg;
=pod
=head1 NAME
Apache::lonmsg: supports internal messaging
=head1 SYNOPSIS
lonmsg provides routines for sending messages.
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.
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 <recuser>$uname</recuser> and
<recdomain>$udom</recdomain> in stored internal messages, compared
with <recipient username="$uname:$udom">$email</recipient> in stored
Domain Coordinator e-mail for the storage of information about
recipients of the message/e-mail.
=head1 SUBROUTINES
=over
=pod
=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<author_res_msg($filename, $message)>: 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<user_crit_msg($user, $domain, $subject, $message, $sendback, $toperm, $sentmessage, $nosentstore, $recipid, $attachmenturl, $permresults, $senthide)>:
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
=item * B<user_normal_msg($user, $domain, $subject, $message, $citation,
$baseurl, $attachmenturl, $toperm, $sentmessage, $symb, $restitle,
$error,$nosentstore,$recipid,$permresults,$senthide)>:
Sends a message to the $user at $domain, with subject $subject and message $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 store_sent_mail()
=item store_recipients()
=item foldersuffix()
=item get_user_folders()
User-defined folders
=item secapply()
=item B<decide_receiver($feedurl,$author,$question,$course,$policy,$defaultflag)>:
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.<name>
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 Apache::loncommon;
use HTML::TokeParser();
use Apache::lonlocal;
use HTML::Entities;
use Encode;
use LONCAPA qw(:DEFAULT :match);
{
my $uniq;
sub get_uniq {
$uniq++;
return $uniq;
}
}
sub packagemsg {
my ($subject,$message,$citation,$baseurl,$attachmenturl,$recuser,$recdomain,
$msgid,$type,$crsmsgid,$symb,$error,$recipid,$senthide,$origmsgid)=@_;
$message =&HTML::Entities::encode($message,'<>&"');
$citation=&HTML::Entities::encode($citation,'<>&"');
$subject =&HTML::Entities::encode($subject,'<>&"');
#remove machine specification
$baseurl =~ s|^https?://[^/]+/|/|;
$baseurl =&HTML::Entities::encode($baseurl,'<>&"');
#remove machine specification
$attachmenturl =~ s|^https?://[^/]+/|/|;
$attachmenturl =&HTML::Entities::encode($attachmenturl,'<>&"');
if ($senthide) {
foreach my $item ($subject,$message) {
if ($item ne '') {
$item = 'Not shown due to IP block';
}
}
if ($attachmenturl ne '') {
$attachmenturl = '';
}
if ($citation ne '') {
$citation = '';
}
if ($msgid ne '') {
$msgid = '';
}
}
my $course_context = &get_course_context();
my $now=time;
my $ip = &Apache::lonnet::get_requestor_ip();
my $msgcount = &get_uniq();
unless(defined($msgid)) {
$msgid = &buildmsgid($now,$subject,$env{'user.name'},$env{'user.domain'},
$msgcount,$course_context,$symb,$error,$$);
}
my $result = '<sendername>'.$env{'user.name'}.'</sendername>'.
'<senderdomain>'.$env{'user.domain'}.'</senderdomain>'.
'<subject>'.$subject.'</subject>'.
'<time>'.&Apache::lonlocal::locallocaltime($now).'</time>';
if (defined($crsmsgid)) {
$result.= '<courseid>'.$course_context.'</courseid>'.
'<coursesec>'.$env{'request.course.sec'}.'</coursesec>'.
'<msgid>'.$msgid.'</msgid>'.
'<coursemsgid>'.$crsmsgid.'</coursemsgid>'.
'<message>'.$message.'</message>';
return ($msgid,$result);
}
$result .= '<servername>'.$ENV{'SERVER_NAME'}.'</servername>'.
'<host>'.$ENV{'HTTP_HOST'}.'</host>'.
'<client>'.$ip.'</client>'.
'<browsertype>'.$env{'browser.type'}.'</browsertype>'.
'<browseros>'.$env{'browser.os'}.'</browseros>'.
'<browserversion>'.$env{'browser.version'}.'</browserversion>'.
'<browsermathml>'.$env{'browser.mathml'}.'</browsermathml>'.
'<browserraw>'.$ENV{'HTTP_USER_AGENT'}.'</browserraw>'.
'<courseid>'.$course_context.'</courseid>'.
'<coursesec>'.$env{'request.course.sec'}.'</coursesec>'.
'<role>'.$env{'request.role'}.'</role>'.
'<resource>'.$env{'request.filename'}.'</resource>'.
'<msgid>'.$msgid.'</msgid>';
if (defined($env{'form.group'})) {
$result .= '<group>'.$env{'form.group'}.'</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 .= '<recipient username="'.$username.'">'.
$email.'</recipient>';
} else {
$result .= '<recuser>'.$$recuser[$i].'</recuser>'.
'<recdomain>'.$$recdomain[$i].'</recdomain>';
}
}
} else {
$result .= '<recuser>'.$recuser.'</recuser>'.
'<recdomain>'.$recdomain.'</recdomain>';
}
$result .= '<message>'.$message.'</message>';
if (defined($citation)) {
$result.='<citation>'.$citation.'</citation>';
}
if (defined($baseurl)) {
$result.= '<baseurl>'.$baseurl.'</baseurl>';
}
if (defined($attachmenturl)) {
$result.= '<attachmenturl>'.$attachmenturl.'</attachmenturl>';
}
if (defined($symb)) {
$result.= '<symb>'.$symb.'</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>'.$resource_title.'</resource_title>';
}
}
}
}
if (defined($recipid)) {
$result.= '<recipid>'.$recipid.'</recipid>';
}
if ($env{'form.can_reply'} eq 'N') {
$result .= '<noreplies>1</noreplies>';
}
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 .= '<replytoaddr>'.$env{'form.reply_to_addr'}.'</replytoaddr>';
}
}
}
if ($senthide) {
$result .= '<senthide>$origmsgid</senthide>';
}
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;
}
sub unpackagemsg {
my ($message,$notoken,$noattachmentlink)=@_;
my %content=();
my $parser=HTML::TokeParser->new(\$message);
my $token;
while ($token=$parser->get_token) {
if ($token->[0] eq 'S') {
my $entry=$token->[1];
my $value=$parser->get_text('/'.$entry);
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 (!exists($content{'recuser'})) { $content{'recuser'} = []; }
if (($content{'attachmenturl'}) && (!$noattachmentlink)) {
my ($fname)=($content{'attachmenturl'}=~m|/([^/]+)$|);
if ($notoken) {
$content{'message'}.='<p>'.&mt('Attachment').': <tt>'.$fname.'</tt>';
} else {
&Apache::lonnet::allowuploaded('/adm/msg',
$content{'attachmenturl'});
$content{'message'}.='<p>'.&mt('Attachment').
': <a href="'.$content{'attachmenturl'}.'"><tt>'.
$fname.'</tt></a>';
}
}
return %content;
}
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,$skipstatus,$status_cache,$onlycid)=@_;
$msgid=&unescape($msgid);
my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$fromcid,
$processid,$symb,$error) = split(/\:/,&unescape($msgid));
if (!defined($processid)) { $fromcid = ''; }
if (($onlycid) && ($onlycid ne $fromcid)) {
return ($sendtime,'',$fromname,$fromdomain,'',$fromcid,'',$error);
}
$shortsubj = &unescape($shortsubj);
$shortsubj = &HTML::Entities::decode($shortsubj);
$symb = &unescape($symb);
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,$to_uname,$to_udom,$user_lh,$attachmenturl)=@_;
my $senderaddress='';
my $replytoaddress='';
my $msgsent;
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,$setreplyto);
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'})) {
$setreplyto = 1;
} else {
if (&Apache::lonnet::homeserver($replytoname,$replytodom) ne 'no_host') {
%senderemails =
&Apache::loncommon::getemails($replytoname,$replytodom);
$have_sender = 1;
$setreplyto = 1;
}
}
}
if (!$have_sender) {
%senderemails=&Apache::loncommon::getemails();
}
foreach my $type ('permanentemail','critnotification','notification') {
if ($senderemails{$type}) {
($senderaddress) = split(/,/,$senderemails{$type});
if ($senderaddress) {
if ($setreplyto) {
$replytoaddress = $senderaddress;
}
last;
}
}
}
}
$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;
$attachmenturl = &Apache::lonnet::filelocation("",$attachmenturl);
my $filesize = (stat($attachmenturl))[7];
if ($filesize > 1048576) {
# Don't send if it exceeds 1 MB.
print '<p><span class="LC_error">'
.&mt('Email not sent. Attachment exceeds permitted length.')
.'</span><br /></p>';
} else {
# Otherwise build and send the email
$subject = '[LON-CAPA] '.$subject;
&Apache::loncommon::mime_email($senderaddress,$replytoaddress,$to,
$subject,$body,'','',$attachmenturl,'','');
$msgsent = 1;
}
return $msgsent;
}
# ==================================================== Send notification emails
sub sendnotification {
my ($to,$touname,$toudom,$subj,$crit,$text,$msgid,$attachmenturl)=@_;
my $sender=$env{'environment.firstname'}.' '.$env{'environment.lastname'};
unless ($sender=~/\w/) {
$sender=$env{'user.name'}.':'.$env{'user.domain'};
}
my $critical=($crit?' critical':'');
my $numsent = 0;
$text=~s/\<\;/\</gs;
$text=~s/\>\;/\>/gs;
my $touhome = &Apache::lonnet::homeserver($touname,$toudom);
my $url = &Apache::lonnet::url_prefix('',$toudom,$touhome,'email').
'/adm/email?username='.$touname.'&domain='.$toudom.
'&display='.&escape($msgid);
my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid,
$symb,$error) = &Apache::lonmsg::unpackmsgid($msgid);
my ($coursetext,$body,$bodybegin,$bodysubj,$bodyend);
my $user_lh = &Apache::loncommon::user_lang($touname,$toudom,$fromcid);
if ($fromcid ne '') {
$coursetext = "\n".&mt_user($user_lh,'Course').': ';
if ($env{'course.'.$fromcid.'.description'} ne '') {
$coursetext .= $env{'course.'.$fromcid.'.description'};
} else {
my %coursehash = &Apache::lonnet::coursedescription($fromcid,);
if ($coursehash{'description'} ne '') {
$coursetext .= $coursehash{'description'};
}
}
$coursetext .= "\n\n";
}
my @recipients = split(/,/,$to);
$bodybegin = $coursetext.
&mt_user($user_lh,
'You received a'.$critical.' message from [_1] in LON-CAPA.',$sender).' ';
$bodysubj = &mt_user($user_lh,'The subject is
[_1]
',$subj)."\n".
'=== '.&mt_user($user_lh,'Excerpt')." ============================================================
";
$bodyend = "
========================================================================
".&mt_user($user_lh,'Use
[_1]
to access the full message.',$url);
my %userenv = &Apache::lonnet::get('environment',['notifywithhtml'],$toudom,$touname);
my $subject = &mt_user($user_lh,"'New'$critical message from [_1]",$sender);
unless ($subj eq '') {
$subject = $subj;
}
my ($blocked,$blocktext,$clientip);
$clientip = &Apache::lonnet::get_requestor_ip();
if (!$crit) {
my %setters;
my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
&Apache::loncommon::blockcheck(\%setters,'com',$clientip,$touname,$toudom);
if ($startblock && $endblock) {
$blocked = 1;
my $showstart = &Apache::lonlocal::locallocaltime($startblock);
my $showend = &Apache::lonlocal::locallocaltime($endblock);
$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);
} elsif ($by_ip) {
$blocked = 1;
$blocktext = &mt_user($user_lh,'LON-CAPA messages sent to you will be inaccessible from your IP address [_1], because communication is being blocked for certain IP address(es).',$clientip);
}
}
if ($userenv{'notifywithhtml'} ne '') {
my @htmlexcerpt = split(/,/,$userenv{'notifywithhtml'});
my $htmlfree = &make_htmlfree($text);
foreach my $addr (@recipients) {
if ($blocked) {
$body = $bodybegin."\n".$blocktext."\n".$bodyend;
} else {
my $sendtext;
if (!grep/^\Q$addr\E/,@htmlexcerpt) {
$sendtext = $htmlfree;
} else {
$sendtext = $text;
}
$body = $bodybegin.$bodysubj.$sendtext.$bodyend;
}
if (&sendemail($addr,$subject,$body,$touname,$toudom,$user_lh,$attachmenturl)) {
$numsent ++;
}
}
} else {
if ($blocked) {
$body = $bodybegin."\n".$blocktext."\n".$bodyend;
} else {
my $htmlfree = &make_htmlfree($text);
$body = $bodybegin.$bodysubj.$htmlfree.$bodyend;
}
if (&sendemail($to,$subject,$body,$touname,$toudom,$user_lh,$attachmenturl)) {
$numsent ++;
}
}
return $numsent;
}
sub make_htmlfree {
my ($text) = @_;
$text =~ s/\<\/*[^\>]+\>//gs;
$text = &HTML::Entities::decode($text);
$text = &Encode::encode('utf8',$text);
return $text;
}
sub mynewmail{
&newmail();
return $env{'user.mailcheck.lastnewmessagetime'} > $env{'user.mailcheck.lastvisit'};
}
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.lastnewmessagetime'=> $what{'recnewemail'}});
if ($what{'recnewemail'}>0) { return 1; }
}
return 0;
}
sub author_res_msg {
my ($filename,$message)=@_;
unless ($message) { return 'empty'; }
$filename=&Apache::lonnet::declutter($filename);
my ($domain,$author,@dummy)=split(/\//,$filename);
my $homeserver=&Apache::lonnet::homeserver($author,$domain);
if ($homeserver ne 'no_host') {
my $id=unpack("%32C*",$message);
$message .= " <p>This error occurred on machine ".
$Apache::lonnet::perlvar{'lonHostID'}."</p>";
my $msgid;
($msgid,$message)=&packagemsg($filename,$message);
return &Apache::lonnet::reply('put:'.$domain.':'.$author.
':nohist_res_msgs:'.
&escape($filename.'_'.$id).'='.
&escape($message),$homeserver);
}
return 'no_host';
}
sub retrieve_author_res_msg {
my $url=shift;
$url=&Apache::lonnet::declutter($url);
my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
my %errormsgs=&Apache::lonnet::dump('nohist_res_msgs',$domain,$author);
my $msgs='';
foreach my $msg (keys(%errormsgs)) {
if ($msg =~ /^\Q$url\E\_\d+$/) {
my %content=&unpackagemsg($errormsgs{$msg});
$msgs.='<p><img src="/adm/lonMisc/bomb.gif" /><b>'.
$content{'time'}.'</b>: '.$content{'message'}.
'<br /></p>';
}
}
return $msgs;
}
sub del_url_author_res_msg {
my $url=shift;
$url=&Apache::lonnet::declutter($url);
my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
my @delmsgs=();
foreach my $msg (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
if ($msg =~ /^\Q$url\E\_\d+$/) {
push (@delmsgs,$msg);
}
}
return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
}
sub clear_author_res_msg {
my $url=shift;
$url=&Apache::lonnet::declutter($url);
my ($domain,$author)=($url=~/^($match_domain)\/($match_username)\//);
my @delmsgs=();
foreach my $msg (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
if ($msg =~ /^\Q$url\E/) {
push (@delmsgs,$msg);
}
}
return &Apache::lonnet::del('nohist_res_msgs',\@delmsgs,$domain,$author);
}
sub all_url_author_res_msg {
my ($author,$domain)=@_;
my %returnhash=();
foreach my $msg (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) {
$msg =~ /^(.+)\_\d+/;
$returnhash{$1}=1;
}
return %returnhash;
}
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,$sentmessage,
$nosentstore,$recipid,$attachmenturl,$permresults,$senthide)=@_;
# Check if allowed missing
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,$packed_message)=&packagemsg($subject,$message,undef,undef,
$attachmenturl,undef,undef,undef,undef,undef,
undef,undef,$recipid);
if ($sendback) { $packed_message.='<sendback>true</sendback>'; }
$status=&Apache::lonnet::cput('critical', {$msgid => $packed_message},
$domain,$user);
if (defined($sentmessage)) {
$$sentmessage = $packed_message;
}
if (!$nosentstore) {
my ($sentmsgid,$packed_message_no_citation) =
&packagemsg($subject,$message,undef,undef,$attachmenturl,$user,
$domain,$msgid,undef,undef,undef,undef,undef,$senthide,$msgid);
if ($status eq 'ok' || $status eq 'con_delayed') {
if ($senthide && $sentmsgid) {
&store_sent_mail($sentmsgid,$packed_message_no_citation);
} else {
&store_sent_mail($msgid,$packed_message_no_citation);
}
}
}
} else {
$status='no_host';
}
# Notifications
my %userenv = &Apache::loncommon::getemails($user,$domain);
my $critnotify = $userenv{'critnotification'};
my $permemail = $userenv{'permanentemail'};
my $numcrit = 0;
my $numperm = 0;
my $permlogmsgstatus;
if ($critnotify) {
$numcrit = &sendnotification($critnotify,$user,$domain,$subject,1,$text,$msgid,$attachmenturl);
}
if ($toperm && $permemail) {
if ($critnotify && $numcrit) {
if (grep(/^\Q$permemail\E/,split(/,/,$critnotify))) {
$numperm = 1;
}
}
unless ($numperm) {
$numperm = &sendnotification($permemail,$user,$domain,$subject,1,$text,$msgid,$attachmenturl);
}
}
if ($toperm) {
$permlogmsgstatus = '. Perm. email log status '.
&Apache::lonnet::log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
"Perm. e-mail count $numperm for $user at $domain");
if (ref($permresults) eq 'HASH') {
$permresults->{"$user:$domain"} = $numperm;
}
}
# Log this
&Apache::lonnet::logthis(
'Sending critical '.$msgid.
', log status: '.
&Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
$env{'user.home'},
'Sending critical '.$msgid.' to '.$user.' at '.$domain.' with status '
.$status).$permlogmsgstatus);
return $status;
}
sub user_crit_msg {
my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage,
$nosentstore,$recipid,$attachmenturl,$permresults,$senthide)=@_;
my @status;
my %userenv = &Apache::lonnet::get('environment',['msgforward'],
$domain,$user);
my $msgforward=$userenv{'msgforward'};
if ($msgforward) {
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,$permresults,$senthide));
}
} else {
push(@status,
&user_crit_msg_raw($user,$domain,$subject,$message,$sendback,
$toperm,$sentmessage,$nosentstore,$recipid,
$attachmenturl,$permresults,$senthide));
}
if (wantarray) {
return @status;
}
return join(' ',@status);
}
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($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}});
$status.=' del: '.
&Apache::lonnet::del('critical',[$contents{'msgid'}]);
&Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
$env{'user.home'},'Received critical message '.
$contents{'msgid'}.
', '.$status);
return $status;
}
sub user_normal_msg_raw {
my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
$toperm,$currid,$newid,$sentmessage,$crsmsgid,$symb,$restitle,
$error,$nosentstore,$recipid,$permresults,$senthide)=@_;
# Check if allowed missing
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,$packed_message)=
&packagemsg($subject,$message,$citation,$baseurl,
$attachmenturl,$user,$domain,$currid,
undef,$crsmsgid,$symb,$error,$recipid);
# Store in user folder
$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 if sent mail storage required
if (!$nosentstore) {
my ($sentmsgid,$packed_message_no_citation) =
&packagemsg($subject,$message,undef,$baseurl,$attachmenturl,
$user,$domain,$currid,undef,$crsmsgid,$symb,$error,
undef,$senthide,$msgid);
if ($status eq 'ok' || $status eq 'con_delayed') {
if ($senthide && $sentmsgid) {
&store_sent_mail($sentmsgid,$packed_message_no_citation);
} else {
&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::loncommon::getemails($user,$domain);
my $notify = $userenv{'notification'};
my $permemail = $userenv{'permanentemail'};
my $numnotify = 0;
my $numperm = 0;
my $permlogmsgstatus;
if ($notify) {
$numnotify = &sendnotification($notify,$user,$domain,$subject,0,$text,$msgid,$attachmenturl);
}
if ($toperm && $permemail) {
if ($notify && $numnotify) {
if (grep(/^\Q$permemail\E/,split(/,/,$notify))) {
$numperm = 1;
}
}
unless ($numperm) {
$numperm = &sendnotification($permemail,$user,$domain,$subject,0,
$text,$msgid,$attachmenturl);
}
}
if ($toperm) {
$permlogmsgstatus = '. Perm. email log status '.
&Apache::lonnet::log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
"Perm. e-mail count $numperm for $user at $domain");
if (ref($permresults) eq 'HASH') {
$permresults->{"$user:$domain"} = $numperm;
}
}
&Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
$env{'user.home'},
'Sending '.$msgid.' to '.$user.' at '.$domain.' with status '.$status.
$permlogmsgstatus);
} else {
$status='no_host';
}
return $status;
}
sub user_normal_msg {
my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl,
$toperm,$sentmessage,$symb,$restitle,$error,$nosentstore,$recipid,
$permresults,$senthide)=@_;
my @status;
my %userenv = &Apache::lonnet::get('environment',['msgforward'],
$domain,$user);
my $msgforward=$userenv{'msgforward'};
if ($msgforward) {
foreach my $fwd (split(/\,/,$msgforward)) {
my ($forwuser,$forwdomain)=split(/\:/,$fwd);
push(@status,
&user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,
$citation,$baseurl,$attachmenturl,$toperm,
undef,undef,$sentmessage,undef,$symb,
$restitle,$error,$nosentstore,$recipid,
$permresults,$senthide));
}
} else {
push(@status,&user_normal_msg_raw($user,$domain,$subject,$message,
$citation,$baseurl,$attachmenturl,$toperm,
undef,undef,$sentmessage,undef,$symb,
$restitle,$error,$nosentstore,$recipid,
$permresults,$senthide));
}
if (wantarray) {
return @status;
}
return join(' ',@status);
}
sub process_sent_mail {
my ($msgsubj,$subj_prefix,$numsent,$stamp,$msgname,$msgdom,$msgcount,
$context,$pid,$savemsg,$recusers,$recudoms,$baseurl,$attachmenturl,
$symb,$error,$senderuname,$senderdom,$recipid) = @_;
my $sentsubj;
if ($numsent > 1) {
$sentsubj = $subj_prefix.' ('.$numsent.' sent) '.$msgsubj;
} else {
if ($subj_prefix) {
$sentsubj = $subj_prefix.' ';
}
$sentsubj .= $msgsubj;
}
$sentsubj = &HTML::Entities::encode($sentsubj,'<>&"');
my $sentmsgid =
&buildmsgid($stamp,$sentsubj,$msgname,$msgdom,$msgcount,$context,$pid);
(undef,my $sentmessage) =
&packagemsg($msgsubj,$savemsg,undef,$baseurl,$attachmenturl,$recusers,
$recudoms,$sentmsgid,undef,undef,$symb,$error,$recipid);
my $status = &store_sent_mail($sentmsgid,$sentmessage,$senderuname,
$senderdom);
return $status;
}
sub store_sent_mail {
my ($msgid,$message,$senderuname,$senderdom) = @_;
if ($senderuname eq '') {
$senderuname = $env{'user.name'};
}
if ($senderdom eq '') {
$senderdom = $env{'user.domain'};
}
my $status =' '.&Apache::lonnet::cput('nohist_email_sent',
{$msgid => $message},
$senderdom,$senderuname);
return $status;
}
sub store_recipients {
my ($subject,$sendername,$senderdom,$reciphash) = @_;
my $context = &get_course_context();
my $now = time();
my $msgcount = &get_uniq();
my $recipid =
&buildmsgid($now,$subject,$sendername,$senderdom,$msgcount,$context,$$);
my %recipinfo = (
$recipid => $reciphash,
);
my $status = &Apache::lonnet::put('nohist_emailrecip',\%recipinfo,
$senderdom,$sendername);
if ($status eq 'ok') {
return ($recipid,$status);
} else {
return (undef,$status);
}
}
sub foldersuffix {
my $folder=shift;
unless ($folder) { return ''; }
my $suffix;
my %folderhash = &get_user_folders($folder);
if (ref($folderhash{$folder}) eq 'HASH') {
$suffix = '_'.&escape($folderhash{$folder}{'id'});
} else {
$suffix = '_'.&escape($folder);
}
return $suffix;
}
sub get_user_folders {
my ($folder) = @_;
my %userfolders =
&Apache::lonnet::dump('email_folders',undef,undef,$folder);
my $lock = "\0".'lock_counter'; # locks db while counter incremented
my $counter = "\0".'idcount'; # used in suffix for email db files
if (defined($userfolders{$lock})) {
delete($userfolders{$lock});
}
if (defined($userfolders{$counter})) {
delete($userfolders{$counter});
}
return %userfolders;
}
sub secapply {
my $rec=shift;
my $defaultflag=shift;
$rec=~s/\s+//g;
unless ($rec =~ /\:/) {
$rec=~s/\@/\:/g;
}
my ($adr,$sections_or_groups)=($rec=~/^([^\(]+)\(([^\)]+)\)/);
if ($sections_or_groups) {
foreach my $item (split(/\;/,$sections_or_groups)) {
if (($item eq $env{'request.course.sec'}) ||
($defaultflag && ($item eq '*'))) {
return $adr;
} elsif ($env{'request.course.groups'}) {
my @usersgroups = split(/:/,$env{'request.course.groups'});
if (grep(/^\Q$item\E$/,@usersgroups)) {
return $adr;
}
}
}
} else {
return $rec;
}
return '';
}
sub decide_receiver {
my ($feedurl,$author,$question,$course,$policy,$defaultflag) = @_;
&Apache::lonenc::check_decrypt(\$feedurl);
my $typestyle='';
my %to=();
if ($env{'form.discuss'} eq 'author' ||$author) {
$typestyle.='Submitting as Author Feedback<br />';
$feedurl=~ m{^/res/($LONCAPA::domain_re)/($LONCAPA::username_re)/};
$to{$2.':'.$1}=1;
}
my $cid = $env{'request.course.id'};
if ($env{'form.discuss'} eq 'question' ||$question) {
$typestyle.=&mt('Submitting as Question').'<br />';
foreach my $item (split(/\,/,$env{'course.'.$cid.'.question.email'})) {
my $rec=&secapply($item,$defaultflag);
if ($rec) { $to{$rec}=1; }
}
}
if ($env{'form.discuss'} eq 'course' ||$course) {
$typestyle.=&mt('Submitting as Comment').'<br />';
foreach my $item (split(/\,/,$env{'course.'.$cid.'.comment.email'})) {
my $rec=&secapply($item,$defaultflag);
if ($rec) { $to{$rec}=1; }
}
}
if ($env{'form.discuss'} eq 'policy' ||$policy) {
$typestyle.=&mt('Submitting as Policy Feedback').'<br />';
foreach my $item (split(/\,/,$env{'course.'.$cid.'.policy.email'})) {
my $rec=&secapply($item,$defaultflag);
if ($rec) { $to{$rec}=1; }
}
}
if ((scalar(%to) eq '0') && (!$defaultflag)) {
($typestyle,%to)=
&decide_receiver($feedurl,$author,$question,$course,$policy,1);
}
return ($typestyle,%to);
}
1;
__END__
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