--- loncom/xml/lonplot.pm 2004/08/30 15:23:23 1.101
+++ loncom/xml/lonplot.pm 2005/05/31 22:15:32 1.108
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Dynamic plot
#
-# $Id: lonplot.pm,v 1.101 2004/08/30 15:23:23 matthew Exp $
+# $Id: lonplot.pm,v 1.108 2005/05/31 22:15:32 foxr Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -35,9 +35,16 @@ use Apache::File;
use Apache::response;
use Apache::lonxml;
use Apache::edit;
+use Apache::lonnet;
use vars qw/$weboutputformat $versionstring/;
+#
+# This variable allows a callback to be registered
+# if a gnuplot tag block is performed.
+#
+my $notify_callback;
+
BEGIN {
&Apache::lonxml::register('Apache::lonplot',('gnuplot'));
#
@@ -47,6 +54,30 @@ BEGIN {
if ($versionstring =~ /^gnuplot 4/) {
$weboutputformat = 'png';
}
+ $notify_callback = undef;
+
+}
+
+# register_callback(\&callback)
+# Arranges for callback to be invoked on the </gnuplot>
+# tag.
+#
+sub register_callback {
+ $notify_callback = shift;
+}
+# clear_callback();
+# Undefs the callback.
+#
+sub clear_callback {
+ $notify_callback = undef;
+}
+# invoke_callback()
+# Invokes the callback if defined
+#
+sub invoke_callback {
+ if (defined $notify_callback) {
+ &$notify_callback();
+ }
}
##
@@ -119,11 +150,10 @@ my $words_test = sub {$_[0]=~s/\s+/
###################################################################
my @gnuplot_edit_order =
qw/alttag bgcolor fgcolor height width font transparent grid samples
- border align texwidth texfont plottype lmargin rmargin tmargin bmargin
- major_ticscale minor_ticscale/;
+ border align texwidth texfont plotcolor plottype lmargin rmargin tmargin
+ bmargin major_ticscale minor_ticscale/;
-my $margin_choices = ['default',
- qw{0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20}];
+my $margin_choices = ['default',0..20];
my %gnuplot_defaults =
(
@@ -215,6 +245,13 @@ my %gnuplot_defaults =
edit_type => 'choice',
choices => [qw/8 10 12 14 16 18 20 22 24 26 28 30 32 34 36/],
},
+ plotcolor => {
+ default => 'monochrome',
+ test => sub {$_[0]=~/^(monochrome|color|colour)$/},
+ description => 'Color setting for printing:',
+ edit_type => 'choice',
+ choices => [qw/monochrome color colour/],
+ },
plottype => {
default => 'Cartesian',
test => sub {$_[0]=~/^(Polar|Cartesian)$/},
@@ -246,7 +283,7 @@ my %gnuplot_defaults =
bmargin => {
default => 'default',
test => sub {$_[0]=~/^(default|\d+)$/},
- description => 'Bottm margin width (pts):',
+ description => 'Bottom margin width (pts):',
edit_type => 'choice',
choices => $margin_choices,
},
@@ -457,10 +494,12 @@ my %curve_defaults =
## parsing and edit rendering ##
## ##
###################################################################
-my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);
+
+undef %Apache::lonplot::plot;
+my (%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);
sub start_gnuplot {
- undef(%plot); undef(%key); undef(%axis);
+ undef(%Apache::lonplot::plot); undef(%key); undef(%axis);
undef($title); undef($xlabel); undef($ylabel);
undef(@labels); undef(@curves);
undef(%xtics); undef(%ytics);
@@ -472,7 +511,7 @@ sub start_gnuplot {
'xtics','ytics'));
push (@Apache::lonxml::namespace,'lonplot');
if ($target eq 'web' || $target eq 'tex') {
- &get_attributes(\%plot,\%gnuplot_defaults,$parstack,$safeeval,
+ &get_attributes(\%Apache::lonplot::plot,\%gnuplot_defaults,$parstack,$safeeval,
$tagstack->[-1]);
} elsif ($target eq 'edit') {
$result .= &Apache::edit::tag_start($target,$token,'GnuPlot');
@@ -507,7 +546,7 @@ sub end_gnuplot {
##
## Determine filename
my $tmpdir = '/home/httpd/perl/tmp/';
- my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}.
+ my $filename = $env{'user.name'}.'_'.$env{'user.domain'}.
'_'.time.'_'.$$.$randnumber.'_plot';
## Write the plot description to the file
&write_gnuplot_file($tmpdir,$filename,$target);
@@ -516,19 +555,22 @@ sub end_gnuplot {
if ($target eq 'web') {
$result .= <<"ENDIMAGE";
<img src = "/cgi-bin/plot.gif?file=$filename.data&output=$weboutputformat"
- width = "$plot{'width'}"
- height = "$plot{'height'}"
- align = "$plot{'align'}"
- alt = "$plot{'alttag'}" />
+ width = "$Apache::lonplot::plot{'width'}"
+ height = "$Apache::lonplot::plot{'height'}"
+ align = "$Apache::lonplot::plot{'align'}"
+ alt = "$Apache::lonplot::plot{'alttag'}" />
ENDIMAGE
} elsif ($target eq 'tex') {
+ &Apache::lonxml::debug(" gnuplot wid = $Apache::lonplot::plot{'width'}");
+ &Apache::lonxml::debug(" gnuplot ht = $Apache::lonplot::plot{'height'}");
#might be inside the safe space, register the URL for later
&Apache::lonxml::register_ssi("/cgi-bin/plot.gif?file=$filename.data&output=eps");
- $result = '\graphicspath{{/home/httpd/perl/tmp/}}\includegraphics[width='.$plot{'texwidth'}.' mm]{'.&Apache::lonnet::unescape($filename).'.eps}';
+ $result = '\graphicspath{{/home/httpd/perl/tmp/}}\includegraphics[width='.$Apache::lonplot::plot{'texwidth'}.' mm]{'.&Apache::lonnet::unescape($filename).'.eps}';
}
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_end($target,$token);
}
+ &invoke_callback();
return $result;
}
@@ -999,7 +1041,7 @@ sub write_gnuplot_file {
my ($tmpdir,$filename,$target)= @_;
my $gnuplot_input = '';
my $curve;
- my $pt = $plot{'texfont'};
+ my $pt = $Apache::lonplot::plot{'texfont'};
#
# Check to be sure we do not have any empty curves
my @curvescopy;
@@ -1020,58 +1062,58 @@ sub write_gnuplot_file {
@curves = @curvescopy;
# Collect all the colors
my @Colors;
- push @Colors, $plot{'bgcolor'};
- push @Colors, $plot{'fgcolor'};
- push @Colors, (defined($axis{'color'})?$axis{'color'}:$plot{'fgcolor'});
+ push @Colors, $Apache::lonplot::plot{'bgcolor'};
+ push @Colors, $Apache::lonplot::plot{'fgcolor'};
+ push @Colors, (defined($axis{'color'})?$axis{'color'}:$Apache::lonplot::plot{'fgcolor'});
foreach $curve (@curves) {
push @Colors, ($curve->{'color'} ne '' ?
$curve->{'color'} :
- $plot{'fgcolor'} );
+ $Apache::lonplot::plot{'fgcolor'} );
}
# set term
if ($target eq 'web') {
- $gnuplot_input .= 'set term gif ';
- $gnuplot_input .= 'transparent ' if ($plot{'transparent'} eq 'on');
- $gnuplot_input .= $plot{'font'} . ' ';
- $gnuplot_input .= 'size '.$plot{'width'}.','.$plot{'height'}.' ';
+ $gnuplot_input .= 'set term '.$weboutputformat .' ';
+ $gnuplot_input .= 'transparent ' if ($Apache::lonplot::plot{'transparent'} eq 'on');
+ $gnuplot_input .= $Apache::lonplot::plot{'font'} . ' ';
+ $gnuplot_input .= 'size '.$Apache::lonplot::plot{'width'}.','.$Apache::lonplot::plot{'height'}.' ';
$gnuplot_input .= "@Colors\n";
# set output
$gnuplot_input .= "set output\n";
} elsif ($target eq 'tex') {
- $gnuplot_input .= "set term postscript eps monochrome solid \"Helvetica\" $pt \n";
+ $gnuplot_input .= "set term postscript eps $Apache::lonplot::plot{'plotcolor'} solid \"Helvetica\" $pt \n";
$gnuplot_input .= "set output \"/home/httpd/perl/tmp/".
&Apache::lonnet::unescape($filename).".eps\"\n";
}
# cartesian or polar?
- if (lc($plot{'plottype'}) eq 'polar') {
+ if (lc($Apache::lonplot::plot{'plottype'}) eq 'polar') {
$gnuplot_input .= 'set polar'.$/;
} else {
# Assume Cartesian
}
# margin
- if (lc($plot{'lmargin'}) ne 'default') {
- $gnuplot_input .= 'set lmargin '.$plot{'lmargin'}.$/;
+ if (lc($Apache::lonplot::plot{'lmargin'}) ne 'default') {
+ $gnuplot_input .= 'set lmargin '.$Apache::lonplot::plot{'lmargin'}.$/;
}
- if (lc($plot{'rmargin'}) ne 'default') {
- $gnuplot_input .= 'set rmargin '.$plot{'rmargin'}.$/;
+ if (lc($Apache::lonplot::plot{'rmargin'}) ne 'default') {
+ $gnuplot_input .= 'set rmargin '.$Apache::lonplot::plot{'rmargin'}.$/;
}
- if (lc($plot{'tmargin'}) ne 'default') {
- $gnuplot_input .= 'set tmargin '.$plot{'tmargin'}.$/;
+ if (lc($Apache::lonplot::plot{'tmargin'}) ne 'default') {
+ $gnuplot_input .= 'set tmargin '.$Apache::lonplot::plot{'tmargin'}.$/;
}
- if (lc($plot{'bmargin'}) ne 'default') {
- $gnuplot_input .= 'set bmargin '.$plot{'bmargin'}.$/;
+ if (lc($Apache::lonplot::plot{'bmargin'}) ne 'default') {
+ $gnuplot_input .= 'set bmargin '.$Apache::lonplot::plot{'bmargin'}.$/;
}
# tic scales
$gnuplot_input .= 'set ticscale '.
- $plot{'major_ticscale'}.' '.$plot{'minor_ticscale'}.$/;
+ $Apache::lonplot::plot{'major_ticscale'}.' '.$Apache::lonplot::plot{'minor_ticscale'}.$/;
# grid
- $gnuplot_input .= 'set grid'.$/ if ($plot{'grid'} eq 'on');
+ $gnuplot_input .= 'set grid'.$/ if ($Apache::lonplot::plot{'grid'} eq 'on');
# border
- $gnuplot_input .= ($plot{'border'} eq 'on'?
+ $gnuplot_input .= ($Apache::lonplot::plot{'border'} eq 'on'?
'set border'.$/ :
'set noborder'.$/ );
# sampling rate for non-data curves
- $gnuplot_input .= "set samples $plot{'samples'}\n";
+ $gnuplot_input .= "set samples $Apache::lonplot::plot{'samples'}\n";
# title, xlabel, ylabel
# titles
if ($target eq 'tex') {
@@ -1123,10 +1165,14 @@ sub write_gnuplot_file {
my $label;
foreach $label (@labels) {
$gnuplot_input .= 'set label "'.$label->{'text'}.'" at '.
- $label->{'xpos'}.','.$label->{'ypos'}.' '.$label->{'justify'}.' font "Helvetica,'.$pt.'pt"'.$/ ;
+ $label->{'xpos'}.','.$label->{'ypos'}.' '.$label->{'justify'};
+ if ($target eq 'tex') {
+ $gnuplot_input .=' font "Helvetica,'.$pt.'pt"' ;
+ }
+ $gnuplot_input .= $/;
}
if ($target eq 'tex') {
- $gnuplot_input .="set size 1,".$plot{'height'}/$plot{'width'}*1.38;
+ $gnuplot_input .="set size 1,".$Apache::lonplot::plot{'height'}/$Apache::lonplot::plot{'width'}*1.38;
$gnuplot_input .="\n";
}
# curves
@@ -1196,7 +1242,7 @@ sub write_gnuplot_file {
sub check_inputs {
## Note: no inputs, no outputs - this acts only on global variables.
## Make sure we have all the input we need:
- if (! %plot) { &set_defaults(\%plot,\%gnuplot_defaults); }
+ if (! %Apache::lonplot::plot) { &set_defaults(\%Apache::lonplot::plot,\%gnuplot_defaults); }
if (! %key ) {} # No key for this plot, thats okay
# if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }
if (! defined($title )) {} # No title for this plot, thats okay
@@ -1234,10 +1280,10 @@ sub edit_attributes {
($description,$attr,$token,
$defaults->{$attr}->{'size'});
} elsif ($defaults->{$attr}->{'edit_type'} eq 'choice') {
- $result .= &Apache::edit::select_arg
+ $result .= &Apache::edit::select_or_text_arg
($description,$attr,$defaults->{$attr}->{'choices'},$token);
} elsif ($defaults->{$attr}->{'edit_type'} eq 'onoff') {
- $result .= &Apache::edit::select_arg
+ $result .= &Apache::edit::select_or_text_arg
($description,$attr,['on','off'],$token);
}
$result .= '<br />';