--- loncom/interface/lonmsg.pm 2006/12/28 19:43:24 1.195
+++ loncom/interface/lonmsg.pm 2007/04/22 02:25:36 1.199
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Routines for messaging
#
-# $Id: lonmsg.pm,v 1.195 2006/12/28 19:43:24 raeburn Exp $
+# $Id: lonmsg.pm,v 1.199 2007/04/22 02:25:36 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -28,6 +28,37 @@
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 HTML::TokeParser();
@@ -256,7 +287,7 @@ sub sendnotification {
$text=~s/\>\;/\>/gs;
$text=~s/\<\/*[^\>]+\>//gs;
my $url='http://'.
- $Apache::lonnet::hostname{&Apache::lonnet::homeserver($touname,$toudom)}.
+ &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);
@@ -553,9 +584,9 @@ sub user_normal_msg_raw {
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'})))) {
+ (&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,$symb,$error);
@@ -563,31 +594,30 @@ sub user_normal_msg_raw {
&store_sent_mail($msgid,$packed_message_no_citation);
}
}
- } else {
- $status='no_host';
- }
- if (defined($newid)) {
- $$newid = $msgid;
- }
- if (defined($sentmessage)) {
- $$sentmessage = $packed_message;
- }
-
+ 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,$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);
+ my %userenv = &Apache::lonnet::get('environment',['notification',
+ 'permanentemail'],
+ $domain,$user);
+ 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';
+ }
return $status;
}
@@ -599,29 +629,40 @@ sub user_normal_msg_raw {
$baseurl, $attachmenturl, $toperm, $sentmessage, $symb, $restitle, $error)>:
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,$attachmenturl,
$toperm,$sentmessage,$symb,$restitle,$error)=@_;
- my $status='';
+ 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.=
+ push(@status,
&user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,
$citation,$baseurl,$attachmenturl,$toperm,
- undef,undef,$sentmessage,undef,$symb,$restitle,$error).' ';
+ undef,undef,$sentmessage,undef,$symb,$restitle,$error));
}
} else {
- $status=&user_normal_msg_raw($user,$domain,$subject,$message,
+ push(@status,&user_normal_msg_raw($user,$domain,$subject,$message,
$citation,$baseurl,$attachmenturl,$toperm,
- undef,undef,$sentmessage,undef,$symb,$restitle,$error);
+ undef,undef,$sentmessage,undef,$symb,$restitle,$error));
}
- return $status;
+ if (wantarray) {
+ return @status;
+ }
+ return join(' ',@status);
}
sub store_sent_mail {
@@ -666,6 +707,102 @@ sub get_user_folders {
return %userfolders;
}
+sub secapply {
+ my $rec=shift;
+ my $defaultflag=shift;
+ $rec=~s/\s+//g;
+ $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 '';
+}
+
+=pod
+
+=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);
+}
+
+=pod
+
+=back
+
+=cut
+
1;
__END__