1: # The LearningOnline Network with CAPA
2: # Dynamic plot
3: #
4: # $Id: lonplot.pm,v 1.49 2002/02/06 10:33:27 matthew Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: # 12/15/01 Matthew
29: # 12/17 12/18 12/19 12/20 12/21 12/27 12/28 12/30 12/31 Matthew
30: # 01/01/02 Matthew
31: # 01/02 01/03 01/04 01/07 01/08 01/09 Matthew
32: # 01/21 02/05 02/06 Matthew
33:
34: package Apache::lonplot;
35:
36: use strict;
37: use Apache::File;
38: use Apache::response;
39: use Apache::lonxml;
40: use Apache::edit;
41:
42: BEGIN {
43: &Apache::lonxml::register('Apache::lonplot',('gnuplot'));
44: }
45:
46: ##
47: ## Description of data structures:
48: ##
49: ## %plot %key %axis
50: ## --------------------------
51: ## height title color
52: ## width box xmin
53: ## bgcolor pos xmax
54: ## fgcolor ymin
55: ## transparent ymax
56: ## grid
57: ## border
58: ## font
59: ## align
60: ##
61: ## @labels: $labels[$i] = \%label
62: ## %label: text, xpos, ypos, justify
63: ##
64: ## @curves: $curves[$i] = \%curve
65: ## %curve: name, linestyle, ( function | data )
66: ##
67: ## $curves[$i]->{'data'} = [ [x1,x2,x3,x4],
68: ## [y1,y2,y3,y4] ]
69: ##
70:
71: ###################################################################
72: ## ##
73: ## Tests used in checking the validitity of input ##
74: ## ##
75: ###################################################################
76:
77: my $max_str_len = 50; # if a label, title, xlabel, or ylabel text
78: # is longer than this, it will be truncated.
79:
80: my %linestyles =
81: (
82: lines => 2, # Maybe this will be used in the future
83: linespoints => 2, # to check on whether or not they have
84: dots => 2, # supplied enough <data></data> fields
85: points => 2, # to use the given line style. But for
86: steps => 2, # now there are more important things
87: fsteps => 2, # for me to deal with.
88: histeps => 2,
89: errorbars => 3,
90: xerrorbars => [3,4],
91: yerrorbars => [3,4],
92: xyerrorbars => [4,6],
93: boxes => 3,
94: # boxerrorbars => [3,4,5],
95: # boxxyerrorbars => [4,6,7],
96: # financebars => 5,
97: # candlesticks => 5,
98: vector => 4
99: );
100:
101: my $int_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^\d+$/};
102: my $real_test =
103: sub {$_[0]=~s/\s+//g;$_[0]=~/^[+-]?\d*\.?\d*([eE][+-]\d+)?$/};
104: my $color_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^x[\da-f]{6}$/};
105: my $onoff_test = sub {$_[0]=~/^(on|off)$/};
106: my $key_pos_test = sub {$_[0]=~/^(top|bottom|right|left|outside|below| )+$/};
107: my $sml_test = sub {$_[0]=~/^(small|medium|large)$/};
108: my $linestyle_test = sub {exists($linestyles{$_[0]})};
109: my $words_test = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^([\w\(\)]+ ?)+$/};
110:
111: ###################################################################
112: ## ##
113: ## Attribute metadata ##
114: ## ##
115: ###################################################################
116: my @gnuplot_edit_order =
117: qw/bgcolor fgcolor height width font transparent grid border align/;
118:
119: my $gnuplot_help_text = <<"ENDPLOTHELP";
120: <p>
121: The <b>gnuplot</b> tag allows an author to design a plot which can
122: be created on the fly. This is intended for use in homework problems
123: where each student needs to see a distinct plot. It can be used in
124: conjunction with a <b>script</b> tag to generate random plots.
125: </p><p>
126: A <b>gnuplot</b> tag can contain the following sub-tags:
127: </p>
128: <dl>
129: <dt> Plot Label
130: <dd> Allows you to place text at a given (x,y) coordinate on the plot.
131: <dt> Plot Title
132: <dd> The title of the plot
133: <dt> Plot Xlabel
134: <dd> The label on the horizontal axis of the plot
135: <dt> Plot Ylabel
136: <dd> The label on the vertical axis of the plot
137: <dt> Plot Axes
138: <dd> allows specification of the x and y ranges displayed in the plot
139: <dt> Plot Key
140: <dd> Lists the functions displayed in the plot.
141: <dt> Plot Curve
142: <dd> Sets the data used in the plot.
143: <dt> Plot Tics
144: <dd> Allows specification of the x and y coordinate 'tics' on the axes.
145: This is mostly used to adjust the grid lines when a grid is displayed.
146: </dl>
147: ENDPLOTHELP
148:
149: my %gnuplot_defaults =
150: (
151: height => {
152: default => 200,
153: test => $int_test,
154: description => 'height of image (pixels)',
155: edit_type => 'entry',
156: size => '10'
157: },
158: width => {
159: default => 200,
160: test => $int_test,
161: description => 'width of image (pixels)',
162: edit_type => 'entry',
163: size => '10'
164: },
165: bgcolor => {
166: default => 'xffffff',
167: test => $color_test,
168: description => 'background color of image (xffffff)',
169: edit_type => 'entry',
170: size => '10'
171: },
172: fgcolor => {
173: default => 'x000000',
174: test => $color_test,
175: description => 'foreground color of image (x000000)',
176: edit_type => 'entry',
177: size => '10'
178: },
179: transparent => {
180: default => 'off',
181: test => $onoff_test,
182: description => 'Transparent image',
183: edit_type => 'onoff'
184: },
185: grid => {
186: default => 'off',
187: test => $onoff_test,
188: description => 'Display grid',
189: edit_type => 'onoff'
190: },
191: border => {
192: default => 'on',
193: test => $onoff_test,
194: description => 'Draw border around plot',
195: edit_type => 'onoff'
196: },
197: font => {
198: default => 'medium',
199: test => $sml_test,
200: description => 'Size of font to use',
201: edit_type => 'choice',
202: choices => ['small','medium','large']
203: },
204: align => {
205: default => 'left',
206: test => sub {$_[0]=~/^(left|right|center)$/},
207: description => 'alignment for image in html',
208: edit_type => 'choice',
209: choices => ['left','right','center']
210: }
211: );
212:
213: my %key_defaults =
214: (
215: title => {
216: default => '',
217: test => $words_test,
218: description => 'Title of key',
219: edit_type => 'entry',
220: size => '40'
221: },
222: box => {
223: default => 'off',
224: test => $onoff_test,
225: description => 'Draw a box around the key?',
226: edit_type => 'onoff'
227: },
228: pos => {
229: default => 'top right',
230: test => $key_pos_test,
231: description => 'position of the key on the plot',
232: edit_type => 'choice',
233: choices => ['top left','top right','bottom left','bottom right',
234: 'outside','below']
235: }
236: );
237:
238: my %label_defaults =
239: (
240: xpos => {
241: default => 0,
242: test => $real_test,
243: description => 'x position of label (graph coordinates)',
244: edit_type => 'entry',
245: size => '10'
246: },
247: ypos => {
248: default => 0,
249: test => $real_test,
250: description => 'y position of label (graph coordinates)',
251: edit_type => 'entry',
252: size => '10'
253: },
254: justify => {
255: default => 'left',
256: test => sub {$_[0]=~/^(left|right|center)$/},
257: description => 'justification of the label text on the plot',
258: edit_type => 'choice',
259: choices => ['left','right','center']
260: }
261: );
262:
263: my @tic_edit_order = ('location','mirror','start','increment','end');
264: my %tic_defaults =
265: (
266: location => {
267: default => 'border',
268: test => sub {$_[0]=~/^(border|axis)$/},
269: description => 'Location of tick marks',
270: edit_type => 'choice',
271: choices => ['border','axis']
272: },
273: mirror => {
274: default => 'on',
275: test => $onoff_test,
276: description => 'mirror ticks on opposite axis?',
277: edit_type => 'onoff'
278: },
279: start => {
280: default => '-10.0',
281: test => $real_test,
282: description => 'Start ticks at',
283: edit_type => 'entry',
284: size => '10'
285: },
286: increment => {
287: default => '1.0',
288: test => $real_test,
289: description => 'Place a tick every',
290: edit_type => 'entry',
291: size => '10'
292: },
293: end => {
294: default => ' 10.0',
295: test => $real_test,
296: description => 'Stop ticks at ',
297: edit_type => 'entry',
298: size => '10'
299: },
300: );
301:
302: my %axis_defaults =
303: (
304: color => {
305: default => 'x000000',
306: test => $color_test,
307: description => 'color of axes (x000000)',
308: edit_type => 'entry',
309: size => '10'
310: },
311: xmin => {
312: default => '-10.0',
313: test => $real_test,
314: description => 'minimum x-value shown in plot',
315: edit_type => 'entry',
316: size => '10'
317: },
318: xmax => {
319: default => ' 10.0',
320: test => $real_test,
321: description => 'maximum x-value shown in plot',
322: edit_type => 'entry',
323: size => '10'
324: },
325: ymin => {
326: default => '-10.0',
327: test => $real_test,
328: description => 'minimum y-value shown in plot',
329: edit_type => 'entry',
330: size => '10'
331: },
332: ymax => {
333: default => ' 10.0',
334: test => $real_test,
335: description => 'maximum y-value shown in plot',
336: edit_type => 'entry',
337: size => '10'
338: }
339: );
340:
341: my $curve_help_text = <<"ENDCURVEHELP";
342: The <b>curve</b> tag is where you set the data to be plotted by gnuplot.
343: There are two ways of entering the information:
344: <dl>
345: <dt> Curve Data
346: <dd> Using a <b>data</b> tag you can specify the numbers used to produce
347: the plot.
348: <p>
349: By default, two <b>data</b> tags will be available in a plot. The
350: first will specify X coordinates of the data and the second will
351: give the Y coordinates of the data. When working with a linestyle that
352: requires more than two data sets, inserting another <b>data</b> tag is
353: required. Unfortunately, you must make sure the <b>data</b> tags appear
354: in the order gnuplot expects the data.
355: </p><p>
356: Specifying the data should usually be done with a perl variable or array,
357: such as \@Xdata and \@Ydata. You may also specify numerical data seperated
358: by commas. Again, the order of the <b>data</b> tags is important. The
359: first tag will be the X data and the second will be the Y data.
360: </p>
361: <dt> Curve Function
362: <dd> The <b>function</b> tag allows you to specify the curve to be
363: plotted as a formula that gnuplot can understand. Be careful using this
364: tag - it is surprisingly easy to give gnuplot a function it cannot deal
365: with properly. Be explicit: 2*sin(2*3.141592*x/4) will work but
366: 2sin(2*3.141592x/4) will not. If you do not receive any errors in the
367: gnuplot data but still do not have an image produced, it is likely there
368: is an error in your <b>function</b> tag.
369: </dl>
370: ENDCURVEHELP
371:
372: my %curve_defaults =
373: (
374: color => {
375: default => 'x000000',
376: test => $color_test,
377: description => 'color of curve (x000000)',
378: edit_type => 'entry',
379: size => '10'
380: },
381: name => {
382: default => '',
383: test => $words_test,
384: description => 'name of curve to appear in key',
385: edit_type => 'entry',
386: size => '20'
387: },
388: linestyle => {
389: default => 'lines',
390: test => $linestyle_test,
391: description => 'Line style',
392: edit_type => 'choice',
393: choices => [keys(%linestyles)]
394: }
395: );
396:
397: ###################################################################
398: ## ##
399: ## parsing and edit rendering ##
400: ## ##
401: ###################################################################
402: my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);
403:
404: sub start_gnuplot {
405: %plot = (); %key = (); %axis = ();
406: $title = undef; $xlabel = undef; $ylabel = undef;
407: $#labels = -1; $#curves = -1;
408: %xtics = (); %ytics = ();
409: #
410: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
411: my $result='';
412: &Apache::lonxml::register('Apache::lonplot',
413: ('title','xlabel','ylabel','key','axis','label','curve',
414: 'xtics','ytics'));
415: push (@Apache::lonxml::namespace,'lonplot');
416: if ($target eq 'web') {
417: my $inside = &Apache::lonxml::get_all_text("/gnuplot",$$parser[-1]);
418: $inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]);
419: &Apache::lonxml::newparser($parser,\$inside);
420: &get_attributes(\%plot,\%gnuplot_defaults,$parstack,$safeeval,
421: $tagstack->[-1]);
422: } elsif ($target eq 'edit') {
423: $result .= &Apache::edit::tag_start($target,$token,'GnuPlot');
424: $result .= &make_javascript();
425: $result .= &help_win($gnuplot_help_text);
426: $result .= &edit_attributes($target,$token,\%gnuplot_defaults,
427: \@gnuplot_edit_order);
428: } elsif ($target eq 'modified') {
429: my $constructtag=&Apache::edit::get_new_args
430: ($token,$parstack,$safeeval,keys(%gnuplot_defaults));
431: if ($constructtag) {
432: $result = &Apache::edit::rebuild_tag($token);
433: }
434: }
435: return $result;
436: }
437:
438: sub end_gnuplot {
439: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
440: pop @Apache::lonxml::namespace;
441: &Apache::lonxml::deregister('Apache::lonplot',
442: ('title','xlabel','ylabel','key','axis','label','curve'));
443: my $result = '';
444: if ($target eq 'web') {
445: &check_inputs(); # Make sure we have all the data we need
446: ##
447: ## Determine filename
448: my $tmpdir = '/home/httpd/perl/tmp/';
449: my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}.
450: '_'.time.'_'.$$.int(rand(1000)).'_plot.data';
451: ## Write the plot description to the file
452: &write_gnuplot_file($tmpdir,$filename);
453: ## return image tag for the plot
454: $result .= <<"ENDIMAGE";
455: <img src = "/cgi-bin/plot.gif?$filename"
456: width = "$plot{'width'}"
457: height = "$plot{'height'}"
458: align = "$plot{'align'}"
459: alt = "image should be /cgi-bin/plot.gif?$filename" />
460: ENDIMAGE
461: } elsif ($target eq 'edit') {
462: $result.=&Apache::edit::tag_end($target,$token);
463: }
464: return $result;
465: }
466:
467:
468: ##--------------------------------------------------------------- xtics
469: sub start_xtics {
470: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
471: my $result='';
472: if ($target eq 'web') {
473: &get_attributes(\%xtics,\%tic_defaults,$parstack,$safeeval,
474: $tagstack->[-1]);
475: } elsif ($target eq 'edit') {
476: $result .= &Apache::edit::tag_start($target,$token,'xtics');
477: $result .= &edit_attributes($target,$token,\%tic_defaults,
478: \@tic_edit_order);
479: } elsif ($target eq 'modified') {
480: my $constructtag=&Apache::edit::get_new_args
481: ($token,$parstack,$safeeval,keys(%tic_defaults));
482: if ($constructtag) {
483: $result = &Apache::edit::rebuild_tag($token);
484: }
485: }
486: return $result;
487: }
488:
489: sub end_xtics {
490: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
491: my $result = '';
492: if ($target eq 'web') {
493: } elsif ($target eq 'edit') {
494: $result.=&Apache::edit::tag_end($target,$token);
495: }
496: return $result;
497: }
498:
499: ##--------------------------------------------------------------- ytics
500: sub start_ytics {
501: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
502: my $result='';
503: if ($target eq 'web') {
504: &get_attributes(\%ytics,\%tic_defaults,$parstack,$safeeval,
505: $tagstack->[-1]);
506: } elsif ($target eq 'edit') {
507: $result .= &Apache::edit::tag_start($target,$token,'ytics');
508: $result .= &edit_attributes($target,$token,\%tic_defaults,
509: \@tic_edit_order);
510: } elsif ($target eq 'modified') {
511: my $constructtag=&Apache::edit::get_new_args
512: ($token,$parstack,$safeeval,keys(%tic_defaults));
513: if ($constructtag) {
514: $result = &Apache::edit::rebuild_tag($token);
515: }
516: }
517: return $result;
518: }
519:
520: sub end_ytics {
521: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
522: my $result = '';
523: if ($target eq 'web') {
524: } elsif ($target eq 'edit') {
525: $result.=&Apache::edit::tag_end($target,$token);
526: }
527: return $result;
528: }
529:
530:
531: ##----------------------------------------------------------------- key
532: sub start_key {
533: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
534: my $result='';
535: if ($target eq 'web') {
536: &get_attributes(\%key,\%key_defaults,$parstack,$safeeval,
537: $tagstack->[-1]);
538: } elsif ($target eq 'edit') {
539: $result .= &Apache::edit::tag_start($target,$token,'Plot Key');
540: $result .= &edit_attributes($target,$token,\%key_defaults);
541: } elsif ($target eq 'modified') {
542: my $constructtag=&Apache::edit::get_new_args
543: ($token,$parstack,$safeeval,keys(%key_defaults));
544: if ($constructtag) {
545: $result = &Apache::edit::rebuild_tag($token);
546: }
547: }
548: return $result;
549: }
550:
551: sub end_key {
552: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
553: my $result = '';
554: if ($target eq 'web') {
555: } elsif ($target eq 'edit') {
556: $result.=&Apache::edit::tag_end($target,$token);
557: }
558: return $result;
559: }
560:
561: ##------------------------------------------------------------------- title
562: sub start_title {
563: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
564: my $result='';
565: if ($target eq 'web') {
566: $title = &Apache::lonxml::get_all_text("/title",$$parser[-1]);
567: $title =~ s/\n/ /g;
568: if (length($title) > $max_str_len) {
569: $title = substr($title,0,$max_str_len);
570: }
571: } elsif ($target eq 'edit') {
572: $result.=&Apache::edit::tag_start($target,$token,'Plot Title');
573: my $text=&Apache::lonxml::get_all_text("/title",$$parser[-1]);
574: $result.=&Apache::edit::end_row().
575: &Apache::edit::start_spanning_row().
576: &Apache::edit::editfield('',$text,'',60,1);
577: } elsif ($target eq 'modified') {
578: my $text=$$parser[-1]->get_text("/title");
579: $result.=&Apache::edit::rebuild_tag($token);
580: $result.=&Apache::edit::modifiedfield($token);
581: }
582: return $result;
583: }
584:
585: sub end_title {
586: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
587: my $result = '';
588: if ($target eq 'web') {
589: } elsif ($target eq 'edit') {
590: $result.=&Apache::edit::tag_end($target,$token);
591: }
592: return $result;
593: }
594: ##------------------------------------------------------------------- xlabel
595: sub start_xlabel {
596: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
597: my $result='';
598: if ($target eq 'web') {
599: $xlabel = &Apache::lonxml::get_all_text("/xlabel",$$parser[-1]);
600: $xlabel =~ s/\n/ /g;
601: if (length($xlabel) > $max_str_len) {
602: $xlabel = substr($xlabel,0,$max_str_len);
603: }
604: } elsif ($target eq 'edit') {
605: $result.=&Apache::edit::tag_start($target,$token,'Plot Xlabel');
606: my $text=&Apache::lonxml::get_all_text("/xlabel",$$parser[-1]);
607: $result.=&Apache::edit::end_row().
608: &Apache::edit::start_spanning_row().
609: &Apache::edit::editfield('',$text,'',60,1);
610: } elsif ($target eq 'modified') {
611: my $text=$$parser[-1]->get_text("/xlabel");
612: $result.=&Apache::edit::rebuild_tag($token);
613: $result.=&Apache::edit::modifiedfield($token);
614: }
615: return $result;
616: }
617:
618: sub end_xlabel {
619: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
620: my $result = '';
621: if ($target eq 'web') {
622: } elsif ($target eq 'edit') {
623: $result.=&Apache::edit::tag_end($target,$token);
624: }
625: return $result;
626: }
627:
628: ##------------------------------------------------------------------- ylabel
629: sub start_ylabel {
630: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
631: my $result='';
632: if ($target eq 'web') {
633: $ylabel = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
634: $ylabel =~ s/\n/ /g;
635: if (length($ylabel) > $max_str_len) {
636: $ylabel = substr($ylabel,0,$max_str_len);
637: }
638: } elsif ($target eq 'edit') {
639: $result .= &Apache::edit::tag_start($target,$token,'Plot Ylabel');
640: my $text = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
641: $result .= &Apache::edit::end_row().
642: &Apache::edit::start_spanning_row().
643: &Apache::edit::editfield('',$text,'',60,1);
644: } elsif ($target eq 'modified') {
645: my $text=$$parser[-1]->get_text("/ylabel");
646: $result.=&Apache::edit::rebuild_tag($token);
647: $result.=&Apache::edit::modifiedfield($token);
648: }
649: return $result;
650: }
651:
652: sub end_ylabel {
653: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
654: my $result = '';
655: if ($target eq 'web') {
656: } elsif ($target eq 'edit') {
657: $result.=&Apache::edit::tag_end($target,$token);
658: }
659: return $result;
660: }
661:
662: ##------------------------------------------------------------------- label
663: sub start_label {
664: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
665: my $result='';
666: if ($target eq 'web') {
667: my %label;
668: &get_attributes(\%label,\%label_defaults,$parstack,$safeeval,
669: $tagstack->[-1]);
670: my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
671: $text =~ s/\n/ /g;
672: $text = substr($text,0,$max_str_len) if (length($text) > $max_str_len);
673: $label{'text'} = $text;
674: push(@labels,\%label);
675: } elsif ($target eq 'edit') {
676: $result .= &Apache::edit::tag_start($target,$token,'Plot Label');
677: $result .= &edit_attributes($target,$token,\%label_defaults);
678: my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
679: $result .= &Apache::edit::end_row().
680: &Apache::edit::start_spanning_row().
681: &Apache::edit::editfield('',$text,'',60,1);
682: } elsif ($target eq 'modified') {
683: &Apache::edit::get_new_args
684: ($token,$parstack,$safeeval,keys(%label_defaults));
685: $result.=&Apache::edit::rebuild_tag($token);
686: my $text=$$parser[-1]->get_text("/label");
687: $result.=&Apache::edit::modifiedfield($token);
688: }
689: return $result;
690: }
691:
692: sub end_label {
693: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
694: my $result = '';
695: if ($target eq 'web') {
696: } elsif ($target eq 'edit') {
697: $result.=&Apache::edit::tag_end($target,$token);
698: }
699: return $result;
700: }
701:
702: ##------------------------------------------------------------------- curve
703: sub start_curve {
704: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
705: my $result='';
706: &Apache::lonxml::register('Apache::lonplot',('function','data'));
707: push (@Apache::lonxml::namespace,'curve');
708: if ($target eq 'web') {
709: my %curve;
710: &get_attributes(\%curve,\%curve_defaults,$parstack,$safeeval,
711: $tagstack->[-1]);
712: push (@curves,\%curve);
713: } elsif ($target eq 'edit') {
714: $result .= &Apache::edit::tag_start($target,$token,'Curve');
715: $result .= &help_win($curve_help_text);
716: $result .= &edit_attributes($target,$token,\%curve_defaults);
717: } elsif ($target eq 'modified') {
718: my $constructtag=&Apache::edit::get_new_args
719: ($token,$parstack,$safeeval,keys(%curve_defaults));
720: if ($constructtag) {
721: $result = &Apache::edit::rebuild_tag($token);
722: $result.= &Apache::edit::handle_insert();
723: }
724: }
725: return $result;
726: }
727:
728: sub end_curve {
729: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
730: my $result = '';
731: pop @Apache::lonxml::namespace;
732: &Apache::lonxml::deregister('Apache::lonplot',('function','data'));
733: if ($target eq 'web') {
734: } elsif ($target eq 'edit') {
735: $result.=&Apache::edit::tag_end($target,$token);
736: }
737: return $result;
738: }
739:
740: ##------------------------------------------------------------ curve function
741: sub start_function {
742: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
743: my $result='';
744: if ($target eq 'web') {
745: if (exists($curves[-1]->{'data'})) {
746: &Apache::lonxml::warning('Use of <function> precludes use of <data>. The <data> will be omitted in favor of the <function> declaration.');
747: delete $curves[-1]->{'data'} ;
748: }
749: $curves[-1]->{'function'} =
750: &Apache::lonxml::get_all_text("/function",$$parser[-1]);
751: } elsif ($target eq 'edit') {
752: $result .= &Apache::edit::tag_start($target,$token,'Gnuplot compatible curve function');
753: my $text = &Apache::lonxml::get_all_text("/function",$$parser[-1]);
754: $result .= &Apache::edit::end_row().
755: &Apache::edit::start_spanning_row().
756: &Apache::edit::editfield('',$text,'',60,1);
757: } elsif ($target eq 'modified') {
758: $result.=&Apache::edit::rebuild_tag($token);
759: my $text=$$parser[-1]->get_text("/function");
760: $result.=&Apache::edit::modifiedfield($token);
761: }
762: return $result;
763: }
764:
765: sub end_function {
766: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
767: my $result = '';
768: if ($target eq 'web') {
769: } elsif ($target eq 'edit') {
770: $result .= &Apache::edit::end_table();
771: }
772: return $result;
773: }
774:
775: ##------------------------------------------------------------ curve data
776: sub start_data {
777: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
778: my $result='';
779: if ($target eq 'web') {
780: if (exists($curves[-1]->{'function'})) {
781: &Apache::lonxml::warning('Use of <data> precludes use of .'.
782: '<function>. The <function> will be omitted in favor of '.
783: 'the <data> declaration.');
784: delete($curves[-1]->{'function'});
785: }
786: my $datatext = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
787: # Deal with cases where we're given an array...
788: if ($datatext =~ /^\@/) {
789: $datatext = &Apache::run::run('return "'.$datatext.'"',
790: $safeeval,1);
791: }
792: $datatext =~ s/\s+/ /g;
793: # Need to do some error checking on the @data array -
794: # make sure it's all numbers and make sure each array
795: # is of the same length.
796: my @data;
797: if ($datatext =~ /,/) { # comma deliminated
798: @data = split /,/,$datatext;
799: } else { # Assume it's space seperated.
800: @data = split / /,$datatext;
801: }
802: for (my $i=0;$i<=$#data;$i++) {
803: # Check that it's non-empty
804: if (! defined($data[$i])) {
805: &Apache::lonxml::warning(
806: 'undefined <data> value. Replacing with '.
807: ' pi/e = 1.15572734979092');
808: $data[$i] = 1.15572734979092;
809: }
810: # Check that it's a number
811: if (! &$real_test($data[$i]) & ! &$int_test($data[$i])) {
812: &Apache::lonxml::warning(
813: 'Bad <data> value of '.$data[$i].' Replacing with '.
814: ' pi/e = 1.15572734979092');
815: $data[$i] = 1.15572734979092;
816: }
817: }
818: # complain if the number of data points is not the same as
819: # in previous sets of data.
820: if (($curves[-1]->{'data'}) && ($#data != $#{@{$curves[-1]->{'data'}->[0]}})){
821: &Apache::lonxml::warning
822: ('Number of data points is not consistent with previous '.
823: 'number of data points');
824: }
825: push @{$curves[-1]->{'data'}},\@data;
826: } elsif ($target eq 'edit') {
827: $result .= &Apache::edit::tag_start($target,$token,'Comma or space deliminated curve data');
828: my $text = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
829: $result .= &Apache::edit::end_row().
830: &Apache::edit::start_spanning_row().
831: &Apache::edit::editfield('',$text,'',60,1);
832: } elsif ($target eq 'modified') {
833: $result.=&Apache::edit::rebuild_tag($token);
834: my $text=$$parser[-1]->get_text("/data");
835: $result.=&Apache::edit::modifiedfield($token);
836: }
837: return $result;
838: }
839:
840: sub end_data {
841: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
842: my $result = '';
843: if ($target eq 'web') {
844: } elsif ($target eq 'edit') {
845: $result .= &Apache::edit::end_table();
846: }
847: return $result;
848: }
849:
850: ##------------------------------------------------------------------- axis
851: sub start_axis {
852: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
853: my $result='';
854: if ($target eq 'web') {
855: &get_attributes(\%axis,\%axis_defaults,$parstack,$safeeval,
856: $tagstack->[-1]);
857: } elsif ($target eq 'edit') {
858: $result .= &Apache::edit::tag_start($target,$token,'Plot Axes');
859: $result .= &edit_attributes($target,$token,\%axis_defaults);
860: } elsif ($target eq 'modified') {
861: my $constructtag=&Apache::edit::get_new_args
862: ($token,$parstack,$safeeval,keys(%axis_defaults));
863: if ($constructtag) {
864: $result = &Apache::edit::rebuild_tag($token);
865: }
866: }
867: return $result;
868: }
869:
870: sub end_axis {
871: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
872: my $result = '';
873: if ($target eq 'web') {
874: } elsif ($target eq 'edit') {
875: $result.=&Apache::edit::tag_end($target,$token);
876: } elsif ($target eq 'modified') {
877: }
878: return $result;
879: }
880:
881: ###################################################################
882: ## ##
883: ## Utility Functions ##
884: ## ##
885: ###################################################################
886:
887: ##----------------------------------------------------------- set_defaults
888: sub set_defaults {
889: my ($var,$defaults) = @_;
890: my $key;
891: foreach $key (keys(%$defaults)) {
892: $var->{$key} = $defaults->{$key}->{'default'};
893: }
894: }
895:
896: ##------------------------------------------------------------------- misc
897: sub get_attributes{
898: my ($values,$defaults,$parstack,$safeeval,$tag) = @_;
899: foreach my $attr (keys(%{$defaults})) {
900: $values->{$attr} =
901: &Apache::lonxml::get_param($attr,$parstack,$safeeval);
902: if ($values->{$attr} eq '' | !defined($values->{$attr})) {
903: $values->{$attr} = $defaults->{$attr}->{'default'};
904: next;
905: }
906: my $test = $defaults->{$attr}->{'test'};
907: if (! &$test($values->{$attr})) {
908: &Apache::lonxml::warning
909: ($tag.':'.$attr.': Bad value.'.'Replacing your value with : '
910: .$defaults->{$attr}->{'default'} );
911: $values->{$attr} = $defaults->{$attr}->{'default'};
912: }
913: }
914: return ;
915: }
916:
917: ##------------------------------------------------------- write_gnuplot_file
918: sub write_gnuplot_file {
919: my ($tmpdir,$filename)= @_;
920: my $gnuplot_input = '';
921: my $curve;
922: # Collect all the colors
923: my @Colors;
924: push @Colors, $plot{'bgcolor'};
925: push @Colors, $plot{'fgcolor'};
926: push @Colors, (defined($axis{'color'})?$axis{'color'}:$plot{'fgcolor'});
927: foreach $curve (@curves) {
928: push @Colors, ($curve->{'color'} ne '' ?
929: $curve->{'color'} :
930: $plot{'fgcolor'} );
931: }
932: # set term
933: $gnuplot_input .= 'set term gif ';
934: $gnuplot_input .= 'transparent ' if ($plot{'transparent'} eq 'on');
935: $gnuplot_input .= $plot{'font'} . ' ';
936: $gnuplot_input .= 'size '.$plot{'width'}.','.$plot{'height'}.' ';
937: $gnuplot_input .= "@Colors\n";
938: # set output
939: $gnuplot_input .= "set output\n";
940: # grid
941: $gnuplot_input .= 'set grid'.$/ if ($plot{'grid'} eq 'on');
942: # border
943: $gnuplot_input .= ($plot{'border'} eq 'on'?
944: 'set border'.$/ :
945: 'set noborder'.$/ ); # title, xlabel, ylabel
946: # titles
947: $gnuplot_input .= "set title \"$title\"\n" if (defined($title)) ;
948: $gnuplot_input .= "set xlabel \"$xlabel\"\n" if (defined($xlabel));
949: $gnuplot_input .= "set ylabel \"$ylabel\"\n" if (defined($ylabel));
950: # tics
951: if (%xtics) {
952: $gnuplot_input .= "set xtics $xtics{'location'} ";
953: $gnuplot_input .= ( $xtics{'mirror'} eq 'on'?"mirror ":"nomirror ");
954: $gnuplot_input .= "$xtics{'start'}, ";
955: $gnuplot_input .= "$xtics{'increment'}, ";
956: $gnuplot_input .= "$xtics{'end'}\n";
957: }
958: if (%ytics) {
959: $gnuplot_input .= "set ytics $ytics{'location'} ";
960: $gnuplot_input .= ( $ytics{'mirror'} eq 'on'?"mirror ":"nomirror ");
961: $gnuplot_input .= "$ytics{'start'}, ";
962: $gnuplot_input .= "$ytics{'increment'}, ";
963: $gnuplot_input .= "$ytics{'end'}\n";
964: }
965: # axis
966: if (%axis) {
967: $gnuplot_input .= "set xrange \[$axis{'xmin'}:$axis{'xmax'}\]\n";
968: $gnuplot_input .= "set yrange \[$axis{'ymin'}:$axis{'ymax'}\]\n";
969: }
970: # Key
971: if (%key) {
972: $gnuplot_input .= 'set key '.$key{'pos'}.' ';
973: if ($key{'title'} ne '') {
974: $gnuplot_input .= 'title " '.$key{'title'}.'" ';
975: }
976: $gnuplot_input .= ($key{'box'} eq 'on' ? 'box ' : 'nobox ').$/;
977: } else {
978: $gnuplot_input .= 'set nokey'.$/;
979: }
980: # labels
981: my $label;
982: foreach $label (@labels) {
983: $gnuplot_input .= 'set label "'.$label->{'text'}.'" at '.
984: $label->{'xpos'}.','.$label->{'ypos'}.' '.$label->{'justify'}.$/ ;
985: }
986: # curves
987: $gnuplot_input .= 'plot ';
988: for (my $i = 0;$i<=$#curves;$i++) {
989: $curve = $curves[$i];
990: $gnuplot_input.= ', ' if ($i > 0);
991: if (exists($curve->{'function'})) {
992: $gnuplot_input.=
993: $curve->{'function'}.' title "'.
994: $curve->{'name'}.'" with '.
995: $curve->{'linestyle'};
996: } elsif (exists($curve->{'data'})) {
997: # Store data values in $datatext
998: my $datatext = '';
999: # get new filename
1000: my $datafilename = "$tmpdir/$filename.$i";
1001: my $fh=Apache::File->new(">$datafilename");
1002: # Compile data
1003: my @Data = @{$curve->{'data'}};
1004: my @Data0 = @{$Data[0]};
1005: for (my $i =0; $i<=$#Data0; $i++) {
1006: my $dataset;
1007: foreach $dataset (@Data) {
1008: $datatext .= $dataset->[$i] . ' ';
1009: }
1010: $datatext .= $/;
1011: }
1012: # write file
1013: print $fh $datatext;
1014: close ($fh);
1015: # generate gnuplot text
1016: $gnuplot_input.= '"'.$datafilename.'" title "'.
1017: $curve->{'name'}.'" with '.
1018: $curve->{'linestyle'};
1019: }
1020: }
1021: # Write the output to a file.
1022: my $fh=Apache::File->new(">$tmpdir$filename");
1023: print $fh $gnuplot_input;
1024: close($fh);
1025: # That's all folks.
1026: return ;
1027: }
1028:
1029: #---------------------------------------------- check_inputs
1030: sub check_inputs {
1031: ## Note: no inputs, no outputs - this acts only on global variables.
1032: ## Make sure we have all the input we need:
1033: if (! %plot) { &set_defaults(\%plot,\%gnuplot_defaults); }
1034: if (! %key ) {} # No key for this plot, thats okay
1035: # if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }
1036: if (! defined($title )) {} # No title for this plot, thats okay
1037: if (! defined($xlabel)) {} # No xlabel for this plot, thats okay
1038: if (! defined($ylabel)) {} # No ylabel for this plot, thats okay
1039: if ($#labels < 0) { } # No labels for this plot, thats okay
1040: if ($#curves < 0) {
1041: &Apache::lonxml::warning("No curves specified for plot!!!!");
1042: return '';
1043: }
1044: my $curve;
1045: foreach $curve (@curves) {
1046: if (!defined($curve->{'function'})&&!defined($curve->{'data'})){
1047: &Apache::lonxml::warning("One of the curves specified did not contain any <data> or <function> declarations\n");
1048: return '';
1049: }
1050: }
1051: }
1052:
1053: #------------------------------------------------ make_edit
1054: sub edit_attributes {
1055: my ($target,$token,$defaults,$keys) = @_;
1056: my ($result,@keys);
1057: if ($keys && ref($keys) eq 'ARRAY') {
1058: @keys = @$keys;
1059: } else {
1060: @keys = sort(keys(%$defaults));
1061: }
1062: foreach my $attr (@keys) {
1063: # append a ' ' to the description if it doesn't have one already.
1064: my $description = $defaults->{$attr}->{'description'};
1065: $description .= ' ' if ($description !~ / $/);
1066: if ($defaults->{$attr}->{'edit_type'} eq 'entry') {
1067: $result .= &Apache::edit::text_arg
1068: ($description,$attr,$token,
1069: $defaults->{$attr}->{'size'});
1070: } elsif ($defaults->{$attr}->{'edit_type'} eq 'choice') {
1071: $result .= &Apache::edit::select_arg
1072: ($description,$attr,$defaults->{$attr}->{'choices'},$token);
1073: } elsif ($defaults->{$attr}->{'edit_type'} eq 'onoff') {
1074: $result .= &Apache::edit::select_arg
1075: ($description,$attr,['on','off'],$token);
1076: }
1077: $result .= '<br />';
1078: }
1079: return $result;
1080: }
1081:
1082:
1083: ###################################################################
1084: ## ##
1085: ## Insertion functions for editing plots ##
1086: ## ##
1087: ###################################################################
1088:
1089: sub insert_gnuplot {
1090: my $result = '';
1091: # plot attributes
1092: $result .= "<plot \n";
1093: foreach my $attr (keys(%gnuplot_defaults)) {
1094: $result .= " $attr=\"$gnuplot_defaults{$attr}->{'default'}\"\n";
1095: }
1096: $result .= ">\n";
1097: # Add the components (most are commented out for simplicity)
1098: # $result .= &insert_key();
1099: # $result .= &insert_axis();
1100: # $result .= &insert_title();
1101: # $result .= &insert_xlabel();
1102: # $result .= &insert_ylabel();
1103: $result .= &insert_curve();
1104: # close up the <plot>
1105: $result .= "</plot>\n";
1106: return $result;
1107: }
1108:
1109: sub insert_tics {
1110: my $result;
1111: $result .= &insert_xtics() . &insert_ytics;
1112: return $result;
1113: }
1114:
1115: sub insert_xtics {
1116: my $result;
1117: $result .= "\n <xtics ";
1118: foreach my $attr (keys(%tic_defaults)) {
1119: $result .= "$attr=\"$tic_defaults{$attr}->{'default'}\" ";
1120: }
1121: $result .= "/>\n";
1122: return $result;
1123: }
1124:
1125: sub insert_ytics {
1126: my $result;
1127: $result .= "\n <ytics ";
1128: foreach my $attr (keys(%tic_defaults)) {
1129: $result .= "$attr=\"$tic_defaults{$attr}->{'default'}\" ";
1130: }
1131: $result .= "/>\n";
1132: return $result;
1133: }
1134:
1135: sub insert_key {
1136: my $result;
1137: $result .= "\n <key \n";
1138: foreach my $attr (keys(%key_defaults)) {
1139: $result .= " $attr=\"$key_defaults{$attr}->{'default'}\"\n";
1140: }
1141: $result .= " />\n";
1142: return $result;
1143: }
1144:
1145: sub insert_axis{
1146: my $result;
1147: $result .= "\n <axis ";
1148: foreach my $attr (keys(%axis_defaults)) {
1149: $result .= " $attr=\"$axis_defaults{$attr}->{'default'}\"\n";
1150: }
1151: $result .= " />\n";
1152: return $result;
1153: }
1154:
1155: sub insert_title { return "\n <title></title>\n"; }
1156: sub insert_xlabel { return "\n <xlabel></xlabel>\n"; }
1157: sub insert_ylabel { return "\n <ylabel></ylabel>\n"; }
1158:
1159: sub insert_label {
1160: my $result;
1161: $result .= "\n <label ";
1162: foreach my $attr (keys(%label_defaults)) {
1163: $result .= ' '.$attr.'="'.
1164: $label_defaults{$attr}->{'default'}."\"\n";
1165: }
1166: $result .= " ></label>\n";
1167: return $result;
1168: }
1169:
1170: sub insert_curve {
1171: my $result;
1172: $result .= "\n <curve ";
1173: foreach my $attr (keys(%curve_defaults)) {
1174: $result .= ' '.$attr.'="'.
1175: $curve_defaults{$attr}->{'default'}."\"\n";
1176: }
1177: $result .= " >\n";
1178: $result .= &insert_data().&insert_data()."</curve>\n";
1179: }
1180:
1181: sub insert_function {
1182: my $result;
1183: $result .= "<function></function>\n";
1184: return $result;
1185: }
1186:
1187: sub insert_data {
1188: my $result;
1189: $result .= " <data></data>\n";
1190: return $result;
1191: }
1192:
1193: ##----------------------------------------------------------------------
1194: # Javascript functions to display help for tags
1195:
1196: sub make_javascript {
1197: my $helpwindowwidth = 400;
1198: my $helpwindowheight = 400;
1199: my $result = '';
1200: $result.=<<"ENDFUNCTION";
1201: <script language="JavaScript">
1202: function openWin(text)
1203: {
1204: newWin = open("", "new_W", "width=$helpwindowwidth,height=$helpwindowheight,resizable=1,scrollbars=1");
1205: newWin.document.open("text/html", "replace");
1206: newWin.document.writeln(text);
1207: newWin.document.writeln('<center><a href=\"javascript:window.close()\">close this window</a></center>');
1208: newWin.document.close();
1209: }
1210: </script>
1211: ENDFUNCTION
1212: return $result;
1213: }
1214:
1215: sub help_win {
1216: my ($helptext)=@_;
1217: $helptext =~ s/\n/ /g;
1218: $helptext =~ s/\'/\\\'/g;
1219: my $result = '';
1220: $result.=<<"ENDWIN";
1221: <table width="100%"><tr><td align="right">
1222: <a href="javascript:openWin('$helptext')">help</a>
1223: </td></tr></table><hr />
1224: ENDWIN
1225: return $result;
1226: }
1227: ##----------------------------------------------------------------------
1228: 1;
1229: __END__
1230:
1231:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonplot.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / xml