--- loncom/xml/lonplot.pm	2002/01/03 22:09:49	1.31
+++ loncom/xml/lonplot.pm	2002/01/15 16:21:39	1.40
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Dynamic plot
 #
-# $Id: lonplot.pm,v 1.31 2002/01/03 22:09:49 matthew Exp $
+# $Id: lonplot.pm,v 1.40 2002/01/15 16:21:39 matthew Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -28,7 +28,14 @@
 # 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 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 <data> plots.
+#      The key does not know this so it is misleading for the user.
+#      Multiple <function>s can be plotted with varying line styles and
+#      colors.
+#
 package Apache::lonplot;
 
 use strict;
@@ -37,7 +44,7 @@ use Apache::response;
 use Apache::lonxml;
 use Apache::edit;
 
-sub BEGIN {
+BEGIN {
   &Apache::lonxml::register('Apache::lonplot',('plot'));
 }
 
@@ -72,6 +79,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
@@ -81,16 +91,16 @@ 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,
+#     boxerrorbars   => [3,4,5],
+#     boxxyerrorbars => [4,6,7],
+#     financebars    => 5,
+#     candlesticks   => 5,
+     vector	    => 4
     );		    
 
 my $int_test       = sub {$_[0]=~s/\s+//g;$_[0]=~/^\d+$/};
@@ -108,48 +118,54 @@ my $words_test     = sub {$_[0]=~s/\s+/
 ##                      Attribute metadata                       ##
 ##                                                               ##
 ###################################################################
+my @plot_edit_order = 
+    qw/bgcolor fgcolor height width font transparent grid border align/;
 my %plot_defaults = 
     (
      height       => {
 	 default     => 200,
 	 test        => $int_test,
 	 description => 'height of image (pixels)',
-	 edit_type   => 'entry' 
+      	 edit_type   => 'entry',
+	 size        => '10'
 	 },
      width        => {
 	 default     => 200,
 	 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 => '',
+	 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         => {
@@ -174,7 +190,8 @@ my %key_defaults =
 	 default => '',
 	 test => $words_test,
 	 description => 'Title of key',
-	 edit_type   => 'entry'
+	 edit_type   => 'entry',
+	 size        => '40'
 	 },
      box   => { 
 	 default => 'off',
@@ -198,13 +215,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',    
@@ -221,31 +240,36 @@ my %axis_defaults =
 	 default => 'x000000', 
 	 test => $color_test,
 	 description => 'color of axes (x000000)',
-	 edit_type   => 'entry'
+	 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'
 	 }
      );
 
@@ -255,24 +279,22 @@ my %curve_defaults =
 	 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)]
 	 }
      );
 
@@ -301,13 +323,13 @@ sub start_plot {
 			$tagstack->[-1]);
     } elsif ($target eq 'edit') {
 	$result .= &Apache::edit::tag_start($target,$token,'Plot');
-	$result .= &edit_attributes($target,$token,\%plot_defaults);
+	$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));
 	if ($constructtag) {
 	    $result = &Apache::edit::rebuild_tag($token);
-#	    $result.= &Apache::edit::handle_insert();
 	}
     }
     return $result;
@@ -328,9 +350,7 @@ sub end_plot {
 	my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}.
 	    '_'.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();
-	close($fh);
+	&write_gnuplot_file($tmpdir,$filename);
 	## return image tag for the plot
 	$result .= <<"ENDIMAGE";
 <img src    = "/cgi-bin/plot.gif?$filename" 
@@ -382,10 +402,14 @@ 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.='</td></tr><tr><td colspan="3">'.
+	$result.=&Apache::edit::end_row().
+	    &Apache::edit::start_spanning_row().
 	    &Apache::edit::editfield('',$text,'',60,1);
     } elsif ($target eq 'modified') {
 	my $text=$$parser[-1]->get_text("/title");
@@ -409,10 +433,14 @@ 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.='</td></tr><tr><td colspan="3">'.
+	$result.=&Apache::edit::end_row().
+	    &Apache::edit::start_spanning_row().
 	    &Apache::edit::editfield('',$text,'',60,1);
     } elsif ($target eq 'modified') {
 	my $text=$$parser[-1]->get_text("/xlabel");
@@ -437,10 +465,14 @@ 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 .= '</td></tr><tr><td colspan="3">'.
+	$result .= &Apache::edit::end_row().
+	    &Apache::edit::start_spanning_row().
 	    &Apache::edit::editfield('',$text,'',60,1);
     } elsif ($target eq 'modified') {
 	my $text=$$parser[-1]->get_text("/ylabel");
@@ -467,18 +499,16 @@ sub start_label {
 	my %label;
 	&get_attributes(\%label,\%label_defaults,$parstack,$safeeval,
 		    $tagstack->[-1]);
-	$label{'text'} = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
-	$label{'text'} =~ s/[\-\:\`\'\"\,\.]//g;
-	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,'Plot Label');
 	$result .= &edit_attributes($target,$token,\%label_defaults);
 	my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
-	$result .= '</td></tr><tr><td colspan="3">'.
+	$result .= &Apache::edit::end_row().
+	    &Apache::edit::start_spanning_row().
 	    &Apache::edit::editfield('',$text,'',60,1);
     } elsif ($target eq 'modified') {
 	my $constructtag=&Apache::edit::get_new_args
@@ -519,7 +549,7 @@ sub start_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();
@@ -552,9 +582,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,'Curve Function');
+	$result .= &Apache::edit::tag_start($target,$token,'Gnuplot compatible curve function');
 	my $text = &Apache::lonxml::get_all_text("/function",$$parser[-1]);
-	$result .= '</td></tr><tr><td colspan="3">'.
+	$result .= &Apache::edit::end_row().
+	    &Apache::edit::start_spanning_row().
 	    &Apache::edit::editfield('',$text,'',60,1);
     } elsif ($target eq 'modified') {
 	# Why do I do this?
@@ -586,12 +617,17 @@ sub start_data {
 	    delete($curves[-1]->{'function'});
 	}
 	my $datatext = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
+	# Deal with cases where we're given an array...
+	if ($datatext =~ /^\@/) {
+	    $datatext = &Apache::run::run('return "'.$datatext.'"',
+					  $safeeval,1);
+	}
 	$datatext =~ s/\s+/ /g;  
 	# 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 =~ /,/) {
+	if ($datatext =~ /,/) { # comma deliminated
 	    @data = split /,/,$datatext;
 	} else { # Assume it's space seperated.
 	    @data = split / /,$datatext;
@@ -612,11 +648,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'}->[0]}})){
+	    &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');
+	$result .= &Apache::edit::tag_start($target,$token,'Comma or space deliminated curve data');
 	my $text = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
-	$result .= '</td></tr><tr><td colspan="3">'.
+	$result .= &Apache::edit::end_row().
+	    &Apache::edit::start_spanning_row().
 	    &Apache::edit::editfield('',$text,'',60,1);
     } elsif ($target eq 'modified') {
 	my $text=$$parser[-1]->get_text("/data");
@@ -702,8 +746,10 @@ sub get_attributes{
     }
     return ;
 }
+
 ##------------------------------------------------------- write_gnuplot_file
 sub write_gnuplot_file {
+    my ($tmpdir,$filename)= @_;
     my $gnuplot_input = '';
     my $curve;
     # Collect all the colors
@@ -754,7 +800,6 @@ sub write_gnuplot_file {
     }
     # curves
     $gnuplot_input .= 'plot ';
-    my $datatext = '';
     for (my $i = 0;$i<=$#curves;$i++) {
 	$curve = $curves[$i];
 	$gnuplot_input.= ', ' if ($i > 0);
@@ -764,9 +809,12 @@ sub write_gnuplot_file {
 		$curve->{'name'}.'" with '.
 		$curve->{'linestyle'};
 	} elsif (exists($curve->{'data'})) {
-	    $gnuplot_input.= '\'-\' title "'.
-		$curve->{'name'}.'" with '.
-		$curve->{'linestyle'};
+	    # Store data values in $datatext
+	    my $datatext = '';
+	    #   get new filename
+	    my $datafilename = "$tmpdir/$filename.$i";
+	    my $fh=Apache::File->new(">$datafilename");
+	    # Compile data
 	    my @Data = @{$curve->{'data'}};
 	    my @Data0 = @{$Data[0]};
 	    for (my $i =0; $i<=$#Data0; $i++) {
@@ -776,11 +824,21 @@ sub write_gnuplot_file {
 		}
 		$datatext .= $/;
 	    }
-	    $datatext .=$/;
+	    #   write file
+	    print $fh $datatext;
+	    close ($fh);
+	    #   generate gnuplot text
+	    $gnuplot_input.= '"'.$datafilename.'" title "'.
+		$curve->{'name'}.'" with '.
+		$curve->{'linestyle'};
 	}
     }
-    $gnuplot_input .= $/.$datatext;
-    return $gnuplot_input;
+    # Write the output to a file.
+    my $fh=Apache::File->new(">$tmpdir$filename");
+    print $fh $gnuplot_input;
+    close($fh);
+    # That's all folks.
+    return ;
 }
 
 #---------------------------------------------- check_inputs
@@ -789,7 +847,7 @@ sub check_inputs {
     ## Make sure we have all the input we need:
     if (! %plot) { &set_defaults(\%plot,\%plot_defaults); }
     if (! %key ) {} # No key for this plot, thats okay
-    if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }
+#    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
@@ -809,20 +867,27 @@ sub check_inputs {
 
 #------------------------------------------------ make_edit
 sub edit_attributes {
-    my ($target,$token,$defaults) = @_;
-    my $result;
-    foreach my $attr (sort keys(%$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,
+		 $defaults->{$attr}->{'size'});
 	} 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 .= '<br />';
     }