Return to loncommunicate.pm CVS log

Up to [LON-CAPA] / loncom / interface

Course Coordinators and Instructors can schedule blocking periods for student display of e-mail.
During a blocking period students will be unable to display LON-CAPA e-mail sent during the current
blocking period. If Course Coodinators or Instructors need to contact students during this time, they
should send a critical message (these will still be viewable). Note: because COM functions can be
used outside a course context, blocking prevents display of all messages sent to the student during the
blocking period (including other courses).

# The LearningOnline Network
# Communicate
#
# $Id: loncommunicate.pm,v 1.22 2004/05/17 19:00:46 raeburn 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::loncommunicate;

use strict;
use Apache::Constants qw(:common);
use Apache::lonmsg();
use Apache::loncommon;
use Apache::lonlocal;

sub menu {
    my $r=shift;
    my %lt=&Apache::lonlocal::texthash(
'vam' => 'View All Messages',
'vcm' => 'View Critical Messages',
'smu' => 'Send Message to User(s)',
'bmc' => 'Broadcast Message to Course',
'dmu' => 'Distribute Messages from Uploaded File to Course',
'unr' => 
     'User Notes, Records of Face-to-Face Discussions, and Critical Messages',
'nm' => 'New Messages',
'su' => 'Subject',
'da' => 'Date',
'us' => 'Username',
'op' => 'Open',
'do' => 'Domain',
'cbs' => 'Configure blocking of student communication during exams' 

);
    my %help=();
    foreach ('Course_Face_To_Face_Records,Course_Critical_Message',
	     'Course_Broadcast_Message') {
	$help{$_}=&Apache::loncommon::help_open_topic($_);
    }
# ------------------------------------------------------------------------ Menu
   $r->print(<<END);
<table cellspacing="10" cellpadding="2">
<tr><td bgcolor="#FFFFAA">
  <b><a href="/adm/email/">$lt{'vam'}</a></b>
</td></tr>
<tr><td bgcolor="#FFFFAA">
  <b><a href="/adm/email?critical=display">$lt{'vcm'}</a></b>
</td></tr>
<tr><td bgcolor="#FFFFAA">
  <b><a href="/adm/email?compose=individual">$lt{'smu'}</a></b>
</td></tr>
END
    if (($ENV{'request.course.id'}) && 
        (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'}))) {
        $r->print(<<END);
<tr><td bgcolor="#FFFFAA">
    <b><a href="/adm/email?compose=group">$lt{'bmc'}</a></b>$help{'Course_Broadcast_Message'}
</td></tr>
<tr><td bgcolor="#FFFFAA">
  <b><a href="/adm/email?compose=upload">$lt{'dmu'}</a></b>
</td></tr>
<tr><td bgcolor="#FFFFAA">
<b><a href="/adm/email?recordftf=query">$lt{'unr'}</a></b>$help{'Course_Face_To_Face_Records,Course_Critical_Message'}
</td></tr>
<tr><td bgcolor="#FFFFAA">
  <b><a href="/adm/email?block=display">$lt{'cbs'}</a>
</td></tr>
END
    }
    $r->print('</table>');
    my @msgids = sort split(/\&/,&Apache::lonnet::reply
                            ('keys:'.$ENV{'user.domain'}.':'.
                             $ENV{'user.name'}.':nohist_email',
                             $ENV{'user.home'}));
    my @newmsgs;
    my %setters = ();
    my $startblock = 0;
    my $endblock = 0;
    my %blocked = ();
    my $numblocked = 0;
    # Check for blocking of display because of scheduled online exams.
    &Apache::lonmsg::blockcheck(\%setters,\$startblock,\$endblock);
    foreach (@msgids) {
        my ($sendtime,$shortsubj,$fromname,$fromdom,$status)=
	    &Apache::lonmsg::unpackmsgid($_);
        if (defined($sendtime) && $sendtime!~/error/) {
            my $numsendtime = $sendtime;
            $sendtime = &Apache::lonlocal::locallocaltime($sendtime);
            if ($status eq 'new') {
                if ($numsendtime >= $startblock && ($numsendtime <= $endblock && $endblock > 0) ) {
                    $blocked{$_} = 'ON';
                    $numblocked ++;
                } else {
                    push @newmsgs, { 
                        msgid    => $_,
                        sendtime => $sendtime,
                        shortsub => &Apache::lonnet::unescape($shortsubj),
                        from     => $fromname,
                        fromdom  => $fromdom 
                        }
                }
            }
        }
    }
    if ($#newmsgs >= 0) {
        $r->print(<<TABLEHEAD);
<h2>$lt{'nm'}</h2>
<table border=2><tr><th>&nbsp</th>
<th>$lt{'da'}</th><th>$lt{'us'}</th><th>$lt{'do'}</th><th>$lt{'su'}</th></tr>
TABLEHEAD
        foreach my $msg (@newmsgs) {
            $r->print(<<"ENDLINK");
<tr bgcolor="#FFBB77">
<td><a href="/adm/email?display=$msg->{'msgid'}">$lt{'op'}</a></td>
ENDLINK
            foreach ('sendtime','from','fromdom','shortsub') {
                $r->print("<td>$msg->{$_}</td>");
            }
            $r->print("</td></tr>");
        }
        $r->print('</table></body></html>');
    } elsif ($numblocked == 0) {
        $r->print("<h3>".&mt('You have no unread messages')."</h3>");
    }
    if ($numblocked > 0) {
        my $beginblock = &Apache::lonlocal::locallocaltime($startblock);
        my $finishblock = &Apache::lonlocal::locallocaltime($endblock);
        if ($numblocked == 1) {
            $r->print("<h3>".&mt('You have').' '.$numblocked.' '.&mt('blocked unread message').".</h3>");
            $r->print(&mt('This message is not viewable because').' ');
        } else {
            $r->print("<h3>".&mt('You have').' '.$numblocked.' '.&mt('blocked unread messages').".</h3>");
            $r->print(&mt('These').' '.$numblocked.' '.&mt('messages are not viewable because '));
        }
        $r->print(
&mt('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').'.');
        &Apache::lonmsg::build_block_table($r,$startblock,$endblock,\%setters);
    }
}

sub handler {
    my $r = shift;
    &Apache::loncommon::content_type($r,'text/html');
    $r->send_http_header;
    return OK if $r->header_only;
#
# Start document
#
    $r->print(<<END);
<html>
<head>
<title>The LearningOnline Network with CAPA</title>
</head>
END

# ----------------------------------------------------------------- Breadcrumbs
    &Apache::lonhtmlcommon::clear_breadcrumbs();
    &Apache::lonhtmlcommon::add_breadcrumb
        ({href=>"/adm/communicate",
          text=>"Communication/Messages",
          faq=>12,bug=>'Communication Tools',});

# ---------------------------------------------------------------------- Header
    &Apache::lonmsg::header($r);
    &menu($r);
    return OK;
}

1;
__END__