--- loncom/xml/lonplot.pm 2001/12/20 20:24:36 1.11
+++ loncom/xml/lonplot.pm 2001/12/21 22:45:47 1.17
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Dynamic plot
#
-# $Id: lonplot.pm,v 1.11 2001/12/20 20:24:36 matthew Exp $
+# $Id: lonplot.pm,v 1.17 2001/12/21 22:45:47 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,7 +26,7 @@
# http://www.lon-capa.org/
#
# 12/15/01 Matthew
-# 12/18 12/19 12/20 Matthew
+# 12/17 12/18 12/19 12/20 12/21 Matthew
package Apache::lonplot;
use strict;
@@ -34,7 +34,7 @@ use Apache::File;
use Apache::response;
use Apache::lonxml;
-use Digest::MD5 qw(md5 md5_hex md5_base64);
+use Digest::MD5 qw(md5_base64);
sub BEGIN {
&Apache::lonxml::register('Apache::lonplot',('plot'));
@@ -56,9 +56,9 @@ sub BEGIN {
##
## @labels: $labels[$i] = \%label
## %label: text, xpos, ypos, justify
-##
+##
## @curves: $curves[$i] = \%curve
-## %curve: name, linestyle, ( function | data )
+## %curve: name, linestyle, ( function | data )
##
## $curves[$i]->{'data'} = [ [x1,x2,x3,x4],
## [y1,y2,y3,y4] ]
@@ -71,10 +71,10 @@ my $int_test = sub {$_[0]=~s/\s+//
my $real_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^[+-]?\d*\.?\d*$/};
my $color_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^x[\da-f]{6}$/};
my $onoff_test = sub {$_[0]=~/^(on|off)$/};
-my $key_pos_test = sub {$_[0]=~/^(top|bottom|right|left|outside|below)+$/};
+my $key_pos_test = sub {$_[0]=~/^(top|bottom|right|left|outside|below| )+$/};
my $sml_test = sub {$_[0]=~/^(small|medium|large)$/};
my $linestyle_test = sub {$_[0]=~/^(lines|linespoints|dots|points|steps)$/};
-my $words_test = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^(\w+ ?)+$/};
+my $words_test = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^([\w\(\)]+ ?)+$/};
##
## Default values for attributes of elements
##
@@ -87,7 +87,8 @@ my %plot_defaults =
transparent => {default => 'off', test => $onoff_test },
grid => {default => 'off', test => $onoff_test },
border => {default => 'on', test => $onoff_test },
- font => {default => 'medium', test => $sml_test }
+ font => {default => 'medium', test => $sml_test },
+ align => {default => 'left', test => $words_test }
);
my %key_defaults =
@@ -111,14 +112,15 @@ my %axis_defaults =
xmin => {default => '-10.0', test => $real_test },
xmax => {default => ' 10.0', test => $real_test },
ymin => {default => '-10.0', test => $real_test },
- ymax => {default => ' 10.0', test => $real_test }
+ ymax => {default => ' 10.0', test => $real_test },
+ linestyle => {default => 'points', test => $linestyle_test}
);
my %curve_defaults =
(
- color => {default => 'x000000', test => $color_test },
- name => {default => 'x000000', test => sub {1} },#sub {$_[0]=~/^[\w ]*$/} },
- linestyle => {default => 'lines', test => $linestyle_test }
+ color => {default => 'x000000', test => $color_test },
+ name => {default => '', test => $words_test },
+ linestyle => {default => 'lines', test => $linestyle_test }
);
##
@@ -133,17 +135,17 @@ sub start_plot {
#
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
- &Apache::lonxml::register('Apache::lonplot',
- ('title','xlabel','ylabel','key','axis','label','curve'));
- push (@Apache::lonxml::namespace,'plot');
- ## Always evaluate the insides of the <plot></plot> tags
- my $inside = &Apache::lonxml::get_all_text("/plot",$$parser[-1]);
- $inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]);
- &Apache::lonxml::newparser($parser,\$inside);
- ##-------------------------------------------------------
- &get_attributes(\%plot,\%plot_defaults,$parstack,$safeeval,
- $tagstack->[-1]);
if ($target eq 'web') {
+ &Apache::lonxml::register('Apache::lonplot',
+ ('title','xlabel','ylabel','key','axis','label','curve'));
+ push (@Apache::lonxml::namespace,'plot');
+ ## Always evaluate the insides of the <plot></plot> tags
+ my $inside = &Apache::lonxml::get_all_text("/plot",$$parser[-1]);
+ $inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]);
+ &Apache::lonxml::newparser($parser,\$inside);
+ ##-------------------------------------------------------
+ &get_attributes(\%plot,\%plot_defaults,$parstack,$safeeval,
+ $tagstack->[-1]);
}
return '';
}
@@ -155,20 +157,43 @@ sub end_plot {
('title','xlabel','ylabel','key','axis','label','curve'));
my $result = '';
if ($target eq 'web') {
- ## Determine filename -- Need to use the 'id' thingy that Gerd
- ## mentioned.
+ ##
+ ## Make sure we have all the input we need:
+ if (! defined(%plot )) { &set_defaults(\%plot,\%plot_defaults); }
+ if (! defined(%key )) {} # No key for this plot
+ if (! defined(%axis )) { &set_defaults(\%axis,\%axis_defaults); }
+ if (! defined($title )) {} # No title for this plot
+ if (! defined($xlabel)) {} # No xlabel for this plot
+ if (! defined($ylabel)) {} # No ylabel for this plot
+ if ($#labels < 0) { } # No labels for this plot
+ if ($#curves < 0) {
+ &Apache::lonxml::warning("No curves specified for plot!!!!");
+ return '';
+ }
+ my $curve;
+ foreach $curve (@curves) {
+ if (!defined($curve->{'function'})&&!defined($curve->{'data'})){
+ &Apache::lonxml::warning("One of the curves specified did not contain any <data> or <function> declarations\n");
+ return '';
+ }
+ }
+ ##
+ ## Determine filename
my $tmpdir = '/home/httpd/perl/tmp/';
- my $filename = $tmpdir.$ENV{'user.name'}.'_'.$ENV{'user.domain'}.
- '_plot.data';
- my $usersees=md5_base64($filename.'_'.$ENV{'REMOTE_ADDR'});
-
+ my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}.
+ '_'.time.'_'.$$.'_plot.data';
## Write the plot description to the file
- my $fh=Apache::File->new('/home/httpd/perl/tmp/'.$filename);
- $result .= '<pre>';
- $result .= &write_gnuplot_file($fh);
- $result .= '</pre>'.$/;
+ my $fh=Apache::File->new(">$tmpdir$filename");
+ print $fh &write_gnuplot_file();
+ close($fh);
## return image tag for the plot
- $result .= '<img src="/cgi-bin/plot.cgi?'.$usersees.'"/>';
+ $result .= <<"ENDIMAGE";
+<img src = "/cgi-bin/plot.gif?$filename"
+ width = "$plot{'width'}"
+ height = "$plot{'height'}"
+ align = "$plot{'align'}"
+ alt = "/cgi-bin/plot.gif?$filename" />
+ENDIMAGE
}
return $result;
}
@@ -177,9 +202,9 @@ sub end_plot {
sub start_key {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
- &get_attributes(\%key,\%key_defaults,$parstack,$safeeval,
- $tagstack->[-1]);
if ($target eq 'web') {
+ &get_attributes(\%key,\%key_defaults,$parstack,$safeeval,
+ $tagstack->[-1]);
# This routine should never return anything.
}
return $result;
@@ -196,9 +221,9 @@ sub end_key {
##------------------------------------------------------------------- title
sub start_title {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
- $title = &Apache::lonxml::get_all_text("/title",$$parser[-1]);
my $result='';
if ($target eq 'web') {
+ $title = &Apache::lonxml::get_all_text("/title",$$parser[-1]);
# This routine should never return anything.
}
return $result;
@@ -216,8 +241,8 @@ sub end_title {
sub start_xlabel {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
- $xlabel = &Apache::lonxml::get_all_text("/xlabel",$$parser[-1]);
if ($target eq 'web') {
+ $xlabel = &Apache::lonxml::get_all_text("/xlabel",$$parser[-1]);
# This routine should never return anything.
}
return $result;
@@ -235,8 +260,8 @@ sub end_xlabel {
sub start_ylabel {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
- $ylabel = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
if ($target eq 'web') {
+ $ylabel = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
# This routine should never return anything.
}
return $result;
@@ -254,18 +279,18 @@ sub end_ylabel {
sub start_label {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
- my %label;
- &get_attributes(\%label,\%label_defaults,$parstack,$safeeval,
- $tagstack->[-1]);
- $label{'text'} = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
- if (! &$words_test($label{'text'})) {
- # I should probably warn about it, too.
- $label{'text'} = 'Illegal text';
- }
- push(@labels,\%label);
if ($target eq 'web') {
- # This routine should never return anything.
+ my %label;
+ &get_attributes(\%label,\%label_defaults,$parstack,$safeeval,
+ $tagstack->[-1]);
+ $label{'text'} = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
+ if (! &$words_test($label{'text'})) {
+ # I should probably warn about it, too.
+ $label{'text'} = 'Illegal text';
+ }
+ push(@labels,\%label);
}
+ # This routine should never return anything.
return $result;
}
@@ -282,13 +307,13 @@ sub end_label {
sub start_curve {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
- my %curve;
- &get_attributes(\%curve,\%curve_defaults,$parstack,$safeeval,
- $tagstack->[-1]);
- push (@curves,\%curve);
- &Apache::lonxml::register('Apache::lonplot',('function','data'));
- push (@Apache::lonxml::namespace,'curve');
if ($target eq 'web') {
+ my %curve;
+ &get_attributes(\%curve,\%curve_defaults,$parstack,$safeeval,
+ $tagstack->[-1]);
+ push (@curves,\%curve);
+ &Apache::lonxml::register('Apache::lonplot',('function','data'));
+ push (@Apache::lonxml::namespace,'curve');
# This routine should never return anything.
}
return $result;
@@ -297,9 +322,9 @@ sub start_curve {
sub end_curve {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result = '';
- pop @Apache::lonxml::namespace;
- &Apache::lonxml::deregister('Apache::lonplot',('function','data'));
if ($target eq 'web') {
+ pop @Apache::lonxml::namespace;
+ &Apache::lonxml::deregister('Apache::lonplot',('function','data'));
# This routine should never return anything.
}
return $result;
@@ -308,13 +333,13 @@ sub end_curve {
sub start_function {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
- if (exists($curves[-1]->{'data'})) {
- &Apache::lonxml::warning('Use of <function> precludes use of <data>. The <data> will be omitted in favor of the <function> declaration.');
- delete $curves[-1]->{'data'} ;
- }
- $curves[-1]->{'function'} =
- &Apache::lonxml::get_all_text("/function",$$parser[-1]);
if ($target eq 'web') {
+ if (exists($curves[-1]->{'data'})) {
+ &Apache::lonxml::warning('Use of <function> precludes use of <data>. The <data> will be omitted in favor of the <function> declaration.');
+ delete $curves[-1]->{'data'} ;
+ }
+ $curves[-1]->{'function'} =
+ &Apache::lonxml::get_all_text("/function",$$parser[-1]);
# This routine should never return anything.
}
return $result;
@@ -332,31 +357,38 @@ sub end_function {
sub start_data {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
- if (exists($curves[-1]->{'function'})) {
- &Apache::lonxml::warning('Use of <data> precludes use of <function>.'.
- ' The <function> will be omitted in favor of the <data>'.
- ' declaration.');
- delete($curves[-1]->{'function'});
- }
- my $datatext = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
- $datatext =~ s/\s+//g; # No whitespace, numbers must be seperated
- # by commas
- if ($datatext !~ /^(([+-]?\d*\.?\d*)[, ]?)+$/) {
- &Apache::lonxml::warning('Malformed data: '.$datatext);
- $datatext = '';
- }
- # Need to do some error checking on the @data array -
- # make sure it's all numbers and make sure each array
- # is of the same length.
- my @data = split /,/,$datatext;
- for (my $i=0;$i<=$#data;$i++) {
- # Check that it's non-empty
- # Check that it's a number
- # Maybe I need a 'debug=on' switch to list the data set
- # out in a warning?
- }
- push @{$curves[-1]->{'data'}},\@data;
if ($target eq 'web') {
+ if (exists($curves[-1]->{'function'})) {
+ &Apache::lonxml::warning('Use of <data> precludes use of .'.
+ '<function>. The <function> will be omitted in favor of '.
+ 'the <data> declaration.');
+ delete($curves[-1]->{'function'});
+ }
+ my $datatext = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
+ &Apache::lonxml::warning(
+ ' Length of data string: '.length($datatext));
+ $datatext =~ s/\s+/ /g;
+ if ($datatext !~ /^(([+-]?\d*\.?\d*)[, ]?)+$/) {
+ &Apache::lonxml::warning('Malformed data: '.$datatext);
+ $datatext = '';
+ }
+ # Need to do some error checking on the @data array -
+ # make sure it's all numbers and make sure each array
+ # is of the same length.
+ my @data;
+ if ($datatext =~ /,/) {
+ @data = split /,/,$datatext;
+ } else { # Assume it's space seperated.
+ @data = split / /,$datatext;
+ }
+ &Apache::lonxml::warning(' Data Points: '.$#data);
+ for (my $i=0;$i<=$#data;$i++) {
+ # Check that it's non-empty
+ # Check that it's a number
+ # Maybe I need a 'debug=on' switch to list the data set
+ # out in a warning?
+ }
+ push @{$curves[-1]->{'data'}},\@data;
# This routine should never return anything.
}
return $result;
@@ -375,9 +407,9 @@ sub end_data {
sub start_axis {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
- &get_attributes(\%axis,\%axis_defaults,$parstack,$safeeval,
- $tagstack->[-1]);
if ($target eq 'web') {
+ &get_attributes(\%axis,\%axis_defaults,$parstack,$safeeval,
+ $tagstack->[-1]);
# This routine should never return anything.
}
return $result;
@@ -392,6 +424,16 @@ sub end_axis {
return $result;
}
+##----------------------------------------------------------- set_defaults
+sub set_defaults {
+ my $var = shift;
+ my $defaults = shift;
+ my $key;
+ foreach $key (keys %$defaults) {
+ $var->{$key} = $defaults->{$key}->{'default'};
+ }
+}
+
##------------------------------------------------------------------- misc
sub get_attributes{
my $values = shift;
@@ -402,7 +444,7 @@ sub get_attributes{
my $attr;
foreach $attr (keys %{$defaults}) {
$values->{$attr} =
- &Apache::lonxml::get_param($attr,$parstack,$safeeval);
+ &Apache::lonxml::get_param($attr,$parstack,$safeeval);
if ($values->{$attr} eq '' | !defined($values->{$attr})) {
$values->{$attr} = $defaults->{$attr}->{'default'};
next;
@@ -417,21 +459,19 @@ sub get_attributes{
}
return ;
}
-
+##------------------------------------------------------- write_gnuplot_file
sub write_gnuplot_file {
- my $fh = shift;
my $gnuplot_input = '';
my $curve;
# Collect all the colors
my @Colors;
push @Colors, $plot{'bgcolor'};
push @Colors, $plot{'fgcolor'};
- push @Colors, $axis{'color'};
- push @Colors, $axis{'color'};
+ push @Colors, (defined($axis{'color'})?$axis{'color'}:$plot{'fgcolor'});
foreach $curve (@curves) {
push @Colors, ($curve->{'color'} ne '' ?
$curve->{'color'} :
- $plot{'fgcolor'} );
+ $plot{'fgcolor'} );
}
# set term
$gnuplot_input .= 'set term gif ';
@@ -445,18 +485,16 @@ sub write_gnuplot_file {
$gnuplot_input .= ($plot{'border'} eq 'on'?
'set border'.$/ :
'set noborder'.$/ ); # title, xlabel, ylabel
- {
- $gnuplot_input .= <<"ENDLABELS";
-set output
-set title "$title"
-set xlabel "$xlabel"
-set ylabel "$ylabel"
-set xrange \[$axis{'xmin'}:$axis{'xmax'}\]
-set yrange \[$axis{'ymin'}:$axis{'ymax'}\]
-ENDLABELS
+ $gnuplot_input .= "set output\n";
+ $gnuplot_input .= "set title \"$title\"\n" if (defined($title)) ;
+ $gnuplot_input .= "set xlabel \"$xlabel\"\n" if (defined($xlabel));
+ $gnuplot_input .= "set ylabel \"$ylabel\"\n" if (defined($ylabel));
+ if (defined(%axis)) {
+ $gnuplot_input .= "set xrange \[$axis{'xmin'}:$axis{'xmax'}\]\n";
+ $gnuplot_input .= "set yrange \[$axis{'ymin'}:$axis{'ymax'}\]\n";
}
# Key
- if (defined($key{'pos'})) {
+ if (defined(%key)) {
$gnuplot_input .= 'set key '.$key{'pos'}.' ';
if ($key{'title'} ne '') {
$gnuplot_input .= 'title "'.$key{'title'}.'" ';
@@ -464,7 +502,7 @@ ENDLABELS
$gnuplot_input .= ($key{'box'} eq 'on' ? 'box ' : 'nobox ').$/;
} else {
$gnuplot_input .= 'set nokey'.$/;
- }
+ }
# labels
my $label;
foreach $label (@labels) {
@@ -500,7 +538,6 @@ ENDLABELS
}
$gnuplot_input .= $/.$datatext;
return $gnuplot_input;
-# print $fh $gnuplot_input;
}
1;