File:
[LON-CAPA] /
loncom /
html /
res /
adm /
pages /
annotator /
admannotations.pm
Revision
1.27:
download - view:
text,
annotated -
select for diffs
Tue Apr 24 23:26:26 2007 UTC (17 years, 5 months ago) by
albertel
Branches:
MAIN
CVS tags:
version_2_7_X,
version_2_7_1,
version_2_7_0,
version_2_6_X,
version_2_6_99_1,
version_2_6_99_0,
version_2_6_3,
version_2_6_2,
version_2_6_1,
version_2_6_0,
version_2_5_X,
version_2_5_99_1,
version_2_5_99_0,
version_2_5_2,
version_2_5_1,
version_2_5_0,
version_2_4_X,
version_2_4_99_0,
version_2_4_2,
version_2_4_1,
version_2_4_0,
version_2_3_99_0,
HEAD
- make annotations work correctly in encrypted mode, encrypted urls have notes stored against their symbs, and un encrypted have thier notes store under the plain url
# The LearningOnline Network with CAPA
# This will take annotations and then plug them into a page.
#
# $Id: admannotations.pm,v 1.27 2007/04/24 23:26:26 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::admannotations;
use strict;
use Apache::Constants qw(:common);
use Apache::loncommon();
use Apache::lonnet;
use Apache::lonlocal;
# --------------------------------------------------------------Put annotation
sub write_annotation {
my ($symb, $enc, $annotation) = @_;
return if (!$annotation);
my $key = $symb;
if (!$enc) {
$key =
&Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
}
&Apache::lonnet::put('nohist_annotations',{$key => $annotation});
return;
}
# --------------------------------------------------------------Get annotation
sub get_annotation {
my ($symb,$enc) = @_;
my $key = $symb;
if (!$enc) {
$key =
&Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
}
my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
return $annotation{$key};
}
# ------------------------------------------------------------Construct editor
sub js_get_symb {
return <<ENDJS;
function get_symb() {
var symb;
if (typeof(window.opener.clientwindow) != 'undefined') {
symb=window.opener.clientwindow.location.href;
} else {
symb=window.opener.location.href;
}
symb=window.opener.currentSymb;
return symb;
}
ENDJS
}
sub construct_editor {
my ($annotation,$symbnew) = @_;
if ($annotation=~/^error:/) { $annotation=''; }
my $get_symb = &js_get_symb();
my $js = <<ENDJS;
<script type="text/javascript">
var timeout;
$get_symb
function changed() {
var symbnew=get_symb();
if (symbnew!=document.annotInfo.symbold.value) {
document.annotInfo.symbnew.value=symbnew;
document.annotInfo.submit();
}
timeout=setTimeout('changed();','1000');
}
</script>
ENDJS
my %load_items = ('onload' => "timeout=setTimeout('changed()','1000')",
'onunload' => 'clearTimeout(timeout);');
my $start_page =
&Apache::loncommon::start_page('Annotations',$js,
{'only_body' => 1,
'add_entries' => \%load_items,});
my $end_page =
&Apache::loncommon::end_page();
my %lt = ( 'close no save' => "Close (no save)",
'save' => "Save and Update",);
%lt = &Apache::lonlocal::texthash(%lt);
return(<<END_HTML)
$start_page
<center>
<form name="annotInfo" method="post" action="/adm/annotations">
<textarea name="annotation" wrap="on" rows="12" cols="36">$annotation</textarea><br />
<input type="hidden" name="symbold" value="$symbnew" />
<input type="hidden" name="symbnew" value="" />
<input type="button" name="send" value="$lt{'save'}"
onclick="javascript:this.form.symbnew.value=get_symb();this.form.submit();" />
<input type="button" name="close" value="$lt{'close no save'}"
onclick="javascript:window.close();" />
</form>
</center>
$end_page
END_HTML
}
# ----------------------------------------------------Constructs error window
sub construct_error {
my ($annot_error,$button_name) = @_;
my $get_symb = &js_get_symb();
my $js = <<ENDJS;
<script type="text/javascript">
$get_symb
</script>
ENDJS
my $start_page = &Apache::loncommon::start_page('Annotations',$js,
{'only_body' => 1,});
my $end_page = &Apache::loncommon::end_page();
my %lt = ( 'close' => "Close",
'button' => $button_name,);
%lt = &Apache::lonlocal::texthash(%lt);
return(<<END_HTML2)
$start_page
<center>
<form name="annotInfo" method="post" action="/adm/annotations">
<table bgcolor="#FFFFFF" width="100%" height="90%" align="center">
<td>
<font size="+1"><i>
$annot_error
</i></font>
</td>
</table>
<input type="hidden" name="symbold" value="" />
<input type="hidden" name="symbnew" value="" />
<input type="button" name="send" value="$lt{'button'}"
onclick="javascript:this.form.symbnew.value=get_symb();this.form.submit();" />
<input type="button" name="close" value="$lt{'close'}"
onclick="javascript:window.close();" />
</form>
</center>
$end_page
END_HTML2
}
sub clean_symb {
my ($symb) = @_;
&Apache::lonenc::check_decrypt(\$symb);
my $enc = $env{'request.enc'};
delete($env{'request.enc'});
return ($symb,$enc);
}
# ---------------------------------------------------------------Main Handler
sub handler {
my ($r) = @_;
&Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
return OK if $r->header_only;
my $page;
my ($symb_old,$symb_old_enc) = &clean_symb($env{'form.symbold'});
my ($symb_new,$symb_new_enc) = &clean_symb($env{'form.symbnew'});
my $annotation=$env{'form.annotation'};
if ($symb_old) {
&write_annotation($symb_old,$symb_old_enc,$annotation);
}
if (exists($env{'form.symbnew'})) {
unless ($symb_new) {
$page=&construct_error(&mt("Cannot annotate current window. Please point your browser to a LON-CAPA page and then 'continue'."),"continue");
} else {
if ($symb_old ne $symb_new) {
$annotation=&get_annotation($symb_new,$symb_new_enc);
}
# pass same symb through.
$page=&construct_editor($annotation,$env{'form.symbnew'});
}
}
$r->print($page);
return OK;
}
1;
__END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>