--- loncom/interface/lonmsg.pm 2003/03/17 17:02:38 1.50 +++ loncom/interface/lonmsg.pm 2007/05/09 23:53:15 1.208 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Routines for messaging # -# $Id: lonmsg.pm,v 1.50 2003/03/17 17:02:38 albertel Exp $ +# $Id: lonmsg.pm,v 1.208 2007/05/09 23:53:15 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,81 +25,183 @@ # # http://www.lon-capa.org/ # -# -# (Routines to control the menu -# -# (TeX Conversion Module -# -# 05/29/00,05/30 Gerd Kortemeyer) -# -# 10/05 Gerd Kortemeyer) -# -# 10/19,10/20,10/30, -# 02/06/01 Gerd Kortemeyer -# 07/27 Guy Albertelli -# 07/27,07/28,07/30,08/03,08/06,08/08,08/09,08/10,8/13,8/15, -# 10/1,11/5 Gerd Kortemeyer -# YEAR=2002 -# 1/1,3/18 Gerd Kortemeyer -# + 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 $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 + +=cut + use strict; -use Apache::lonnet(); -use vars qw($msgcount); +use Apache::lonnet; use HTML::TokeParser(); -use Apache::Constants qw(:common); -use Apache::loncommon(); -use Apache::lontexconvert(); -use HTML::Entities(); +use Apache::lonlocal; +use Mail::Send; +use LONCAPA qw(:DEFAULT :match); + +{ + my $uniq; + sub get_uniq { + $uniq++; + return $uniq; + } +} # ===================================================================== Package sub packagemsg { - my ($subject,$message,$citation,$baseurl)=@_; - $message =&HTML::Entities::encode($message); - $citation=&HTML::Entities::encode($citation); - $subject =&HTML::Entities::encode($subject); + my ($subject,$message,$citation,$baseurl,$attachmenturl, + $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 =&HTML::Entities::encode($baseurl); + $baseurl =&HTML::Entities::encode($baseurl,'<>&"'); + #remove machine specification + $attachmenturl =~ s|^http://[^/]+/|/|; + $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.':'.$$); - my $result=''.$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,$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'}.''. - ''.$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 = &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.''; } if (defined($baseurl)) { $result.= ''.$baseurl.''; } - return $msgid,$result; + if (defined($attachmenturl)) { + $result.= ''.$attachmenturl.''; + } + 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; + if (defined($env{'form.replyid'})) { + my ($sendtime,$shortsubj,$fromname,$fromdomain,$count,$origcid)= + split(/\:/,&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(/\:/,&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=shift; + my ($message,$notoken)=@_; my %content=(); my $parser=HTML::TokeParser->new(\$message); my $token; @@ -107,7 +209,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; @@ -115,20 +238,152 @@ sub unpackagemsg { # ======================================================= 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=&Apache::lonnet::unescape(shift); - my ($sendtime,$shortsubj,$fromname,$fromdomain)=split(/\:/, - &Apache::lonnet::unescape($msgid)); - 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=&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 %senderemails=&Apache::loncommon::getemails(); + my $senderaddress=''; + foreach my $type ('notification','permanentemail','critnotification') { + if ($senderemails{$type}) { + $senderaddress=$senderemails{$type}; + } + } + $body= + "*** ".&mt('This is an automatic message generated by the LON-CAPA system.')."\n". + "*** ".($senderaddress?&mt('You can reply to this message'):&mt('Please do not reply to this address.')."\n*** ". + &mt('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 ($senderaddress) { $msg->add('Reply-to',$senderaddress); $msg->add('From',$senderaddress); } + if (my $fh = $msg->open()) { + print $fh $body; + $fh->close; + } +} +# ==================================================== Send notification emails + +sub sendnotification { + 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'}; + } + my $critical=($crit?' critical':''); + + $text=~s/\<\;/\/gs; + my $url='http://'. + &Apache::lonnet::hostname(&Apache::lonnet::homeserver($touname,$toudom)). + '/adm/email?username='.$touname.'&domain='.$toudom; + my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid, + $symb,$error) = &Apache::lonmsg::unpackmsgid($msgid); + my ($coursetext,$body,$bodybegin,$bodysubj,$bodyend); + if ($fromcid ne '') { + $coursetext = "\n".&mt('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('You received a'.$critical.' message from [_1] in LON-CAPA.',$sender).' '; + $bodysubj = &mt('The subject is + + [_1] + +',$subj)."\n". +'=== '.&mt('Excerpt')." ============================================================ +"; + $bodyend = " +======================================================================== + +".&mt('Use + + [_1] + +to access the full message.',$url); + my %userenv = &Apache::lonnet::get('environment',['notifywithhtml'],$toudom,$touname); + my $subject = &mt("'New' $critical message from ").$sender; + + my ($blocked,$blocktext); + if (!$crit) { + my %setters; + my ($startblock,$endblock) = + &Apache::loncommon::blockcheck(\%setters,'com',$touname,$toudom); + if ($startblock && $endblock) { + $blocked = 1; + my $showstart = localtime($startblock); + my $showend = localtime($endblock); + $blocktext = &mt('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); + } + } + if ($userenv{'notifywithhtml'} ne '') { + my @htmlexcerpt = split(/,/,$userenv{'notifywithhtml'}); + foreach my $addr (@recipients) { + if ($blocked) { + $body = $bodybegin."\n".$blocktext."\n".$bodyend; + } else { + my $sendtext = $text; + if (!grep/^\Q$addr\E/,@htmlexcerpt) { + $sendtext =~ s/\<\/*[^\>]+\>//gs; + } + $body = $bodybegin.$bodysubj.$sendtext.$bodyend; + } + &sendemail($addr,$subject,$body); + } + } else { + if ($blocked) { + $body = $bodybegin."\n".$blocktext."\n".$bodyend; + } else { + $text =~ s/\<\/*[^\>]+\>//gs; + $body = $bodybegin.$bodysubj.$text.$bodyend; + } + &sendemail($to,$subject,$body); + } +} # ============================================================= Check for email sub newmail { - if ((time-$ENV{'user.mailcheck.time'})>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; } @@ -138,6 +393,13 @@ sub newmail { # =============================== 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'; } @@ -146,47 +408,144 @@ 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=~/^($match_domain)\/($match_username)\//); + 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=~/^($match_domain)\/($match_username)\//); + 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=~/^($match_domain)\/($match_username)\//); + 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; +} + +# ====================================== Add a comment to the User Notes screen + +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; +} + # ================================================== Critical message to a user sub user_crit_msg_raw { - my ($user,$domain,$subject,$message,$sendback)=@_; + my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage, + $nosentstore,$recipid)=@_; # 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'; } + ($msgid,$packed_message)=&packagemsg($subject,$message,undef,undef, + undef,undef,undef,undef,undef,undef,undef, + undef,$recipid); + if ($sendback) { $packed_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); - } + &escape($msgid).'='. + &escape($packed_message),$homeserver); + if (defined($sentmessage)) { + $$sentmessage = $packed_message; + } + if (!$nosentstore) { + (undef,my $packed_message_no_citation) = + &packagemsg($subject,$message,undef,undef,undef,$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::loncommon::getemails($user,$domain); + if ($userenv{'critnotification'}) { + &sendnotification($userenv{'critnotification'},$user,$domain,$subject,1, + $text,$msgid); + } + if ($toperm && $userenv{'permanentemail'}) { + &sendnotification($userenv{'permanentemail'},$user,$domain,$subject,1, + $text,$msgid); + } +# 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; @@ -194,23 +553,47 @@ sub user_crit_msg_raw { # 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 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 + +=cut + sub user_crit_msg { - my ($user,$domain,$subject,$message,$sendback)=@_; - my $status=''; + my ($user,$domain,$subject,$message,$sendback,$toperm,$sentmessage, + $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_crit_msg_raw($forwuser,$forwdomain,$subject,$message, - $sendback).' '; + 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)); } } else { - $status=&user_crit_msg_raw($user,$domain,$subject,$message,$sendback); + push(@status, + &user_crit_msg_raw($user,$domain,$subject,$message,$sendback, + $toperm,$sentmessage,$nosentstore,$recipid)); } - return $status; + if (wantarray) { + return @status; + } + return join(' ',@status); } # =================================================== Critical message received @@ -218,22 +601,32 @@ sub user_crit_msg { sub user_crit_received { my $msgid=shift; my %message=&Apache::lonnet::get('critical',[$msgid]); - my %contents=&unpackagemsg($message{$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'}, - 'Receipt: '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}, - 'User '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}. - ' acknowledged receipt of message'."\n".' "'. - $contents{'subject'}.'"'."\n".'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}}); $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; @@ -242,665 +635,296 @@ sub user_crit_received { # ======================================================== Normal communication sub user_normal_msg_raw { - my ($user,$domain,$subject,$message,$citation,$baseurl)=@_; + my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl, + $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); + ($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); + &escape($msgid).'='. + &escape($packed_message),$homeserver); +# Save new message received time &Apache::lonnet::put ('email_status',{'recnewemail'=>time},$domain,$user); - } else { +# 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::loncommon::getemails($user,$domain); + if ($userenv{'notification'}) { + &sendnotification($userenv{'notification'},$user,$domain,$subject,0, + $text,$msgid); + } + if ($toperm && $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'; - } - &Apache::lonnet::log($ENV{'user.domain'},$ENV{'user.name'}, - $ENV{'user.home'}, - 'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status); + } 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. + + 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 + +=cut + sub user_normal_msg { - my ($user,$domain,$subject,$message,$citation,$baseurl)=@_; - my $status=''; + my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl, + $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).' '; - } - } else { - $status=&user_normal_msg_raw($user,$domain,$subject,$message, - $citation,$baseurl); + foreach (split(/\,/,$msgforward)) { + my ($forwuser,$forwdomain)=split(/\:/,$_); + push(@status, + &user_normal_msg_raw($forwuser,$forwdomain,$subject,$message, + $citation,$baseurl,$attachmenturl,$toperm, + undef,undef,$sentmessage,undef,$symb, + $restitle,$error,$nosentstore,$recipid)); + } + } else { + push(@status,&user_normal_msg_raw($user,$domain,$subject,$message, + $citation,$baseurl,$attachmenturl,$toperm, + undef,undef,$sentmessage,undef,$symb, + $restitle,$error,$nosentstore,$recipid)); + } + 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,$senderhome) = @_; + 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); + my $status = &store_sent_mail($sentmsgid,$sentmessage,$senderuname, + $senderdom,$senderhome); return $status; } - -# =============================================================== Status Change - -sub statuschange { - my ($msgid,$newstatus)=@_; - my %status=&Apache::lonnet::get('email_status',[$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',{$msgid => $newstatus}); - } - if (($newstatus eq 'deleted') || ($newstatus eq 'new')) { - &Apache::lonnet::put('email_status',{$msgid => $newstatus}); - } +sub store_sent_mail { + my ($msgid,$message,$senderuname,$senderdom,$senderhome) = @_; + if ($senderuname eq '') { + $senderuname = $env{'user.name'}; + } + if ($senderdom eq '') { + $senderdom = $env{'user.domain'}; + } + if ($senderhome eq '') { + $senderhome = $env{'user.home'}; + } + my $status =' '.&Apache::lonnet::critical( + 'put:'.$senderdom.':'.$senderuname.':nohist_email_sent:'. + &escape($msgid).'='.&escape($message),$senderhome); + return $status; } -# ======================================================= Display a course list - -sub discourse { - my $r=shift; - my %courselist=&Apache::lonnet::dump( - 'classlist', - $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}, - $ENV{'course.'.$ENV{'request.course.id'}.'.num'}); - my $now=time; - $r->print(< - -  - -  - -

-ENDDISHEADER - foreach (sort keys %courselist) { - my ($end,$start)=split(/\:/,$courselist{$_}); - my $active=1; - if (($end) && ($now>$end)) { $active=0; } - if ($active) { - my ($sname,$sdom)=split(/\:/,$_); - my %reply=&Apache::lonnet::get('environment', - ['firstname','middlename','lastname','generation'], - $sdom,$sname); - my $section=&Apache::lonnet::usection - ($sdom,$sname,$ENV{'request.course.id'}); - $r->print( - '
'. - $reply{'firstname'}.' '. - $reply{'middlename'}.' '. - $reply{'lastname'}.' '. - $reply{'generation'}. - ' ('.$_.') '.$section); - } +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); } } -# ==================================================== Display Critical Message - -sub discrit { - my $r=shift; - my $header = '

Critical Messages

'. - '
'. - ''; - my %what=&Apache::lonnet::dump('critical'); - my $result = ''; - foreach (sort keys %what) { - my %content=&unpackagemsg($what{$_}); - next if ($content{'senderdomain'} eq ''); - $content{'message'}=~s/\n/\/g; - $result.='
From: '. -&Apache::loncommon::aboutmewrapper( - &Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).' ('. -$content{'sendername'}.'@'. - $content{'senderdomain'}.') '.$content{'time'}. - '
Subject: '.$content{'subject'}. - '
'. - &Apache::lontexconvert::msgtexconverted($content{'message'}). - '
'. - ''. - ''; - } - # Check to see if there were any messages. - if ($result eq '') { - $result = "

You have no critical messages.

"; +# =============================================================== Folder suffix + +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 { - $r->print($header); + $suffix = '_'.&escape($folder); } - $r->print($result); - $r->print(''); + return $suffix; } -# =============================================================== Compose reply +# ========================================================= User-defined folders -sub comprep { - my ($r,$msgid)=@_; - my %message=&Apache::lonnet::get('nohist_email',[$msgid]); - my %content=&unpackagemsg($message{$msgid}); - my $quotemsg='> '.$content{'message'}; - $quotemsg=~s/\r/\n/g; - $quotemsg=~s/\f/\n/g; - $quotemsg=~s/\n+/\n\> /g; - my $subject='Re: '.$content{'subject'}; - my $dispcrit=''; - if (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) { - my $crithelp = Apache::loncommon::help_open_topic("Course_Critical_Message"); - $dispcrit= - ' Send as critical message ' . $crithelp . - '
'. - ' Send as critical message ' . - ' and return receipt' . $crithelp . '

'; - } - $r->print(<<"ENDREPLY"); -

- -Subject:

-

-$dispcrit - -

-ENDREPLY -} - -# ======================================================== Display all messages - -sub disall { - my $r=shift; - $r->print(< - function checkall() { - for (i=0; i -ENDDISHEADER - $r->print( - '

Display All Messages

'. - ''. - ''); - foreach (sort split(/\&/,&Apache::lonnet::reply('keys:'. - $ENV{'user.domain'}.':'. - $ENV{'user.name'}.':nohist_email', - $ENV{'user.home'}))) { - my ($sendtime,$shortsubj,$fromname,$fromdomain,$status)= - &Apache::lonmsg::unpackmsgid($_); - if (($status ne 'deleted') && defined($sendtime) && $sendtime!~/error/) { - if ($status eq 'new') { - $r->print(''); - } elsif ($status eq 'read') { - $r->print(''); - } elsif ($status eq 'replied') { - $r->print(''); - } else { - $r->print(''); - } - $r->print(''. - ''); - } - } - $r->print('
 DateUsernameDomainSubjectStatus
OpenDelete'.localtime($sendtime).''. - $fromname.''.$fromdomain.''. - &Apache::lonnet::unescape($shortsubj).''. - $status.'

'. - 'Check All '. - 'Uncheck All

'. - ''. - '

'); -} - -# ============================================================== Compose output - -sub compout { - my ($r,$forwarding,$broadcast)=@_; - my $dispcrit=''; - my $dissub=''; - my $dismsg=''; - my $func='Send New'; - if (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) { - my $crithelp = Apache::loncommon::help_open_topic("Course_Critical_Message"); - $dispcrit= - ' Send as critical message ' . $crithelp . - '
'. - ' Send as critical message ' . - ' and return receipt' . $crithelp . '

'; - } - if ($forwarding) { - $dispcrit.=''; - $func='Forward'; - my %message=&Apache::lonnet::get('nohist_email',[$forwarding]); - my %content=&unpackagemsg($message{$forwarding}); - - $dissub='Forwarding: '.$content{'subject'}; - $dismsg='Forwarded message from '. - $content{'sendername'}.' at '.$content{'senderdomain'}; - } - my $defdom=$ENV{'user.domain'}; - if ($ENV{'form.recdom'}) { $defdom=$ENV{'form.recdom'}; } - $r->print( - '

'."\n". - ''."\n". - ''); - unless (($broadcast eq 'group') || ($broadcast eq 'upload')) { - my $domform = &Apache::loncommon::select_dom_form($defdom,'recdomain'); - my $selectlink=&Apache::loncommon::selectstudent_link - ('compemail','recuname','recdomain'); - $r->print(<<"ENDREC"); -
- - - -ENDREC - } - if ($broadcast ne 'upload') { - $r->print(<<"ENDCOMP"); - -
Username:$selectlink
Domain:$domform
Additional Recipients
username\@domain,username\@domain, ... -		 -
Subject: -
-

-$dispcrit - -ENDCOMP - } else { # $broadcast is 'upload' - $r->print(< -

Generate messages from a file

-

-Subject: -

-

General message text
-

-

-The file format for the uploaded portion of the message is: -

-username1\@domain1: text
-username2\@domain2: text
-username3\@domain1: text
-
-

-

-The messages will be assembled from all lines with the respective -username\@domain, and appended to the general message text.

-

-

-$dispcrit - -ENDUPLOAD - } - if ($broadcast eq 'group') { - &discourse; - } - $r->print('

'); -} - -# ---------------------------------------------------- Display all face to face - -sub disfacetoface { - my ($r,$user,$domain)=@_; - unless ($ENV{'request.course.id'}) { return; } - unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) { - return; - } - my %records=&Apache::lonnet::dump('nohist_email', - $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}, - $ENV{'course.'.$ENV{'request.course.id'}.'.num'}, - '%255b'.$user.'%253a'.$domain.'%255d'); - my $result=''; - foreach (sort keys %records) { - my %content=&unpackagemsg($records{$_}); - next if ($content{'senderdomain'} eq ''); - $content{'message'}=~s/\n/\/g; - if ($content{'subject'}=~/^Record/) { - $result.='

Record

'; - } else { - $result.='

Sent Message

'; - %content=&unpackagemsg($content{'message'}); - $content{'message'}= - 'Subject: '.$content{'subject'}.'
'. - $content{'message'}; - } - $result.='By: '. -&Apache::loncommon::aboutmewrapper( - &Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).' ('. -$content{'sendername'}.'@'. - $content{'senderdomain'}.') '.$content{'time'}. - '
'. - &Apache::lontexconvert::msgtexconverted($content{'message'}). - '
'; - } - # Check to see if there were any messages. - if ($result eq '') { - $r->print("

No notes, face-to-face discussion records, or critical messages in this course.

"); } else { - $r->print($result); + return $rec; } + return ''; } -# ---------------------------------------------------------------- Face to face +=pod -sub facetoface { - my ($r,$stage)=@_; - unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) { - return; - } -# from query string - if ($ENV{'form.recname'}) { $ENV{'form.recuname'}=$ENV{'form.recname'}; } - if ($ENV{'form.recdom'}) { $ENV{'form.recdomain'}=$ENV{'form.recdom'}; } - - my $defdom=$ENV{'user.domain'}; -# already filled in - if ($ENV{'form.recdomain'}) { $defdom=$ENV{'form.recdomain'}; } -# generate output - my $domform = &Apache::loncommon::select_dom_form($defdom,'recdomain'); - my $stdbrws = &Apache::loncommon::selectstudent_link - ('stdselect','recuname','recdomain'); - $r->print(<<"ENDTREC"); -

User Notes, Records of Face-To-Face Discussions, and Critical Messages in Course

-
- - - - - - - -
Username: -$stdbrws -
Domain:$domform
-
-ENDTREC - if (($stage ne 'query') && - ($ENV{'form.recdomain'}) && ($ENV{'form.recuname'})) { - chomp($ENV{'form.newrecord'}); - if ($ENV{'form.newrecord'}) { - &user_normal_msg_raw( - $ENV{'course.'.$ENV{'request.course.id'}.'.num'}, - $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}, - 'Record ['.$ENV{'form.recuname'}.':'.$ENV{'form.recdomain'}.']', - $ENV{'form.newrecord'}); - } - $r->print('

'.&Apache::loncommon::plainname($ENV{'form.recuname'}, - $ENV{'form.recdomain'}).'

'); - &disfacetoface($r,$ENV{'form.recuname'},$ENV{'form.recdomain'}); - $r->print(< - - -ENDRHEAD - $r->print(<New Record (record is visible to course faculty and staff)
- -
- - - -ENDBFORM - } -} - -# ===================================================================== Handler - -sub handler { - my $r=shift; - -# ----------------------------------------------------------- Set document type - - $r->content_type('text/html'); - $r->send_http_header; - - return OK if $r->header_only; - -# --------------------------- Get query string for limited number of parameters - &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, - ['display','replyto','forward','markread','markdel','markunread', - 'sendreply','compose','sendmail','critical','recname','recdom', - 'recordftf']); - -# ------------------------------------------------------ They checked for email - &Apache::lonnet::put('email_status',{'recnewemail'=>0}); -# --------------------------------------------------------------- Render Output - if (!$ENV{'form.display'}) { - $r->print('EMail and Messaging'. - &Apache::loncommon::studentbrowser_javascript().''. - &Apache::loncommon::bodytag('EMail and Messages')); - } - if ($ENV{'form.display'}) { - my $msgid=$ENV{'form.display'}; - &statuschange($msgid,'read'); - my %message=&Apache::lonnet::get('nohist_email',[$msgid]); - my %content=&unpackagemsg($message{$msgid}); - $r->print('EMail and Messaging'); - if (defined($content{'baseurl'})) { - $r->print(""); - } - $r->print(&Apache::loncommon::studentbrowser_javascript(). - ''. - &Apache::loncommon::bodytag('EMail and Messages')); - $r->print('Subject: '.$content{'subject'}. - '
From: '. -&Apache::loncommon::aboutmewrapper( -&Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}), -$content{'sendername'},$content{'senderdomain'}).' ('. - $content{'sendername'}.' at '. - $content{'senderdomain'}.') '. - '
Time: '.$content{'time'}.'

'. - ''. - ''. - ''. - ''. - ''. - ''. - '
Functions:ReplyForwardMark UnreadDeleteDisplay all Messages

'.
-             &Apache::lontexconvert::msgtexconverted($content{'message'}).
-             '
'.$content{'citation'}); - } elsif ($ENV{'form.replyto'}) { - &comprep($r,$ENV{'form.replyto'}); - } elsif ($ENV{'form.sendreply'}) { - my $msgid=$ENV{'form.sendreply'}; - my %message=&Apache::lonnet::get('nohist_email',[$msgid]); - my %content=&unpackagemsg($message{$msgid}); - &statuschange($msgid,'replied'); - if ((($ENV{'form.critmsg'}) || ($ENV{'form.sendbck'})) && - (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'}))) { - $r->print('Sending critical: '. - &user_crit_msg($content{'sendername'}, - $content{'senderdomain'}, - $ENV{'form.subject'}, - $ENV{'form.message'}, - $ENV{'form.sendbck'})); - } else { - $r->print('Sending: '.&user_normal_msg($content{'sendername'}, - $content{'senderdomain'}, - $ENV{'form.subject'}, - $ENV{'form.message'})); - } - if ($ENV{'form.displayedcrit'}) { - &discrit($r); - } else { - &disall($r); - } - } elsif ($ENV{'form.confirm'}) { - foreach (keys %ENV) { - if ($_=~/^form\.rec\_(.*)$/) { - $r->print('Confirming Receipt: '. - &user_crit_received($1).'
'); - } - if ($_=~/^form\.reprec\_(.*)$/) { - my $msgid=$1; - $r->print('Confirming Receipt: '. - &user_crit_received($msgid).'
'); - &comprep($r,$msgid); - } - } - &discrit($r); - } elsif ($ENV{'form.critical'}) { - &discrit($r); - } elsif ($ENV{'form.forward'}) { - &compout($r,$ENV{'form.forward'}); - } elsif ($ENV{'form.markread'}) { - } elsif ($ENV{'form.markdel'}) { - &statuschange($ENV{'form.markdel'},'deleted'); - &disall($r); - } elsif ($ENV{'form.markeddel'}) { - my $total=0; - foreach (keys %ENV) { - if ($_=~/^form\.delmark_(.*)$/) { - &statuschange(&Apache::lonnet::unescape($1),'deleted'); - $total++; - } - } - $r->print('Deleted '.$total.' message(s)

'); - &disall($r); - } elsif ($ENV{'form.markunread'}) { - &statuschange($ENV{'form.markunread'},'new'); - &disall($r); - } elsif ($ENV{'form.compose'}) { - &compout($r,'',$ENV{'form.compose'}); - } elsif ($ENV{'form.recordftf'}) { - &facetoface($r,$ENV{'form.recordftf'}); - } elsif ($ENV{'form.sendmail'}) { - my %content=(); - undef %content; - if ($ENV{'form.forwid'}) { - my $msgid=$ENV{'form.forwid'}; - my %message=&Apache::lonnet::get('nohist_email',[$msgid]); - %content=&unpackagemsg($message{$msgid}); - &statuschange($msgid,'forwarded'); - $ENV{'form.message'}.="\n\n-- Forwarded message --\n\n". - $content{'message'}; - } - my %toaddr=(); - undef %toaddr; - if ($ENV{'form.sendmode'} eq 'group') { - foreach (keys %ENV) { - if ($_=~/^form\.send\_to\_\&\&\&[^\&]*\&\&\&\_(.+)$/) { - $toaddr{$1}=''; - } - } - } elsif ($ENV{'form.sendmode'} eq 'upload') { - foreach (split(/[\n\r\f]+/,$ENV{'form.upfile'})) { - my ($rec,$txt)=split(/\s*\:\s*/,$_); - if ($txt) { - $rec=~s/\@/\:/; - $toaddr{$rec}.=$txt."\n"; - } - } - } else { - $toaddr{$ENV{'form.recuname'}.':'.$ENV{'form.recdomain'}}=''; - } - if ($ENV{'form.additionalrec'}) { - foreach (split(/\,/,$ENV{'form.additionalrec'})) { - my ($auname,$audom)=split(/\@/,$_); - $toaddr{$auname.':'.$audom}=''; - } - } - foreach (keys %toaddr) { - my ($recuname,$recdomain)=split(/\:/,$_); - my $msgtxt=$ENV{'form.message'}; - if ($toaddr{$_}) { $msgtxt.='

'.$toaddr{$_}; } - if ((($ENV{'form.critmsg'}) || ($ENV{'form.sendbck'})) && - (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'}))) { - $r->print('Sending critical: '. - &user_crit_msg($recuname,$recdomain, - $ENV{'form.subject'}, - $msgtxt, - $ENV{'form.sendbck'})); - } else { - $r->print('Sending: '.&user_normal_msg($recuname,$recdomain, - $ENV{'form.subject'}, - $msgtxt, - $content{'citation'})); - } - $r->print('
'); - } - if ($ENV{'form.displayedcrit'}) { - &discrit($r); - } else { - &disall($r); - } - } else { - &disall($r); - } - $r->print(''); - return OK; +=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 + +=cut + +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
'; + $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').'
'; + 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').'
'; + 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').'
'; + 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); } -# ================================================= Main program, reset counter - -BEGIN { - $msgcount=0; -} - -1; -__END__ - - +=pod +=back +=cut +1; +__END__