--- loncom/xml/lonplot.pm 2002/01/01 19:34:25 1.29
+++ loncom/xml/lonplot.pm 2007/05/23 22:36:28 1.117
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Dynamic plot
#
-# $Id: lonplot.pm,v 1.29 2002/01/01 19:34:25 matthew Exp $
+# $Id: lonplot.pm,v 1.117 2007/05/23 22:36:28 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -25,20 +25,38 @@
#
# http://www.lon-capa.org/
#
-# 12/15/01 Matthew
-# 12/17 12/18 12/19 12/20 12/21 12/27 12/28 12/30 Matthew
+
package Apache::lonplot;
use strict;
+use warnings FATAL=>'all';
+no warnings 'uninitialized';
use Apache::File;
use Apache::response;
use Apache::lonxml;
use Apache::edit;
+use Apache::lonnet;
+use lib '/home/httpd/lib/perl/';
+use LONCAPA;
+
+
+use vars qw/$weboutputformat $versionstring/;
+
-sub BEGIN {
- &Apache::lonxml::register('Apache::lonplot',('plot'));
+
+BEGIN {
+ &Apache::lonxml::register('Apache::lonplot',('gnuplot'));
+ #
+ # Determine the version of GNUPLOT
+ $weboutputformat = 'gif';
+ $versionstring = `gnuplot --version 2>/dev/null`;
+ if ($versionstring =~ /^gnuplot 4/) {
+ $weboutputformat = 'png';
+ }
+
}
+
##
## Description of data structures:
##
@@ -70,6 +88,9 @@ sub BEGIN {
## ##
###################################################################
+my $max_str_len = 50; # if a label, title, xlabel, or ylabel text
+ # is longer than this, it will be truncated.
+
my %linestyles =
(
lines => 2, # Maybe this will be used in the future
@@ -79,76 +100,107 @@ my %linestyles =
steps => 2, # now there are more important things
fsteps => 2, # for me to deal with.
histeps => 2,
- errorbars => 2,
- xerrorbars => 2,
- yerrorbars => 2,
- xyerrorbars => 2,
- boxes => 2,
- boxerrorbars => 2,
- boxxyerrorbars => 2,
- financebars => 2,
- candlesticks => 2,
- vector => 2
+ errorbars => 3,
+ xerrorbars => [3,4],
+ yerrorbars => [3,4],
+ xyerrorbars => [4,6],
+ boxes => 3,
+ filledcurves => 2,
+ vector => 4
);
my $int_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^\d+$/};
my $real_test =
sub {$_[0]=~s/\s+//g;$_[0]=~/^[+-]?\d*\.?\d*([eE][+-]\d+)?$/};
-my $color_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^x[\da-f]{6}$/};
+my $pos_real_test =
+ sub {$_[0]=~s/\s+//g;$_[0]=~/^[+]?\d*\.?\d*([eE][+-]\d+)?$/};
+my $color_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^x[\da-fA-F]{6}$/};
my $onoff_test = sub {$_[0]=~/^(on|off)$/};
my $key_pos_test = sub {$_[0]=~/^(top|bottom|right|left|outside|below| )+$/};
my $sml_test = sub {$_[0]=~/^(small|medium|large)$/};
my $linestyle_test = sub {exists($linestyles{$_[0]})};
-my $words_test = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^([\w\(\)]+ ?)+$/};
+my $words_test = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^([\w~!\@\#\$\%^&\*\(\)-=_\+\[\]\{\}:\;\'<>,\.\/\?\\]+ ?)+$/};
###################################################################
## ##
## Attribute metadata ##
## ##
###################################################################
-my %plot_defaults =
+my @gnuplot_edit_order =
+ qw/alttag bgcolor fgcolor height width font transparent grid samples
+ border align texwidth texfont plotcolor plottype gridtype lmargin rmargin
+ tmargin bmargin major_ticscale minor_ticscale boxwidth gridlayer fillstyle
+ pattern solid/;
+
+my $margin_choices = ['default',0..20];
+
+my %gnuplot_defaults =
(
+ alttag => {
+ default => 'dynamically generated plot',
+ test => $words_test,
+ description => 'brief description of the plot',
+ edit_type => 'entry',
+ size => '40'
+ },
height => {
- default => 200,
+ default => 300,
test => $int_test,
description => 'height of image (pixels)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
width => {
- default => 200,
+ default => 400,
test => $int_test,
description => 'width of image (pixels)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
bgcolor => {
default => 'xffffff',
test => $color_test,
description => 'background color of image (xffffff)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
fgcolor => {
default => 'x000000',
test => $color_test,
description => 'foreground color of image (x000000)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
transparent => {
default => 'off',
test => $onoff_test,
- description => '',
- edit_type => 'on_off'
+ description => 'Transparent image',
+ edit_type => 'onoff'
},
grid => {
+ default => 'on',
+ test => $onoff_test,
+ description => 'Display grid',
+ edit_type => 'onoff'
+ },
+ gridlayer => {
default => 'off',
test => $onoff_test,
- description => '',
- edit_type => 'on_off'
+ description => 'Display grid front layer over filled boxes or filled curves',
+ edit_type => 'onoff'
+ },
+ box_border => {
+ default => 'noborder',
+ test => sub {$_[0]=~/^(noborder|border)$/},
+ description => 'Draw border for boxes',
+ edit_type => 'choice',
+ choices => ['border','noborder']
},
border => {
default => 'on',
test => $onoff_test,
- description => '',
- edit_type => 'on_off'
+ description => 'Draw border around plot',
+ edit_type => 'onoff'
},
font => {
default => 'medium',
@@ -157,13 +209,125 @@ my %plot_defaults =
edit_type => 'choice',
choices => ['small','medium','large']
},
+ samples => {
+ default => '100',
+ test => $int_test,
+ description => 'Number of samples for non-data plots',
+ edit_type => 'choice',
+ choices => ['100','200','500','1000','2000','5000']
+ },
align => {
- default => 'left',
- test => sub {$_[0]=~/^(left|right|center)$/},
+ default => 'middle',
+ test => sub {$_[0]=~/^(left|right|middle|center)$/},
description => 'alignment for image in html',
edit_type => 'choice',
- choices => ['left','right','center']
- }
+ choices => ['left','right','middle']
+ },
+ texwidth => {
+ default => '93',
+ test => $int_test,
+ description => 'Width of plot when printed (mm)',
+ edit_type => 'entry',
+ size => '5'
+ },
+ texfont => {
+ default => '22',
+ test => $int_test,
+ description => 'Font size to use in TeX output (pts):',
+ 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/],
+ },
+ pattern => {
+ default => '',
+ test => $int_test,
+ description => 'pattern value for boxes:',
+ edit_type => 'choice',
+ choices => [0,1,2,3,4,5,6]
+ },
+ solid => {
+ default => 0,
+ test => $real_test,
+ description => 'The density of fill style for boxes',
+ edit_type => 'entry',
+ size => '5'
+ },
+ fillstyle => {
+ default => 'empty',
+ test => sub {$_[0]=~/^(empty|solid|pattern)$/},
+ description => 'Filled style for boxes:',
+ edit_type => 'choice',
+ choices => ['empty','solid','pattern']
+ },
+ plottype => {
+ default => 'Cartesian',
+ test => sub {$_[0]=~/^(Polar|Cartesian)$/},
+ description => 'Plot type:',
+ edit_type => 'choice',
+ choices => ['Cartesian','Polar']
+ },
+ gridtype => {
+ default => 'Cartesian',
+ test => sub {$_[0]=~/^(Polar|Cartesian)$/},
+ description => 'Grid type:',
+ edit_type => 'choice',
+ choices => ['Cartesian','Polar']
+ },
+ lmargin => {
+ default => 'default',
+ test => sub {$_[0]=~/^(default|\d+)$/},
+ description => 'Left margin width (pts):',
+ edit_type => 'choice',
+ choices => $margin_choices,
+ },
+ rmargin => {
+ default => 'default',
+ test => sub {$_[0]=~/^(default|\d+)$/},
+ description => 'Right margin width (pts):',
+ edit_type => 'choice',
+ choices => $margin_choices,
+ },
+ tmargin => {
+ default => 'default',
+ test => sub {$_[0]=~/^(default|\d+)$/},
+ description => 'Top margin width (pts):',
+ edit_type => 'choice',
+ choices => $margin_choices,
+ },
+ bmargin => {
+ default => 'default',
+ test => sub {$_[0]=~/^(default|\d+)$/},
+ description => 'Bottom margin width (pts):',
+ edit_type => 'choice',
+ choices => $margin_choices,
+ },
+ boxwidth => {
+ default => '',
+ test => $real_test,
+ description => 'width of boxes default auto',
+ edit_type => 'entry',
+ size => '5'
+ },
+ major_ticscale => {
+ default => '1',
+ test => $real_test,
+ description => 'Size of major tic marks (plot coordinates)',
+ edit_type => 'entry',
+ size => '5'
+ },
+ minor_ticscale => {
+ default => '0.5',
+ test => $real_test,
+ description => 'Size of minor tic mark (plot coordinates)',
+ edit_type => 'entry',
+ size => '5'
+ },
);
my %key_defaults =
@@ -172,13 +336,14 @@ my %key_defaults =
default => '',
test => $words_test,
description => 'Title of key',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '40'
},
box => {
default => 'off',
test => $onoff_test,
description => 'Draw a box around the key?',
- edit_type => 'on_off'
+ edit_type => 'onoff'
},
pos => {
default => 'top right',
@@ -196,13 +361,15 @@ my %label_defaults =
default => 0,
test => $real_test,
description => 'x position of label (graph coordinates)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
ypos => {
default => 0,
test => $real_test,
description => 'y position of label (graph coordinates)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
justify => {
default => 'left',
@@ -213,65 +380,147 @@ my %label_defaults =
}
);
+my @tic_edit_order = ('location','mirror','start','increment','end',
+ 'minorfreq');
+my %tic_defaults =
+ (
+ location => {
+ default => 'border',
+ test => sub {$_[0]=~/^(border|axis)$/},
+ description => 'Location of major tic marks',
+ edit_type => 'choice',
+ choices => ['border','axis']
+ },
+ mirror => {
+ default => 'on',
+ test => $onoff_test,
+ description => 'mirror tics on opposite axis?',
+ edit_type => 'onoff'
+ },
+ start => {
+ default => '-10.0',
+ test => $real_test,
+ description => 'Start major tics at',
+ edit_type => 'entry',
+ size => '10'
+ },
+ increment => {
+ default => '1.0',
+ test => $real_test,
+ description => 'Place a major tic every',
+ edit_type => 'entry',
+ size => '10'
+ },
+ end => {
+ default => ' 10.0',
+ test => $real_test,
+ description => 'Stop major tics at ',
+ edit_type => 'entry',
+ size => '10'
+ },
+ minorfreq => {
+ default => '0',
+ test => $int_test,
+ description => 'Number of minor tics per major tic mark',
+ edit_type => 'entry',
+ size => '10'
+ },
+ );
+
+my @axis_edit_order = ('color','xmin','xmax','ymin','ymax');
my %axis_defaults =
(
color => {
default => 'x000000',
test => $color_test,
- description => 'color of axes (x000000)',
- edit_type => 'entry'
+ description => 'color of grid lines (x000000)',
+ edit_type => 'entry',
+ size => '10'
},
xmin => {
default => '-10.0',
test => $real_test,
description => 'minimum x-value shown in plot',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
xmax => {
default => ' 10.0',
test => $real_test,
description => 'maximum x-value shown in plot',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
ymin => {
default => '-10.0',
test => $real_test,
description => 'minimum y-value shown in plot',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
ymax => {
default => ' 10.0',
test => $real_test,
description => 'maximum y-value shown in plot',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
}
);
+my @curve_edit_order = ('color','name','linestyle','pointtype','pointsize','limit');
+
my %curve_defaults =
(
color => {
default => 'x000000',
test => $color_test,
description => 'color of curve (x000000)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
name => {
default => '',
test => $words_test,
description => 'name of curve to appear in key',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '20'
},
linestyle => {
default => 'lines',
test => $linestyle_test,
- description => 'Style of the axis lines',
+ description => 'Line style',
edit_type => 'choice',
- choices => ['lines','linespoints','dots','points','steps',
- 'fsteps','histeps','errorbars','xerrorbars',
- 'yerrorbars','xyerrorbars','boxes','boxerrorbars',
- 'boxxyerrorbars','financebars','candlesticks',
- 'vector']
- }
+ choices => [keys(%linestyles)]
+ },
+# gnuplots term=gif driver does not handle linewidth :(
+# linewidth => {
+# default => 1,
+# test => $int_test,
+# description => 'Line width (may not apply to all line styles)',
+# edit_type => 'choice',
+# choices => [1,2,3,4,5,6,7,8,9,10]
+# },
+ pointsize => {
+ default => 1,
+ test => $pos_real_test,
+ description => 'point size (may not apply to all line styles)',
+ edit_type => 'entry',
+ size => '5'
+ },
+ pointtype => {
+ default => 1,
+ test => $int_test,
+ description => 'point type (may not apply to all line styles)',
+ edit_type => 'choice',
+ choices => [0,1,2,3,4,5,6]
+ },
+ limit => {
+ default => 'closed',
+ test => sub {$_[0]=~/^(closed|x1|x2|y1|y2)$/},
+ description => 'point to fill -- for filledcurves',
+ edit_type => 'choice',
+ choices => ['closed','x1','x2','y1','y2']
+ },
);
###################################################################
@@ -279,75 +528,158 @@ my %curve_defaults =
## parsing and edit rendering ##
## ##
###################################################################
-my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves);
-sub start_plot {
- %plot = (); %key = (); %axis = ();
- $title = undef; $xlabel = undef; $ylabel = undef;
- $#labels = -1; $#curves = -1;
+undef %Apache::lonplot::plot;
+my (%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);
+
+sub start_gnuplot {
+ undef(%Apache::lonplot::plot); undef(%key); undef(%axis);
+ undef($title); undef($xlabel); undef($ylabel);
+ undef(@labels); undef(@curves);
+ undef(%xtics); undef(%ytics);
#
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
&Apache::lonxml::register('Apache::lonplot',
- ('title','xlabel','ylabel','key','axis','label','curve'));
+ ('title','xlabel','ylabel','key','axis','label','curve',
+ 'xtics','ytics'));
push (@Apache::lonxml::namespace,'lonplot');
- if ($target eq 'web') {
- 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,
+ if ($target eq 'web' || $target eq 'tex') {
+ &get_attributes(\%Apache::lonplot::plot,\%gnuplot_defaults,$parstack,$safeeval,
$tagstack->[-1]);
} elsif ($target eq 'edit') {
- $result .= &Apache::edit::tag_start($target,$token,'Plot');
- $result .= &edit_attributes($target,$token,\%plot_defaults);
+ $result .= &Apache::edit::tag_start($target,$token,'GnuPlot');
+ $result .= &edit_attributes($target,$token,\%gnuplot_defaults,
+ \@gnuplot_edit_order)
+ .&Apache::edit::end_row()
+ .&Apache::edit::start_spanning_row();
} elsif ($target eq 'modified') {
my $constructtag=&Apache::edit::get_new_args
- ($token,$parstack,$safeeval,keys(%plot_defaults));
+ ($token,$parstack,$safeeval,keys(%gnuplot_defaults));
if ($constructtag) {
$result = &Apache::edit::rebuild_tag($token);
-# $result.= &Apache::edit::handle_insert();
}
}
return $result;
}
-sub end_plot {
+sub end_gnuplot {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
-
pop @Apache::lonxml::namespace;
&Apache::lonxml::deregister('Apache::lonplot',
('title','xlabel','ylabel','key','axis','label','curve'));
my $result = '';
- if ($target eq 'web') {
+ my $randnumber;
+ # need to call rand everytime start_script would evaluate, as the
+ # safe space rand number generator and the global rand generator
+ # are not separate
+ if ($target eq 'web' || $target eq 'tex' || $target eq 'grade' ||
+ $target eq 'answer') {
+ $randnumber=int(rand(1000));
+ }
+ if ($target eq 'web' || $target eq 'tex') {
&check_inputs(); # Make sure we have all the data we need
##
## Determine filename
my $tmpdir = '/home/httpd/perl/tmp/';
- my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}.
- '_'.time.'_'.$$.int(rand(1000)).'_plot.data';
+ my $filename = $env{'user.name'}.'_'.$env{'user.domain'}.
+ '_'.time.'_'.$$.$randnumber.'_plot';
## Write the plot description to the file
- my $fh=Apache::File->new(">$tmpdir$filename");
- print $fh &write_gnuplot_file();
- close($fh);
+ &write_gnuplot_file($tmpdir,$filename,$target);
+ $filename = &escape($filename);
## return image tag for the plot
- $result .= <<"ENDIMAGE";
-
+ if ($target eq 'web') {
+ $result .= <<"ENDIMAGE";
+
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 = "%DYNAMICIMAGE:$Apache::lonplot::plot{'width'}:$Apache::lonplot::plot{'height'}:$Apache::lonplot::plot{'texwidth'}\n";
+ $result .= '\graphicspath{{/home/httpd/perl/tmp/}}'."\n";
+ $result .= '\includegraphics[width='.$Apache::lonplot::plot{'texwidth'}.' mm]{'.&unescape($filename).'.eps}';
+ }
+ } elsif ($target eq 'edit') {
+ $result.=&Apache::edit::tag_end($target,$token);
+ }
+ return $result;
+}
+
+
+##--------------------------------------------------------------- xtics
+sub start_xtics {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+ my $result='';
+ if ($target eq 'web' || $target eq 'tex') {
+ &get_attributes(\%xtics,\%tic_defaults,$parstack,$safeeval,
+ $tagstack->[-1]);
+ } elsif ($target eq 'edit') {
+ $result .= &Apache::edit::tag_start($target,$token,'xtics');
+ $result .= &edit_attributes($target,$token,\%tic_defaults,
+ \@tic_edit_order);
+ } elsif ($target eq 'modified') {
+ my $constructtag=&Apache::edit::get_new_args
+ ($token,$parstack,$safeeval,keys(%tic_defaults));
+ if ($constructtag) {
+ $result = &Apache::edit::rebuild_tag($token);
+ }
+ }
+ return $result;
+}
+
+sub end_xtics {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+ my $result = '';
+ if ($target eq 'web' || $target eq 'tex') {
+ } elsif ($target eq 'edit') {
+ $result.=&Apache::edit::tag_end($target,$token);
+ }
+ return $result;
+}
+
+##--------------------------------------------------------------- ytics
+sub start_ytics {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+ my $result='';
+ if ($target eq 'web' || $target eq 'tex') {
+ &get_attributes(\%ytics,\%tic_defaults,$parstack,$safeeval,
+ $tagstack->[-1]);
+ } elsif ($target eq 'edit') {
+ $result .= &Apache::edit::tag_start($target,$token,'ytics');
+ $result .= &edit_attributes($target,$token,\%tic_defaults,
+ \@tic_edit_order);
+ } elsif ($target eq 'modified') {
+ my $constructtag=&Apache::edit::get_new_args
+ ($token,$parstack,$safeeval,keys(%tic_defaults));
+ if ($constructtag) {
+ $result = &Apache::edit::rebuild_tag($token);
+ }
+ }
+ return $result;
+}
+
+sub end_ytics {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+ my $result = '';
+ if ($target eq 'web' || $target eq 'tex') {
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_end($target,$token);
}
return $result;
}
+
##----------------------------------------------------------------- key
sub start_key {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
- if ($target eq 'web') {
+ if ($target eq 'web' || $target eq 'tex') {
&get_attributes(\%key,\%key_defaults,$parstack,$safeeval,
$tagstack->[-1]);
} elsif ($target eq 'edit') {
@@ -358,7 +690,6 @@ sub start_key {
($token,$parstack,$safeeval,keys(%key_defaults));
if ($constructtag) {
$result = &Apache::edit::rebuild_tag($token);
- $result.= &Apache::edit::handle_insert();
}
}
return $result;
@@ -367,7 +698,7 @@ sub start_key {
sub end_key {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result = '';
- if ($target eq 'web') {
+ if ($target eq 'web' || $target eq 'tex') {
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_end($target,$token);
}
@@ -378,16 +709,20 @@ sub end_key {
sub start_title {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
- if ($target eq 'web') {
- $title = &Apache::lonxml::get_all_text("/title",$$parser[-1]);
+ if ($target eq 'web' || $target eq 'tex') {
+ $title = &Apache::lonxml::get_all_text("/title",$parser,$style);
+ $title=&Apache::run::evaluate($title,$safeeval,$$parstack[-1]);
+ $title =~ s/\n/ /g;
+ if (length($title) > $max_str_len) {
+ $title = substr($title,0,$max_str_len);
+ }
} elsif ($target eq 'edit') {
$result.=&Apache::edit::tag_start($target,$token,'Plot Title');
- my $text=&Apache::lonxml::get_all_text("/title",$$parser[-1]);
- $result.='