--- loncom/xml/lonplot.pm 2001/12/28 15:49:38 1.21 +++ loncom/xml/lonplot.pm 2002/01/09 16:51:51 1.35 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Dynamic plot # -# $Id: lonplot.pm,v 1.21 2001/12/28 15:49:38 matthew Exp $ +# $Id: lonplot.pm,v 1.35 2002/01/09 16:51:51 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,7 +26,16 @@ # http://www.lon-capa.org/ # # 12/15/01 Matthew -# 12/17 12/18 12/19 12/20 12/21 12/27 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 + +# Current issues +# 1. Gnuplot is unable to vary the color or linestyle of plots. +# The key does not know this so it is misleading for the user. +# Multiple s can be plotted with varying line styles and +# colors. +# package Apache::lonplot; use strict; @@ -35,7 +44,7 @@ use Apache::response; use Apache::lonxml; use Apache::edit; -sub BEGIN { +BEGIN { &Apache::lonxml::register('Apache::lonplot',('plot')); } @@ -69,6 +78,31 @@ sub BEGIN { ## Tests used in checking the validitity of input ## ## ## ################################################################### + +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 + linespoints => 2, # to check on whether or not they have + dots => 2, # supplied enough fields + points => 2, # to use the given line style. But for + steps => 2, # now there are more important things + fsteps => 2, # for me to deal with. + histeps => 2, + errorbars => 3, + xerrorbars => [3,4], + yerrorbars => [3,4], + xyerrorbars => [4,6], + boxes => 3, +# boxerrorbars => [3,4,5], +# boxxyerrorbars => [4,6,7], +# financebars => 5, +# candlesticks => 5, + 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+)?$/}; @@ -76,7 +110,7 @@ my $color_test = sub {$_[0]=~s/\s+// 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 {$_[0]=~/^(lines|linespoints|dots|points|steps)$/}; +my $linestyle_test = sub {exists($linestyles{$_[0]})}; my $words_test = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^([\w\(\)]+ ?)+$/}; ################################################################### @@ -84,18 +118,20 @@ my $words_test = sub {$_[0]=~s/\s+/ ## Attribute metadata ## ## ## ################################################################### +my @plot_edit_order = + qw/bgcolor fgcolor height width font transparent grid border/; my %plot_defaults = ( height => { default => 200, test => $int_test, - description => 'vertical size of image (pixels)', + description => 'height of image (pixels)', edit_type => 'entry' }, width => { default => 200, test => $int_test, - description => 'horizontal size of image (pixels)', + description => 'width of image (pixels)', edit_type => 'entry' }, bgcolor => { @@ -113,19 +149,19 @@ my %plot_defaults = transparent => { default => 'off', test => $onoff_test, - description => '', + description => 'Transparent image', edit_type => 'on_off' }, grid => { default => 'off', test => $onoff_test, - description => '', + description => 'Display grid', edit_type => 'on_off' }, border => { default => 'on', test => $onoff_test, - description => '', + description => 'Draw border around plot', edit_type => 'on_off' }, font => { @@ -193,7 +229,7 @@ my %label_defaults = my %axis_defaults = ( - color => { + color => { default => 'x000000', test => $color_test, description => 'color of axes (x000000)', @@ -222,13 +258,6 @@ my %axis_defaults = test => $real_test, description => 'maximum y-value shown in plot', edit_type => 'entry' - }, - linestyle => { - default => 'points', - test => $linestyle_test, - description => 'Style of the axis lines', - edit_type => 'choice', - choices => ['lines','linespoints','dots','points'] } ); @@ -249,9 +278,13 @@ my %curve_defaults = linestyle => { default => 'lines', test => $linestyle_test, - description => 'Style of the axis lines', + description => 'Line style', edit_type => 'choice', - choices => ['lines','linespoints','dots','points','steps'] + choices => ['lines','linespoints','dots','points','steps', + 'fsteps','histeps','errorbars','xerrorbars', + 'yerrorbars','xyerrorbars','boxes','boxerrorbars', + 'boxxyerrorbars','financebars','candlesticks', + 'vector'] } ); @@ -263,32 +296,31 @@ my %curve_defaults = my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves); sub start_plot { - %plot = undef; %key = undef; %axis = undef; + %plot = (); %key = (); %axis = (); $title = undef; $xlabel = undef; $ylabel = undef; $#labels = -1; $#curves = -1; # 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,'lonplot'); 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 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]); } elsif ($target eq 'edit') { - $result .= &Apache::edit::tag_start($target,$token); - $result .= &edit_attributes($target,$token,\%plot_defaults); + $result .= &Apache::edit::tag_start($target,$token,'Plot'); + $result .= &edit_attributes($target,$token,\%plot_defaults, + \@plot_edit_order); } elsif ($target eq 'modified') { my $constructtag=&Apache::edit::get_new_args - ($token,$parstack,$safeeval,keys %plot_defaults); + ($token,$parstack,$safeeval,keys(%plot_defaults)); if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); - $result.= &Apache::edit::handle_insert(); +# $result.= &Apache::edit::handle_insert(); } } return $result; @@ -296,6 +328,7 @@ sub start_plot { sub end_plot { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; + pop @Apache::lonxml::namespace; &Apache::lonxml::deregister('Apache::lonplot', ('title','xlabel','ylabel','key','axis','label','curve')); @@ -306,7 +339,7 @@ sub end_plot { ## Determine filename my $tmpdir = '/home/httpd/perl/tmp/'; my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}. - '_'.time.'_'.$$.'_plot.data'; + '_'.time.'_'.$$.int(rand(1000)).'_plot.data'; ## Write the plot description to the file my $fh=Apache::File->new(">$tmpdir$filename"); print $fh &write_gnuplot_file(); @@ -333,11 +366,11 @@ sub start_key { &get_attributes(\%key,\%key_defaults,$parstack,$safeeval, $tagstack->[-1]); } elsif ($target eq 'edit') { - $result .= &Apache::edit::tag_start($target,$token); + $result .= &Apache::edit::tag_start($target,$token,'Plot Key'); $result .= &edit_attributes($target,$token,\%key_defaults); } elsif ($target eq 'modified') { my $constructtag=&Apache::edit::get_new_args - ($token,$parstack,$safeeval,keys %key_defaults); + ($token,$parstack,$safeeval,keys(%key_defaults)); if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); $result.= &Apache::edit::handle_insert(); @@ -362,9 +395,16 @@ sub start_title { my $result=''; if ($target eq 'web') { $title = &Apache::lonxml::get_all_text("/title",$$parser[-1]); + 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.=''. + &Apache::edit::editfield('',$text,'',60,1); } elsif ($target eq 'modified') { - my $text=$$parser[-1]->get_text("/function"); + my $text=$$parser[-1]->get_text("/title"); $result.=&Apache::edit::modifiedfield($token); } return $result; @@ -375,6 +415,7 @@ sub end_title { my $result = ''; if ($target eq 'web') { } elsif ($target eq 'edit') { + $result.=&Apache::edit::tag_end($target,$token); } return $result; } @@ -384,9 +425,16 @@ sub start_xlabel { my $result=''; if ($target eq 'web') { $xlabel = &Apache::lonxml::get_all_text("/xlabel",$$parser[-1]); + if (length($xlabel) > $max_str_len) { + $xlabel = substr($xlabel,0,$max_str_len); + } } elsif ($target eq 'edit') { + $result.=&Apache::edit::tag_start($target,$token,'Plot Xlabel'); + my $text=&Apache::lonxml::get_all_text("/xlabel",$$parser[-1]); + $result.=''. + &Apache::edit::editfield('',$text,'',60,1); } elsif ($target eq 'modified') { - my $text=$$parser[-1]->get_text("/function"); + my $text=$$parser[-1]->get_text("/xlabel"); $result.=&Apache::edit::modifiedfield($token); } return $result; @@ -397,6 +445,7 @@ sub end_xlabel { my $result = ''; if ($target eq 'web') { } elsif ($target eq 'edit') { + $result.=&Apache::edit::tag_end($target,$token); } return $result; } @@ -407,9 +456,16 @@ sub start_ylabel { my $result=''; if ($target eq 'web') { $ylabel = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]); + if (length($ylabel) > $max_str_len) { + $ylabel = substr($ylabel,0,$max_str_len); + } } elsif ($target eq 'edit') { + $result .= &Apache::edit::tag_start($target,$token,'Plot Ylabel'); + my $text = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]); + $result .= ''. + &Apache::edit::editfield('',$text,'',60,1); } elsif ($target eq 'modified') { - my $text=$$parser[-1]->get_text("/function"); + my $text=$$parser[-1]->get_text("/ylabel"); $result.=&Apache::edit::modifiedfield($token); } return $result; @@ -420,6 +476,7 @@ sub end_ylabel { my $result = ''; if ($target eq 'web') { } elsif ($target eq 'edit') { + $result.=&Apache::edit::tag_end($target,$token); } return $result; } @@ -432,23 +489,24 @@ sub start_label { 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'; - } + my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]); + $text = substr($text,0,$max_str_len) if (length($text) > $max_str_len); + $label{'text'} = $text; push(@labels,\%label); } elsif ($target eq 'edit') { - $result .= &Apache::edit::tag_start($target,$token); + $result .= &Apache::edit::tag_start($target,$token,'Plot Label'); $result .= &edit_attributes($target,$token,\%label_defaults); + my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]); + $result .= ''. + &Apache::edit::editfield('',$text,'',60,1); } elsif ($target eq 'modified') { my $constructtag=&Apache::edit::get_new_args - ($token,$parstack,$safeeval,keys %label_defaults); + ($token,$parstack,$safeeval,keys(%label_defaults)); if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); $result.= &Apache::edit::handle_insert(); } - my $text=$$parser[-1]->get_text("/function"); + my $text=$$parser[-1]->get_text("/label"); $result.=&Apache::edit::modifiedfield($token); } return $result; @@ -468,19 +526,19 @@ sub end_label { sub start_curve { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result=''; + &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'); } elsif ($target eq 'edit') { - $result .= &Apache::edit::tag_start($target,$token); + $result .= &Apache::edit::tag_start($target,$token,'Curve'); $result .= &edit_attributes($target,$token,\%curve_defaults); } elsif ($target eq 'modified') { my $constructtag=&Apache::edit::get_new_args - ($token,$parstack,$safeeval,keys %label_defaults); + ($token,$parstack,$safeeval,keys(%curve_defaults)); if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); $result.= &Apache::edit::handle_insert(); @@ -492,9 +550,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')); } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); } @@ -513,11 +571,10 @@ sub start_function { $curves[-1]->{'function'} = &Apache::lonxml::get_all_text("/function",$$parser[-1]); } elsif ($target eq 'edit') { - $result.=&Apache::edit::tag_start($target,$token); - my $text=&Apache::lonxml::get_all_text("/function",$$parser[-1]); - $result.=''. - &Apache::edit::editfield('',$text,'',20,1). - &Apache::edit::end_table(); + $result .= &Apache::edit::tag_start($target,$token,'Curve Function'); + my $text = &Apache::lonxml::get_all_text("/function",$$parser[-1]); + $result .= ''. + &Apache::edit::editfield('',$text,'',60,1); } elsif ($target eq 'modified') { # Why do I do this? my $text=$$parser[-1]->get_text("/function"); @@ -531,6 +588,7 @@ sub end_function { my $result = ''; if ($target eq 'web') { } elsif ($target eq 'edit') { + $result .= &Apache::edit::end_table(); } return $result; } @@ -552,7 +610,7 @@ sub start_data { # make sure it's all numbers and make sure each array # is of the same length. my @data; - if ($datatext =~ /,/) { + if ($datatext =~ /,/) { # comma deliminated @data = split /,/,$datatext; } else { # Assume it's space seperated. @data = split / /,$datatext; @@ -573,8 +631,19 @@ sub start_data { $data[$i] = 1.15572734979092; } } + # complain if the number of data points is not the same as + # in previous sets of data. + if (($curves[-1]->{'data'}) && ($#data != $#{$curves[-1]->{'data'}})){ + &Apache::lonxml::warning + ('Number of data points is not consistent with previous '. + 'number of data points'); + } push @{$curves[-1]->{'data'}},\@data; } elsif ($target eq 'edit') { + $result .= &Apache::edit::tag_start($target,$token,'Curve Data'); + my $text = &Apache::lonxml::get_all_text("/data",$$parser[-1]); + $result .= ''. + &Apache::edit::editfield('',$text,'',60,1); } elsif ($target eq 'modified') { my $text=$$parser[-1]->get_text("/data"); $result.=&Apache::edit::modifiedfield($token); @@ -587,6 +656,7 @@ sub end_data { my $result = ''; if ($target eq 'web') { } elsif ($target eq 'edit') { + $result .= &Apache::edit::end_table(); } return $result; } @@ -599,9 +669,15 @@ sub start_axis { &get_attributes(\%axis,\%axis_defaults,$parstack,$safeeval, $tagstack->[-1]); } elsif ($target eq 'edit') { - $result .= &Apache::edit::tag_start($target,$token); + $result .= &Apache::edit::tag_start($target,$token,'Plot Axes'); $result .= &edit_attributes($target,$token,\%axis_defaults); } elsif ($target eq 'modified') { + my $constructtag=&Apache::edit::get_new_args + ($token,$parstack,$safeeval,keys(%axis_defaults)); + if ($constructtag) { + $result = &Apache::edit::rebuild_tag($token); + $result.= &Apache::edit::handle_insert(); + } } return $result; } @@ -613,12 +689,6 @@ sub end_axis { } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); } elsif ($target eq 'modified') { - my $constructtag=&Apache::edit::get_new_args - ($token,$parstack,$safeeval,keys %axis_defaults); - if ($constructtag) { - $result = &Apache::edit::rebuild_tag($token); - $result.= &Apache::edit::handle_insert(); - } } return $result; } @@ -633,7 +703,7 @@ sub end_axis { sub set_defaults { my ($var,$defaults) = @_; my $key; - foreach $key (keys %$defaults) { + foreach $key (keys(%$defaults)) { $var->{$key} = $defaults->{$key}->{'default'}; } } @@ -641,7 +711,7 @@ sub set_defaults { ##------------------------------------------------------------------- misc sub get_attributes{ my ($values,$defaults,$parstack,$safeeval,$tag) = @_; - foreach my $attr (keys %{$defaults}) { + foreach my $attr (keys(%{$defaults})) { $values->{$attr} = &Apache::lonxml::get_param($attr,$parstack,$safeeval); if ($values->{$attr} eq '' | !defined($values->{$attr})) { @@ -688,12 +758,12 @@ sub write_gnuplot_file { $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)) { + if (%axis) { $gnuplot_input .= "set xrange \[$axis{'xmin'}:$axis{'xmax'}\]\n"; $gnuplot_input .= "set yrange \[$axis{'ymin'}:$axis{'ymax'}\]\n"; } # Key - if (defined(%key)) { + if (%key) { $gnuplot_input .= 'set key '.$key{'pos'}.' '; if ($key{'title'} ne '') { $gnuplot_input .= 'title "'.$key{'title'}.'" '; @@ -743,9 +813,9 @@ 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 (! defined(%plot )) { &set_defaults(\%plot,\%plot_defaults); } - if (! defined(%key )) {} # No key for this plot, thats okay - if (! defined(%axis )) { &set_defaults(\%axis,\%axis_defaults); } + if (! %plot) { &set_defaults(\%plot,\%plot_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 if (! defined($xlabel)) {} # No xlabel for this plot, thats okay if (! defined($ylabel)) {} # No ylabel for this plot, thats okay @@ -765,21 +835,28 @@ sub check_inputs { #------------------------------------------------ make_edit sub edit_attributes { - my ($target,$token,$defaults) = @_; - my $result; - foreach my $attr (%$defaults) { + my ($target,$token,$defaults,$keys) = @_; + my ($result,@keys); + if ($keys && ref($keys) eq 'ARRAY') { + @keys = @$keys; + } else { + @keys = sort(keys(%$defaults)); + } + foreach my $attr (@keys) { + # append a ' ' to the description if it doesn't have one already. + my $description = $defaults->{$attr}->{'description'}; + $description .= ' ' if ($description !~ / $/); if ($defaults->{$attr}->{'edit_type'} eq 'entry') { - $result .= &Apache::edit::text_arg( - $defaults->{$attr}->{'description'}, - $attr, - $token); + $result .= &Apache::edit::text_arg + ($description,$attr,$token); } elsif ($defaults->{$attr}->{'edit_type'} eq 'choice') { - $result .= &Apache::edit::select_arg( - $defaults->{$attr}->{'description'}, - $attr, - $defaults->{$attr}->{'choices'}, - $token); + $result .= &Apache::edit::select_arg + ($description,$attr,$defaults->{$attr}->{'choices'},$token); + } elsif ($defaults->{$attr}->{'edit_type'} eq 'on_off') { + $result .= &Apache::edit::select_arg + ($description,$attr,['on','off'],$token); } + $result .= '
'; } return $result; } @@ -793,24 +870,20 @@ sub edit_attributes { #------------------------------------------------ insert_xxxxxxx sub insert_plot { - my $result; + my $result = ''; # plot attributes - $result .= '{'default'}. - "\"\n"; + $result .= "{'default'}\"\n"; } $result .= ">\n"; # Add the components $result .= &insert_key(); $result .= &insert_axis(); - $result .= &insert_label(); - $result .= &insert_curve(); - $result .= &insert_function(); - $result .= "\n"; + $result .= &insert_title(); + $result .= &insert_xlabel(); + $result .= &insert_ylabel(); $result .= &insert_curve(); - $result .= &insert_data(); - $result .= "\n"; # close up the $result .= "\n"; return $result; @@ -818,10 +891,9 @@ sub insert_plot { sub insert_key { my $result; - $result .= ' {'default'}. - "\"\n"; + $result .= " {'default'}\"\n"; } $result .= " />\n"; return $result; @@ -830,19 +902,22 @@ sub insert_key { sub insert_axis{ my $result; $result .= ' {'default'}. - "\"\n"; + foreach my $attr (keys(%axis_defaults)) { + $result .= " $attr=\"$axis_defaults{$attr}->{'default'}\"\n"; } $result .= " />\n"; return $result; } +sub insert_title { return " \n"; } +sub insert_xlabel { return " \n"; } +sub insert_ylabel { return " \n"; } + sub insert_label { my $result; $result .= '