# The LearningOnline Network with CAPA # Routines for messaging display # # $Id: lonmsgdisplay.pm,v 1.16 2006/04/25 23:12:34 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::lonmsgdisplay; =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 XLON-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: A message the recipient B acknowlegde receipt of before they are allowed to continue using the system, preventing a user from claiming they never got a message =item * B: 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: 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: 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 screen, but generally, LON-CAPA messages are much more useful than 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. The routines used to package messages and unpackage messages are not only used by lonmsg when creating/extracting messages for LON-CAPA's internal messaging system, but also by lonnotify.pm which is available for use by Domain Coordinators to broadcast standard e-mail to specified users in their domain. The XML packaging used in the two cases is very similar. The differences are the use of $uname and $udom in stored internal messages, compared with $email in stored Domain Coordinator e-mail for the storage of information about recipients of the message/e-mail. =head1 FUNCTIONS =over 4 =cut use strict; use Apache::lonnet; use HTML::TokeParser(); use Apache::Constants qw(:common); use Apache::loncommon(); use Apache::lontexconvert(); use HTML::Entities(); use Apache::lonlocal; use Apache::loncommunicate; use Apache::lonfeedback; use Apache::lonrss(); # Querystring component with sorting type my $sqs; my $startdis; my $interdis; # ============================================================ List all folders sub folderlist { my $folder=shift; my @allfolders=&Apache::lonnet::getkeys('email_folders'); if ($allfolders[0]=~/^error:/) { @allfolders=(); } return '
'. &mt('Folder').': '. &Apache::loncommon::select_form($folder,'folder', ('' => &mt('INBOX'),'trash' => &mt('TRASH'), 'new' => &mt('New Messages Only'), 'critical' => &mt('Critical'), 'sent' => &mt('Sent Messages'), map { $_ => $_ } @allfolders)). ' '.&mt('Show'). ''. '
'. ''. ($folder=~/^(new|critical)/?'
':''); } sub scrollbuttons { my ($start,$maxdis,$first,$finish,$total)=@_; unless ($total>0) { return ''; } $start++; $maxdis++;$first++;$finish++; return &mt('Page').': '. ''. ''. ' of '.$maxdis. ''. '
'. &mt('Showing messages [_1] through [_2] of [_3]',$first,$finish,$total).''; } # =============================================================== Status Change sub statuschange { my ($msgid,$newstatus,$folder)=@_; my $suffix=&Apache::lonmsg::foldersuffix($folder); my %status=&Apache::lonnet::get('email_status'.$suffix,[$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'.$suffix,{$msgid => $newstatus}); } if (($newstatus eq 'deleted') || ($newstatus eq 'new')) { &Apache::lonnet::put('email_status'.$suffix,{$msgid => $newstatus}); } if ($newstatus eq 'deleted') { return &movemsg($msgid,$folder,'trash'); } return ; } # ============================================================= Make new folder sub makefolder { my ($newfolder)=@_; if (($newfolder eq 'sent') || ($newfolder eq 'critical') || ($newfolder eq 'trash') || ($newfolder eq 'new')) { return; } &Apache::lonnet::put('email_folders',{$newfolder => time}); } # ======================================================== Move between folders sub movemsg { my ($msgid,$srcfolder,$trgfolder)=@_; if ($srcfolder eq 'new') { $srcfolder=''; } my $srcsuffix=&Apache::lonmsg::foldersuffix($srcfolder); my $trgsuffix=&Apache::lonmsg::foldersuffix($trgfolder); if ($srcsuffix eq $trgsuffix) { return (0,&mt('Message not moved, Attempted to move message to the same folder as it already is in.')); } # Copy message my %message=&Apache::lonnet::get('nohist_email'.$srcsuffix,[$msgid]); if (!exists($message{$msgid}) || $message{$msgid} eq '') { if (&Apache::slotrequest::network_error(%message)) { return (0,&mt('Message not moved, A network error occurred.')); } else { return (0,&mt('Message not moved as the message is no longer in the source folder.')); } } my $result =&Apache::lonnet::put('nohist_email'.$trgsuffix, {$msgid => $message{$msgid}}); if (&Apache::slotrequest::network_error($result)) { return (0,&mt('Message not moved, A network error occurred.')); } # Copy status unless ($trgfolder eq 'trash') { my %status=&Apache::lonnet::get('email_status'.$srcsuffix,[$msgid]); # a non-existant status is the mark of an unread msg if (&Apache::slotrequest::network_error(%status)) { return (0,&mt('Message copied to new folder but status was not, A network error occurred.')); } my $result=&Apache::lonnet::put('email_status'.$trgsuffix, {$msgid => $status{$msgid}}); if (&Apache::slotrequest::network_error($result)) { return (0,&mt('Message copied to new folder but status was not, A network error occurred.')); } } # Delete orginals my $result_del_msg = &Apache::lonnet::del('nohist_email'.$srcsuffix,[$msgid]); my $result_del_stat = &Apache::lonnet::del('email_status'.$srcsuffix,[$msgid]); if (&Apache::slotrequest::network_error($result_del_msg)) { return (0,&mt('Message copied, but unable to delete the original from the source folder.')); } if (&Apache::slotrequest::network_error($result_del_stat)) { return (0,&mt('Message copied, but unable to delete the original status from the source folder.')); } return (1); } # ======================================================= Display a course list sub discourse { my $r=shift; my $classlist = &Apache::loncoursedata::get_classlist(); my $now=time; my %lt=&Apache::lonlocal::texthash('cfa' => 'Check All', 'cfs' => 'Check Section/Group', 'cfn' => 'Uncheck All'); $r->print(<    

ENDDISHEADER my %coursepersonnel=&Apache::lonnet::get_course_adv_roles(); $r->print(''); foreach my $role (sort keys %coursepersonnel) { foreach (split(/\,/,$coursepersonnel{$role})) { my ($puname,$pudom)=split(/\:/,$_); $r->print(''. ''); } } $r->print('
('.$_.'),'.$role.'
'); my $sort = sub { my $aname=lc($classlist->{$a}[&Apache::loncoursedata::CL_FULLNAME()]); if (!$aname) { $aname=$a; } my $bname=lc($classlist->{$b}[&Apache::loncoursedata::CL_FULLNAME()]); if (!$bname) { $bname=$b; } return $aname cmp $bname; }; foreach my $student (sort $sort (keys(%{$classlist}))) { my $info=$classlist->{$student}; my ($sname,$sdom,$status,$fullname,$section) = (@{$info}[&Apache::loncoursedata::CL_SNAME(), &Apache::loncoursedata::CL_SDOM(), &Apache::loncoursedata::CL_STATUS(), &Apache::loncoursedata::CL_FULLNAME(), &Apache::loncoursedata::CL_SECTION()]); next if ($status ne 'Active'); next if ($env{'request.course.sec'} && $section ne $env{'request.course.sec'}); my $key = 'send_to_&&&'.$section.'&&&_'.$student; if (! defined($fullname) || $fullname eq '') { $fullname = $sname; } $r->print(''); } $r->print('
'.$sname.':'.$sdom.''.$section. '
'); } # ==================================================== Display Critical Message sub discrit { my $r=shift; my $header = '

'.&mt('Critical Messages').'

'. '
'. ''; my %what=&Apache::lonnet::dump('critical'); my $result = ''; foreach (sort keys %what) { my %content=&Apache::lonmsg::unpackagemsg($what{$_}); next if ($content{'senderdomain'} eq ''); $result.='
'.&mt('From').': '. &Apache::loncommon::aboutmewrapper( &Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).' ('. $content{'sendername'}.':'. $content{'senderdomain'}.') '.$content{'time'}. '
'.&mt('Subject').': '.$content{'subject'}. '
'.
              &Apache::lontexconvert::msgtexconverted($content{'message'}).
            '
'. &mt('You have to confirm that you received this message. After confirmation, this message will be moved to your regular inbox'). '
'. ''. ''; } # Check to see if there were any messages. if ($result eq '') { $result = "

".&mt('You have no critical messages.')."

". ''.&mt('Select a course').'
'. ''.&mt('Communicate').''; } else { $r->print($header); } $r->print($result); $r->print('
'); } sub sortedmessages { my ($blocked,$startblock,$endblock,$numblocked,$folder) = @_; my $suffix=&Apache::lonmsg::foldersuffix($folder); my @messages = &Apache::lonnet::getkeys('nohist_email'.$suffix); #unpack the varibles and repack into temp for sorting my @temp; my %descriptions; my %status_cache = &Apache::lonnet::get('email_status'.&Apache::lonmsg::foldersuffix($folder),\@messages); my $get_received; if ($folder eq 'sent' && ($env{'form.sortedby'} =~ m/^(rev)?(user|domain)$/)) { $get_received = 1; } foreach my $msgid (@messages) { my $esc_msgid=&Apache::lonnet::escape($msgid); my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid)= &Apache::lonmsg::unpackmsgid($esc_msgid,$folder,undef, \%status_cache); my $description = &get_course_desc($fromcid,\%descriptions); my @temp1 = ($sendtime,$shortsubj,$fromname,$fromdomain,$status, $esc_msgid,$description); if ($get_received) { my %message = &Apache::lonnet::get('nohist_email'.$suffix, [$msgid]); my %content = &Apache::lonmsg::unpackagemsg($message{$msgid}); push(@temp1,$content{'recuser'},$content{'recdomain'}); } # Check whether message was sent during blocking period. if ($sendtime >= $startblock && ($sendtime <= $endblock && $endblock > 0) ) { $$blocked{$msgid} = '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"){ if ($get_received) { @temp = sort {lc($a->[7][0]) cmp lc($b->[7][0])} @temp; } else { @temp = sort {lc($a->[2]) cmp lc($b->[2])} @temp; } } if ($env{'form.sortedby'} eq "revuser"){ if ($get_received) { @temp = sort {lc($b->[7][0]) cmp lc($a->[7][0])} @temp; } else { @temp = sort {lc($b->[2]) cmp lc($a->[2])} @temp; } } if ($env{'form.sortedby'} eq "domain"){ if ($get_received) { @temp = sort {$a->[8][0] cmp $b->[8][0]} @temp; } else { @temp = sort {$a->[3] cmp $b->[3]} @temp; } } if ($env{'form.sortedby'} eq "revdomain"){ if ($get_received) { @temp = sort {$b->[8][0] cmp $a->[8][0]} @temp; } else { @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 "course"){ @temp = sort {lc($a->[6]) cmp lc($b->[6])} @temp; } if ($env{'form.sortedby'} eq "revcourse"){ @temp = sort {lc($b->[6]) cmp lc($a->[6])} @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; } sub get_course_desc { my ($fromcid,$descriptions) = @_; my $description; if (!$fromcid) { return $description; } else { if (defined($$descriptions{$fromcid})) { $description = $$descriptions{$fromcid}; } else { if (defined($env{'course.'.$fromcid.'.description'})) { $description = $env{'course.'.$fromcid.'.description'}; } else { my %courseinfo=&Apache::lonnet::coursedescription($fromcid); $description = $courseinfo{'description'}; $description = $courseinfo{'description'}; } $$descriptions{$fromcid} = $description; } return $description; } } # ======================================================== Display new messages sub disnew { my $r=shift; my %lt=&Apache::lonlocal::texthash( 'nm' => 'New Messages', 'su' => 'Subject', 'co' => 'Course', 'da' => 'Date', 'us' => 'Username', 'op' => 'Open', 'do' => 'Domain' ); my @msgids = sort(&Apache::lonnet::getkeys('nohist_email')); 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. &blockcheck(\%setters,\$startblock,\$endblock); my %status_cache = &Apache::lonnet::get('email_status',\@msgids); my %descriptions; foreach (@msgids) { my $msgid=&Apache::lonnet::escape($_); my ($sendtime,$shortsubj,$fromname,$fromdom,$status,$fromcid)= &Apache::lonmsg::unpackmsgid($msgid,undef,undef,\%status_cache); if (defined($sendtime) && $sendtime!~/error/) { my $description = &get_course_desc($fromcid,\%descriptions); 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 => $msgid, sendtime => $sendtime, shortsub => $shortsubj, from => $fromname, fromdom => $fromdom, course => $description } } } } } if ($#newmsgs >= 0) { $r->print(<$lt{'nm'} TABLEHEAD foreach my $msg (@newmsgs) { $r->print(<<"ENDLINK"); ENDLINK foreach ('sendtime','from','fromdom','shortsub','course') { $r->print(""); } $r->print(""); } $r->print('
  $lt{'da'}$lt{'us'}$lt{'do'}$lt{'su'}$lt{'co'}
$lt{'op'}$msg->{$_}
'); } elsif ($numblocked == 0) { $r->print("

".&mt('You have no unread messages')."

"); } if ($numblocked > 0) { my $beginblock = &Apache::lonlocal::locallocaltime($startblock); my $finishblock = &Apache::lonlocal::locallocaltime($endblock); if ($numblocked == 1) { $r->print("

".&mt('You have').' '.$numblocked.' '.&mt('blocked unread message').".

"); $r->print(&mt('This message is not viewable because').' '); } else { $r->print("

".&mt('You have').' '.$numblocked.' '.&mt('blocked unread messages').".

"); $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').'.'); &build_block_table($r,$startblock,$endblock,\%setters); } } # ======================================================== Display all messages sub disall { my ($r,$folder)=@_; $r->print(&folderlist($folder)); if ($folder eq 'new') { &disnew($r); } elsif ($folder eq 'critical') { &discrit($r); } else { &disfolder($r,$folder); } } # ============================================================ Display a folder sub disfolder { my ($r,$folder)=@_; my %blocked = (); my %setters = (); my $startblock; my $endblock; my $numblocked = 0; &blockcheck(\%setters,\$startblock,\$endblock); $r->print(< function checkall() { for (i=0; i ENDDISHEADER my $fsqs='&folder='.$folder; my @temp=sortedmessages(\%blocked,$startblock,$endblock,\$numblocked,$folder); my $totalnumber=$#temp+1; unless ($totalnumber>0) { $r->print('

'.&mt('Empty Folder').'

'); return; } unless ($interdis) { $interdis=20; } my $number=int($totalnumber/$interdis); if (($startdis<0) || ($startdis>$number)) { $startdis=$number; } my $firstdis=$interdis*$startdis; if ($firstdis>$#temp) { $firstdis=$#temp-$interdis+1; } my $lastdis=$firstdis+$interdis-1; if ($lastdis>$#temp) { $lastdis=$#temp; } $r->print(&scrollbuttons($startdis,$number,$firstdis,$lastdis,$totalnumber)); $r->print('
'. ''); } else { $r->print(''.&mt('Date').''); } $r->print(''); } else { $r->print(''.&mt('Status').''); } $r->print("\n"); my $suffix = &Apache::lonmsg::foldersuffix($folder); for (my $n=$firstdis;$n<=$lastdis;$n++) { my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$origID, $description,$recv_name,$recv_domain)= @{$temp[$n]}; if (($status ne 'deleted') && defined($sendtime) && $sendtime!~/error/) { if ($status eq 'new') { $r->print(''); } elsif ($status eq 'read') { $r->print(''); } elsif ($status eq 'replied') { $r->print(''); } else { $r->print(''); } my ($dis_name,$dis_domain) = ($fromname,$fromdomain); if ($folder eq 'sent') { if (defined($recv_name) && !defined($recv_domain)) { $dis_name = join('
',@{$recv_name}); $dis_domain = join('
',@{$recv_domain}); } else { my $msg_id = &Apache::lonnet::unescape($origID); my %message = &Apache::lonnet::get('nohist_email'.$suffix, [$msg_id]); my %content = &Apache::lonmsg::unpackagemsg($message{$msg_id}); $dis_name = join('
',@{$content{'recuser'}}); $dis_domain = join('
',@{$content{'recdomain'}}); } } $r->print(''. ''."\n"); } elsif ($status eq 'deleted') { # purge my ($result,$msg) = &movemsg(&Apache::lonnet::unescape($origID),$folder,'trash'); } } $r->print("
 '); if ($env{'form.sortedby'} eq "revdate") { $r->print(''.&mt('Date').''); if ($env{'form.sortedby'} eq "revuser") { $r->print(''.&mt('Username').''); } else { $r->print(''.&mt('Username').''); } $r->print(''); if ($env{'form.sortedby'} eq "revdomain") { $r->print(''.&mt('Domain').''); } else { $r->print(''.&mt('Domain').''); } $r->print(''); if ($env{'form.sortedby'} eq "revsubject") { $r->print(''.&mt('Subject').''); } else { $r->print(''.&mt('Subject').''); } $r->print(''); if ($env{'form.sortedby'} eq "revcourse") { $r->print(''.&mt('Course').''); } else { $r->print(''.&mt('Course').''); } $r->print(''); if ($env{'form.sortedby'} eq "revstatus") { $r->print(''.&mt('Status').'
'.&mt('Open').''. ($folder ne 'trash'?''.&mt('Delete'):' ').''.&Apache::lonlocal::locallocaltime($sendtime).''. $dis_name.''.$dis_domain.''. $shortsubj.''. $description.''.$status.'
\n

". ''.&mt('Check All').' '. ''.&mt('Uncheck All').'

'. ''); if ($folder ne 'trash') { $r->print( '

'); } $r->print('

'); my @allfolders=&Apache::lonnet::getkeys('email_folders'); if ($allfolders[0]=~/^error:/) { @allfolders=(); } $r->print( &Apache::loncommon::select_form('','movetofolder', ( map { $_ => $_ } @allfolders)) ); my $postedstartdis=$startdis+1; $r->print('

'); if ($numblocked > 0) { my $beginblock = &Apache::lonlocal::locallocaltime($startblock); my $finishblock = &Apache::lonlocal::locallocaltime($endblock); $r->print('

'. $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); } } # ============================================================== Compose output sub compout { my ($r,$forwarding,$replying,$broadcast,$replycrit,$folder,$dismode)=@_; my $suffix=&Apache::lonmsg::foldersuffix($folder); 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('

'.&mt('Replying to a Critical Message').'

'); $replying=$replycrit; } else { &printheader($r,'/adm/email?compose=upload', 'Distribute from Uploaded File'); } my $dispcrit=''; my $dissub=''; my $dismsg=''; my $disbase=''; 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'}) || &Apache::lonnet::allowed('srm',$env{'request.course.id'}. '/'.$env{'request.course.sec'})) { my $crithelp = Apache::loncommon::help_open_topic("Course_Critical_Message"); $dispcrit= '

' . $crithelp . '

'. '' . $crithelp . '

'. '

'; } my %message; my %content; my $defdom=$env{'user.domain'}; if ($forwarding) { %message=&Apache::lonnet::get('nohist_email'.$suffix,[$forwarding]); %content=&Apache::lonmsg::unpackagemsg($message{$forwarding},$folder); $dispcrit.=''; $func=&mt('Forward'); $dissub=&mt('Forwarding').': '.$content{'subject'}; $dismsg=&mt('Forwarded message from').' '. $content{'sendername'}.' '.&mt('at').' '.$content{'senderdomain'}; if ($content{'baseurl'}) { $disbase=''; } } if ($replying) { %message=&Apache::lonnet::get('nohist_email'.$suffix,[$replying]); %content=&Apache::lonmsg::unpackagemsg($message{$replying},$folder); $dispcrit.=''; $func=&mt('Send Reply 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 ($content{'baseurl'}) { $disbase=''; if ($env{'user.adv'}) { $disbase.=' '. &mt('Show re-usable messages').'
'; } } } my $citation=&displayresource(%content); if ($env{'form.recdom'}) { $defdom=$env{'form.recdom'}; } $r->print( '
'."\n". ''."\n". ''); unless (($broadcast eq 'group') || ($broadcast eq 'upload')) { if ($replying) { $r->print(''); } else { my $domform = &Apache::loncommon::select_dom_form($defdom,'recdomain'); my $selectlink=&Apache::loncommon::selectstudent_link ('compemail','recuname','recdomain'); $r->print(<<"ENDREC"); ENDREC } } my $latexHelp = Apache::loncommon::helpLatexCheatsheet(); if ($broadcast ne 'upload') { $r->print(<<"ENDCOMP");
'.&mt('Replying to').' '. &Apache::loncommon::aboutmewrapper( &Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).' ('. $content{'sendername'}.':'. $content{'senderdomain'}.')'. ''. ''. '
$lt{'us'}:$selectlink
$lt{'do'}: $domform
$lt{'ad'}
username\@domain,username\@domain, ...
$lt{'sb'}:
$latexHelp


$dispcrit $disbase
$citation ENDCOMP } else { # $broadcast is 'upload' $r->print(<

Generate messages from a file

Subject:

General message text

The file format for the uploaded portion of the message is:

username1\@domain1: text
username2\@domain2: text
username3\@domain1: text

The messages will be assembled from all lines with the respective username\@domain, and appended to the general message text.

$dispcrit

ENDUPLOAD } if ($broadcast eq 'group') { &discourse($r); } $r->print(''. &Apache::lonfeedback::generate_preview_button('compemail','message'). &Apache::lonhtmlcommon::htmlareaselectactive('message')); } # ---------------------------------------------------- Display all face to face sub retrieve_instructor_comments { my ($user,$domain)=@_; my $target=$env{'form.grade_target'}; if (! $env{'request.course.id'}) { return; } if (! &Apache::lonnet::allowed('srm',$env{'request.course.id'}) && ! &Apache::lonnet::allowed('srm',$env{'request.course.id'}. '/'.$env{'request.course.sec'})) { 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=&Apache::lonmsg::unpackagemsg($records{$_}); next if ($content{'senderdomain'} eq ''); next if ($content{'subject'} !~ /^Record/); # &Apache::lonfeedback::newline_to_br(\$content{'message'}); $result.='Recorded by '. $content{'sendername'}.':'.$content{'senderdomain'}."\n"; $result.= &Apache::lontexconvert::msgtexconverted($content{'message'})."\n"; } return $result; } sub disfacetoface { my ($r,$user,$domain)=@_; my $target=$env{'form.grade_target'}; unless ($env{'request.course.id'}) { return; } if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'}) && ! &Apache::lonnet::allowed('srm',$env{'request.course.id'}. '/'.$env{'request.course.sec'})) { $r->print('Not allowed'); 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=&Apache::lonmsg::unpackagemsg($records{$_}); next if ($content{'senderdomain'} eq ''); &Apache::lonfeedback::newline_to_br(\$content{'message'}); if ($content{'subject'}=~/^Record/) { $result.='

'.&mt('Record').'

'; } elsif ($content{'subject'}=~/^Broadcast/) { $result .='

'.&mt('Broadcast Message').'

'; if ($content{'subject'}=~/^Broadcast\./) { if (defined($content{'coursemsgid'})) { my $crsmsgid = &Apache::lonnet::escape($content{'coursemsgid'}); my $broadcast_message = &general_message($crsmsgid); $content{'message'} = ''.&mt('Subject').': '.$content{'message'}.'
'.$broadcast_message; } else { %content=&Apache::lonmsg::unpackagemsg($content{'message'}); $content{'message'} = ''.&mt('Subject').': '.$content{'subject'}.'
'. $content{'message'}; } } } else { $result.='

'.&mt('Critical Message').'

'; if (defined($content{'coursemsgid'})) { my $crsmsgid=&Apache::lonnet::escape($content{'coursemsgid'}); my $critical_message = &general_message($crsmsgid); $content{'message'} = ''.&mt('Subject').': '.$content{'message'}.'
'.$critical_message; } else { %content=&Apache::lonmsg::unpackagemsg($content{'message'}); $content{'message'}= ''.&mt('Subject').': '.$content{'subject'}.'
'. $content{'message'}; } } $result.=&mt('By').': '. &Apache::loncommon::aboutmewrapper( &Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).' ('. $content{'sendername'}.':'. $content{'senderdomain'}.') '.$content{'time'}. '
'.
              &Apache::lontexconvert::msgtexconverted($content{'message'}).
	      '
'; } # Check to see if there were any messages. if ($result eq '') { if ($target ne 'tex') { $r->print("

".&mt("No notes, face-to-face discussion records, critical messages, or broadcast messages in this course.")."

"); } else { $r->print('\textbf{'.&mt("No notes, face-to-face discussion records, critical messages or broadcast messages in this course.").'}\\\\'); } } else { $r->print($result); } } sub general_message { my ($crsmsgid) = @_; my %general_content; if ($crsmsgid) { my %course_content = &Apache::lonnet::get('nohist_email',[$crsmsgid], $env{'course.'.$env{'request.course.id'}.'.domain'}, $env{'course.'.$env{'request.course.id'}.'.num'}); %general_content = &Apache::lonmsg::unpackagemsg($course_content{$crsmsgid}); } return $general_content{'message'}; } # ---------------------------------------------------------------- Face to face sub facetoface { my ($r,$stage)=@_; if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'}) && ! &Apache::lonnet::allowed('srm',$env{'request.course.id'}. '/'.$env{'request.course.sec'})) { $r->print('Not allowed'); 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");

$lt{'head'}

$lt{'user'}: $stdbrws
$lt{'dom'}: $domform
ENDTREC if (($stage ne 'query') && ($env{'form.recdomain'}) && ($env{'form.recuname'})) { chomp($env{'form.newrecord'}); if ($env{'form.newrecord'}) { my $recordtxt = $env{'form.newrecord'}; &Apache::lonmsg::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'}.']', $recordtxt); } $r->print('

'.&Apache::loncommon::plainname($env{'form.recuname'}, $env{'form.recdomain'}).'

'); &disfacetoface($r,$env{'form.recuname'},$env{'form.recdomain'}); $r->print(< ENDRHEAD $r->print(<$lt{'newr'}

ENDBFORM } } # ----------------------------------------------------------- Blocking during exams sub examblock { my ($r,$action) = @_; unless ($env{'request.course.id'}) { return;} if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'}) && ! &Apache::lonnet::allowed('srm',$env{'request.course.id'}. '/'.$env{'request.course.sec'})) { $r->print('Not allowed'); return; } 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('

'.$lt{'cbds'}.'

'); if ($action eq 'store') { &blockstore($r); } $r->print($lt{'desc'}.'

'); $r->print('

'.$lt{'mecb'}.'

'); 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'}.'

'); } &display_addblocker_table($r,$parmcount,\%ltext); my $end_page=&Apache::loncommon::end_page(); $r->print(<<"END");
$end_page 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('

'.$lt{'head'}.'

'); 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'}.'
    '); if ($canceltotal > 0) { $r->print('
  • '.$canceltotal.' '.$lt{'cbps'},' '.$lt{'werm'}.'
  • '); } if ($modtotal > 0) { $r->print('
  • '.$modtotal.' '.$lt{'cbps'},' '.$lt{'wemo'}.'
  • '); } if ($addtotal > 0) { $r->print('
  • '.$addtotal.' '.$lt{'cbps'},' '.$lt{'wead'}.'
  • '); } $r->print('
'); } else { $r->print($lt{'ncwm'}); } $r->print('
'); 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}); if ((keys(%{$records}))[0] =~ /^error: 2 /) { $records = {}; $$blockcount = 0; } } sub display_blocker_status { my ($r,$records,$ltext) = @_; my $parmcount = 0; my %lt = &Apache::lonlocal::texthash( 'modi' => 'Modify', 'canc' => 'Cancel', ); $r->print(<<"END"); 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 ($setuname,$setudom,$title) = &parse_block_record($$records{$_}); my $settername = &Apache::loncommon::plainname($setuname,$setudom); $r->print(<<"END"); END $parmcount ++; } $r->print(<<"END");
$$ltext{'dura'} $$ltext{'setb'} $$ltext{'even'} $$ltext{'actn'}?
$$ltext{'star'}: $startform
$$ltext{'endd'}:  $endform
$settername


END return $parmcount; } sub parse_block_record { my ($record) = @_; my ($setuname,$setudom,$title); my @data = split(/:/,$record,3); if (scalar(@data) eq 2) { $title = $data[1]; ($setuname,$setudom) = split(/@/,$data[0]); } else { ($setuname,$setudom,$title) = @data; } return ($setuname,$setudom,$title); } 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 %lt = &Apache::lonlocal::texthash( 'addb' => 'Add block', 'exam' => 'e.g., Exam 1', 'addn' => 'Add new communication blocking periods' ); $r->print(<<"END");

$lt{'addn'}

$$ltext{'dura'} $$ltext{'even'} $lt{'exam'} $$ltext{'actn'}?
$$ltext{'star'}: $startform
$$ltext{'endd'}:  $endform
END return; } sub blockcheck { my ($setters,$startblock,$endblock) = @_; # Retrieve active student roles and active course coordinator/instructor roles my %live_courses = map { $_ => 1} &Apache::loncommon::findallcourses(); # FIXME should really probe for apriv, but ::allowed can only probe the # currently active role my %staff_of = map { $_ => 1} &Apache::loncommon::findallcourses(['cc','in']); # Retrieve blocking times and identity of blocker for active courses # for students. return if (!%live_courses); &Apache::lonnet::logthis("hmm"); &Apache::lonnet::logthis(join(" ",%live_courses)); &Apache::lonnet::logthis(join(" ",%staff_of)); foreach my $course (keys(%live_courses)) { my ($cdom,$cnum) = split(/_/,$course); # if they are a staff member and are currently not playing student next if ( $staff_of{$course} && ($env{'request.role'} !~ m{^st\./$cdom/$cnum})); $setters->{$course} = {}; $setters->{$course}{'staff'} = []; $setters->{$course}{'times'} = []; my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum); foreach my $record (keys %records) { my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/); if ($start <= time && $end >= time) { my ($staff_name,$staff_dom,$title) = &parse_block_record($records{$record}); push(@{$$setters{$course}{'staff'}}, [$staff_name,$staff_dom]); push(@{$$setters{$course}{'times'}}, [$start,$end]); if ( ($$startblock == 0) || ($$startblock > $1) ) { $$startblock = $1; } if ( ($$endblock == 0) || ($$endblock < $2) ) { $$endblock = $2; } } } } } sub build_block_table { my ($r,$startblock,$endblock,$setters) = @_; my %lt = &Apache::lonlocal::texthash( 'cacb' => 'Currently active communication blocks', 'cour' => 'Course', 'dura' => 'Duration', 'blse' => 'Block set by' ); $r->print(<<"END");
$lt{'cacb'}:

END foreach (keys %{$setters}) { my %courseinfo=&Apache::lonnet::coursedescription($_); for (my $i=0; $i<@{$$setters{$_}{staff}}; $i++) { my ($uname,$udom) = @{$$setters{$_}{staff}[$i]}; my $fullname = &Apache::loncommon::plainname($uname,$udom); my ($openblock,$closeblock) = @{$$setters{$_}{times}[$i]}; $openblock = &Apache::lonlocal::locallocaltime($openblock); $closeblock= &Apache::lonlocal::locallocaltime($closeblock); $r->print(''. ''. ''); } } $r->print('
$lt{'cour'} $lt{'dura'} $lt{'blse'}
'.$courseinfo{'description'}.''.$openblock.' to '.$closeblock.''.$fullname.' ('.$uname.':'.$udom. ')
'); } # ----------------------------------------------------------- Display a message sub displaymessage { my ($r,$msgid,$folder)=@_; my $suffix=&Apache::lonmsg::foldersuffix($folder); 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,$folder); 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',$folder); my %message=&Apache::lonnet::get('nohist_email'.$suffix,[$msgid]); my %content=&Apache::lonmsg::unpackagemsg($message{$msgid}); my $counter=0; $r->print('
');
    my $escmsgid=&Apache::lonnet::escape($msgid);
    foreach (@messages) {
	if ($_->[5] eq $escmsgid){
	    last;
	}
	$counter++;
    }
    $r->print('
'); 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(''. ''. ''. ''. ''. ''); if ($counter > 0){ $r->print(''); } if ($counter < $number_of_messages - 1){ $r->print(''); } $r->print('
'.&mt('Functions').':'.&mt('Reply').''.&mt('Forward').''.&mt('Mark Unread').''.&mt('Delete').''.&mt('Back to Folder Display').''.&mt('Previous').''.&mt('Next').'
'); if ($env{'user.adv'}) { $r->print(''); my $symb=&Apache::lonnet::symbread($content{'baseurl'}); if (&Apache::lonnet::allowed('vgr',$env{'request.course.id'})) { $r->print(''); } if (&Apache::lonnet::allowed('opa',$env{'request.course.id'}) && $symb) { $r->print(''); } if (&Apache::lonnet::allowed('mgr',$env{'request.course.id'}) && $symb) { $r->print(''); } $r->print('
'.&mt('Currently available actions (will open extra window)').':'.&Apache::loncommon::track_student_link(&mt('View recent activity'),$content{'sendername'},$content{'senderdomain'},'check').''.&Apache::loncommon::pprmlink(&mt('Set/Change parameters'),$content{'sendername'},$content{'senderdomain'},$symb,'check').''.&Apache::loncommon::pgrdlink(&mt('Set/Change grades'),$content{'sendername'},$content{'senderdomain'},$symb,'check').'
'); } my $tolist; my @recipients = (); for (my $i=0; $i<@{$content{'recuser'}}; $i++) { $recipients[$i] = &Apache::loncommon::aboutmewrapper( &Apache::loncommon::plainname($content{'recuser'}[$i], $content{'recdomain'}[$i]), $content{'recuser'}[$i],$content{'recdomain'}[$i]). ' ('.$content{'recuser'}[$i].' at '.$content{'recdomain'}[$i].') '; } $tolist = join(', ',@recipients); $r->print('
'.&mt('Subject').': '.$content{'subject'}. ($folder ne 'sent'?'
'.&mt('From').': '. &Apache::loncommon::aboutmewrapper( &Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}), $content{'sendername'},$content{'senderdomain'}).' ('. $content{'sendername'}.' at '. $content{'senderdomain'}.') ':'
'.&mt('To').': '. $tolist). ($content{'courseid'}?'
'.&mt('Course').': '.$courseinfo{'description'}. ($content{'coursesec'}?' ('.&mt('Group/Section').': '.$content{'coursesec'}.')':''):''). '
'.&mt('Time').': '.$content{'time'}. ($content{'baseurl'}?'
'.&mt('Refers to').': '. $content{'baseurl'}.' ('.&Apache::lonnet::gettitle($content{'baseurl'}).')':''). '

'.
	      &Apache::lontexconvert::msgtexconverted($content{'message'},1).
	      '

'.&displayresource(%content).'

'); return; } # =========================================================== Show the citation sub displayresource { my %content=@_; # # If the recipient is in the same course that the message was sent from and # has sufficient privileges, show "all details," else show citation # if (($env{'request.course.id'} eq $content{'courseid'}) && (&Apache::lonnet::allowed('vgr',$content{'courseid'}))) { my $symb=&Apache::lonnet::symbread($content{'baseurl'}); # Could not get a symb, give up unless ($symb) { return $content{'citation'}; } # Have a symb, can render return '

'.&mt('Current attempts of student (if applicable)').'

'. &Apache::loncommon::get_previous_attempt($symb, $content{'sendername'}, $content{'senderdomain'}, $content{'courseid'}). '

'.&mt('Current screen output (if applicable)').'

'. &Apache::loncommon::get_student_view($symb, $content{'sendername'}, $content{'senderdomain'}, $content{'courseid'}). '

'.&mt('Correct Answer(s) (if applicable)').'

'. &Apache::loncommon::get_student_answers($symb, $content{'sendername'}, $content{'senderdomain'}, $content{'courseid'}); } elsif ($env{'user.adv'}) { return $content{'citation'}; } return ''; } # ================================================================== The Header sub header { my ($r,$title,$baseurl)=@_; my $extra = &Apache::loncommon::studentbrowser_javascript(); if ($baseurl) { $extra .= ""; } $r->print(&Apache::loncommon::start_page('Communication and Messages', $extra)); $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); } # ------------------------------------------------------------ Store the comment sub storecomment { my ($r)=@_; my $msgtxt=&Apache::lonfeedback::clear_out_html($env{'form.message'}); my $cleanmsgtxt=''; foreach (split(/[\n\r]/,$msgtxt)) { unless ($_=~/^\s*(\>|\>\;)/) { $cleanmsgtxt.=$_."\n"; } } my $key=&Apache::lonnet::escape($env{'form.baseurl'}).'___'.time; &Apache::lonnet::put('nohist_stored_comments',{ $key => $cleanmsgtxt }); } sub storedcommentlisting { my ($r)=@_; my %msgs=&Apache::lonnet::dump('nohist_stored_comments',undef,undef, '^'.&Apache::lonnet::escape(&Apache::lonnet::escape($env{'form.showcommentbaseurl'}))); $r->print(&Apache::loncommon::start_page('Stored Comment Listing',undef, {'onlybody' => 1})); if ((keys %msgs)[0]=~/^error\:/) { $r->print(&mt('No stored comments yet.')); } else { my $found=0; foreach (sort keys %msgs) { $r->print("\n".$msgs{$_}."
"); $found=1; } unless ($found) { $r->print(&mt('No stored comments yet for this resource.')); } } } # ---------------------------------------------------------------- Send an email sub sendoffmail { my ($r,$folder)=@_; my $suffix=&Apache::lonmsg::foldersuffix($folder); my $sendstatus=''; my %specialmsg_status; my $numspecial = 0; 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'.$suffix,[$msgid]); %content=&Apache::lonmsg::unpackagemsg($message{$msgid},1); &statuschange($msgid,'forwarded',$folder); $env{'form.message'}.="\n\n-- Forwarded message --\n\n". $content{'message'}; } if ($env{'form.replyid'}) { my $msgid=$env{'form.replyid'}; my %message=&Apache::lonnet::get('nohist_email'.$suffix,[$msgid]); %content=&Apache::lonmsg::unpackagemsg($message{$msgid},1); &statuschange($msgid,'replied',$folder); } my %toaddr; if ($env{'form.sendmode'} eq 'group') { foreach my $address (keys(%env)) { if ($address=~/^form\.send\_to\_\&\&\&[^\&]*\&\&\&\_(.+)$/) { $toaddr{$1}=''; } } } elsif ($env{'form.sendmode'} eq 'upload') { foreach my $line (split(/[\n\r\f]+/,$env{'form.upfile'})) { my ($rec,$txt)=split(/\s*\:\s*/,$line); 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}=''; } } my $savemsg; my $msgtype; my %sentmessage; my $msgsubj=&Apache::lonfeedback::clear_out_html($env{'form.subject'}, undef,1); if ((($env{'form.critmsg'}) || ($env{'form.sendbck'})) && (&Apache::lonnet::allowed('srm',$env{'request.course.id'}) || &Apache::lonnet::allowed('srm',$env{'request.course.id'}. '/'.$env{'request.course.sec'}) )) { $savemsg=&Apache::lonfeedback::clear_out_html($env{'form.message'},1); $msgtype = 'critical'; } else { $savemsg=&Apache::lonfeedback::clear_out_html($env{'form.message'}); } foreach my $address (sort(keys(%toaddr))) { my ($recuname,$recdomain)=split(/\:/,$address); my $msgtxt = $savemsg; if ($toaddr{$address}) { $msgtxt.='
'.$toaddr{$address}; } my @thismsg; if ((($env{'form.critmsg'}) || ($env{'form.sendbck'})) && (&Apache::lonnet::allowed('srm',$env{'request.course.id'}) || &Apache::lonnet::allowed('srm',$env{'request.course.id'}. '/'.$env{'request.course.sec'}))) { $r->print(&mt('Sending critical message').' '.$recuname.':'.$recdomain.': '); @thismsg= &Apache::lonmsg::user_crit_msg($recuname,$recdomain, $msgsubj,$msgtxt, $env{'form.sendbck'}, $env{'form.permanent'}, \$sentmessage{$address}); } else { $r->print(&mt('Sending').' '.$recuname.':'.$recdomain.': '); @thismsg= &Apache::lonmsg::user_normal_msg($recuname,$recdomain, $msgsubj,$msgtxt, $content{'citation'}, undef,undef, $env{'form.permanent'}, \$sentmessage{$address}); } if (($env{'request.course.id'}) && (($msgtype eq 'critical') || ($env{'form.sendmode'} eq 'group'))) { $specialmsg_status{$recuname.':'.$recdomain} = join(' ',@thismsg); foreach my $result (@thismsg) { if ($result eq 'ok') { $numspecial++; } } } $sendstatus.=' '.join(' ',@thismsg); } if (($env{'request.course.id'}) && (($env{'form.sendmode'} eq 'group') || ($msgtype eq 'critical'))) { my $subj_prefix; if ($msgtype eq 'critical') { $subj_prefix = 'Critical.'; } else { $subj_prefix = 'Broadcast.'; } my ($specialmsgid,$specialresult); my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; my $course_str = &Apache::lonnet::escape('['.$cnum.':'.$cdom.']'); if ($numspecial) { $specialresult = &Apache::lonmsg::user_normal_msg_raw($cnum,$cdom,$subj_prefix. ' '.$course_str,$savemsg,undef,undef,undef, undef,undef,\$specialmsgid); $specialmsgid = &Apache::lonnet::unescape($specialmsgid); } if ($specialresult eq 'ok') { my $record_sent; my @recusers; my @recudoms; my ($stamp,$crssubj,$msgname,$msgdom,$msgcount,$context,$pid) = split(/\:/,&Apache::lonnet::unescape($specialmsgid)); foreach my $recipient (sort(keys(%toaddr))) { if ($specialmsg_status{$recipient} eq 'ok') { my $usersubj = $subj_prefix.'['.$recipient.']'; my $usermsgid = &Apache::lonmsg::buildmsgid($stamp,$usersubj, $msgname,$msgdom, $msgcount,$context, $pid); &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 (@recusers) { my $specialmessage; my $sentsubj = $subj_prefix.' ('.$numspecial.' sent) '.$msgsubj; $sentsubj = &HTML::Entities::encode($sentsubj,'<>&"'); my $sentmsgid = &Apache::lonmsg::buildmsgid($stamp,$sentsubj,$msgname, $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 { &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'); } } } else { &printheader($r,'','No messages sent.'); } if ($sendstatus=~/^(\s*(?:ok|con_delayed)\s*)*$/) { $r->print('
'.&mt('Completed.').''); if ($env{'form.displayedcrit'}) { &discrit($r); } else { &Apache::loncommunicate::menu($r); } } else { $r->print('

'.&mt('Could not deliver message').' '. &mt('Please use the browser "Back" button and correct the recipient addresses').'

'); } } # ===================================================================== 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','folder','startdis','interdis', 'showcommentbaseurl','dismode']); $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',}); # ------------------------------------------------------------------ Get Folder my $folder=$env{'form.folder'}; unless ($folder) { $folder=''; } else { $sqs.='&folder='.&Apache::lonnet::escape($folder); } # ------------------------------------------------------------ Get Display Mode my $dismode=$env{'form.dismode'}; unless ($dismode) { $dismode=''; } else { $sqs.='&dismode='.&Apache::lonnet::escape($dismode); } # --------------------------------------------------------------------- Display $startdis=$env{'form.startdis'}; $startdis--; unless ($startdis) { $startdis=0; } $interdis=$env{'form.interdis'}; unless ($interdis) { $interdis=20; } $sqs.='&interdis='.$interdis; if ($env{'form.firstview'}) { $startdis=0; } if ($env{'form.lastview'}) { $startdis=-1; } if ($env{'form.prevview'}) { $startdis--; } if ($env{'form.nextview'}) { $startdis++; } my $postedstartdis=$startdis+1; $sqs.='&startdis='.$postedstartdis; # --------------------------------------------------------------- Render Output if ($env{'form.display'}) { &displaymessage($r,$env{'form.display'},$folder); } elsif ($env{'form.replyto'}) { &compout($r,'',$env{'form.replyto'},undef,undef,$folder,$dismode); } elsif ($env{'form.confirm'}) { &printheader($r,'','Confirmed Receipt'); foreach (keys %env) { if ($_=~/^form\.rec\_(.*)$/) { $r->print(''.&mt('Confirming Receipt').': '. &Apache::lonmsg::user_crit_received($1).'
'); } if ($_=~/^form\.reprec\_(.*)$/) { my $msgid=$1; $r->print(''.&mt('Confirming Receipt').': '. &Apache::lonmsg::user_crit_received($msgid).'
'); &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'},undef,undef,undef,$folder); } elsif ($env{'form.markdel'}) { &printheader($r,'','Deleted Message'); my ($result,$msg) = &statuschange($env{'form.markdel'},'deleted',$folder); if (!$result) { $r->print('

'. &mt('Failed to delete the message.').'

'. '

'.$msg."

\n"); } &Apache::loncommunicate::menu($r); &disall($r,($folder?$folder:$dismode)); } elsif ($env{'form.markedmove'}) { my ($total,$failed,@failed_msg)=(0,0); foreach my $key (keys(%env)) { if ($key=~/^form\.delmark_(.*)$/) { my ($result,$msg) = &movemsg(&Apache::lonnet::unescape($1),$folder, $env{'form.movetofolder'}); if ($result) { $total++; } else { $failed++; push(@failed_msg,$msg); } } } &printheader($r,'','Moved Messages'); if ($failed) { $r->print('

'.&mt('Failed to move [_1] message(s)',$failed). '

'); $r->print('

'. join("

\n

",@failed_msg). "

\n"); } $r->print(&mt('Moved [_1] message(s)',$total).'

'); &Apache::loncommunicate::menu($r); &disall($r,($folder?$folder:$dismode)); } elsif ($env{'form.markeddel'}) { my ($total,$failed,@failed_msg)=(0,0); foreach my $key (keys(%env)) { if ($key=~/^form\.delmark_(.*)$/) { my ($result,$msg) = &statuschange(&Apache::lonnet::unescape($1),'deleted', $folder); if ($result) { $total++; } else { $failed++; push(@failed_msg,$msg); } } } &printheader($r,'','Deleted Messages'); if ($failed) { $r->print('

'.&mt('Failed to delete [_1] message(s)',$failed). '

'); $r->print('

'. join("

\n

",@failed_msg). "

\n"); } $r->print(&mt('Deleted [_1] message(s)',$total).'

'); &Apache::loncommunicate::menu($r); &disall($r,($folder?$folder:$dismode)); } elsif ($env{'form.markunread'}) { &printheader($r,'','Marked Message as Unread'); &statuschange($env{'form.markunread'},'new'); &Apache::loncommunicate::menu($r); &disall($r,($folder?$folder:$dismode)); } 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'}) { &sendoffmail($r,$folder); if ($env{'form.storebasecomment'}) { &storecomment($r); } if (($env{'form.rsspost'}) && ($env{'request.course.id'})) { &Apache::lonrss::addentry($env{'course.'.$env{'request.course.id'}.'.num'}, $env{'course.'.$env{'request.course.id'}.'.domain'}, 'Course_Announcements', $env{'form.subject'}, $env{'form.message'},'/adm/communicate','public'); } &disall($r,($folder?$folder:$dismode)); } elsif ($env{'form.newfolder'}) { &printheader($r,'','New Folder'); &makefolder($env{'form.newfolder'}); &Apache::loncommunicate::menu($r); &disall($r,$env{'form.newfolder'}); } elsif ($env{'form.showcommentbaseurl'}) { &storedcommentlisting($r); } else { &printheader($r,'','Display All Messages'); &Apache::loncommunicate::menu($r); &disall($r,($folder?$folder:$dismode)); } $r->print(&Apache::loncommon::end_page()); return OK; } # ================================================= Main program, reset counter =pod =back =cut 1; __END__