--- loncom/interface/lonmsg.pm 2001/02/06 16:51:24 1.6 +++ loncom/interface/lonmsg.pm 2006/04/23 04:04:38 1.182 @@ -1,66 +1,145 @@ # The LearningOnline Network with CAPA -# # Routines for messaging # -# (Routines to control the menu +# $Id: lonmsg.pm,v 1.182 2006/04/23 04:04:38 albertel 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. # -# (TeX Conversion Module +# 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. # -# 05/29/00,05/30 Gerd Kortemeyer) +# 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 # -# 10/05 Gerd Kortemeyer) +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ # -# 10/19,10/20,10/30, -# 02/06/01 Gerd Kortemeyer package Apache::lonmsg; use strict; -use Apache::lonnet(); -use vars qw($msgcount); -use HTML::TokeParser; -use Apache::Constants qw(:common); +use Apache::lonnet; +use HTML::TokeParser(); +use Apache::lonlocal; +use Mail::Send; + +{ + my $uniq; + sub get_uniq { + $uniq++; + return $uniq; + } +} # ===================================================================== Package sub packagemsg { - my ($subject,$message)=@_; - $message=~s/\/\>\;/g; - $subject=~s/\/\>\;/g; + my ($subject,$message,$citation,$baseurl,$attachmenturl, + $recuser,$recdomain,$msgid,$type,$crsmsgid)=@_; + $message =&HTML::Entities::encode($message,'<>&"'); + $citation=&HTML::Entities::encode($citation,'<>&"'); + $subject =&HTML::Entities::encode($subject,'<>&"'); + #remove machine specification + $baseurl =~ s|^http://[^/]+/|/|; + $baseurl =&HTML::Entities::encode($baseurl,'<>&"'); + #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); - $partsubj=substr($partsubj,0,50); - my $msgid=&Apache::lonnet::escape( - $now.':'.$partsubj.':'.$ENV{'user.name'}.':'. - $ENV{'user.domain'}.':'.$msgcount.':'.$$); - return $msgid, - ''.$ENV{'user.name'}.''. - ''.$ENV{'user.domain'}.''. + my $msgcount = &get_uniq(); + 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'}.''. + ''; + 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'}.''. - ''.$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.role'}.''. - ''.$ENV{'request.filename'}.''. - ''.$msgid.''. - ''.$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.''; + } + if (defined($baseurl)) { + $result.= ''.$baseurl.''; + } + if (defined($attachmenturl)) { + $result.= ''.$attachmenturl.''; + } + return $msgid,$result; } # ================================================== Unpack message into a hash sub unpackagemsg { - my $message=shift; + my ($message,$notoken)=@_; my %content=(); my $parser=HTML::TokeParser->new(\$message); my $token; @@ -68,7 +147,28 @@ 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 (!exists($content{'recuser'})) { $content{'recuser'} = []; } + if ($content{'attachmenturl'}) { + my ($fname)=($content{'attachmenturl'}=~m|/([^/]+)$|); + if ($notoken) { + $content{'message'}.='

'.&mt('Attachment').': '.$fname.''; + } else { + &Apache::lonnet::allowuploaded('/adm/msg', + $content{'attachmenturl'}); + $content{'message'}.='

'.&mt('Attachment'). + ': '. + $fname.''; } } return %content; @@ -76,19 +176,102 @@ 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=shift; - my ($sendtime,$shortsubj,$fromname,$fromdomain)=split(/\:/, - &Apache::lonnet::unescape( - &Apache::lonnet::unescape($_))); - my %status=&Apache::lonnet::get('email_status',$msgid); - if ($status{$msgid}=~/^error\:/) { $status{$msgid}=''; } - unless ($status{$msgid}) { $status{$msgid}='new'; } - return ($sendtime,$shortsubj,$fromname,$fromdomain,$status{$msgid}); -} + my ($msgid,$folder,$skipstatus,$status_cache)=@_; + $msgid=&Apache::lonnet::unescape($msgid); + my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$fromcid, + $processid)=split(/\:/,&Apache::lonnet::unescape($msgid)); + $shortsubj = &Apache::lonnet::unescape($shortsubj); + $shortsubj = &HTML::Entities::decode($shortsubj); + 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); +} + + +sub sendemail { + my ($to,$subject,$body)=@_; + $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; + my $msg = new Mail::Send; + $msg->to($to); + $msg->subject('[LON-CAPA] '.$subject); + if (my $fh = $msg->open()) { + print $fh $body; + $fh->close; + } +} + +# ==================================================== Send notification emails + +sub sendnotification { + my ($to,$touname,$toudom,$subj,$crit,$text)=@_; + my $sender=$env{'environment.firstname'}.' '.$env{'environment.lastname'}; + unless ($sender=~/\w/) { + $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=(<300) { + my %what=&Apache::lonnet::get('email_status',['recnewemail']); + &Apache::lonnet::appenv('user.mailcheck.time'=>time); + 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)=@_; unless ($message) { return 'empty'; } @@ -97,6 +280,8 @@ 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. @@ -107,160 +292,285 @@ sub author_res_msg { 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 %errormsgs=&Apache::lonnet::dump('nohist_res_msgs',$domain,$author); + my $msgs=''; + foreach (keys %errormsgs) { + if ($_=~/^\Q$url\E\_\d+$/) { + my %content=&unpackagemsg($errormsgs{$_}); + $msgs.='

'. + $content{'time'}.': '.$content{'message'}. + '

'; + } + } + return $msgs; +} + + +# =============================== 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 @delmsgs=(); + foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) { + if ($_=~/^\Q$url\E\_\d+$/) { + push (@delmsgs,$_); + } + } + 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 { + my ($author,$domain)=@_; + my %returnhash=(); + foreach (&Apache::lonnet::getkeys('nohist_res_msgs',$domain,$author)) { + $_=~/^(.+)\_\d+/; + $returnhash{$1}=1; + } + return %returnhash; +} + # ================================================== Critical message to a user -sub user_crit_msg { - my ($user,$domain,$subject,$message)=@_; +sub user_crit_msg_raw { + my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage)=@_; # Check if allowed missing my $status=''; my $msgid='undefined'; unless (($message)&&($user)&&($domain)) { $status='empty'; }; + my $text=$message; my $homeserver=&Apache::lonnet::homeserver($user,$domain); if ($homeserver ne 'no_host') { - my $msgid; ($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 (defined($sentmessage)) { + $$sentmessage = $message; + } } else { $status='no_host'; } +# Notifications + my %userenv = &Apache::lonnet::get('environment',['critnotification', + 'permanentemail'], + $domain,$user); + if ($userenv{'critnotification'}) { + &sendnotification($userenv{'critnotification'},$user,$domain,$subject,1, + $text); + } + if ($toperm && $userenv{'permanentemail'}) { + &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,1, + $text); + } +# Log this &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; } +# 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,$sentmessage)=@_; + 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,$sentmessage).' '; + } + } else { + $status=&user_crit_msg_raw($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage); + } + return $status; +} + # =================================================== Critical message received sub user_crit_received { - my $message=shift; - my %contents=&unpackagemsg($message); - my $status='rec: '. + my $msgid=shift; + my %message=&Apache::lonnet::get('critical',[$msgid]); + my %contents=&unpackagemsg($message{$msgid},1); + my $status='rec: '.($contents{'sendback'}? &user_normal_msg($contents{'sendername'},$contents{'senderdomain'}, - 'Receipt: '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}, - 'User '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}. - ' acknowledged receipt of message "'. - $contents{'subject'}.'" dated '.$contents{'time'}.".\n\n" - .'Message ID: '.$contents{'msgid'}); + &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); + &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 '. + &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; } # ======================================================== Normal communication -sub user_normal_msg { - my ($user,$domain,$subject,$message)=@_; +sub user_normal_msg_raw { + my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl, + $toperm,$currid,$newid,$sentmessage,$crsmsgid)=@_; # 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') { - my $msgid; - ($msgid,$message)=&packagemsg($subject,$message); + ($msgid,$packed_message)= + &packagemsg($subject,$message,$citation,$baseurl, + $attachmenturl,$user,$domain,$currid, + undef,$crsmsgid); + +# Store in user folder $status=&Apache::lonnet::critical( 'put:'.$domain.':'.$user.':nohist_email:'. &Apache::lonnet::escape($msgid).'='. - &Apache::lonnet::escape($message),$homeserver); + &Apache::lonnet::escape($packed_message),$homeserver); +# Save new message received time + &Apache::lonnet::put + ('email_status',{'recnewemail'=>time},$domain,$user); +# 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'}) + || &Apache::lonnet::allowed('srm',$env{'request.course.id'}. + '/'.$env{'request.course.sec'})))) { + (undef, my $packed_message_no_citation)= + &packagemsg($subject,$message,undef ,$baseurl, + $attachmenturl,$user,$domain,$currid, + undef,$crsmsgid); + + $status .= &store_sent_mail($msgid,$packed_message_no_citation); + } } else { $status='no_host'; } - &Apache::lonnet::log($ENV{'user.domain'},$ENV{'user.name'}, - $ENV{'user.home'}, + if (defined($newid)) { + $$newid = $msgid; + } + if (defined($sentmessage)) { + $$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); return $status; } -# ===================================================================== Handler - -sub handler { - my $r=shift; - -# ----------------------------------------------------------- Set document type +# New routine that respects "forward" and calls old routine - $r->content_type('text/html'); - $r->send_http_header; +=pod - return OK if $r->header_only; +=item * B: Sends a message to the + $user at $domain, with subject $subject and message $message. -# --------------------------- Get query string for limited number of parameters +=cut - map { - my ($name, $value) = split(/=/,$_); - $value =~ tr/+/ /; - $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg; - if (($name eq 'display') || ($name eq 'replyto') || - ($name eq 'forward') || ($name eq 'mark')) { - unless ($ENV{'form.'.$name}) { - $ENV{'form.'.$name}=$value; - } - } - } (split(/&/,$ENV{'QUERY_STRING'})); - -# --------------------------------------------------------------- Render Output - - $r->print('EMail and Messaging'); - $r->print(''); - $r->print('

EMail

'); - if ($ENV{'form.display'}) { - } elsif ($ENV{'form.replyto'}) { - } elsif ($ENV{'form.forward'}) { - } elsif ($ENV{'form.mark'}) { - } else { - $r->print(''. - ''); - map { - my ($sendtime,$shortsubj,$fromname,$fromdomain,$status)= - &Apache::lonmsg::unpackmsgid($_); - if ($status eq 'new') { - $r->print(''); - } elsif ($status eq 'read') { - $r->print(''); - } elsif ($status eq 'replied') { - $r->print(''); - } else { - $r->print(''); +sub user_normal_msg { + my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl, + $toperm,$sentmessage)=@_; + 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, + undef,undef,$sentmessage).' '; } - $r->print(''); - } sort split(/\&/,&Apache::lonnet::reply('keys:'. - $ENV{'user.domain'}.':'. - $ENV{'user.name'}.':nohist_email', - $ENV{'user.home'})); - $r->print('
 DateUsernameDomainSubjectStatus
Open'.localtime($sendtime).''. - $fromname.''.$fromdomain.''. - &Apache::lonnet::unescape($shortsubj).''. - $status.'
'); - - } - $r->print(''); - return OK; + } else { + $status=&user_normal_msg_raw($user,$domain,$subject,$message, + $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; } -# ================================================= Main program, reset counter -sub BEGIN { - $msgcount=0; +# =============================================================== Folder suffix + +sub foldersuffix { + my $folder=shift; + unless ($folder) { return ''; } + return '_'.&Apache::lonnet::escape($folder); } 1; __END__ - - - - - -