version 1.65, 2007/01/22 21:51:05
|
version 1.71, 2007/05/01 18:40:57
|
Line 33 package Apache::lonmsgdisplay;
|
Line 33 package Apache::lonmsgdisplay;
|
|
|
=head1 NAME |
=head1 NAME |
|
|
Apache::lonmsg: supports internal messaging |
Apache::lonmsgdisplay: supports internal messaging |
|
|
=head1 SYNOPSIS |
=head1 SYNOPSIS |
|
|
lonmsg provides routines for sending messages, receiving messages, and |
lonmsgdisplay provides a handler to allow users to read, send, |
a handler to allow users to read, send, and delete messages. |
and delete messages, and to create and delete message folders, |
|
and to move messages between folders. |
|
|
=head1 OVERVIEW |
=head1 OVERVIEW |
|
|
Line 93 addresses on their B<PREF> screen, but g
|
Line 94 addresses on their B<PREF> screen, but g
|
are much more useful than traditional email can be made to be, even |
are much more useful than traditional email can be made to be, even |
with HTML support. |
with HTML support. |
|
|
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 FUNCTIONS |
|
|
|
=over 4 |
|
|
|
=cut |
=cut |
|
|
use strict; |
use strict; |
Line 119 use Apache::lonnet;
|
Line 101 use Apache::lonnet;
|
use HTML::TokeParser(); |
use HTML::TokeParser(); |
use Apache::Constants qw(:common); |
use Apache::Constants qw(:common); |
use Apache::loncommon(); |
use Apache::loncommon(); |
|
use Apache::lonhtmlcommon(); |
use Apache::lontexconvert(); |
use Apache::lontexconvert(); |
use HTML::Entities(); |
use HTML::Entities(); |
use Apache::lonlocal; |
use Apache::lonlocal; |
Line 1054 ENDDISHEADER
|
Line 1037 ENDDISHEADER
|
} |
} |
my ($dis_name,$dis_domain) = ($fromname,$fromdomain); |
my ($dis_name,$dis_domain) = ($fromname,$fromdomain); |
if ($folder eq 'sent') { |
if ($folder eq 'sent') { |
if (defined($recv_name) && !defined($recv_domain)) { |
if (defined($recv_name) && defined($recv_domain)) { |
$dis_name = join('<br />',@{$recv_name}); |
if (ref($recv_name) eq 'ARRAY' && |
$dis_domain = join('<br />',@{$recv_domain}); |
ref($recv_domain) eq 'ARRAY') { |
|
$dis_name = join('<br />',@{$recv_name}); |
|
$dis_domain = join('<br />',@{$recv_domain}); |
|
} |
} else { |
} else { |
my $msg_id = &unescape($origID); |
my $msg_id = &unescape($origID); |
my %message = &Apache::lonnet::get('nohist_email'.$suffix, |
my %message = &Apache::lonnet::get('nohist_email'.$suffix, |
[$msg_id]); |
[$msg_id]); |
my %content = &Apache::lonmsg::unpackagemsg($message{$msg_id}); |
my %content = &Apache::lonmsg::unpackagemsg($message{$msg_id}); |
$dis_name = join('<br />',@{$content{'recuser'}}); |
if (ref($content{'recuser'}) eq 'ARRAY') { |
$dis_domain = join('<br />',@{$content{'recdomain'}}); |
$dis_name = join('<br />',@{$content{'recuser'}}); |
|
} |
|
if (ref($content{'recdomain'}) eq 'ARRAY') { |
|
$dis_domain = join('<br />',@{$content{'recdomain'}}); |
|
} |
} |
} |
} |
} |
my $localsenttime = &Apache::lonlocal::locallocaltime($sendtime); |
my $localsenttime = &Apache::lonlocal::locallocaltime($sendtime); |
Line 1196 sub compout {
|
Line 1186 sub compout {
|
text=>"Display All Messages"}); |
text=>"Display All Messages"}); |
&printheader($r,'/adm/email?compose=multiforward', |
&printheader($r,'/adm/email?compose=multiforward', |
'Forwarding Multiple Messages'); |
'Forwarding Multiple Messages'); |
$r->print(&mt('Each of the <b>[quant,_1,message]</b> you checked will be forwarded to the recipient(s) you select below.',$multiforward).'<br />'); |
if ($multiforward > 1) { |
|
$r->print(&mt('Each of the <b>[quant,_1,message]</b> you checked |
|
will be forwarded to the recipient(s) you select below.',$multiforward).'<br />'); |
|
} else { |
|
$r->print(&mt('The message you checked will be forwarded to the recipient(s) you select below.').'<br />'); |
|
} |
|
|
} else { |
} else { |
&printheader($r,'/adm/email?compose=upload', |
&printheader($r,'/adm/email?compose=upload', |
'Distribute from Uploaded File'); |
'Distribute from Uploaded File'); |
Line 1232 sub compout {
|
Line 1228 sub compout {
|
&mt('Send copy to permanent email address (if known)').'</label></p>'. |
&mt('Send copy to permanent email address (if known)').'</label></p>'. |
'<p><label><input type="checkbox" name="rsspost" /> '. |
'<p><label><input type="checkbox" name="rsspost" /> '. |
&mt('Include in course RSS newsfeed').'</label></p>'; |
&mt('Include in course RSS newsfeed').'</label></p>'; |
} |
} |
|
if ($broadcast ne 'group') { |
|
if (&Apache::lonnet::allowed('dff',$env{'request.course.id'}) || |
|
&Apache::lonnet::allowed('dff',$env{'request.course.id'}. |
|
'/'.$env{'request.course.sec'})) { |
|
|
|
$dispcrit.='<p><label>'. |
|
'<input type="checkbox" name="courserecord" value="1" /> '. |
|
&mt("Include in course's 'User records' for recipient(s)"). |
|
'</label></p>'; |
|
} |
|
} |
|
|
my %message; |
my %message; |
my %content; |
my %content; |
my $defdom=$env{'user.domain'}; |
my $defdom=$env{'user.domain'}; |
Line 1517 sub disfacetoface {
|
Line 1525 sub disfacetoface {
|
'<b>'.&mt('Subject').': '.$content{'subject'}.'</b><br />'. |
'<b>'.&mt('Subject').': '.$content{'subject'}.'</b><br />'. |
$content{'message'}; |
$content{'message'}; |
} |
} |
} |
} |
|
} elsif ($content{'subject'}=~/^Archive/) { |
|
$result.='<h3>'.&mt('Archived Message').'</h3>'; |
|
if (defined($content{'coursemsgid'})) { |
|
my $crsmsgid = &escape($content{'coursemsgid'}); |
|
my $archive_message = &general_message($crsmsgid); |
|
$content{'message'} = '<b>'.&mt('Subject').': '.$content{'message'}.'</b><br />'.$archive_message; |
|
} else { |
|
%content=&Apache::lonmsg::unpackagemsg($content{'message'}); |
|
$content{'message'} = |
|
'<b>'.&mt('Subject').': '.$content{'subject'}.'</b><br |
|
'. |
|
$content{'message'}; |
|
} |
} else { |
} else { |
$result.='<h3>'.&mt('Critical Message').'</h3>'; |
$result.='<h3>'.&mt('Critical Message').'</h3>'; |
if (defined($content{'coursemsgid'})) { |
if (defined($content{'coursemsgid'})) { |
Line 1580 sub facetoface {
|
Line 1601 sub facetoface {
|
: 'faculty and staff'; |
: 'faculty and staff'; |
&printheader($r, |
&printheader($r, |
'/adm/email?recordftf=query', |
'/adm/email?recordftf=query', |
"User Notes, Face-to-Face, Critical Messages, Broadcast Messages"); |
"User Notes, Face-to-Face, Critical Messages, Broadcast Messages, Archived Messages"); |
# from query string |
# from query string |
|
|
if ($env{'form.recname'}) { $env{'form.recuname'}=$env{'form.recname'}; } |
if ($env{'form.recname'}) { $env{'form.recuname'}=$env{'form.recname'}; } |
Line 1595 sub facetoface {
|
Line 1616 sub facetoface {
|
('stdselect','recuname','recdomain'); |
('stdselect','recuname','recdomain'); |
my %lt=&Apache::lonlocal::texthash('user' => 'Username', |
my %lt=&Apache::lonlocal::texthash('user' => 'Username', |
'dom' => 'Domain', |
'dom' => 'Domain', |
'head' => "User Notes, Records of Face-To-Face Discussions, Critical Messages, and Broadcast Messages in $crstype", |
'head' => "User Notes, Records of Face-To-Face Discussions, Critical Messages, Broadcast Messages and Archived Messages in $crstype", |
'subm' => 'Retrieve discussion and message records', |
'subm' => 'Retrieve discussion and message records', |
'newr' => 'New Record (record is visible to '.lc($crstype).' '.$leaders.')', |
'newr' => 'New Record (record is visible to '.lc($crstype).' '.$leaders.')', |
'post' => 'Post this Record'); |
'post' => 'Post this Record'); |
Line 2039 sub displaymessage {
|
Line 2060 sub displaymessage {
|
if (defined($content{'baseurl'})) { |
if (defined($content{'baseurl'})) { |
$baseurl = &Apache::lonenc::check_encrypt($content{'baseurl'}); |
$baseurl = &Apache::lonenc::check_encrypt($content{'baseurl'}); |
} |
} |
|
$r->print(&Apache::loncommon::student_image_tag($content{'senderdomain'},$content{'sendername'})); |
$r->print('<br /><b>'.&mt('Subject').':</b> '.$content{'subject'}. |
$r->print('<br /><b>'.&mt('Subject').':</b> '.$content{'subject'}. |
($folder ne 'sent'?'<br /><b>'.&mt('From').':</b> '. |
($folder ne 'sent'?'<br /><b>'.&mt('From').':</b> '. |
&Apache::loncommon::aboutmewrapper( |
&Apache::loncommon::aboutmewrapper( |
Line 2208 sub sendoffmail {
|
Line 2230 sub sendoffmail {
|
my ($r,$folder)=@_; |
my ($r,$folder)=@_; |
my $suffix=&Apache::lonmsg::foldersuffix($folder); |
my $suffix=&Apache::lonmsg::foldersuffix($folder); |
my $sendstatus=''; |
my $sendstatus=''; |
my %specialmsg_status; |
my %msg_status; |
my $numspecial = 0; |
my $numsent = 0; |
|
my $nosentstore = 1; |
my ($cdom,$cnum,$group); |
my ($cdom,$cnum,$group); |
if (exists($env{'form.group'})) { |
if (exists($env{'form.group'})) { |
$group = $env{'form.group'}; |
$group = $env{'form.group'}; |
Line 2266 sub sendoffmail {
|
Line 2289 sub sendoffmail {
|
} |
} |
} |
} |
} elsif ($env{'form.sendmode'} eq 'upload') { |
} elsif ($env{'form.sendmode'} eq 'upload') { |
|
$nosentstore = 0; |
foreach my $line (split(/[\n\r\f]+/,$env{'form.upfile'})) { |
foreach my $line (split(/[\n\r\f]+/,$env{'form.upfile'})) { |
my ($rec,$txt) = ($line =~ /^([^:]+:[^:]+):(.*)$/); |
my ($rec,$txt) = ($line =~ /^([^:]+:[^:]+):(.*)$/); |
if ($txt) { |
if ($txt) { |
Line 2280 sub sendoffmail {
|
Line 2304 sub sendoffmail {
|
} |
} |
} |
} |
if ($env{'form.additionalrec'}) { |
if ($env{'form.additionalrec'}) { |
foreach my $rec (split(/\,/,$env{'form.additionalrec'})) { |
foreach my $rec (split(/\s*,\s*/,$env{'form.additionalrec'})) { |
my ($auname,$audom)=split(/:/,$rec); |
my ($auname,$audom)=split(/:/,$rec); |
if (($auname ne "") && ($audom ne "")) { |
if (($auname ne "") && ($audom ne "")) { |
$toaddr{$auname.':'.$audom}=''; |
$toaddr{$auname.':'.$audom}=''; |
Line 2303 sub sendoffmail {
|
Line 2327 sub sendoffmail {
|
} else { |
} else { |
$savemsg=&Apache::lonfeedback::clear_out_html($env{'form.message'}); |
$savemsg=&Apache::lonfeedback::clear_out_html($env{'form.message'}); |
} |
} |
|
my @recusers; |
|
my @recudoms; |
foreach my $address (sort(keys(%toaddr))) { |
foreach my $address (sort(keys(%toaddr))) { |
my ($recuname,$recdomain)=split(/\:/,$address); |
my ($recuname,$recdomain)=split(/\:/,$address); |
my $msgtxt = $savemsg; |
my $msgtxt = $savemsg; |
Line 2317 sub sendoffmail {
|
Line 2342 sub sendoffmail {
|
$msgsubj,$msgtxt, |
$msgsubj,$msgtxt, |
$env{'form.sendbck'}, |
$env{'form.sendbck'}, |
$env{'form.permanent'}, |
$env{'form.permanent'}, |
\$sentmessage{$address}); |
\$sentmessage{$address}, |
|
$nosentstore); |
} else { |
} else { |
$r->print(&mt('Sending').' '.$recuname.':'.$recdomain.': '); |
$r->print(&mt('Sending').' '.$recuname.':'.$recdomain.': '); |
@thismsg= |
@thismsg= |
Line 2326 sub sendoffmail {
|
Line 2352 sub sendoffmail {
|
$content{'citation'}, |
$content{'citation'}, |
undef,undef, |
undef,undef, |
$env{'form.permanent'}, |
$env{'form.permanent'}, |
\$sentmessage{$address}); |
\$sentmessage{$address}, |
} |
undef,undef,undef, |
if (($env{'request.course.id'}) && (($msgtype eq 'critical') || |
$nosentstore); |
($env{'form.sendmode'} eq 'group'))) { |
} |
$specialmsg_status{$recuname.':'.$recdomain} = |
$msg_status{$recuname.':'.$recdomain}=join(' ',@thismsg); |
join(' ',@thismsg); |
if ($msg_status{$recuname.':'.$recdomain} =~ /(ok|con_delayed)/) { |
foreach my $result (@thismsg) { |
$numsent++; |
if ($result eq 'ok' || $result eq 'con_delayed') { |
push(@recusers,$recuname); |
$numspecial++; |
push(@recudoms,$recdomain); |
} |
|
} |
|
} |
} |
$sendstatus.=' '.join(' ',@thismsg); |
$sendstatus.=' '.join(' ',@thismsg); |
} |
} |
if (($env{'request.course.id'}) && (($env{'form.sendmode'} eq 'group') |
my $subj_prefix; |
|| ($msgtype eq 'critical'))) { |
if ($numsent > 0) { |
my $subj_prefix; |
if (($env{'request.course.id'}) && |
if ($msgtype eq 'critical') { |
(($env{'form.sendmode'} eq 'group') || |
$subj_prefix = 'Critical.'; |
($env{'form.courserecord'}) || |
} else { |
($msgtype eq 'critical'))) { |
$subj_prefix = 'Broadcast.'; |
if ($msgtype eq 'critical') { |
} |
$subj_prefix = 'Critical.'; |
my ($specialmsgid,$specialresult); |
} elsif ($env{'form.sendmode'} eq 'group') { |
my $course_str = &escape('['.$cnum.':'.$cdom.']'); |
$subj_prefix = 'Broadcast.'; |
|
} else { |
|
$subj_prefix = 'Archive'; |
|
} |
|
my ($specialmsgid,$specialresult); |
|
my $course_str = &escape('['.$cnum.':'.$cdom.']'); |
|
|
if ($numspecial) { |
$specialresult = |
$specialresult = &Apache::lonmsg::user_normal_msg_raw($cnum,$cdom,$subj_prefix. |
&Apache::lonmsg::user_normal_msg_raw($cnum,$cdom, |
' '.$course_str,$savemsg,undef,undef,undef, |
$subj_prefix.' '.$course_str,$savemsg,undef,undef, |
undef,undef,\$specialmsgid); |
undef,undef,undef,\$specialmsgid,undef,undef,undef, |
|
undef,undef,1); |
$specialmsgid = &unescape($specialmsgid); |
$specialmsgid = &unescape($specialmsgid); |
} |
if ($specialresult eq 'ok') { |
if ($specialresult eq 'ok') { |
my ($stamp,$crssubj,$msgname,$msgdom,$msgcount,$context,$pid) = |
my $record_sent; |
split(/\:/,&unescape($specialmsgid)); |
my @recusers; |
|
my @recudoms; |
foreach my $recipient (sort(keys(%toaddr))) { |
my ($stamp,$crssubj,$msgname,$msgdom,$msgcount,$context,$pid) = |
if ($msg_status{$recipient} =~ /\s*(ok|con_delayed)\s*/) { |
split(/\:/,&unescape($specialmsgid)); |
my $usersubj = $subj_prefix.'['.$recipient.']'; |
|
my $usermsgid = |
foreach my $recipient (sort(keys(%toaddr))) { |
&Apache::lonmsg::buildmsgid($stamp,$usersubj, |
if ($specialmsg_status{$recipient} eq 'ok') { |
$msgname,$msgdom, |
my $usersubj = $subj_prefix.'['.$recipient.']'; |
$msgcount,$context, |
my $usermsgid = |
$pid); |
&Apache::lonmsg::buildmsgid($stamp,$usersubj, |
&Apache::lonmsg::user_normal_msg_raw($cnum,$cdom, |
$msgname,$msgdom, |
$subj_prefix.' ['.$recipient.']',$msgsubj, |
$msgcount,$context, |
undef,undef,undef,undef,$usermsgid,undef, |
$pid); |
undef,$specialmsgid,undef,undef,undef,1); |
&Apache::lonmsg::user_normal_msg_raw($cnum,$cdom,$subj_prefix. |
} |
' ['.$recipient.']',$msgsubj,undef, |
|
undef,undef,undef,$usermsgid,undef,undef,$specialmsgid); |
|
my ($uname,$udom) = split(/:/,$recipient); |
|
push(@recusers,$uname); |
|
push(@recudoms,$udom); |
|
} |
} |
} |
if (($env{'form.sendmode'} ne 'upload') && (@recusers > 0)) { |
if (@recusers) { |
&Apache::lonmsg::process_sent_mail($msgsubj, |
my $specialmessage; |
$subj_prefix,$numsent,$stamp,$msgname,$msgdom, |
my $sentsubj = |
$msgcount,$context,$pid,$savemsg,\@recusers, |
$subj_prefix.' ('.$numspecial.' sent) '.$msgsubj; |
\@recudoms); |
$sentsubj = &HTML::Entities::encode($sentsubj,'<>&"'); |
} |
my $sentmsgid = |
} else { |
&Apache::lonmsg::buildmsgid($stamp,$sentsubj,$msgname, |
&Apache::lonnet::logthis('Failed to create record of critical, broadcast or archived message in '.$env{'course.'.$env{'request.course.id'}.'.num'}.' at '.$env{'course.'.$env{'request.course.id'}.'.domain'}.' - no msgid generated'); |
$msgdom,$msgcount,$context, |
|
$pid); |
|
($specialmsgid,$specialmessage) = &Apache::lonmsg::packagemsg($msgsubj,$savemsg, |
|
undef,undef,undef,\@recusers,\@recudoms,$sentmsgid); |
|
$record_sent = &Apache::lonmsg::store_sent_mail($specialmsgid,$specialmessage); |
|
} |
} |
} else { |
} else { |
&Apache::lonnet::logthis('Failed to create record of critical message or broadcast in '.$env{'course.'.$env{'request.course.id'}.'.num'}.' at '.$env{'course.'.$env{'request.course.id'}.'.domain'}.' - no msgid generated'); |
my $stamp = time; |
|
my $msgcount = &Apache::lonmsg::get_uniq(); |
|
my $context = &Apache::lonmsg::get_course_context(); |
|
&Apache::lonmsg::process_sent_mail($msgsubj,$subj_prefix, |
|
$numsent,$stamp,$env{'user.name'}, |
|
$env{'user.domain'},$msgcount,$context, |
|
$$,$savemsg,\@recusers,\@recudoms); |
} |
} |
} |
} |
} else { |
if (!$env{'form.multiforward'}) { |
&printheader($r,'','No messages sent.'); |
if ($sendstatus=~/^(\s*(?:ok|con_delayed)\s*)*$/) { |
} |
$r->print('<br /><span class="LC_success">'.&mt('Completed.'). |
if (!$env{'form.multiforward'}) { |
'</span>'); |
if ($sendstatus=~/^(\s*(?:ok|con_delayed)\s*)*$/) { |
if ($env{'form.displayedcrit'}) { |
$r->print('<br /><span class="LC_success">'.&mt('Completed.'). |
&discrit($r); |
'</span>'); |
} |
if ($env{'form.displayedcrit'}) { |
if ($group ne '') { |
&discrit($r); |
$r->print(&groupmail_sent($group,$cdom,$cnum)); |
|
} else { |
|
&Apache::loncommunicate::menu($r); |
|
} |
|
} else { |
|
$r->print('<p><span class="LC_error">'.&mt('Could not deliver message').'</span> '. |
|
&mt('Please use the browser "Back" button and correct the recipient addresses '."($sendstatus)").'</p>'); |
} |
} |
if ($group ne '') { |
|
$r->print(&groupmail_sent($group,$cdom,$cnum)); |
|
} else { |
|
&Apache::loncommunicate::menu($r); |
|
} |
|
} else { |
|
$r->print('<p><span class="LC_error">'.&mt('Could not deliver message').'</span> '. |
|
&mt('Please use the browser "Back" button and correct the recipient addresses '."($sendstatus)").'</p>'); |
|
} |
} |
} |
} |
return $sendstatus; |
return $sendstatus; |
Line 2758 sub handler {
|
Line 2782 sub handler {
|
|
|
=pod |
=pod |
|
|
=back |
|
|
|
=cut |
=cut |
|
|
1; |
1; |