--- loncom/xml/lonplot.pm 2003/08/28 20:38:25 1.87 +++ loncom/xml/lonplot.pm 2005/06/07 22:30:42 1.109 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Dynamic plot # -# $Id: lonplot.pm,v 1.87 2003/08/28 20:38:25 matthew Exp $ +# $Id: lonplot.pm,v 1.109 2005/06/07 22:30:42 foxr Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,24 +25,35 @@ # # 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 12/31 Matthew -# 01/01/02 Matthew -# 01/02 01/03 01/04 01/07 01/08 01/09 Matthew -# 01/21 02/05 02/06 2/28Matthew 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 vars qw/$weboutputformat $versionstring/; + + BEGIN { - &Apache::lonxml::register('Apache::lonplot',('gnuplot')); + &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: ## @@ -113,39 +124,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 plottype/; + border align texwidth texfont plotcolor plottype lmargin rmargin tmargin + bmargin major_ticscale minor_ticscale/; -my $gnuplot_help_text = <<"ENDPLOTHELP"; -

-The gnuplot tag allows an author to design a plot which can -be created on the fly. This is intended for use in homework problems -where each student needs to see a distinct plot. It can be used in -conjunction with a script tag to generate random plots. -

-A gnuplot tag can contain the following sub-tags: -

-
-
Plot Label -
Allows you to place text at a given (x,y) coordinate on the plot. -
Plot Title -
The title of the plot -
Plot Xlabel -
The label on the horizontal axis of the plot -
Plot Ylabel -
The label on the vertical axis of the plot -
Plot Axes -
allows specification of the x and y ranges displayed in the plot -
Plot Key -
Lists the functions displayed in the plot. -
Plot Curve -
Sets the data used in the plot. -
Plot Tics -
Allows specification of the x and y coordinate 'tics' on the axes. -This is mostly used to adjust the grid lines when a grid is displayed. -
-If you are having trouble with your plot, please read the help -available on Plot Curve. -ENDPLOTHELP +my $margin_choices = ['default',0..20]; my %gnuplot_defaults = ( @@ -230,12 +212,68 @@ my %gnuplot_defaults = 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/], + }, plottype => { default => 'Cartesian', test => sub {$_[0]=~/^(Polar|Cartesian)$/}, description => 'Plot type:', edit_type => 'choice', - choices => ['Polar','Cartesian'] + 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, + }, + 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' }, ); @@ -289,43 +327,51 @@ my %label_defaults = } ); -my @tic_edit_order = ('location','mirror','start','increment','end'); +my @tic_edit_order = ('location','mirror','start','increment','end', + 'minorfreq'); my %tic_defaults = ( location => { default => 'border', test => sub {$_[0]=~/^(border|axis)$/}, - description => 'Location of tick marks', + description => 'Location of major tic marks', edit_type => 'choice', choices => ['border','axis'] }, mirror => { default => 'on', test => $onoff_test, - description => 'mirror ticks on opposite axis?', + description => 'mirror tics on opposite axis?', edit_type => 'onoff' }, start => { default => '-10.0', test => $real_test, - description => 'Start ticks at', + description => 'Start major tics at', edit_type => 'entry', size => '10' }, increment => { default => '1.0', test => $real_test, - description => 'Place a tick every', + description => 'Place a major tic every', edit_type => 'entry', size => '10' }, end => { default => ' 10.0', test => $real_test, - description => 'Stop ticks at ', + 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'); @@ -368,37 +414,6 @@ my %axis_defaults = } ); -my $curve_help_text = <<"ENDCURVEHELP"; -The curve tag is where you set the data to be plotted by gnuplot. -There are two ways of entering the information: -
-
Curve Data -
Using a data tag you can specify the numbers used to produce -the plot. -

-By default, two data tags will be available in a plot. The -first will specify X coordinates of the data and the second will -give the Y coordinates of the data. When working with a linestyle that -requires more than two data sets, inserting another data tag is -required. Unfortunately, you must make sure the data tags appear -in the order gnuplot expects the data. -

-Specifying the data should usually be done with a perl variable or array, -such as \@Xdata and \@Ydata. You may also specify numerical data seperated -by commas. Again, the order of the data tags is important. The -first tag will be the X data and the second will be the Y data. -

-
Curve Function -
The function tag allows you to specify the curve to be -plotted as a formula that gnuplot can understand. Be careful using this -tag. It is surprisingly easy to give gnuplot a function it cannot deal -with properly. Be explicit: 2*sin(2*3.141592*x/4) will work but -2sin(2*3.141592x/4) will not. If you do not receive any errors in the -gnuplot data but still do not have an image produced, it is likely there -is an error in your function tag. -
-ENDCURVEHELP - my @curve_edit_order = ('color','name','linestyle','pointtype','pointsize'); my %curve_defaults = @@ -453,13 +468,15 @@ 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 { - %plot = (); %key = (); %axis = (); - $title = undef; $xlabel = undef; $ylabel = undef; - $#labels = -1; $#curves = -1; - %xtics = (); %ytics = (); + 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=''; @@ -468,12 +485,10 @@ 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'); - $result .= &make_javascript(); - $result .= &help_win($gnuplot_help_text); $result .= &edit_attributes($target,$token,\%gnuplot_defaults, \@gnuplot_edit_order); } elsif ($target eq 'modified') { @@ -495,7 +510,7 @@ sub end_gnuplot { 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 seperate + # are not separate if ($target eq 'web' || $target eq 'tex' || $target eq 'grade' || $target eq 'answer') { $randnumber=int(rand(1000)); @@ -505,7 +520,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); @@ -513,16 +528,20 @@ sub end_gnuplot { ## return image tag for the plot if ($target eq 'web') { $result .= <<"ENDIMAGE"; -$plot{'alttag'} +$Apache::lonplot::plot{'alttag'} ENDIMAGE } elsif ($target eq 'tex') { - &Apache::lonnet::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}'; + &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]{'.&Apache::lonnet::unescape($filename).'.eps}'; } } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); @@ -642,9 +661,8 @@ sub start_title { &Apache::edit::start_spanning_row(). &Apache::edit::editline('',$text,'',60); } elsif ($target eq 'modified') { - my $text=$$parser[-1]->get_text("/title"); $result.=&Apache::edit::rebuild_tag($token); - $result.=&Apache::edit::modifiedfield($token); + $result.=&Apache::edit::modifiedfield("/title",$parser); } return $result; } @@ -676,9 +694,8 @@ sub start_xlabel { &Apache::edit::start_spanning_row(). &Apache::edit::editline('',$text,'',60); } elsif ($target eq 'modified') { - my $text=$$parser[-1]->get_text("/xlabel"); $result.=&Apache::edit::rebuild_tag($token); - $result.=&Apache::edit::modifiedfield($token); + $result.=&Apache::edit::modifiedfield("/xlabel",$parser); } return $result; } @@ -711,9 +728,8 @@ sub start_ylabel { &Apache::edit::start_spanning_row(). &Apache::edit::editline('',$text,'',60); } elsif ($target eq 'modified') { - my $text=$$parser[-1]->get_text("/ylabel"); $result.=&Apache::edit::rebuild_tag($token); - $result.=&Apache::edit::modifiedfield($token); + $result.=&Apache::edit::modifiedfield("/ylabel",$parser); } return $result; } @@ -753,8 +769,7 @@ sub start_label { &Apache::edit::get_new_args ($token,$parstack,$safeeval,keys(%label_defaults)); $result.=&Apache::edit::rebuild_tag($token); - my $text=$$parser[-1]->get_text("/label"); - $result.=&Apache::edit::modifiedfield($token); + $result.=&Apache::edit::modifiedfield("/label",$parser); } return $result; } @@ -782,7 +797,6 @@ sub start_curve { push (@curves,\%curve); } elsif ($target eq 'edit') { $result .= &Apache::edit::tag_start($target,$token,'Curve'); - $result .= &help_win($curve_help_text); $result .= &edit_attributes($target,$token,\%curve_defaults, \@curve_edit_order); } elsif ($target eq 'modified') { @@ -832,8 +846,7 @@ sub start_function { &Apache::edit::editline('',$text,'',60); } elsif ($target eq 'modified') { $result.=&Apache::edit::rebuild_tag($token); - my $text=$$parser[-1]->get_text("/function"); - $result.=&Apache::edit::modifiedfield($token); + $result.=&Apache::edit::modifiedfield("/function",$parser); } return $result; } @@ -875,7 +888,7 @@ sub start_data { my @data; if ($datatext =~ /,/) { # comma deliminated @data = split /,/,$datatext; - } else { # Assume it's space seperated. + } else { # Assume it's space separated. @data = split / /,$datatext; } for (my $i=0;$i<=$#data;$i++) { @@ -910,8 +923,7 @@ sub start_data { &Apache::edit::editline('',$text,'',60); } elsif ($target eq 'modified') { $result.=&Apache::edit::rebuild_tag($token); - my $text=$$parser[-1]->get_text("/data"); - $result.=&Apache::edit::modifiedfield($token); + $result.=&Apache::edit::modifiedfield("/data",$parser); } return $result; } @@ -977,7 +989,7 @@ sub set_defaults { sub get_attributes{ my ($values,$defaults,$parstack,$safeeval,$tag) = @_; foreach my $attr (keys(%{$defaults})) { - if ($attr eq 'texwidth') { + if ($attr eq 'texwidth' || $attr eq 'texfont') { $values->{$attr} = &Apache::lonxml::get_param($attr,$parstack,$safeeval,undef,1); } else { @@ -1004,49 +1016,90 @@ sub write_gnuplot_file { my ($tmpdir,$filename,$target)= @_; my $gnuplot_input = ''; my $curve; + my $pt = $Apache::lonplot::plot{'texfont'}; + # + # Check to be sure we do not have any empty curves + my @curvescopy; + foreach my $curve (@curves) { + if (exists($curve->{'function'})) { + if ($curve->{'function'} !~ /^\s*$/) { + push(@curvescopy,$curve); + } + } elsif (exists($curve->{'data'})) { + foreach my $data (@{$curve->{'data'}}) { + if (scalar(@$data) > 0) { + push(@curvescopy,$curve); + last; + } + } + } + } + @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\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($Apache::lonplot::plot{'lmargin'}) ne 'default') { + $gnuplot_input .= 'set lmargin '.$Apache::lonplot::plot{'lmargin'}.$/; + } + if (lc($Apache::lonplot::plot{'rmargin'}) ne 'default') { + $gnuplot_input .= 'set rmargin '.$Apache::lonplot::plot{'rmargin'}.$/; + } + if (lc($Apache::lonplot::plot{'tmargin'}) ne 'default') { + $gnuplot_input .= 'set tmargin '.$Apache::lonplot::plot{'tmargin'}.$/; + } + if (lc($Apache::lonplot::plot{'bmargin'}) ne 'default') { + $gnuplot_input .= 'set bmargin '.$Apache::lonplot::plot{'bmargin'}.$/; + } + # tic scales + $gnuplot_input .= 'set 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 - $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 ($target eq 'tex') { + $gnuplot_input .= "set title \"$title\" font \"Helvetica,".$pt."pt\"\n" if (defined($title)) ; + $gnuplot_input .= "set xlabel \"$xlabel\" font \"Helvetica,".$pt."pt\" \n" if (defined($xlabel)); + $gnuplot_input .= "set ylabel \"$ylabel\" font \"Helvetica,".$pt."pt\"\n" if (defined($ylabel)); + } else { + $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)); + } # tics if (%xtics) { $gnuplot_input .= "set xtics $xtics{'location'} "; @@ -1054,6 +1107,9 @@ sub write_gnuplot_file { $gnuplot_input .= "$xtics{'start'}, "; $gnuplot_input .= "$xtics{'increment'}, "; $gnuplot_input .= "$xtics{'end'}\n"; + if ($xtics{'minorfreq'} != 0) { + $gnuplot_input .= "set mxtics ".$xtics{'minorfreq'}."\n"; + } } if (%ytics) { $gnuplot_input .= "set ytics $ytics{'location'} "; @@ -1061,6 +1117,9 @@ sub write_gnuplot_file { $gnuplot_input .= "$ytics{'start'}, "; $gnuplot_input .= "$ytics{'increment'}, "; $gnuplot_input .= "$ytics{'end'}\n"; + if ($ytics{'minorfreq'} != 0) { + $gnuplot_input .= "set mytics ".$ytics{'minorfreq'}."\n"; + } } # axis if (%axis) { @@ -1081,10 +1140,14 @@ sub write_gnuplot_file { my $label; foreach $label (@labels) { $gnuplot_input .= 'set label "'.$label->{'text'}.'" at '. - $label->{'xpos'}.','.$label->{'ypos'}.' '.$label->{'justify'}.$/ ; + $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 @@ -1154,7 +1217,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 @@ -1192,10 +1255,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 .= '
'; @@ -1315,40 +1378,6 @@ sub insert_data { } ##---------------------------------------------------------------------- -# Javascript functions to display help for tags - -sub make_javascript { - my $helpwindowwidth = 400; - my $helpwindowheight = 400; - my $result = ''; - $result.=<<"ENDFUNCTION"; - -ENDFUNCTION - return $result; -} - -sub help_win { - my ($helptext)=@_; - $helptext =~ s/\n/ /g; - $helptext =~ s/\'/\\\'/g; - my $result = ''; - $result.=<<"ENDWIN"; -
-help -
-ENDWIN - return $result; -} -##---------------------------------------------------------------------- 1; __END__