version 1.63, 2007/01/04 20:58:26
|
version 1.70, 2007/04/22 13:41:22
|
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 924 sub disfolder {
|
Line 907 sub disfolder {
|
nome => 'No messages have been selected to apply ths action to.', |
nome => 'No messages have been selected to apply ths action to.', |
chec => 'Check the checkbox for at least one message.', |
chec => 'Check the checkbox for at least one message.', |
); |
); |
|
my $jscript = &Apache::loncommon::check_uncheck_jscript(); |
$r->print(<<ENDDISHEADER); |
$r->print(<<ENDDISHEADER); |
<script type="text/javascript"> |
<script type="text/javascript"> |
function checkall() { |
$jscript |
for (i=0; i<document.forms.disall.delmark.length; i++) { |
|
document.forms.disall.delmark[i].checked=true; |
|
} |
|
} |
|
|
|
function uncheckall() { |
|
for (i=0; i<document.forms.disall.delmark.length; i++) { |
|
document.forms.disall.delmark[i].checked=false; |
|
} |
|
} |
|
function checkfoldermove() { |
function checkfoldermove() { |
if (document.disall.checkedaction.options[document.disall.checkedaction.selectedIndex].value == 'markedmove') { |
if (document.disall.checkedaction.options[document.disall.checkedaction.selectedIndex].value == 'markedmove') { |
if (document.disall.movetofolder.options[document.disall.movetofolder.selectedIndex].value == "") { |
if (document.disall.movetofolder.options[document.disall.movetofolder.selectedIndex].value == "") { |
Line 956 sub disfolder {
|
Line 931 sub disfolder {
|
} |
} |
} |
} |
var checktotal = 0; |
var checktotal = 0; |
for (var i=0; i<document.forms.disall.delmark.length; i++) { |
if (document.forms.disall.delmark.length > 0) { |
if (document.forms.disall.delmark[i].checked) { |
for (var i=0; i<document.forms.disall.delmark.length; i++) { |
|
if (document.forms.disall.delmark[i].checked) { |
|
checktotal ++; |
|
} |
|
} |
|
} else { |
|
if (document.forms.disall.delmark.checked) { |
checktotal ++; |
checktotal ++; |
} |
} |
} |
} |
if (checktotal == 0) { |
if (checktotal == 0) { |
alert("$lt{'nome'}\\n$lt{'chec'}"); |
alert("$lt{'nome'}\\n$lt{'chec'}"); |
return; |
return; |
Line 982 ENDDISHEADER
|
Line 963 ENDDISHEADER
|
} else { |
} else { |
$r->print('<h2>'.&mt('There are no '.lc($statushash{$msgstatus}).' messages in this folder.').'</h2>'); |
$r->print('<h2>'.&mt('There are no '.lc($statushash{$msgstatus}).' messages in this folder.').'</h2>'); |
} |
} |
|
if ($numblocked > 0) { |
|
$r->print(&blocked_in_folder($numblocked,$startblock,$endblock, |
|
\%setters)); |
|
} |
return; |
return; |
} |
} |
my $interdis = $env{'form.interdis'}; |
my $interdis = $env{'form.interdis'}; |
Line 1052 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 1097 ENDDISHEADER
|
Line 1089 ENDDISHEADER
|
$r->print('<table border="0" cellspacing="2" cellpadding="2"> |
$r->print('<table border="0" cellspacing="2" cellpadding="2"> |
<tr> |
<tr> |
<td>'. |
<td>'. |
'<input type="button" onclick="javascript:checkall()" value="'.&mt('Check All').'" /><br />'."\n". |
'<input type="button" onclick="javascript:checkAll(document.disall.delmark)" value="'.&mt('Check All').'" /><br />'."\n". |
'<input type="button" onclick="javascript:uncheckall()" value="'.&mt('Uncheck All').'" />'."\n". |
'<input type="button" onclick="javascript:uncheckAll(document.disall.delmark)" value="'.&mt('Uncheck All').'" />'."\n". |
'<input type="hidden" name="sortedby" value="'.$env{'form.sortedby'}.'" /></td><td> </td>'."\n". |
'<input type="hidden" name="sortedby" value="'.$env{'form.sortedby'}.'" /></td><td> </td>'."\n". |
'<td align="center"><b>'.&mt('Action').'</b><br />'."\n". |
'<td align="center"><b>'.&mt('Action').'</b><br />'."\n". |
' <select name="checkedaction" onchange="javascript:checkfoldermove()">'."\n"); |
' <select name="checkedaction" onchange="javascript:checkfoldermove()">'."\n"); |
Line 1138 ENDDISHEADER
|
Line 1130 ENDDISHEADER
|
my $postedstartdis=$startdis+1; |
my $postedstartdis=$startdis+1; |
$r->print('<input type="hidden" name="folder" value="'.$folder.'" /><input type="hidden" name="startdis" value="'.$postedstartdis.'" /><input type="hidden" name="interdis" value="'.$env{'form.interdis'}.'" /><input type="hidden" name="msgstatus" value="'.$msgstatus.'" ><input type="hidden" name="markedaction" value="" /></form>'); |
$r->print('<input type="hidden" name="folder" value="'.$folder.'" /><input type="hidden" name="startdis" value="'.$postedstartdis.'" /><input type="hidden" name="interdis" value="'.$env{'form.interdis'}.'" /><input type="hidden" name="msgstatus" value="'.$msgstatus.'" ><input type="hidden" name="markedaction" value="" /></form>'); |
if ($numblocked > 0) { |
if ($numblocked > 0) { |
my $beginblock = &Apache::lonlocal::locallocaltime($startblock); |
$r->print(&blocked_in_folder($numblocked,$startblock,$endblock, |
my $finishblock = &Apache::lonlocal::locallocaltime($endblock); |
\%setters)); |
$r->print('<br /><br />'. |
|
&mt('[quant,_1,message is, messages are] not viewable because display of LON-CAPA messages sent to you by other students between [_2] and [_3] is currently being blocked because of online exams.',$numblocked,$beginblock,$finishblock)); |
|
$r->print(&Apache::loncommon::build_block_table($startblock,$endblock, |
|
\%setters)); |
|
} |
} |
} |
} |
|
|
|
sub blocked_in_folder { |
|
my ($numblocked,$startblock,$endblock,$setters) = @_; |
|
my $beginblock = &Apache::lonlocal::locallocaltime($startblock); |
|
my $finishblock = &Apache::lonlocal::locallocaltime($endblock); |
|
my $output = '<br /><br />'. |
|
&mt('[quant,_1,message is, messages are] not viewable because display of LON-CAPA messages sent to you by other students between [_2] and [_3] is currently being blocked because of online exams.',$numblocked,$beginblock,$finishblock); |
|
$output .= &Apache::loncommon::build_block_table($startblock,$endblock, |
|
$setters); |
|
return $output; |
|
} |
|
|
# ============================================================== Compose output |
# ============================================================== Compose output |
|
|
sub compout { |
sub compout { |
Line 1187 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 1223 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 (&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 1508 sub disfacetoface {
|
Line 1523 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 1571 sub facetoface {
|
Line 1599 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 1586 sub facetoface {
|
Line 1614 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 2030 sub displaymessage {
|
Line 2058 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 2271 sub sendoffmail {
|
Line 2300 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 2319 sub sendoffmail {
|
Line 2348 sub sendoffmail {
|
$env{'form.permanent'}, |
$env{'form.permanent'}, |
\$sentmessage{$address}); |
\$sentmessage{$address}); |
} |
} |
if (($env{'request.course.id'}) && (($msgtype eq 'critical') || |
if (($env{'request.course.id'}) && |
($env{'form.sendmode'} eq 'group'))) { |
(($msgtype eq 'critical') || |
|
($env{'form.sendmode'} eq 'group') || |
|
($env{'form.courserecord'}))) { |
$specialmsg_status{$recuname.':'.$recdomain} = |
$specialmsg_status{$recuname.':'.$recdomain} = |
join(' ',@thismsg); |
join(' ',@thismsg); |
foreach my $result (@thismsg) { |
foreach my $result (@thismsg) { |
Line 2331 sub sendoffmail {
|
Line 2362 sub sendoffmail {
|
} |
} |
$sendstatus.=' '.join(' ',@thismsg); |
$sendstatus.=' '.join(' ',@thismsg); |
} |
} |
if (($env{'request.course.id'}) && (($env{'form.sendmode'} eq 'group') |
if (($env{'request.course.id'}) && |
|| ($msgtype eq 'critical'))) { |
(($env{'form.sendmode'} eq 'group') || |
|
($env{'form.courserecord'}) || |
|
($msgtype eq 'critical'))) { |
my $subj_prefix; |
my $subj_prefix; |
if ($msgtype eq 'critical') { |
if ($msgtype eq 'critical') { |
$subj_prefix = 'Critical.'; |
$subj_prefix = 'Critical.'; |
} else { |
} elsif ($env{'form.sendmode'} eq 'group') { |
$subj_prefix = 'Broadcast.'; |
$subj_prefix = 'Broadcast.'; |
|
} else { |
|
$subj_prefix = 'Archive'; |
} |
} |
my ($specialmsgid,$specialresult); |
my ($specialmsgid,$specialresult); |
my $course_str = &escape('['.$cnum.':'.$cdom.']'); |
my $course_str = &escape('['.$cnum.':'.$cdom.']'); |
Line 2356 sub sendoffmail {
|
Line 2391 sub sendoffmail {
|
split(/\:/,&unescape($specialmsgid)); |
split(/\:/,&unescape($specialmsgid)); |
|
|
foreach my $recipient (sort(keys(%toaddr))) { |
foreach my $recipient (sort(keys(%toaddr))) { |
if ($specialmsg_status{$recipient} eq 'ok') { |
if ($specialmsg_status{$recipient} =~ /\s*(ok|con_delayed)\s*/) { |
my $usersubj = $subj_prefix.'['.$recipient.']'; |
my $usersubj = $subj_prefix.'['.$recipient.']'; |
my $usermsgid = |
my $usermsgid = |
&Apache::lonmsg::buildmsgid($stamp,$usersubj, |
&Apache::lonmsg::buildmsgid($stamp,$usersubj, |
Line 2718 sub handler {
|
Line 2753 sub handler {
|
my $delresult = &deletefolder($folder); |
my $delresult = &deletefolder($folder); |
if ($delresult eq 'ok') { |
if ($delresult eq 'ok') { |
$r->print(&mt('Mail folder "[_1]" deleted.',$folder).'<br />'); |
$r->print(&mt('Mail folder "[_1]" deleted.',$folder).'<br />'); |
|
$env{'form.folder'} = ''; |
} else { |
} else { |
$r->print(&mt('Deletion failed.').' '.$delresult.'<br />'); |
$r->print(&mt('Deletion failed.').' '.$delresult.'<br />'); |
$showfolder = $folder; |
$showfolder = $folder; |
Line 2748 sub handler {
|
Line 2784 sub handler {
|
|
|
=pod |
=pod |
|
|
=back |
|
|
|
=cut |
=cut |
|
|
1; |
1; |