loncom/interface/lonmsg.pm - diff

Return to lonmsg.pm CVS log

Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonmsg.pm between versions 1.46 and 1.58

version 1.46, 2002/12/30 14:10:58	version 1.58, 2003/07/25 01:18:04
Line 44	Line 44
#	#
package Apache::lonmsg;	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.

	=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 strict;
use Apache::lonnet();	use Apache::lonnet();
use vars qw($msgcount);	use vars qw($msgcount);
use HTML::TokeParser;	use HTML::TokeParser();
use Apache::Constants qw(:common);	use Apache::Constants qw(:common);
use Apache::loncommon;	use Apache::loncommon();
use Apache::lontexconvert;	use Apache::lontexconvert();
	use HTML::Entities();
	use Mail::Send;

# ===================================================================== Package	# ===================================================================== Package

sub packagemsg {	sub packagemsg {
my ($subject,$message,$citation)=@_;	my ($subject,$message,$citation,$baseurl,$attachmenturl)=@_;
$message=~s/\</\&lt\;/g;	$message =&HTML::Entities::encode($message);
$message=~s/\>/\&gt\;/g;	$citation=&HTML::Entities::encode($citation);
$citation=~s/\</\&lt\;/g;	$subject =&HTML::Entities::encode($subject);
$citation=~s/\>/\&gt\;/g;	#remove machine specification
$subject=~s/\</\&lt\;/g;	$baseurl =~ s\|^http://[^/]+/\|/\|;
$subject=~s/\>/\&gt\;/g;	$baseurl =&HTML::Entities::encode($baseurl);
	#remove machine specification
	$attachmenturl =~ s\|^http://[^/]+/\|/\|;
	$attachmenturl =&HTML::Entities::encode($attachmenturl);

my $now=time;	my $now=time;
$msgcount++;	$msgcount++;
my $partsubj=$subject;	my $partsubj=$subject;
Line 69 sub packagemsg {	Line 137 sub packagemsg {
my $msgid=&Apache::lonnet::escape(	my $msgid=&Apache::lonnet::escape(
$now.':'.$partsubj.':'.$ENV{'user.name'}.':'.	$now.':'.$partsubj.':'.$ENV{'user.name'}.':'.
$ENV{'user.domain'}.':'.$msgcount.':'.$$);	$ENV{'user.domain'}.':'.$msgcount.':'.$$);
return $msgid,	my $result='<sendername>'.$ENV{'user.name'}.'</sendername>'.
'<sendername>'.$ENV{'user.name'}.'</sendername>'.
'<senderdomain>'.$ENV{'user.domain'}.'</senderdomain>'.	'<senderdomain>'.$ENV{'user.domain'}.'</senderdomain>'.
'<subject>'.$subject.'</subject>'.	'<subject>'.$subject.'</subject>'.
'<time>'.localtime($now).'</time>'.	'<time>'.localtime($now).'</time>'.
Line 86 sub packagemsg {	Line 153 sub packagemsg {
'<role>'.$ENV{'request.role'}.'</role>'.	'<role>'.$ENV{'request.role'}.'</role>'.
'<resource>'.$ENV{'request.filename'}.'</resource>'.	'<resource>'.$ENV{'request.filename'}.'</resource>'.
'<msgid>'.$msgid.'</msgid>'.	'<msgid>'.$msgid.'</msgid>'.
'<message>'.$message.'</message>'.	'<message>'.$message.'</message>';
'<citation>'.$citation.'</citation>';	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	# ================================================== Unpack message into a hash

sub unpackagemsg {	sub unpackagemsg {
my $message=shift;	my ($message,$notoken)=@_;
my %content=();	my %content=();
my $parser=HTML::TokeParser->new(\$message);	my $parser=HTML::TokeParser->new(\$message);
my $token;	my $token;
Line 104 sub unpackagemsg {	Line 180 sub unpackagemsg {
$content{$entry}=$value;	$content{$entry}=$value;
}	}
}	}
	if ($content{'attachmenturl'}) {
	my ($fname,$ft)=($content{'attachmenturl'}=~/\/(\w+)\.(\w+)$/);
	if ($notoken) {
	$content{'message'}.='<p>Attachment: <tt>'.$fname.'.'.$ft.'</tt>';
	} else {
	$content{'message'}.='<p>Attachment: <a href="'.
	&Apache::lonnet::tokenwrapper($content{'attachmenturl'}).
	'"><tt>'.$fname.'.'.$ft.'</tt></a>';
	}
	}
return %content;	return %content;
}	}

Line 119 sub unpackmsgid {	Line 205 sub unpackmsgid {
return ($sendtime,$shortsubj,$fromname,$fromdomain,$status{$msgid});	return ($sendtime,$shortsubj,$fromname,$fromdomain,$status{$msgid});
}	}


	sub sendemail {
	my ($to,$subject,$body)=@_;
	$body=
	"*** This is an automatic message generated by the LON-CAPA system.\n".
	"*** Please do not reply to this address.\n\n".$body;
	my $msg = new Mail::Send;
	$msg->to($to);
	$msg->subject('[LON-CAPA] '.$subject);
	my $fh = $msg->open('smtp',Server => 'localhost');
	print $fh $body;
	$fh->close;
	}

	# ==================================================== 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	# ============================================================= Check for email

sub newmail {	sub newmail {
Line 132 sub newmail {	Line 254 sub newmail {

# =============================== Automated message to the author of a resource	# =============================== 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 {	sub author_res_msg {
my ($filename,$message)=@_;	my ($filename,$message)=@_;
unless ($message) { return 'empty'; }	unless ($message) { return 'empty'; }
Line 176 sub user_crit_msg_raw {	Line 305 sub user_crit_msg_raw {
} else {	} else {
$status='no_host';	$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(	&Apache::lonnet::logthis(
'Sending critical email '.$msgid.	'Sending critical email '.$msgid.
', log status: '.	', log status: '.
Line 188 sub user_crit_msg_raw {	Line 324 sub user_crit_msg_raw {

# New routine that respects "forward" and calls old routine	# 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 {	sub user_crit_msg {
my ($user,$domain,$subject,$message,$sendback)=@_;	my ($user,$domain,$subject,$message,$sendback)=@_;
my $status='';	my $status='';
Line 212 sub user_crit_msg {	Line 356 sub user_crit_msg {
sub user_crit_received {	sub user_crit_received {
my $msgid=shift;	my $msgid=shift;
my %message=&Apache::lonnet::get('critical',[$msgid]);	my %message=&Apache::lonnet::get('critical',[$msgid]);
my %contents=&unpackagemsg($message{$msgid});	my %contents=&unpackagemsg($message{$msgid},1);
my $status='rec: '.($contents{'sendback'}?	my $status='rec: '.($contents{'sendback'}?
&user_normal_msg($contents{'sendername'},$contents{'senderdomain'},	&user_normal_msg($contents{'sendername'},$contents{'senderdomain'},
'Receipt: '.$ENV{'user.name'}.' at '.$ENV{'user.domain'},	'Receipt: '.$ENV{'user.name'}.' at '.$ENV{'user.domain'},
Line 236 sub user_crit_received {	Line 380 sub user_crit_received {
# ======================================================== Normal communication	# ======================================================== Normal communication

sub user_normal_msg_raw {	sub user_normal_msg_raw {
my ($user,$domain,$subject,$message,$citation)=@_;	my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl)=@_;
# Check if allowed missing	# Check if allowed missing
my $status='';	my $status='';
my $msgid='undefined';	my $msgid='undefined';
unless (($message)&&($user)&&($domain)) { $status='empty'; };	unless (($message)&&($user)&&($domain)) { $status='empty'; };
my $homeserver=&Apache::lonnet::homeserver($user,$domain);	my $homeserver=&Apache::lonnet::homeserver($user,$domain);
if ($homeserver ne 'no_host') {	if ($homeserver ne 'no_host') {
($msgid,$message)=&packagemsg($subject,$message,$citation);	($msgid,$message)=&packagemsg($subject,$message,$citation,$baseurl,
	$attachmenturl);
$status=&Apache::lonnet::critical(	$status=&Apache::lonnet::critical(
'put:'.$domain.':'.$user.':nohist_email:'.	'put:'.$domain.':'.$user.':nohist_email:'.
&Apache::lonnet::escape($msgid).'='.	&Apache::lonnet::escape($msgid).'='.
Line 253 sub user_normal_msg_raw {	Line 398 sub user_normal_msg_raw {
} else {	} else {
$status='no_host';	$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'},	&Apache::lonnet::log($ENV{'user.domain'},$ENV{'user.name'},
$ENV{'user.home'},	$ENV{'user.home'},
'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status);	'Sending '.$msgid.' to '.$user.' at '.$domain.' with status: '.$status);
Line 261 sub user_normal_msg_raw {	Line 412 sub user_normal_msg_raw {

# New routine that respects "forward" and calls old routine	# 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 {	sub user_normal_msg {
my ($user,$domain,$subject,$message,$citation)=@_;	my ($user,$domain,$subject,$message,$citation,$baseurl,$attachmenturl)=@_;
my $status='';	my $status='';
my %userenv = &Apache::lonnet::get('environment',['msgforward'],	my %userenv = &Apache::lonnet::get('environment',['msgforward'],
$domain,$user);	$domain,$user);
Line 272 sub user_normal_msg {	Line 431 sub user_normal_msg {
my ($forwuser,$forwdomain)=split(/\:/,$_);	my ($forwuser,$forwdomain)=split(/\:/,$_);
$status.=	$status.=
&user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,	&user_normal_msg_raw($forwuser,$forwdomain,$subject,$message,
$citation).' ';	$citation,$baseurl,$attachmenturl).' ';
}	}
} else {	} else {
$status=	$status=&user_normal_msg_raw($user,$domain,$subject,$message,
&user_normal_msg_raw($user,$domain,$subject,$message,$citation);	$citation,$baseurl,$attachmenturl);
}	}
return $status;	return $status;
}	}
Line 407 $content{'sendername'}.'@'.	Line 566 $content{'sendername'}.'@'.
sub comprep {	sub comprep {
my ($r,$msgid)=@_;	my ($r,$msgid)=@_;
my %message=&Apache::lonnet::get('nohist_email',[$msgid]);	my %message=&Apache::lonnet::get('nohist_email',[$msgid]);
my %content=&unpackagemsg($message{$msgid});	my %content=&unpackagemsg($message{$msgid},1);
my $quotemsg='> '.$content{'message'};	my $quotemsg='> '.$content{'message'};
$quotemsg=~s/\r/\n/g;	$quotemsg=~s/\r/\n/g;
$quotemsg=~s/\f/\n/g;	$quotemsg=~s/\f/\n/g;
$quotemsg=~s/\n+/\n\> /g;	$quotemsg=~s/\n+/\n\> /g;
	my $torepl=&Apache::loncommon::aboutmewrapper(
	&Apache::loncommon::plainname($content{'sendername'},$content{'senderdomain'}),$content{'sendername'},$content{'senderdomain'}).' ('.
	$content{'sendername'}.'@'.
	$content{'senderdomain'}.')';
my $subject='Re: '.$content{'subject'};	my $subject='Re: '.$content{'subject'};
my $dispcrit='';	my $dispcrit='';
if (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {	if (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
Line 425 sub comprep {	Line 588 sub comprep {
$r->print(<<"ENDREPLY");	$r->print(<<"ENDREPLY");
<form action="/adm/email" method=post>	<form action="/adm/email" method=post>
<input type=hidden name=sendreply value="$msgid">	<input type=hidden name=sendreply value="$msgid">
	To: $torepl<br />
Subject: <input type=text size=50 name=subject value="$subject"><p>	Subject: <input type=text size=50 name=subject value="$subject"><p>
<textarea name=message cols=84 rows=10 wrap=hard>	<textarea name=message cols=84 rows=10 wrap=hard>
$quotemsg	$quotemsg
Line 542 sub compout {	Line 706 sub compout {
<td>$domform</td></tr>	<td>$domform</td></tr>
ENDREC	ENDREC
}	}
	my $latexHelp = Apache::loncommon::helpLatexCheatsheet();
if ($broadcast ne 'upload') {	if ($broadcast ne 'upload') {
$r->print(<<"ENDCOMP");	$r->print(<<"ENDCOMP");
<tr><td>Additional Recipients<br><tt>username\@domain,username\@domain, ...	<tr><td>Additional Recipients<br><tt>username\@domain,username\@domain, ...
Line 549 ENDREC	Line 714 ENDREC
<input type=text size=50 name=additionalrec></td></tr>	<input type=text size=50 name=additionalrec></td></tr>
<tr><td>Subject:</td><td><input type=text size=50 name=subject value="$dissub">	<tr><td>Subject:</td><td><input type=text size=50 name=subject value="$dissub">
</td></tr></table>	</td></tr></table>
	$latexHelp
<textarea name=message cols=80 rows=10 wrap=hard>$dismsg	<textarea name=message cols=80 rows=10 wrap=hard>$dismsg
</textarea><p>	</textarea><p>
$dispcrit	$dispcrit
Line 713 sub handler {	Line 879 sub handler {
# ------------------------------------------------------ They checked for email	# ------------------------------------------------------ They checked for email
&Apache::lonnet::put('email_status',{'recnewemail'=>0});	&Apache::lonnet::put('email_status',{'recnewemail'=>0});
# --------------------------------------------------------------- Render Output	# --------------------------------------------------------------- Render Output
	if (!$ENV{'form.display'}) {
$r->print('<html><head><title>EMail and Messaging</title>'.	$r->print('<html><head><title>EMail and Messaging</title>'.
&Apache::loncommon::studentbrowser_javascript().'</head>'.	&Apache::loncommon::studentbrowser_javascript().'</head>'.
&Apache::loncommon::bodytag('EMail and Messages'));	&Apache::loncommon::bodytag('EMail and Messages'));
	}
if ($ENV{'form.display'}) {	if ($ENV{'form.display'}) {
my $msgid=$ENV{'form.display'};	my $msgid=$ENV{'form.display'};
&statuschange($msgid,'read');	&statuschange($msgid,'read');
my %message=&Apache::lonnet::get('nohist_email',[$msgid]);	my %message=&Apache::lonnet::get('nohist_email',[$msgid]);
my %content=&unpackagemsg($message{$msgid});	my %content=&unpackagemsg($message{$msgid});
	$r->print('<html><head><title>EMail and Messaging</title>');
	if (defined($content{'baseurl'})) {
	$r->print("<base href=\"http://$ENV{'SERVER_NAME'}/$content{'baseurl'}\" />");
	}
	$r->print(&Apache::loncommon::studentbrowser_javascript().
	'</head>'.
	&Apache::loncommon::bodytag('EMail and Messages'));
$r->print('<b>Subject:</b> '.$content{'subject'}.	$r->print('<b>Subject:</b> '.$content{'subject'}.
'<br><b>From:</b> '.	'<br><b>From:</b> '.
&Apache::loncommon::aboutmewrapper(	&Apache::loncommon::aboutmewrapper(
Line 748 $content{'sendername'},$content{'senderd	Line 922 $content{'sendername'},$content{'senderd
} elsif ($ENV{'form.sendreply'}) {	} elsif ($ENV{'form.sendreply'}) {
my $msgid=$ENV{'form.sendreply'};	my $msgid=$ENV{'form.sendreply'};
my %message=&Apache::lonnet::get('nohist_email',[$msgid]);	my %message=&Apache::lonnet::get('nohist_email',[$msgid]);
my %content=&unpackagemsg($message{$msgid});	my %content=&unpackagemsg($message{$msgid},1);
&statuschange($msgid,'replied');	&statuschange($msgid,'replied');
if ((($ENV{'form.critmsg'}) \|\| ($ENV{'form.sendbck'})) &&	if ((($ENV{'form.critmsg'}) \|\| ($ENV{'form.sendbck'})) &&
(&Apache::lonnet::allowed('srm',$ENV{'request.course.id'}))) {	(&Apache::lonnet::allowed('srm',$ENV{'request.course.id'}))) {
$r->print('Sending critical: '.	$r->print('Sending critical: '.
&user_crit_msg($content{'sendername'},	&user_crit_msg($content{'sendername'},
$content{'senderdomain'},	$content{'senderdomain'},
$ENV{'form.subject'},	&Apache::lonfeedback::clear_out_html($ENV{'form.subject'}),
$ENV{'form.message'},	&Apache::lonfeedback::clear_out_html($ENV{'form.message'}),
$ENV{'form.sendbck'}));	$ENV{'form.sendbck'}));
} else {	} else {
$r->print('Sending: '.&user_normal_msg($content{'sendername'},	$r->print('Sending: '.&user_normal_msg($content{'sendername'},
$content{'senderdomain'},	$content{'senderdomain'},
$ENV{'form.subject'},	&Apache::lonfeedback::clear_out_html($ENV{'form.subject'}),
$ENV{'form.message'}));	&Apache::lonfeedback::clear_out_html($ENV{'form.message'})));
}	}
if ($ENV{'form.displayedcrit'}) {	if ($ENV{'form.displayedcrit'}) {
&discrit($r);	&discrit($r);
Line 814 $content{'sendername'},$content{'senderd	Line 988 $content{'sendername'},$content{'senderd
if ($ENV{'form.forwid'}) {	if ($ENV{'form.forwid'}) {
my $msgid=$ENV{'form.forwid'};	my $msgid=$ENV{'form.forwid'};
my %message=&Apache::lonnet::get('nohist_email',[$msgid]);	my %message=&Apache::lonnet::get('nohist_email',[$msgid]);
%content=&unpackagemsg($message{$msgid});	%content=&unpackagemsg($message{$msgid},1);
&statuschange($msgid,'forwarded');	&statuschange($msgid,'forwarded');
$ENV{'form.message'}.="\n\n-- Forwarded message --\n\n".	$ENV{'form.message'}.="\n\n-- Forwarded message --\n\n".
$content{'message'};	$content{'message'};
Line 846 $content{'sendername'},$content{'senderd	Line 1020 $content{'sendername'},$content{'senderd
}	}
foreach (keys %toaddr) {	foreach (keys %toaddr) {
my ($recuname,$recdomain)=split(/\:/,$_);	my ($recuname,$recdomain)=split(/\:/,$_);
my $msgtxt=$ENV{'form.message'};	my $msgtxt=&Apache::lonfeedback::clear_out_html($ENV{'form.message'});
if ($toaddr{$_}) { $msgtxt.='<hr>'.$toaddr{$_}; }	if ($toaddr{$_}) { $msgtxt.='<hr>'.$toaddr{$_}; }
if ((($ENV{'form.critmsg'}) \|\| ($ENV{'form.sendbck'})) &&	if ((($ENV{'form.critmsg'}) \|\| ($ENV{'form.sendbck'})) &&
(&Apache::lonnet::allowed('srm',$ENV{'request.course.id'}))) {	(&Apache::lonnet::allowed('srm',$ENV{'request.course.id'}))) {
$r->print('Sending critical: '.	$r->print('Sending critical: '.
&user_crit_msg($recuname,$recdomain,	&user_crit_msg($recuname,$recdomain,
$ENV{'form.subject'},	&Apache::lonfeedback::clear_out_html($ENV{'form.subject'}),
$msgtxt,	$msgtxt,
$ENV{'form.sendbck'}));	$ENV{'form.sendbck'}));
} else {	} else {
$r->print('Sending: '.&user_normal_msg($recuname,$recdomain,	$r->print('Sending: '.&user_normal_msg($recuname,$recdomain,
$ENV{'form.subject'},	&Apache::lonfeedback::clear_out_html($ENV{'form.subject'}),
$msgtxt,	$msgtxt,
$content{'citation'}));	$content{'citation'}));
}	}
Line 881 BEGIN {	Line 1055 BEGIN {
$msgcount=0;	$msgcount=0;
}	}

	=pod

	=back

	=end

1;	1;
__END__	__END__

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.46
changed lines
	Added in v.1.58