Diff for /loncom/xml/lonplot.pm between versions 1.5 and 1.10

version 1.5, 2001/12/18 22:29:42 version 1.10, 2001/12/20 19:20:43
Line 26 Line 26
 # http://www.lon-capa.org/  # http://www.lon-capa.org/
 #  #
 # 12/15/01 Matthew  # 12/15/01 Matthew
 # 12/18 Matthew  # 12/18 12/19 12/20 Matthew
 package Apache::lonplot;  package Apache::lonplot;
   
 use strict;  use strict;
   use Apache::File;
 use Apache::response;  use Apache::response;
 use Apache::lonxml;  use Apache::lonxml;
   
 use Digest::MD5  qw(md5 md5_hex md5_base64);  use Digest::MD5  qw(md5 md5_hex md5_base64);
   
 sub BEGIN {  sub BEGIN {
   &Apache::lonxml::register('Apache::lonplot',('plot'));    &Apache::lonxml::register('Apache::lonplot',('plot'));
 }  }
   
   ## 
   ## Description of data structures:
   ##
   ##  %plot       %key    %axis
   ## --------------------------
   ##  height      title   color
   ##  width       box     xmin
   ##  bgcolor     pos     xmax
   ##  fgcolor             ymin
   ##  transparent         ymax
   ##  grid
   ##  border
   ##  font
   ##
   ##  @labels: $labels[$i] = \%label
   ##           %label: text, xpos, ypos, justify
   ## 
   ##  @curves: $curves[$i] = \%curve
   ##        %curve: name, linestyle, ( function | data )
   ##
   ##  $curves[$i]->{'data'} = [ [x1,x2,x3,x4],
   ##                            [y1,y2,y3,y4] ]
   ##
   ##------------------------------------------------------------
 ##  ##
 ## Tests used in checking the validitity of input  ## Tests used in checking the validitity of input
 ##  ##
Line 48  my $onoff_test     = sub {$_[0]=~/^(on|o Line 74  my $onoff_test     = sub {$_[0]=~/^(on|o
 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 $sml_test       = sub {$_[0]=~/^(small|medium|large)$/};
 my $linestyle_test = sub {$_[0]=~/^(lines|linespoints|dots|points|steps)$/};  my $linestyle_test = sub {$_[0]=~/^(lines|linespoints|dots|points|steps)$/};
 my $words_test     = sub {$_[0]=~/^((\w+\b*)+$/};  my $words_test     = sub {$_[0]=~/^(\w+ *)+$/};
 ##  ##
 ## Default values for attributes of elements  ## Default values for attributes of elements
 ##  ##
 my %plot_defaults =   my %plot_defaults = 
     (      (
      height       => {default => 200,       test => $int_test  },       height       => {default => 200,       test => $int_test   },
      width        => {default => 200,       test => $int_test  },       width        => {default => 200,       test => $int_test   },
      bgcolor      => {default => 'xffffff', test => $color_test},       bgcolor      => {default => 'xffffff', test => $color_test },
      fgcolor      => {default => 'x000000', test => $color_test},       fgcolor      => {default => 'x000000', test => $color_test },
      transparent  => {default => 'off',     test => $onoff_test},       transparent  => {default => 'off',     test => $onoff_test },
      grid         => {default => 'off',     test => $onoff_test},       grid         => {default => 'off',     test => $onoff_test },
      border       => {default => 'on',      test => $onoff_test},       border       => {default => 'on',      test => $onoff_test },
      font         => {default => 'medium',  test => $sml_test  }       font         => {default => 'medium',  test => $sml_test   }
      );       );
   
 my %key_defaults =   my %key_defaults = 
     (      (
      title => { default => '',          test => $words_test  },       title => { default => '',          test => $words_test   },
      box   => { default => 'off',       test => $onoff_test  },       box   => { default => 'off',       test => $onoff_test   },
      pos   => { default => 'top right', test => $key_pos_test}       pos   => { default => 'top right', test => $key_pos_test }
      );       );
   
 my %label_defaults =   my %label_defaults = 
     (      (
      xpos    => {default => 0,         test => $real_test                   },       xpos    => {default => 0,         test => $real_test     },
      ypos    => {default => 0,         test => $real_test                   },       ypos    => {default => 0,         test => $real_test     },
      color   => {default => 'x000000', test => $color_test                  },  
      justify => {default => 'left',           justify => {default => 'left',    
                  test => sub {$_[0]=~/^(left|right|center)$/}}                   test => sub {$_[0]=~/^(left|right|center)$/} }
      );       );
   
 my %axis_defaults =   my %axis_defaults = 
     (      (
      color     => {default => 'x000000', test => $color_test},       color     => {default => 'x000000', test => $color_test},
      thickness => {default => 1,         test => $int_test  },  
      xmin      => {default => -10.0,     test => $real_test },       xmin      => {default => -10.0,     test => $real_test },
      xmax      => {default =>  10.0,     test => $real_test },       xmax      => {default =>  10.0,     test => $real_test },
      ymin      => {default => -10.0,     test => $real_test },       ymin      => {default => -10.0,     test => $real_test },
Line 92  my %axis_defaults = Line 116  my %axis_defaults =
   
 my %curve_defaults =   my %curve_defaults = 
     (      (
      color     => {default => 'x000000', test => $color_test      },       color     => {default => 'x000000', test => $color_test             },
      name      => {default => 'x000000', test => sub {$_[0]=~/^[\w ]*$/} },       name      => {default => 'x000000', test => sub {$_[0]=~/^[\w ]*$/} },
      linestyle => {default => 'lines',   test => $linestyle_test  }       linestyle => {default => 'lines',   test => $linestyle_test         }
      );       );
   
 ##  ##
Line 103  my %curve_defaults = Line 127  my %curve_defaults =
 my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves);  my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves);
   
 sub start_plot {  sub start_plot {
     %plot = '';   %key='';    %axis='';       %plot    = undef;   %key     = undef;   %axis   = undef; 
     $title='';    $xlabel=''; $ylabel='';      $title   = undef;   $xlabel  = undef;   $ylabel = undef;
     @labels = ''; @curves='';      $#labels = -1;      $#curves = -1;
       #
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
     my $result='';      my $result='';
     &Apache::lonxml::register('Apache::plot',      &Apache::lonxml::register('Apache::lonplot',
      ('title','xlabel','ylabel','key','axis','label','curve'));       ('title','xlabel','ylabel','key','axis','label','curve'));
     push (@Apache::lonxml::namespace,'plot');      push (@Apache::lonxml::namespace,'plot');
     ## Always evaluate the insides of the <plot></plot> tags      ## Always evaluate the insides of the <plot></plot> tags
Line 117  sub start_plot { Line 141  sub start_plot {
     $inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]);      $inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]);
     &Apache::lonxml::newparser($parser,\$inside);      &Apache::lonxml::newparser($parser,\$inside);
     ##-------------------------------------------------------      ##-------------------------------------------------------
     &get_attributes(\%plot,\%plot_defaults,$parstack,$safeeval,'plot');      &get_attributes(\%plot,\%plot_defaults,$parstack,$safeeval,$tagstack);
     if ($target eq 'web') {      if ($target eq 'web') {
     }      }
     return '';      return '';
Line 130  sub end_plot { Line 154  sub end_plot {
  ('title','xlabel','ylabel','key','axis','label','curve'));   ('title','xlabel','ylabel','key','axis','label','curve'));
     my $result = '';      my $result = '';
     if ($target eq 'web') {      if ($target eq 'web') {
  ## Determine filename -- may need a better way later   ## Determine filename -- Need to use the 'id' thingy that Gerd 
    ## mentioned.
  my $tmpdir = '/home/httpd/perl/tmp/';   my $tmpdir = '/home/httpd/perl/tmp/';
  my $filename = $tmpdir.$ENV{'user.name'}.'_'.$ENV{'user.domain'}.   my $filename = $tmpdir.$ENV{'user.name'}.'_'.$ENV{'user.domain'}.
     '_plot.data';      '_plot.data';
  my $usersees=md5_base64($filename.'_'.$ENV{'REMOTE_ADDR'});   my $usersees=md5_base64($filename.'_'.$ENV{'REMOTE_ADDR'});
   # my $usersees=$filename.'_'.$ENV{'REMOTE_ADDR'};
   
  ## Write the plot description to the file   ## Write the plot description to the file
  my $fh=&Apache::File->new('/home/httpd/perl/tmp/'.$realname);   my $fh=Apache::File->new('/home/httpd/perl/tmp/'.$filename);
  # write plot values   $result .= '<pre>';
  # write title, xlabel, ylabel   $result .= &write_gnuplot_file($fh);
  # write key values   $result .= '</pre>';
  # write axis values  
  # write label values  
  # write curve values  
  ## Ack!   
  ## return image tag for the plot   ## return image tag for the plot
  $result = '<img src=\"/cgi-bin/plot.cgi?'.$usersees.'"';  # $result = '<img src=\"/cgi-bin/plot.cgi?'.$usersees.'"';
     }      }
     return $result;      return $result;
 }  }
Line 232  sub start_label { Line 254  sub start_label {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
     my $result='';      my $result='';
     my %label;      my %label;
     &get_attributes($label,\%label_defaults,$parstack,$safeeval,$tagstack);      &get_attributes(\%label,\%label_defaults,$parstack,$safeeval,$tagstack);
     $label->{'text'} = &Apache::lonxml::get_all_text("/label",$$parser[-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);      push(@labels,\%label);
     if ($target eq 'web') {      if ($target eq 'web') {
  # This routine should never return anything.   # This routine should never return anything.
Line 255  sub start_curve { Line 281  sub start_curve {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
     my $result='';      my $result='';
     my %curve;      my %curve;
     &get_attributes($curve,\%curve_defaults,$parstack,$safeeval,$tagstack);      &get_attributes(\%curve,\%curve_defaults,$parstack,$safeeval,$tagstack);
     push (@curves,$curve);      push (@curves,\%curve);
     &Apache::lonxml::register('Apache::lonplot',('function','data'));      &Apache::lonxml::register('Apache::lonplot',('function','data'));
     push (@Apache::lonxml::namespace,'curve');      push (@Apache::lonxml::namespace,'curve');
     if ($target eq 'web') {      if ($target eq 'web') {
Line 275  sub end_curve { Line 301  sub end_curve {
     }      }
     return $result;      return $result;
 }  }
   
 ##------------------------------------------------------------ curve function  ##------------------------------------------------------------ curve function
 sub start_function {  sub start_function {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
     my $result='';      my $result='';
     if (exists($curves[-1]->{'data'}) {      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.');   &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'});   delete $curves[-1]->{'data'} ;
     }      }
     $curves[-1]->{'function'} =       $curves[-1]->{'function'} = 
  &Apache::lonxml::get_all_text("/function",$$parser[-1]);   &Apache::lonxml::get_all_text("/function",$$parser[-1]);
Line 300  sub end_function { Line 325  sub end_function {
     }      }
     return $result;      return $result;
 }  }
   
 ##------------------------------------------------------------ curve  data  ##------------------------------------------------------------ curve  data
 sub start_data {  sub start_data {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
     my $result='';      my $result='';
     if (exists($curves[-1]->{'function'})) {      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.');   &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'});   delete($curves[-1]->{'function'});
     }      }
     my $datatext = &Apache::lonxml::get_all_text("/data",$$parser[-1]);      my $datatext = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
     $datatext =~ s/(\s+$|^\s+)//g;      $datatext =~ s/\s+//g;  # No whitespace, numbers must be seperated
     $datatext =~ s/\s+/ /g;                              # by commas
     if ($datatext !~ /^(([+-]?\d*\.?\d*)[, ]?)+$/) {      if ($datatext !~ /^(([+-]?\d*\.?\d*)[, ]?)+$/) {
  &Apache::lonxml::warning('Malformed data: '.$datatext);   &Apache::lonxml::warning('Malformed data: '.$datatext);
  $datatext = '';   $datatext = '';
     }      }
     push( @{$curves[-1]->{'data'}},$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 ($target eq 'web') {
  # This routine should never return anything.   # This routine should never return anything.
     }      }
Line 354  sub end_axis { Line 390  sub end_axis {
   
 ##------------------------------------------------------------------- misc  ##------------------------------------------------------------------- misc
 sub get_attributes{  sub get_attributes{
     %values   = %{shift};      my $values   = shift;
     %defaults = %{shift};      my $defaults = shift;
     $parstack = shift;      my $parstack = shift;
     $safeeval = shift;      my $safeeval = shift;
     $tag      = shift;      my $tag      = shift;
     my $attr;      my $attr;
     foreach $attr (keys %defaults) {      foreach $attr (keys %{$defaults}) {
  $values{$attr} = &Apache::lonxml::get_param($attr,$parstack,$safeeval);   $values->{$attr} = 
  my $test = $defaults{$attr}->{'test'};               &Apache::lonxml::get_param($attr,$parstack,$safeeval);
  if (! &$test($values{$attr})) {   if ($values->{$attr} eq '' | !defined($values->{$attr})) {
     &Apache::lonxml::warning($tag.':'.$attr.': Bad value.  Replacing your value with : '.$defaults{$attr});      $values->{$attr} = $defaults->{$attr};
     $values{$attr} = $defaults{$attr};      next;
     }   }
     return ;   my $test = $defaults->{$attr}->{'test'};
    if (! &$test($values->{$attr})) {
       &Apache::lonxml::warning
    ($tag.':'.$attr.': Bad value.'.'Replacing your value with : '
    .$defaults->{$attr} );
       $values->{$attr} = $defaults->{$attr};
    }
    return ;
       }
   }
   
   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'}; 
       foreach $curve (@curves) {
    push @Colors, ($curve->{'color'} ne '' ? 
          $curve->{'color'}       : 
          $plot{'fgcolor'}      );
       }
       # set term
       $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 .= "@Colors\n";
       # grid
       $gnuplot_input .= 'set grid'.$/ if ($plot{'grid'} eq 'on');
       # border
       $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
       }
       # Key
       if (defined($key{'pos'})) {
    $gnuplot_input .= 'set key '.$key{'pos'}.' ';
    $gnuplot_input .= ($key{'box'} eq 'on' ? 'box ' : 'nobox ');
    if ($key{'title'} ne '') {
       $gnuplot_input .= 'title "'.$key{'title'}.'"'.$/;
    } else {
       $gnuplot_input .= $/;
    }
       } else {
    $gnuplot_input .= 'set nokey'.$/;
       }    
       # labels
       my $label;
       foreach $label (@labels) {
    $gnuplot_input .= 'set label "'.$label->{'text'}.'" at '.
       $label->{'xpos'}.','.$label->{'ypos'}.' '.$label->{'justify'}.$/ ;
       }
       # curves
       $gnuplot_input .= 'plot ';
       my $datatext = '';
       for (my $i = 0;$i<=$#curves;$i++) {
    $curve = $curves[$i];
    $gnuplot_input.= ', ' if ($i > 0);
    if (exists($curve->{'function'})) {
       $gnuplot_input.= 
    $curve->{'function'}.' title "'.
    $curve->{'name'}.'" with '.
    $curve->{'linestyle'};
    } elsif (exists($curve->{'data'})) {
       $gnuplot_input.= '\'-\' title "'.
    $curve->{'name'}.'" with '.
    $curve->{'linestyle'};
       my @Data = @{$curve->{'data'}};
       my @Data0 = @{$Data[0]};
       for (my $i =0; $i<=$#Data0; $i++) {
    my $dataset;
    foreach $dataset (@Data) {
       $datatext .= $dataset->[$i] . ' ';
    }
    $datatext .= $/;
       }
       $datatext .=$/;
    }
       }
       $gnuplot_input .= $/.$datatext;
       return $gnuplot_input;
   #    print $fh $gnuplot_input;
 }  }
   
 1;  1;

Removed from v.1.5  
changed lines
  Added in v.1.10


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>