# The LearningOnline Network with CAPA
# Routines for messaging
#
# $Id: lonmsg.pm,v 1.103 2004/07/09 21:08:24 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.
#
# 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.
#
# 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
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
package Apache::lonmsg;
=pod
=head1 NAME
Apache::lonmsg: supports internal messaging
=head1 SYNOPSIS
lonmsg provides routines for sending messages, receiving messages, and
a handler to allow users to read, send, and delete messages.
=head1 OVERVIEW
=head2 Messaging Overview
X<messages>LON-CAPA provides an internal messaging system similar to
email, but customized for LON-CAPA's usage. LON-CAPA implements its
own messaging system, rather then building on top of email, because of
the features LON-CAPA messages can offer that conventional e-mail can
not:
=over 4
=item * B<Critical messages>: A message the recipient B<must>
acknowlegde receipt of before they are allowed to continue using the
system, preventing a user from claiming they never got a message
=item * B<Receipts>: LON-CAPA can reliably send reciepts informing the
sender that it has been read; again, useful for preventing students
from claiming they did not see a message. (While conventional e-mail
has some reciept support, it's sporadic, e-mail client-specific, and
generally the receiver can opt to not send one, making it useless in
this case.)
=item * B<Context>: LON-CAPA knows about the sender, such as where
they are in a course. When a student mails an instructor asking for
help on the problem, the instructor receives not just the student's
question, but all submissions the student has made up to that point,
the user's rendering of the problem, and the complete view the student
saw of the resource, including discussion up to that point. Finally,
the instructor is reading all of this inside of LON-CAPA, not their
email program, so they have full access to LON-CAPA's grading
interface, or other features they may wish to use in response to the
student's query.
=item * B<Blocking>: LON-CAPA can block display of e-mails that are
sent to a student during an online exam. A course coordinator or
instructor can set an open and close date/time for scheduled online
exams in a course. If a user uses the LON-CAPA internal messaging
system to display e-mails during the scheduled blocking event,
display of all e-mail sent during the blocking period will be
suppressed, and a message of explanation, including details of the
currently active blocking periods will be displayed instead. A user
who has a course coordinator or instructor role in a course will be
unaffected by any blocking periods for the course, unless the user
also has a student role in the course, AND has selected the student role.
=back
Users can ask LON-CAPA to forward messages to conventional e-mail
addresses on their B<PREF> screen, but generally, LON-CAPA messages
are much more useful then traditional email can be made to be, even
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.
=head1 FUNCTIONS
=over 4
=cut
use strict;
use Apache::lonnet();
use vars qw($msgcount);
use HTML::TokeParser();
use Apache::Constants qw(:common);
use Apache::loncommon();
use Apache::lontexconvert();
use HTML::Entities();
use Mail::Send;
use Apache::lonlocal;
use Apache::loncommunicate;
# Querystring component with sorting type
my $sqs;
# ===================================================================== Package
sub packagemsg {
my ($subject,$message,$citation,$baseurl,$attachmenturl)=@_;
$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 $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='<sendername>'.$ENV{'user.name'}.'</sendername>'.
'<senderdomain>'.$ENV{'user.domain'}.'</senderdomain>'.
'<subject>'.$subject.'</subject>'.
'<time>'.&Apache::lonlocal::locallocaltime($now).'</time>'.
'<servername>'.$ENV{'SERVER_NAME'}.'</servername>'.
'<host>'.$ENV{'HTTP_HOST'}.'</host>'.
'<client>'.$ENV{'REMOTE_ADDR'}.'</client>'.
'<browsertype>'.$ENV{'browser.type'}.'</browsertype>'.
'<browseros>'.$ENV{'browser.os'}.'</browseros>'.
'<browserversion>'.$ENV{'browser.version'}.'</browserversion>'.
'<browsermathml>'.$ENV{'browser.mathml'}.'</browsermathml>'.
'<browserraw>'.$ENV{'HTTP_USER_AGENT'}.'</browserraw>'.
'<courseid>'.$ENV{'request.course.id'}.'</courseid>'.
'<coursesec>'.$ENV{'request.course.sec'}.'</coursesec>'.
'<role>'.$ENV{'request.role'}.'</role>'.
'<resource>'.$ENV{'request.filename'}.'</resource>'.
'<msgid>'.$msgid.'</msgid>'.
'<message>'.$message.'</message>';
if (defined($citation)) {
$result.='<citation>'.$citation.'</citation>';
}
if (defined($baseurl)) {
$result.= '<baseurl>'.$baseurl.'</baseurl>';
}
if (defined($attachmenturl)) {
$result.= '<attachmenturl>'.$attachmenturl.'</attachmenturl>';
}
return $msgid,$result;
}
# ================================================== Unpack message into a hash
sub unpackagemsg {
my ($message,$notoken)=@_;
my %content=();
my $parser=HTML::TokeParser->new(\$message);
my $token;
while ($token=$parser->get_token) {
if ($token->[0] eq 'S') {
my $entry=$token->[1];
my $value=$parser->get_text('/'.$entry);
$content{$entry}=$value;
}
}
if ($content{'attachmenturl'}) {
my ($fname)=($content{'attachmenturl'}=~m|/([^/]+)$|);
if ($notoken) {
$content{'message'}.='<p>'.&mt('Attachment').': <tt>'.$fname.'</tt>';
} else {
&Apache::lonnet::allowuploaded('/adm/msg',
$content{'attachmenturl'});
$content{'message'}.='<p>'.&mt('Attachment').
': <a href="'.$content{'attachmenturl'}.'"><tt>'.
$fname.'</tt></a>';
}
}
return %content;
}
# ======================================================= Get info out of msgid
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});
}
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);
my %oldENV=%ENV;
undef(%ENV);
if (my $fh = $msg->open()) {
print $fh $body;
$fh->close;
}
%ENV=%oldENV;
undef(%oldENV);
}
# ==================================================== Send notification emails
sub sendnotification {
my ($to,$touname,$toudom,$subj,$crit)=@_;
my $sender=$ENV{'environment.firstname'}.' '.$ENV{'environment.lastname'};
my $critical=($crit?' critical':'');
my $url='http://'.
$Apache::lonnet::hostname{&Apache::lonnet::homeserver($touname,$toudom)}.
'/adm/email?username='.$touname.'&domain='.$toudom;
my $body=(<<ENDMSG);
You received a$critical message from $sender in LON-CAPA. The subject is
$subj
Use
$url
to access this message.
ENDMSG
&sendemail($to,'New'.$critical.' message from '.$sender,$body);
}
# ============================================================= Check for email
sub newmail {
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; }
}
return 0;
}
# =============================== Automated message to the author of a resource
=pod
=item * B<author_res_msg($filename, $message)>: 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'; }
$filename=&Apache::lonnet::declutter($filename);
my ($domain,$author,@dummy)=split(/\//,$filename);
my $homeserver=&Apache::lonnet::homeserver($author,$domain);
if ($homeserver ne 'no_host') {
my $id=unpack("%32C*",$message);
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);
}
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.='<p><img src="/adm/lonMisc/bomb.gif" /><b>'.
$content{'time'}.'</b>: '.$content{'message'}.
'<br /></p>';
}
}
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);
}
# ================= 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_raw {
my ($user,$domain,$subject,$message,$sendback)=@_;
# Check if allowed missing
my $status='';
my $msgid='undefined';
unless (($message)&&($user)&&($domain)) { $status='empty'; };
my $homeserver=&Apache::lonnet::homeserver($user,$domain);
if ($homeserver ne 'no_host') {
($msgid,$message)=&packagemsg($subject,$message);
if ($sendback) { $message.='<sendback>true</sendback>'; }
$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);
}
} else {
$status='no_host';
}
# Notifications
my %userenv = &Apache::lonnet::get('environment',['critnotification'],
$domain,$user);
if ($userenv{'critnotification'}) {
&sendnotification($userenv{'critnotification'},$user,$domain,$subject,1);
}
# Log this
&Apache::lonnet::logthis(
'Sending critical email '.$msgid.
', log status: '.
&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<user_crit_msg($user, $domain, $subject, $message, $sendback)>: 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)=@_;
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).' ';
}
} else {
$status=&user_crit_msg_raw($user,$domain,$subject,$message,$sendback);
}
return $status;
}
# =================================================== Critical message received
sub user_crit_received {
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'},
&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 '.
$contents{'msgid'}.
', '.$status);
return $status;
}
# ======================================================== Normal communication
sub user_normal_msg_raw {
my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl)=@_;
# Check if allowed missing
my $status='';
my $msgid='undefined';
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,
$attachmenturl);
$status=&Apache::lonnet::critical(
'put:'.$domain.':'.$user.':nohist_email:'.
&Apache::lonnet::escape($msgid).'='.
&Apache::lonnet::escape($message),$homeserver);
&Apache::lonnet::put
('email_status',{'recnewemail'=>time},$domain,$user);
} else {
$status='no_host';
}
# Notifications
my %userenv = &Apache::lonnet::get('environment',['notification'],
$domain,$user);
if ($userenv{'notification'}) {
&sendnotification($userenv{'notification'},$user,$domain,$subject,0);
}
&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<user_normal_msg($user, $domain, $subject, $message,
$citation, $baseurl, $attachmenturl)>: Sends a message to the
$user at $domain, with subject $subject and message $message.
=cut
sub user_normal_msg {
my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl)=@_;
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).' ';
}
} else {
$status=&user_normal_msg_raw($user,$domain,$subject,$message,
$citation,$baseurl,$attachmenturl);
}
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});
}
}
# ======================================================= 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;
my %lt=&Apache::lonlocal::texthash('cfa' => 'Check for All',
'cfs' => 'Check for Section/Group',
'cfn' => 'Check for None');
$r->print(<<ENDDISHEADER);
<input type="hidden" name="sendmode" value="group" />
<script>
function checkall() {
for (i=0; i<document.forms.compemail.elements.length; i++) {
if
(document.forms.compemail.elements[i].name.indexOf('send_to_')==0) {
document.forms.compemail.elements[i].checked=true;
}
}
}
function checksec() {
for (i=0; i<document.forms.compemail.elements.length; i++) {
if
(document.forms.compemail.elements[i].name.indexOf
('send_to_&&&'+document.forms.compemail.chksec.value)==0) {
document.forms.compemail.elements[i].checked=true;
}
}
}
function uncheckall() {
for (i=0; i<document.forms.compemail.elements.length; i++) {
if
(document.forms.compemail.elements[i].name.indexOf('send_to_')==0) {
document.forms.compemail.elements[i].checked=false;
}
}
}
</script>
<input type="button" onClick="checkall()" value="$lt{'cfa'}" />
<input type="button" onClick="checksec()" value="$lt{'cfs'}" />
<input type="text" size="5" name=chksec />
<input type="button" onClick="uncheckall()" value="$lt{'cfn'}" />
<p>
ENDDISHEADER
my %coursepersonnel=
&Apache::lonnet::get_course_adv_roles();
foreach my $role (sort keys %coursepersonnel) {
foreach (split(/\,/,$coursepersonnel{$role})) {
my ($puname,$pudom)=split(/\:/,$_);
$r->print(
'<br /><input type="checkbox" name="send_to_&&&&&&_'.
$puname.':'.$pudom.'" /> '.
&Apache::loncommon::plainname($puname,
$pudom).' ('.$_.'), <i>'.$role.'</i>');
}
}
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(
'<br><input type=checkbox name="send_to_&&&'.$section.'&&&_'.$_.'"> '.
$reply{'firstname'}.' '.
$reply{'middlename'}.' '.
$reply{'lastname'}.' '.
$reply{'generation'}.
' ('.$_.') '.$section);
}
}
}
# ==================================================== Display Critical Message
sub discrit {
my $r=shift;
my $header = '<h1><font color=red>'.&mt('Critical Messages').'</font></h1>'.
'<form action=/adm/email method=post>'.
'<input type=hidden name=confirm value=true>';
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/\<br\>/g;
$result.='<hr>'.&mt('From').': <b>'.
&Apache::loncommon::aboutmewrapper(
&Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).'</b> ('.
$content{'sendername'}.'@'.
$content{'senderdomain'}.') '.$content{'time'}.
'<br>'.&mt('Subject').': '.$content{'subject'}.
'<br><blockquote>'.
&Apache::lontexconvert::msgtexconverted($content{'message'}).
'</blockquote><small>'.
&mt('You have to confirm that you received this message. After confirmation, this message will be moved to your regular inbox').
'</small><br />'.
'<input type=submit name="rec_'.$_.'" value="'.&mt('Confirm Receipt').'">'.
'<input type=submit name="reprec_'.$_.'" '.
'value="'.&mt('Confirm Receipt and Reply').'">';
}
# Check to see if there were any messages.
if ($result eq '') {
$result = "<h2>".&mt('You have no critical messages.')."</h2>".
'<a href="/adm/roles">'.&mt('Select a course').'</a>';
} else {
$r->print($header);
}
$r->print($result);
$r->print('<input type=hidden name="displayedcrit" value="true"></form>');
}
sub sortedmessages {
my ($blocked,$startblock,$endblock,$numblocked) = @_;
my @messages = &Apache::lonnet::getkeys('nohist_email');
#unpack the varibles and repack into temp for sorting
my @temp;
foreach (@messages) {
my $msgid=&Apache::lonnet::escape($_);
my ($sendtime,$shortsubj,$fromname,$fromdomain,$status)=
&Apache::lonmsg::unpackmsgid($msgid);
my @temp1 = ($sendtime,$shortsubj,$fromname,$fromdomain,$status,
$msgid);
# Check whether message was sent during blocking period.
if ($sendtime >= $startblock && ($sendtime <= $endblock && $endblock > 0) ) {
my $escid = &Apache::lonnet::unescape($msgid);
$$blocked{$escid} = 'ON';
$$numblocked ++;
} else {
push @temp ,\@temp1;
}
}
#default sort
@temp = sort {$a->[0] <=> $b->[0]} @temp;
if ($ENV{'form.sortedby'} eq "date"){
@temp = sort {$a->[0] <=> $b->[0]} @temp;
}
if ($ENV{'form.sortedby'} eq "revdate"){
@temp = sort {$b->[0] <=> $a->[0]} @temp;
}
if ($ENV{'form.sortedby'} eq "user"){
@temp = sort {lc($a->[2]) cmp lc($b->[2])} @temp;
}
if ($ENV{'form.sortedby'} eq "revuser"){
@temp = sort {lc($b->[2]) cmp lc($a->[2])} @temp;
}
if ($ENV{'form.sortedby'} eq "domain"){
@temp = sort {$a->[3] cmp $b->[3]} @temp;
}
if ($ENV{'form.sortedby'} eq "revdomain"){
@temp = sort {$b->[3] cmp $a->[3]} @temp;
}
if ($ENV{'form.sortedby'} eq "subject"){
@temp = sort {lc($a->[1]) cmp lc($b->[1])} @temp;
}
if ($ENV{'form.sortedby'} eq "revsubject"){
@temp = sort {lc($b->[1]) cmp lc($a->[1])} @temp;
}
if ($ENV{'form.sortedby'} eq "status"){
@temp = sort {$a->[4] cmp $b->[4]} @temp;
}
if ($ENV{'form.sortedby'} eq "revstatus"){
@temp = sort {$b->[4] cmp $a->[4]} @temp;
}
return @temp;
}
# ======================================================== Display all messages
sub disall {
my $r=shift;
my %blocked = ();
my %setters = ();
my $startblock;
my $endblock;
my $numblocked = 0;
&blockcheck(\%setters,\$startblock,\$endblock);
$r->print(<<ENDDISHEADER);
<script>
function checkall() {
for (i=0; i<document.forms.disall.elements.length; i++) {
if
(document.forms.disall.elements[i].name.indexOf('delmark_')==0) {
document.forms.disall.elements[i].checked=true;
}
}
}
function uncheckall() {
for (i=0; i<document.forms.disall.elements.length; i++) {
if
(document.forms.disall.elements[i].name.indexOf('delmark_')==0) {
document.forms.disall.elements[i].checked=false;
}
}
}
</script>
ENDDISHEADER
$r->print('<h1>'.&mt('Display All Messages').'</h1><form method=post name=disall '.
'action="/adm/email">'.
'<table border=2><tr><th colspan=2> </th><th>');
if ($ENV{'form.sortedby'} eq "revdate") {
$r->print('<a href = "?sortedby=date">'.&mt('Date').'</a></th>');
} else {
$r->print('<a href = "?sortedby=revdate">'.&mt('Date').'</a></th>');
}
$r->print('<th>');
if ($ENV{'form.sortedby'} eq "revuser") {
$r->print('<a href = "?sortedby=user">'.&mt('Username').'</a>');
} else {
$r->print('<a href = "?sortedby=revuser">'.&mt('Username').'</a>');
}
$r->print('</th><th>');
if ($ENV{'form.sortedby'} eq "revdomain") {
$r->print('<a href = "?sortedby=domain">'.&mt('Domain').'</a>');
} else {
$r->print('<a href = "?sortedby=revdomain">'.&mt('Domain').'</a>');
}
$r->print('</th><th>');
if ($ENV{'form.sortedby'} eq "revsubject") {
$r->print('<a href = "?sortedby=subject">'.&mt('Subject').'</a>');
} else {
$r->print('<a href = "?sortedby=revsubject">'.&mt('Subject').'</a>');
}
$r->print('</th><th>');
if ($ENV{'form.sortedby'} eq "revstatus") {
$r->print('<a href = "?sortedby=status">'.&mt('Status').'</th>');
} else {
$r->print('<a href = "?sortedby=revstatus">'.&mt('Status').'</th>');
}
$r->print('</tr>');
my @temp=sortedmessages(\%blocked,$startblock,$endblock,\$numblocked);
foreach (@temp){
my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$origID)= @$_;
if (($status ne 'deleted') && defined($sendtime) && $sendtime!~/error/) {
if ($status eq 'new') {
$r->print('<tr bgcolor="#FFBB77">');
} elsif ($status eq 'read') {
$r->print('<tr bgcolor="#BBBB77">');
} elsif ($status eq 'replied') {
$r->print('<tr bgcolor="#AAAA88">');
} else {
$r->print('<tr bgcolor="#99BBBB">');
}
$r->print('<td><a href="/adm/email?display='.$origID.$sqs.
'">'.&mt('Open').'</a></td><td><a href="/adm/email?markdel='.$origID.$sqs.
'">'.&mt('Delete').'</a><input type=checkbox name="delmark_'.$origID.'" /></td>'.
'<td>'.&Apache::lonlocal::locallocaltime($sendtime).'</td><td>'.
$fromname.'</td><td>'.$fromdomain.'</td><td>'.
&Apache::lonnet::unescape($shortsubj).'</td><td>'.
$status.'</td></tr>');
}
}
$r->print('</table><p>'.
'<a href="javascript:checkall()">'.&mt('Check All').'</a> '.
'<a href="javascript:uncheckall()">'.&mt('Uncheck All').'</a><p>'.
'<input type="hidden" name="sortedby" value="'.$ENV{'form.sortedby'}.'" />'.
'<input type="submit" name="markeddel" value="'.&mt('Delete Checked').'" />'.
'</form>');
if ($numblocked > 0) {
my $beginblock = &Apache::lonlocal::locallocaltime($startblock);
my $finishblock = &Apache::lonlocal::locallocaltime($endblock);
$r->print('<br /><br />'.
$numblocked.' '.&mt('message(s) is/are not viewable because display of LON-CAPA messages sent to you by other students between').' '.$beginblock.' '.&mt('and').' '.$finishblock.' '.&mt('is currently being blocked because of online exams.'));
&build_block_table($r,$startblock,$endblock,\%setters);
}
$r->print('</body></html>');
}
# ============================================================== Compose output
sub compout {
my ($r,$forwarding,$replying,$broadcast,$replycrit)=@_;
if ($broadcast eq 'individual') {
&printheader($r,'/adm/email?compose=individual',
'Send a Message');
} elsif ($broadcast) {
&printheader($r,'/adm/email?compose=group',
'Broadcast Message');
} elsif ($forwarding) {
&Apache::lonhtmlcommon::add_breadcrumb
({href=>"/adm/email?display=".&Apache::lonnet::escape($forwarding),
text=>"Display Message"});
&printheader($r,'/adm/email?forward='.&Apache::lonnet::escape($forwarding),
'Forwarding a Message');
} elsif ($replying) {
&Apache::lonhtmlcommon::add_breadcrumb
({href=>"/adm/email?display=".&Apache::lonnet::escape($replying),
text=>"Display Message"});
&printheader($r,'/adm/email?replyto='.&Apache::lonnet::escape($replying),
'Replying to a Message');
} elsif ($replycrit) {
$r->print('<h3>'.&mt('Replying to a Critical Message').'</h3>');
$replying=$replycrit;
} else {
&printheader($r,'/adm/email?compose=upload',
'Distribute from Uploaded File');
}
my $dispcrit='';
my $dissub='';
my $dismsg='';
my $func=&mt('Send New');
my %lt=&Apache::lonlocal::texthash('us' => 'Username',
'do' => 'Domain',
'ad' => 'Additional Recipients',
'sb' => 'Subject',
'ca' => 'Cancel',
'ma' => 'Mail');
if (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
my $crithelp = Apache::loncommon::help_open_topic("Course_Critical_Message");
$dispcrit=
'<input type="checkbox" name="critmsg" /> '.&mt('Send as critical message').' ' . $crithelp .
'<br>'.
'<input type="checkbox" name="sendbck" /> '.&mt('Send as critical message').' ' .
&mt('and return receipt') . $crithelp . '<p>';
}
my %message;
my %content;
my $defdom=$ENV{'user.domain'};
if ($forwarding) {
%message=&Apache::lonnet::get('nohist_email',[$forwarding]);
%content=&unpackagemsg($message{$forwarding});
$dispcrit.='<input type="hidden" name="forwid" value="'.
$forwarding.'" />';
$func=&mt('Forward');
$dissub=&mt('Forwarding').': '.$content{'subject'};
$dismsg=&mt('Forwarded message from').' '.
$content{'sendername'}.' '.&mt('at').' '.$content{'senderdomain'};
}
if ($replying) {
%message=&Apache::lonnet::get('nohist_email',[$replying]);
%content=&unpackagemsg($message{$replying});
$dispcrit.='<input type="hidden" name="forwid" value="'.
$forwarding.'" />';
$func=&mt('Replying to');
$dissub=&mt('Reply').': '.$content{'subject'};
$dismsg='> '.$content{'message'};
$dismsg=~s/\r/\n/g;
$dismsg=~s/\f/\n/g;
$dismsg=~s/\n+/\n\> /g;
}
if ($ENV{'form.recdom'}) { $defdom=$ENV{'form.recdom'}; }
$r->print(
'<form action="/adm/email" name="compemail" method="post"'.
' enctype="multipart/form-data">'."\n".
'<input type="hidden" name="sendmail" value="on" />'."\n".
'<table>');
unless (($broadcast eq 'group') || ($broadcast eq 'upload')) {
if ($replying) {
$r->print('<tr><td colspan="2">'.&mt('Replying to').' '.
&Apache::loncommon::aboutmewrapper(
&Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).' ('.
$content{'sendername'}.'@'.
$content{'senderdomain'}.')'.
'<input type="hidden" name="recuname" value="'.$content{'sendername'}.'" />'.
'<input type="hidden" name="recdomain" value="'.$content{'senderdomain'}.'" />'.
'</td></tr>');
} else {
my $domform = &Apache::loncommon::select_dom_form($defdom,'recdomain');
my $selectlink=&Apache::loncommon::selectstudent_link
('compemail','recuname','recdomain');
$r->print(<<"ENDREC");
<tr><td>$lt{'us'}:</td><td><input type="text" size="12" name="recuname" value="$ENV{'form.recname'}"></td><td rowspan="2">$selectlink</td></tr>
<tr><td>$lt{'do'}:</td>
<td>$domform</td></tr>
ENDREC
}
}
my $latexHelp = Apache::loncommon::helpLatexCheatsheet();
if ($broadcast ne 'upload') {
$r->print(<<"ENDCOMP");
<tr><td>$lt{'ad'}<br /><tt>username\@domain,username\@domain, ...
</tt></td><td>
<input type="text" size="50" name="additionalrec" /></td></tr>
<tr><td>$lt{'sb'}:</td><td><input type="text" size="50" name="subject" value="$dissub" />
</td></tr></table>
$latexHelp
<textarea name="message" cols="80" rows="15" wrap="hard">$dismsg
</textarea></p><br />
$dispcrit
<input type="submit" name="send" value="$func $lt{'ma'}" />
<input type="submit" name="cancel" value="$lt{'ca'}" />
ENDCOMP
} else { # $broadcast is 'upload'
$r->print(<<ENDUPLOAD);
<input type="hidden" name="sendmode" value="upload" />
<input type="hidden" name="send" value="on" />
<h3>Generate messages from a file</h3>
<p>
Subject: <input type="text" size="50" name="subject" />
</p>
<p>General message text<br />
<textarea name="message" cols="60" rows="10" wrap="hard">$dismsg
</textarea></p>
<p>
The file format for the uploaded portion of the message is:
<pre>
username1\@domain1: text
username2\@domain2: text
username3\@domain1: text
</pre>
</p>
<p>
The messages will be assembled from all lines with the respective
<tt>username\@domain</tt>, and appended to the general message text.</p>
<p>
<input type="file" name="upfile" size="40" /></p><p>
$dispcrit
<input type="submit" value="Upload and Send" /></p>
ENDUPLOAD
}
if ($broadcast eq 'group') {
&discourse;
}
$r->print('</form>');
}
# ---------------------------------------------------- Display all face to face
sub disfacetoface {
my ($r,$user,$domain)=@_;
my $target=$ENV{'form.grade_target'};
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/\<br\>/g;
if ($content{'subject'}=~/^Record/) {
$result.='<h3>'.&mt('Record').'</h3>';
} elsif ($content{'subject'}=~/^Broadcast/) {
$result .='<h3>'.&mt('Broadcast Message').'</h3>';
} else {
$result.='<h3>'.&mt('Critical Message').'</h3>';
%content=&unpackagemsg($content{'message'});
$content{'message'}=
'<b>'.&mt('Subject').': '.$content{'subject'}.'</b><br />'.
$content{'message'};
}
$result.=&mt('By').': <b>'.
&Apache::loncommon::aboutmewrapper(
&Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).'</b> ('.
$content{'sendername'}.'@'.
$content{'senderdomain'}.') '.$content{'time'}.
'<br /><blockquote>'.
&Apache::lontexconvert::msgtexconverted($content{'message'}).
'</blockquote>';
}
# Check to see if there were any messages.
if ($result eq '') {
if ($target ne 'tex') {
$r->print("<p><b>".&mt("No notes, face-to-face discussion records, critical messages, or broadcast messages in this course.")."</b></p>");
} else {
$r->print('\textbf{'.&mt("No notes, face-to-face discussion records, critical messages or broadcast messages in this course.").'}\\\\');
}
} else {
$r->print($result);
}
}
# ---------------------------------------------------------------- Face to face
sub facetoface {
my ($r,$stage)=@_;
unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
return;
}
&printheader($r,
'/adm/email?recordftf=query',
"User Notes, Face-to-Face, Critical Messages, Broadcast Messages");
# 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');
my %lt=&Apache::lonlocal::texthash('user' => 'Username',
'dom' => 'Domain',
'head' => 'User Notes, Records of Face-To-Face Discussions, Critical Messages, and Broadcast Messages in Course',
'subm' => 'Retrieve discussion and message records',
'newr' => 'New Record (record is visible to course faculty and staff)',
'post' => 'Post this Record');
$r->print(<<"ENDTREC");
<h3>$lt{'head'}</h3>
<form method="post" action="/adm/email" name="stdselect">
<input type="hidden" name="recordftf" value="retrieve" />
<table>
<tr><td>$lt{'user'}:</td><td><input type="text" size="12" name="recuname" value="$ENV{'form.recuname'}" /></td>
<td rowspan="2">
$stdbrws
<input type="submit" value="$lt{'subm'}" /></td>
</tr>
<tr><td>$lt{'dom'}:</td>
<td>$domform</td></tr>
</table>
</form>
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'},
&mt('Record').
' ['.$ENV{'form.recuname'}.':'.$ENV{'form.recdomain'}.']',
$ENV{'form.newrecord'});
}
$r->print('<h3>'.&Apache::loncommon::plainname($ENV{'form.recuname'},
$ENV{'form.recdomain'}).'</h3>');
&disfacetoface($r,$ENV{'form.recuname'},$ENV{'form.recdomain'});
$r->print(<<ENDRHEAD);
<form method="post" action="/adm/email">
<input name="recdomain" value="$ENV{'form.recdomain'}" type="hidden" />
<input name="recuname" value="$ENV{'form.recuname'}" type="hidden" />
ENDRHEAD
$r->print(<<ENDBFORM);
<hr />$lt{'newr'}<br />
<textarea name="newrecord" cols="80" rows="10" wrap="hard"></textarea>
<br />
<input type="hidden" name="recordftf" value="post" />
<input type="submit" value="$lt{'post'}" />
</form>
ENDBFORM
}
}
# ----------------------------------------------------------- Blocking during exams
sub examblock {
my ($r,$action) = @_;
unless ($ENV{'request.course.id'}) { return;}
unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) { $r->print('Not allowed'); }
my %lt=&Apache::lonlocal::texthash(
'comb' => 'Communication Blocking',
'cbds' => 'Communication blocking during scheduled exams',
'desc' => 'You can use communication blocking to prevent students enrolled in this course from displaying LON-CAPA messages sent by other students during an online exam. As blocking of communication could potentially interrupt legitimate communication between students who are also both enrolled in a different LON-CAPA course, please be careful that you select the correct start and end times for your scheduled exam when setting or modifying these parameters.',
'mecb' => 'Modify existing communication blocking periods',
'ncbc' => 'No communication blocks currently stored'
);
my %ltext = &Apache::lonlocal::texthash(
'dura' => 'Duration',
'setb' => 'Set by',
'even' => 'Event',
'actn' => 'Action',
'star' => 'Start',
'endd' => 'End'
);
&printheader($r,'/adm/email?block=display',$lt{'comb'});
$r->print('<h3>'.$lt{'cbds'}.'</h3>');
if ($action eq 'store') {
&blockstore($r);
}
$r->print($lt{'desc'}.'<br /><br />
<form name="blockform" method="post" action="/adm/email?block=store">
');
$r->print('<h4>'.$lt{'mecb'}.'</h4>');
my %records = ();
my $blockcount = 0;
my $parmcount = 0;
&get_blockdates(\%records,\$blockcount);
if ($blockcount > 0) {
$parmcount = &display_blocker_status($r,\%records,\%ltext);
} else {
$r->print($lt{'ncbc'}.'<br /><br />');
}
&display_addblocker_table($r,$parmcount,\%ltext);
$r->print(<<"END");
<br />
<input type="hidden" name="blocktotal" value="$blockcount" />
<input type ="submit" value="Save Changes" />
</form>
</body>
</html>
END
return;
}
sub blockstore {
my $r = shift;
my %lt=&Apache::lonlocal::texthash(
'tfcm' => 'The following changes were made',
'cbps' => 'communication blocking period(s)',
'werm' => 'was/were removed',
'wemo' => 'was/were modified',
'wead' => 'was/were added',
'ncwm' => 'No changes were made.'
);
my %adds = ();
my %removals = ();
my %cancels = ();
my $modtotal = 0;
my $canceltotal = 0;
my $addtotal = 0;
my %blocking = ();
$r->print('<h3>'.$lt{'head'}.'</h3>');
foreach (keys %ENV) {
if ($_ =~ m/^form\.modify_(\w+)$/) {
$adds{$1} = $1;
$removals{$1} = $1;
$modtotal ++;
} elsif ($_ =~ m/^form\.cancel_(\d+)$/) {
$cancels{$1} = $1;
unless ( defined($removals{$1}) ) {
$removals{$1} = $1;
$canceltotal ++;
}
} elsif ($_ =~ m/^form\.add_(\d+)$/) {
$adds{$1} = $1;
$addtotal ++;
}
}
foreach (keys %removals) {
my $hashkey = $ENV{'form.key_'.$_};
&Apache::lonnet::del('comm_block',["$hashkey"],
$ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
$ENV{'course.'.$ENV{'request.course.id'}.'.num'}
);
}
foreach (keys %adds) {
unless ( defined($cancels{$_}) ) {
my ($newstart,$newend) = &get_dates_from_form($_);
my $newkey = $newstart.'____'.$newend;
$blocking{$newkey} = $ENV{'user.name'}.'@'.$ENV{'user.domain'}.':'.$ENV{'form.title_'.$_};
}
}
if ($addtotal + $modtotal > 0) {
&Apache::lonnet::put('comm_block',\%blocking,
$ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
$ENV{'course.'.$ENV{'request.course.id'}.'.num'}
);
}
my $chgestotal = $canceltotal + $modtotal + $addtotal;
if ($chgestotal > 0) {
$r->print($lt{'tfcm'}.'<ul>');
if ($canceltotal > 0) {
$r->print('<li>'.$canceltotal.' '.$lt{'cbps'},' '.$lt{'werm'}.'</li>');
}
if ($modtotal > 0) {
$r->print('<li>'.$modtotal.' '.$lt{'cbps'},' '.$lt{'wemo'}.'</li>');
}
if ($addtotal > 0) {
$r->print('<li>'.$addtotal.' '.$lt{'cbps'},' '.$lt{'wead'}.'</li>');
}
$r->print('</ul>');
} else {
$r->print($lt{'ncwm'});
}
$r->print('<br />');
return;
}
sub get_dates_from_form {
my $item = shift;
my $startdate = &Apache::lonhtmlcommon::get_date_from_form('startdate_'.$item);
my $enddate = &Apache::lonhtmlcommon::get_date_from_form('enddate_'.$item);
return ($startdate,$enddate);
}
sub get_blockdates {
my ($records,$blockcount) = @_;
$$blockcount = 0;
%{$records} = &Apache::lonnet::dump('comm_block',
$ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
$ENV{'course.'.$ENV{'request.course.id'}.'.num'}
);
$$blockcount = keys %{$records};
foreach (keys %{$records}) {
if ($_ eq 'error: 2 tie(GDBM) Failed while attempting dump') {
$$blockcount = 0;
last;
}
}
}
sub display_blocker_status {
my ($r,$records,$ltext) = @_;
my $parmcount = 0;
my @bgcols = ("#eeeeee","#dddddd");
my $function = &Apache::loncommon::get_users_function();
my $color = &Apache::loncommon::designparm($function.'.tabbg',
$ENV{'user.domain'});
my %lt = &Apache::lonlocal::texthash(
'modi' => 'Modify',
'canc' => 'Cancel',
);
$r->print(<<"END");
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="100%" bgcolor="#000000">
<table width="100%" border="0" cellpadding="1" cellspacing="0">
<tr>
<td width="100%" bgcolor="#000000">
<table border="0" cellpadding="3" cellspacing="3" bgcolor="#FFFFFF">
<tr bgcolor="$color">
<td><b>$$ltext{'dura'}</b></td>
<td><b>$$ltext{'setb'}</b></td>
<td><b>$$ltext{'even'}</b></td>
<td><b>$$ltext{'actn'}?</b></td>
</tr>
END
foreach (sort keys %{$records}) {
my $iter = $parmcount%2;
my $onchange = 'onFocus="javascript:window.document.forms['.
"'blockform'].elements['modify_".$parmcount."'].".
'checked=true;"';
my ($start,$end) = split/____/,$_;
my $startform = &Apache::lonhtmlcommon::date_setter('blockform','startdate_'.$parmcount,$start,$onchange);
my $endform = &Apache::lonhtmlcommon::date_setter('blockform','enddate_'.$parmcount,$end,$onchange);
my ($setter,$title) = split/:/,$$records{$_};
my ($setuname,$setudom) = split/@/,$setter;
my $settername = &Apache::loncommon::plainname($setuname,$setudom);
$r->print(<<"END");
<tr bgcolor="$bgcols[$iter]">
<td>$$ltext{'star'}: $startform<br/>$$ltext{'endd'}: $endform</td>
<td>$settername</td>
<td><input type="text" name="title_$parmcount" size="15" value="$title"/><input type="hidden" name="key_$parmcount" value="$_"></td>
<td>$lt{'modi'}? <input type="checkbox" name="modify_$parmcount"/><br />$lt{'canc'}? <input type="checkbox" name="cancel_$parmcount"/>
</tr>
END
$parmcount ++;
}
$r->print(<<"END");
</table>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br />
<br />
END
return $parmcount;
}
sub display_addblocker_table {
my ($r,$parmcount,$ltext) = @_;
my $start = time;
my $end = $start + (60 * 60 * 2); #Default is an exam of 2 hours duration.
my $onchange = 'onFocus="javascript:window.document.forms['.
"'blockform'].elements['add_".$parmcount."'].".
'checked=true;"';
my $startform = &Apache::lonhtmlcommon::date_setter('blockform','startdate_'.$parmcount,$start,$onchange);
my $endform = &Apache::lonhtmlcommon::date_setter('blockform','enddate_'.$parmcount,$end,$onchange);
my $function = &Apache::loncommon::get_users_function();
my $color = &Apache::loncommon::designparm($function.'.tabbg',
$ENV{'user.domain'});
my %lt = &Apache::lonlocal::texthash(
'addb' => 'Add block',
'exam' => 'e.g., Exam 1',
'addn' => 'Add new communication blocking periods'
);
$r->print(<<"END");
<h4>$lt{'addn'}</h4>
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="100%" bgcolor="#000000">
<table width="100%" border="0" cellpadding="1" cellspacing="0">
<tr>
<td width="100%" bgcolor="#000000">
<table border="0" cellpadding="3" cellspacing="3" bgcolor="#FFFFFF">
<tr bgcolor="#CCCCFF">
<td><b>$$ltext{'dura'}</b></td>
<td><b>$$ltext{'even'} $lt{'exam'}</b></td>
<td><b>$$ltext{'actn'}?</b></td>
</tr>
<tr bgcolor="#eeeeee">
<td>$$ltext{'star'}: $startform<br />$$ltext{'endd'}: $endform</td>
<td><input type="text" name="title_$parmcount" size="15" value=""/></td>
<td>$lt{'addb'}? <input type="checkbox" name="add_$parmcount" value="1"/></td>
</tr>
</table>
</td>
</tr>
</table>
</td>
</tr>
</table>
END
return;
}
sub blockcheck {
my ($setters,$startblock,$endblock) = @_;
# Retrieve active student roles and active course coordinator/instructor roles
my @livecses = ();
my @staffcses = ();
$$startblock = 0;
$$endblock = 0;
foreach (keys %ENV) {
if ($_ =~ m-^user\.role\.(st|cc|in)\./(.+)$-) {
my $role = $1;
my $cse = $2;
$cse =~ s|/|_|;
if ($ENV{$_} =~ m/^(\d*)\.(\d*)$/) {
unless (($2 > 0 && $2 < time) || ($1 > time)) {
if ($role eq 'st') {
push @livecses, $cse;
} else {
unless (grep/^$cse$/,@staffcses) {
push @staffcses, $cse;
}
}
}
}
} elsif ($_ =~ m-user\.role\.cr/(\w+)/(\w+)/([^/]+)\./(.+)$- ) {
my $rolepriv = $ENV{'user.role..rolesdef_'.$3};
}
}
# Retrieve blocking times and identity of blocker for active courses for students.
if (@livecses > 0) {
foreach my $cse (@livecses) {
my ($cdom,$crs) = split/_/,$cse;
if ( (grep/^$cse$/,@staffcses) && ($ENV{'request.role'} !~ m-^st\./$cdom/$crs$-) ) {
next;
} else {
%{$$setters{$cse}} = ();
@{$$setters{$cse}{'staff'}} = ();
@{$$setters{$cse}{'times'}} = ();
my %records = &Apache::lonnet::dump('comm_block',$cdom,$crs);
foreach (keys %records) {
if ($_ =~ m/^(\d+)____(\d+)$/) {
if ($1 <= time && $2 >= time) {
my ($staff,$title) = split/:/,$records{$_};
push @{$$setters{$cse}{'staff'}}, $staff;
push @{$$setters{$cse}{'times'}}, $_;
if ( ($$startblock == 0) || ($$startblock > $1) ) {
$$startblock = $1;
}
if ( ($$endblock == 0) || ($$endblock < $2) ) {
$$endblock = $2;
}
}
}
}
}
}
}
}
sub build_block_table {
my ($r,$startblock,$endblock,$setters) = @_;
my $function = &Apache::loncommon::get_users_function();
my $color = &Apache::loncommon::designparm($function.'.tabbg',
$ENV{'user.domain'});
my %lt = &Apache::lonlocal::texthash(
'cacb' => 'Currently active communication blocks',
'cour' => 'Course',
'dura' => 'Duration',
'blse' => 'Block set by'
);
$r->print(<<"END");
<br /<br />$lt{'cacb'}:<br /><br />
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="100%" bgcolor="#000000">
<table width="100%" border="0" cellpadding="1" cellspacing="0">
<tr>
<td width="100%" bgcolor="#000000">
<table border="0" cellpadding="3" cellspacing="3" bgcolor="#FFFFFF">
<tr bgcolor="$color">
<td><b>$lt{'cour'}</b></td>
<td><b>$lt{'dura'}</b></td>
<td><b>$lt{'blse'}</b></td>
</tr>
END
foreach (keys %{$setters}) {
my %courseinfo=&Apache::lonnet::coursedescription($_);
for (my $i=0; $i<@{$$setters{$_}{staff}}; $i++) {
my ($uname,$udom) = split/\@/,$$setters{$_}{staff}[$i];
my $fullname = &Apache::loncommon::plainname($uname,$udom);
my ($openblock,$closeblock) = split/____/,$$setters{$_}{times}[$i];
$openblock = &Apache::lonlocal::locallocaltime($openblock);
$closeblock= &Apache::lonlocal::locallocaltime($closeblock);
$r->print('<tr><td>'.$courseinfo{'description'}.'</td>'.
'<td>'.$openblock.' to '.$closeblock.'</td>'.
'<td>'.$fullname.' ('.$uname.'@'.$udom.
')</td></tr>');
}
}
$r->print('</table></td></tr></table></td></tr></table>');
}
# ----------------------------------------------------------- Display a message
sub displaymessage {
my ($r,$msgid)=@_;
my %blocked = ();
my %setters = ();
my $startblock = 0;
my $endblock = 0;
my $numblocked = 0;
# info to generate "next" and "previous" buttons and check if message is blocked
&blockcheck(\%setters,\$startblock,\$endblock);
my @messages=&sortedmessages(\%blocked,$startblock,$endblock,\$numblocked);
if ( $blocked{$msgid} eq 'ON' ) {
&printheader($r,'/adm/email',&mt('Display a Message'));
$r->print(&mt('You attempted to display a message that is currently blocked because you are enrolled in one or more courses for which there is an ongoing online exam.'));
&build_block_table($r,$startblock,$endblock,\%setters);
return;
}
&statuschange($msgid,'read');
my %message=&Apache::lonnet::get('nohist_email',[$msgid]);
my %content=&unpackagemsg($message{$msgid});
my $counter=0;
$r->print('<pre>');
my $escmsgid=&Apache::lonnet::escape($msgid);
foreach (@messages) {
if ($_->[5] eq $escmsgid){
last;
}
$counter++;
}
$r->print('</pre>');
my $number_of_messages = scalar(@messages); #subtract 1 for last index
# start output
&printheader($r,'/adm/email?display='.&Apache::lonnet::escape($msgid),'Display a Message','',$content{'baseurl'});
my %courseinfo=&Apache::lonnet::coursedescription($content{'courseid'});
# Functions
$r->print('<table border="2" width="100%"><tr bgcolor="#FFFFAA"><td>'.&mt('Functions').':</td>'.
'<td><a href="/adm/email?replyto='.&Apache::lonnet::escape($msgid).$sqs.
'"><b>'.&mt('Reply').'</b></a></td>'.
'<td><a href="/adm/email?forward='.&Apache::lonnet::escape($msgid).$sqs.
'"><b>'.&mt('Forward').'</b></a></td>'.
'<td><a href="/adm/email?markunread='.&Apache::lonnet::escape($msgid).$sqs.
'"><b>'.&mt('Mark Unread').'</b></a></td>'.
'<td><a href="/adm/email?markdel='.&Apache::lonnet::escape($msgid).$sqs.
'"><b>Delete</b></a></td>'.
'<td><a href="/adm/email?sortedby='.$ENV{'form.sortedby'}.
'"><b>'.&mt('Display all Messages').'</b></a></td>');
if ($counter > 0){
$r->print('<td><a href="/adm/email?display='.$messages[$counter-1]->[5].$sqs.
'"><b>'.&mt('Previous').'</b></a></td>');
}
if ($counter < $number_of_messages - 1){
$r->print('<td><a href="/adm/email?display='.$messages[$counter+1]->[5].$sqs.
'"><b>'.&mt('Next').'</b></a></td>');
}
$r->print('</tr></table>');
$r->print('<br /><b>'.&mt('Subject').':</b> '.$content{'subject'}.
'<br /><b>'.&mt('From').':</b> '.
&Apache::loncommon::aboutmewrapper(
&Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),
$content{'sendername'},$content{'senderdomain'}).' ('.
$content{'sendername'}.' at '.
$content{'senderdomain'}.') '.
($content{'courseid'}?'<br /><b>'.&mt('Course').':</b> '.$courseinfo{'description'}.
($content{'coursesec'}?' ('.&mt('Group/Section').': '.$content{'coursesec'}.')':''):'').
'<br /><b>'.&mt('Time').':</b> '.$content{'time'}.
'<p><pre>'.
&Apache::lontexconvert::msgtexconverted($content{'message'},1).
'</pre><hr />'.$content{'citation'}.'</p>');
return;
}
# ================================================================== The Header
sub header {
my ($r,$title,$baseurl)=@_;
$r->print('<html><head><title>Communication and Messages</title>');
if ($baseurl) {
$r->print("<base href=\"http://$ENV{'SERVER_NAME'}/$baseurl\" />");
}
$r->print(&Apache::loncommon::studentbrowser_javascript().'</head>'.
&Apache::loncommon::bodytag('Communication and Messages'));
$r->print(&Apache::lonhtmlcommon::breadcrumbs
(undef,($title?$title:'Communication and Messages')));
}
# ---------------------------------------------------------------- Print header
sub printheader {
my ($r,$url,$desc,$title,$baseurl)=@_;
&Apache::lonhtmlcommon::add_breadcrumb
({href=>$url,
text=>$desc});
&header($r,$title,$baseurl);
}
# ===================================================================== Handler
sub handler {
my $r=shift;
# ----------------------------------------------------------- Set document type
&Apache::loncommon::content_type($r,'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','sortedby','block']);
$sqs='&sortedby='.$ENV{'form.sortedby'};
# ------------------------------------------------------ They checked for email
unless ($ENV{'form.block'}) {
&Apache::lonnet::put('email_status',{'recnewemail'=>0});
}
# ----------------------------------------------------------------- Breadcrumbs
&Apache::lonhtmlcommon::clear_breadcrumbs();
&Apache::lonhtmlcommon::add_breadcrumb
({href=>"/adm/communicate",
text=>"Communication/Messages",
faq=>12,bug=>'Communication Tools',});
# --------------------------------------------------------------- Render Output
if ($ENV{'form.display'}) {
&displaymessage($r,$ENV{'form.display'});
} elsif ($ENV{'form.replyto'}) {
&compout($r,'',$ENV{'form.replyto'});
} elsif ($ENV{'form.confirm'}) {
&printheader($r,'','Confirmed Receipt');
foreach (keys %ENV) {
if ($_=~/^form\.rec\_(.*)$/) {
$r->print('<b>'.&mt('Confirming Receipt').':</b> '.
&user_crit_received($1).'<br>');
}
if ($_=~/^form\.reprec\_(.*)$/) {
my $msgid=$1;
$r->print('<b>'.&mt('Confirming Receipt').':</b> '.
&user_crit_received($msgid).'<br>');
&compout($r,'','','',$msgid);
}
}
&discrit($r);
} elsif ($ENV{'form.critical'}) {
&printheader($r,'','Displaying Critical Messages');
&discrit($r);
} elsif ($ENV{'form.forward'}) {
&compout($r,$ENV{'form.forward'});
} elsif ($ENV{'form.markdel'}) {
&printheader($r,'','Deleted Message');
&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++;
}
}
&printheader($r,'','Deleted Messages');
$r->print('Deleted '.$total.' message(s)<p>');
&disall($r);
} elsif ($ENV{'form.markunread'}) {
&printheader($r,'','Marked Message as Unread');
&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.block'}) {
&examblock($r,$ENV{'form.block'});
} elsif ($ENV{'form.sendmail'}) {
my $sendstatus='';
if ($ENV{'form.send'}) {
&printheader($r,'','Messages being sent.');
$r->rflush();
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},1);
&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=&Apache::lonfeedback::clear_out_html($ENV{'form.message'});
if ($toaddr{$_}) { $msgtxt.='<hr />'.$toaddr{$_}; }
my $thismsg;
if ((($ENV{'form.critmsg'}) || ($ENV{'form.sendbck'})) &&
(&Apache::lonnet::allowed('srm',$ENV{'request.course.id'}))) {
$r->print(&mt('Sending critical message').' '.$recuname.'@'.$recdomain.': ');
$thismsg=&user_crit_msg($recuname,$recdomain,
&Apache::lonfeedback::clear_out_html($ENV{'form.subject'}),
$msgtxt,
$ENV{'form.sendbck'});
} else {
$r->print(&mt('Sending').' '.$recuname.'@'.$recdomain.': ');
$thismsg=&user_normal_msg($recuname,$recdomain,
&Apache::lonfeedback::clear_out_html($ENV{'form.subject'}),
$msgtxt,
$content{'citation'});
if (($ENV{'request.course.id'}) && ($ENV{'form.sendmode'} eq 'group')) {
&user_normal_msg_raw(
$ENV{'course.'.$ENV{'request.course.id'}.'.num'},
$ENV{'course.'.$ENV{'request.course.id'}.'.domain'},
'Broadcast ['.$recuname.':'.$recdomain.']',
$msgtxt);
}
}
$r->print($thismsg.'<br />');
$sendstatus.=' '.$thismsg;
}
} else {
&printheader($r,'','No messages sent.');
}
if ($sendstatus=~/^(\s*(?:ok|con_delayed)\s*)*$/) {
$r->print('<br /><font color="green">'.&mt('Completed.').'</font>');
if ($ENV{'form.displayedcrit'}) {
&discrit($r);
} else {
&Apache::loncommunicate::menu($r);
}
} else {
$r->print(
'<h2><font color="red">'.&mt('Could not deliver message').'</font></h2>'.
&mt('Please use the browser "Back" button and correct the recipient addresses')
);
}
} else {
&printheader($r,'','Display All Messages');
&disall($r);
}
$r->print('</body></html>');
return OK;
}
# ================================================= Main program, reset counter
BEGIN {
$msgcount=0;
}
=pod
=back
=cut
1;
__END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonmsg.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface