1: # The LearningOnline Network with CAPA
2: # Dynamic plot
3: #
4: # $Id: lonplot.pm,v 1.120 2007/07/30 21:50:29 albertel 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:
29: package Apache::lonplot;
30:
31: use strict;
32: use warnings FATAL=>'all';
33: no warnings 'uninitialized';
34: use Apache::File;
35: use Apache::response;
36: use Apache::lonxml;
37: use Apache::edit;
38: use Apache::lonnet;
39: use lib '/home/httpd/lib/perl/';
40: use LONCAPA;
41:
42:
43: use vars qw/$weboutputformat $versionstring/;
44:
45:
46:
47: BEGIN {
48: &Apache::lonxml::register('Apache::lonplot',('gnuplot'));
49: #
50: # Determine the version of GNUPLOT
51: $weboutputformat = 'gif';
52: $versionstring = `gnuplot --version 2>/dev/null`;
53: if ($versionstring =~ /^gnuplot 4/) {
54: $weboutputformat = 'png';
55: }
56:
57: }
58:
59:
60: ##
61: ## Description of data structures:
62: ##
63: ## %plot %key %axis
64: ## --------------------------
65: ## height title color
66: ## width box xmin
67: ## bgcolor pos xmax
68: ## fgcolor ymin
69: ## transparent ymax
70: ## grid
71: ## border
72: ## font
73: ## align
74: ##
75: ## @labels: $labels[$i] = \%label
76: ## %label: text, xpos, ypos, justify
77: ##
78: ## @curves: $curves[$i] = \%curve
79: ## %curve: name, linestyle, ( function | data )
80: ##
81: ## $curves[$i]->{'data'} = [ [x1,x2,x3,x4],
82: ## [y1,y2,y3,y4] ]
83: ##
84:
85: ###################################################################
86: ## ##
87: ## Tests used in checking the validitity of input ##
88: ## ##
89: ###################################################################
90:
91: my $max_str_len = 50; # if a label, title, xlabel, or ylabel text
92: # is longer than this, it will be truncated.
93:
94: my %linestyles =
95: (
96: lines => 2, # Maybe this will be used in the future
97: linespoints => 2, # to check on whether or not they have
98: dots => 2, # supplied enough <data></data> fields
99: points => 2, # to use the given line style. But for
100: steps => 2, # now there are more important things
101: fsteps => 2, # for me to deal with.
102: histeps => 2,
103: errorbars => 3,
104: xerrorbars => [3,4],
105: yerrorbars => [3,4],
106: xyerrorbars => [4,6],
107: boxes => 3,
108: filledcurves => 2,
109: vector => 4
110: );
111:
112: my $int_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^\d+$/};
113: my $real_test =
114: sub {$_[0]=~s/\s+//g;$_[0]=~/^[+-]?\d*\.?\d*([eE][+-]\d+)?$/};
115: my $pos_real_test =
116: sub {$_[0]=~s/\s+//g;$_[0]=~/^[+]?\d*\.?\d*([eE][+-]\d+)?$/};
117: my $color_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^x[\da-fA-F]{6}$/};
118: my $onoff_test = sub {$_[0]=~/^(on|off)$/};
119: my $key_pos_test = sub {$_[0]=~/^(top|bottom|right|left|outside|below| )+$/};
120: my $sml_test = sub {$_[0]=~/^(\d+|small|medium|large)$/};
121: my $linestyle_test = sub {exists($linestyles{$_[0]})};
122: my $words_test = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^([\w~!\@\#\$\%^&\*\(\)-=_\+\[\]\{\}:\;\'<>,\.\/\?\\]+ ?)+$/};
123:
124: ###################################################################
125: ## ##
126: ## Attribute metadata ##
127: ## ##
128: ###################################################################
129: my @gnuplot_edit_order =
130: qw/alttag bgcolor fgcolor height width fontface font transparent grid samples
131: border align texwidth texfont plotcolor plottype gridtype lmargin rmargin
132: tmargin bmargin major_ticscale minor_ticscale boxwidth gridlayer fillstyle
133: pattern solid/;
134:
135: my $margin_choices = ['default',0..20];
136:
137: my %gnuplot_defaults =
138: (
139: alttag => {
140: default => 'dynamically generated plot',
141: test => $words_test,
142: description => 'Brief description of the plot',
143: edit_type => 'entry',
144: size => '40'
145: },
146: height => {
147: default => 300,
148: test => $int_test,
149: description => 'Height of image (pixels)',
150: edit_type => 'entry',
151: size => '10'
152: },
153: width => {
154: default => 400,
155: test => $int_test,
156: description => 'Width of image (pixels)',
157: edit_type => 'entry',
158: size => '10'
159: },
160: bgcolor => {
161: default => 'xffffff',
162: test => $color_test,
163: description => 'Background color of image (xffffff)',
164: edit_type => 'entry',
165: size => '10'
166: },
167: fgcolor => {
168: default => 'x000000',
169: test => $color_test,
170: description => 'Foreground color of image (x000000)',
171: edit_type => 'entry',
172: size => '10'
173: },
174: transparent => {
175: default => 'off',
176: test => $onoff_test,
177: description => 'Transparent image',
178: edit_type => 'onoff'
179: },
180: grid => {
181: default => 'on',
182: test => $onoff_test,
183: description => 'Display grid',
184: edit_type => 'onoff'
185: },
186: gridlayer => {
187: default => 'off',
188: test => $onoff_test,
189: description => 'Display grid front layer over filled boxes or filled curves',
190: edit_type => 'onoff'
191: },
192: box_border => {
193: default => 'noborder',
194: test => sub {$_[0]=~/^(noborder|border)$/},
195: description => 'Draw border for boxes',
196: edit_type => 'choice',
197: choices => ['border','noborder']
198: },
199: border => {
200: default => 'on',
201: test => $onoff_test,
202: description => 'Draw border around plot',
203: edit_type => 'onoff'
204: },
205: font => {
206: default => '9',
207: test => $sml_test,
208: description => 'Size of font to use',
209: edit_type => 'choice',
210: choices => [['5','5 (small)'],'7',['9','9 (medium)'],'10','12',['15','15 (large)']]
211: },
212: fontface => {
213: default => 'sans-serif',
214: test => sub {$_[0]=~/^(sans-serif|serif|classic)$/},
215: description => 'Type of font to use',
216: edit_type => 'choice',
217: choices => ['sans-serif','serif', 'classic']
218: },
219: samples => {
220: default => '100',
221: test => $int_test,
222: description => 'Number of samples for non-data plots',
223: edit_type => 'choice',
224: choices => ['100','200','500','1000','2000','5000']
225: },
226: align => {
227: default => 'middle',
228: test => sub {$_[0]=~/^(left|right|middle|center)$/},
229: description => 'Alignment for image in HTML',
230: edit_type => 'choice',
231: choices => ['left','right','middle']
232: },
233: texwidth => {
234: default => '93',
235: test => $int_test,
236: description => 'Width of plot when printed (mm)',
237: edit_type => 'entry',
238: size => '5'
239: },
240: texfont => {
241: default => '22',
242: test => $int_test,
243: description => 'Font size to use in TeX output (pts):',
244: edit_type => 'choice',
245: choices => [qw/8 10 12 14 16 18 20 22 24 26 28 30 32 34 36/],
246: },
247: plotcolor => {
248: default => 'monochrome',
249: test => sub {$_[0]=~/^(monochrome|color|colour)$/},
250: description => 'Color setting for printing:',
251: edit_type => 'choice',
252: choices => [qw/monochrome color colour/],
253: },
254: pattern => {
255: default => '',
256: test => $int_test,
257: description => 'Pattern value for boxes:',
258: edit_type => 'choice',
259: choices => [0,1,2,3,4,5,6]
260: },
261: solid => {
262: default => 0,
263: test => $real_test,
264: description => 'The density of fill style for boxes',
265: edit_type => 'entry',
266: size => '5'
267: },
268: fillstyle => {
269: default => 'empty',
270: test => sub {$_[0]=~/^(empty|solid|pattern)$/},
271: description => 'Filled style for boxes:',
272: edit_type => 'choice',
273: choices => ['empty','solid','pattern']
274: },
275: plottype => {
276: default => 'Cartesian',
277: test => sub {$_[0]=~/^(Polar|Cartesian)$/},
278: description => 'Plot type:',
279: edit_type => 'choice',
280: choices => ['Cartesian','Polar']
281: },
282: gridtype => {
283: default => 'Cartesian',
284: test => sub {$_[0]=~/^(Polar|Cartesian|Linear-Log|Log-Linear|Log-Log)$/},
285: description => 'Grid type:',
286: edit_type => 'choice',
287: choices => ['Cartesian','Polar','Linear-Log','Log-Linear','Log-Log']
288: },
289: lmargin => {
290: default => 'default',
291: test => sub {$_[0]=~/^(default|\d+)$/},
292: description => 'Left margin width (pts):',
293: edit_type => 'choice',
294: choices => $margin_choices,
295: },
296: rmargin => {
297: default => 'default',
298: test => sub {$_[0]=~/^(default|\d+)$/},
299: description => 'Right margin width (pts):',
300: edit_type => 'choice',
301: choices => $margin_choices,
302: },
303: tmargin => {
304: default => 'default',
305: test => sub {$_[0]=~/^(default|\d+)$/},
306: description => 'Top margin width (pts):',
307: edit_type => 'choice',
308: choices => $margin_choices,
309: },
310: bmargin => {
311: default => 'default',
312: test => sub {$_[0]=~/^(default|\d+)$/},
313: description => 'Bottom margin width (pts):',
314: edit_type => 'choice',
315: choices => $margin_choices,
316: },
317: boxwidth => {
318: default => '',
319: test => $real_test,
320: description => 'Width of boxes, default is auto',
321: edit_type => 'entry',
322: size => '5'
323: },
324: major_ticscale => {
325: default => '1',
326: test => $real_test,
327: description => 'Size of major tic marks (plot coordinates)',
328: edit_type => 'entry',
329: size => '5'
330: },
331: minor_ticscale => {
332: default => '0.5',
333: test => $real_test,
334: description => 'Size of minor tic mark (plot coordinates)',
335: edit_type => 'entry',
336: size => '5'
337: },
338: );
339:
340: my %key_defaults =
341: (
342: title => {
343: default => '',
344: test => $words_test,
345: description => 'Title of key',
346: edit_type => 'entry',
347: size => '40'
348: },
349: box => {
350: default => 'off',
351: test => $onoff_test,
352: description => 'Draw a box around the key?',
353: edit_type => 'onoff'
354: },
355: pos => {
356: default => 'top right',
357: test => $key_pos_test,
358: description => 'Position of the key on the plot',
359: edit_type => 'choice',
360: choices => ['top left','top right','bottom left','bottom right',
361: 'outside','below']
362: }
363: );
364:
365: my %label_defaults =
366: (
367: xpos => {
368: default => 0,
369: test => $real_test,
370: description => 'X position of label (graph coordinates)',
371: edit_type => 'entry',
372: size => '10'
373: },
374: ypos => {
375: default => 0,
376: test => $real_test,
377: description => 'Y position of label (graph coordinates)',
378: edit_type => 'entry',
379: size => '10'
380: },
381: justify => {
382: default => 'left',
383: test => sub {$_[0]=~/^(left|right|center)$/},
384: description => 'justification of the label text on the plot',
385: edit_type => 'choice',
386: choices => ['left','right','center']
387: }
388: );
389:
390: my @tic_edit_order = ('location','mirror','start','increment','end',
391: 'minorfreq');
392: my %tic_defaults =
393: (
394: location => {
395: default => 'border',
396: test => sub {$_[0]=~/^(border|axis)$/},
397: description => 'Location of major tic marks',
398: edit_type => 'choice',
399: choices => ['border','axis']
400: },
401: mirror => {
402: default => 'on',
403: test => $onoff_test,
404: description => 'Mirror tics on opposite axis?',
405: edit_type => 'onoff'
406: },
407: start => {
408: default => '-10.0',
409: test => $real_test,
410: description => 'Start major tics at',
411: edit_type => 'entry',
412: size => '10'
413: },
414: increment => {
415: default => '1.0',
416: test => $real_test,
417: description => 'Place a major tic every',
418: edit_type => 'entry',
419: size => '10'
420: },
421: end => {
422: default => ' 10.0',
423: test => $real_test,
424: description => 'Stop major tics at ',
425: edit_type => 'entry',
426: size => '10'
427: },
428: minorfreq => {
429: default => '0',
430: test => $int_test,
431: description => 'Number of minor tics per major tic mark',
432: edit_type => 'entry',
433: size => '10'
434: },
435: );
436:
437: my @axis_edit_order = ('color','xmin','xmax','ymin','ymax');
438: my %axis_defaults =
439: (
440: color => {
441: default => 'x000000',
442: test => $color_test,
443: description => 'Color of grid lines (x000000)',
444: edit_type => 'entry',
445: size => '10'
446: },
447: xmin => {
448: default => '-10.0',
449: test => $real_test,
450: description => 'Minimum x-value shown in plot',
451: edit_type => 'entry',
452: size => '10'
453: },
454: xmax => {
455: default => ' 10.0',
456: test => $real_test,
457: description => 'Maximum x-value shown in plot',
458: edit_type => 'entry',
459: size => '10'
460: },
461: ymin => {
462: default => '-10.0',
463: test => $real_test,
464: description => 'Minimum y-value shown in plot',
465: edit_type => 'entry',
466: size => '10'
467: },
468: ymax => {
469: default => ' 10.0',
470: test => $real_test,
471: description => 'Maximum y-value shown in plot',
472: edit_type => 'entry',
473: size => '10'
474: }
475: );
476:
477: my @curve_edit_order = ('color','name','linestyle','linewidth','pointtype','pointsize','limit');
478:
479: my %curve_defaults =
480: (
481: color => {
482: default => 'x000000',
483: test => $color_test,
484: description => 'Color of curve (x000000)',
485: edit_type => 'entry',
486: size => '10'
487: },
488: name => {
489: default => '',
490: test => $words_test,
491: description => 'Name of curve to appear in key',
492: edit_type => 'entry',
493: size => '20'
494: },
495: linestyle => {
496: default => 'lines',
497: test => $linestyle_test,
498: description => 'Line style',
499: edit_type => 'choice',
500: choices => [keys(%linestyles)]
501: },
502: linewidth => {
503: default => 4,
504: test => $int_test,
505: description => 'Line width (may not apply to all line styles)',
506: edit_type => 'choice',
507: choices => [1,2,3,4,5,6,7,8,9,10]
508: },
509: pointsize => {
510: default => 1,
511: test => $pos_real_test,
512: description => 'Point size (may not apply to all line styles)',
513: edit_type => 'entry',
514: size => '5'
515: },
516: pointtype => {
517: default => 1,
518: test => $int_test,
519: description => 'Point type (may not apply to all line styles)',
520: edit_type => 'choice',
521: choices => [0,1,2,3,4,5,6]
522: },
523: limit => {
524: default => 'closed',
525: test => sub {$_[0]=~/^(closed|x1|x2|y1|y2)$/},
526: description => 'Point to fill -- for filledcurves',
527: edit_type => 'choice',
528: choices => ['closed','x1','x2','y1','y2']
529: },
530: );
531:
532: ###################################################################
533: ## ##
534: ## parsing and edit rendering ##
535: ## ##
536: ###################################################################
537:
538: undef %Apache::lonplot::plot;
539: my (%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);
540:
541: sub start_gnuplot {
542: undef(%Apache::lonplot::plot); undef(%key); undef(%axis);
543: undef($title); undef($xlabel); undef($ylabel);
544: undef(@labels); undef(@curves);
545: undef(%xtics); undef(%ytics);
546: #
547: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
548: my $result='';
549: &Apache::lonxml::register('Apache::lonplot',
550: ('title','xlabel','ylabel','key','axis','label','curve',
551: 'xtics','ytics'));
552: push (@Apache::lonxml::namespace,'lonplot');
553: if ($target eq 'web' || $target eq 'tex') {
554: &get_attributes(\%Apache::lonplot::plot,\%gnuplot_defaults,$parstack,$safeeval,
555: $tagstack->[-1]);
556: } elsif ($target eq 'edit') {
557: $result .= &Apache::edit::tag_start($target,$token,'GnuPlot');
558: $result .= &edit_attributes($target,$token,\%gnuplot_defaults,
559: \@gnuplot_edit_order)
560: .&Apache::edit::end_row()
561: .&Apache::edit::start_spanning_row();
562: } elsif ($target eq 'modified') {
563: my $constructtag=&Apache::edit::get_new_args
564: ($token,$parstack,$safeeval,keys(%gnuplot_defaults));
565: if ($constructtag) {
566: $result = &Apache::edit::rebuild_tag($token);
567: }
568: }
569: return $result;
570: }
571:
572: sub end_gnuplot {
573: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
574: pop @Apache::lonxml::namespace;
575: &Apache::lonxml::deregister('Apache::lonplot',
576: ('title','xlabel','ylabel','key','axis','label','curve'));
577: my $result = '';
578: my $randnumber;
579: # need to call rand everytime start_script would evaluate, as the
580: # safe space rand number generator and the global rand generator
581: # are not separate
582: if ($target eq 'web' || $target eq 'tex' || $target eq 'grade' ||
583: $target eq 'answer') {
584: $randnumber=int(rand(1000));
585: }
586: if ($target eq 'web' || $target eq 'tex') {
587: &check_inputs(); # Make sure we have all the data we need
588: ##
589: ## Determine filename
590: my $tmpdir = '/home/httpd/perl/tmp/';
591: my $filename = $env{'user.name'}.'_'.$env{'user.domain'}.
592: '_'.time.'_'.$$.$randnumber.'_plot';
593: ## Write the plot description to the file
594: &write_gnuplot_file($tmpdir,$filename,$target);
595: $filename = &escape($filename);
596: ## return image tag for the plot
597: if ($target eq 'web') {
598: $result .= <<"ENDIMAGE";
599: <img src = "/cgi-bin/plot.$weboutputformat?file=$filename.data"
600: width = "$Apache::lonplot::plot{'width'}"
601: height = "$Apache::lonplot::plot{'height'}"
602: align = "$Apache::lonplot::plot{'align'}"
603: alt = "$Apache::lonplot::plot{'alttag'}" />
604: ENDIMAGE
605: } elsif ($target eq 'tex') {
606: &Apache::lonxml::debug(" gnuplot wid = $Apache::lonplot::plot{'width'}");
607: &Apache::lonxml::debug(" gnuplot ht = $Apache::lonplot::plot{'height'}");
608: #might be inside the safe space, register the URL for later
609: &Apache::lonxml::register_ssi("/cgi-bin/plot.gif?file=$filename.data&output=eps");
610: $result = "%DYNAMICIMAGE:$Apache::lonplot::plot{'width'}:$Apache::lonplot::plot{'height'}:$Apache::lonplot::plot{'texwidth'}\n";
611: $result .= '\graphicspath{{/home/httpd/perl/tmp/}}'."\n";
612: $result .= '\includegraphics[width='.$Apache::lonplot::plot{'texwidth'}.' mm]{'.&unescape($filename).'.eps}';
613: }
614: } elsif ($target eq 'edit') {
615: $result.=&Apache::edit::tag_end($target,$token);
616: }
617: return $result;
618: }
619:
620:
621: ##--------------------------------------------------------------- xtics
622: sub start_xtics {
623: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
624: my $result='';
625: if ($target eq 'web' || $target eq 'tex') {
626: &get_attributes(\%xtics,\%tic_defaults,$parstack,$safeeval,
627: $tagstack->[-1]);
628: } elsif ($target eq 'edit') {
629: $result .= &Apache::edit::tag_start($target,$token,'xtics');
630: $result .= &edit_attributes($target,$token,\%tic_defaults,
631: \@tic_edit_order);
632: } elsif ($target eq 'modified') {
633: my $constructtag=&Apache::edit::get_new_args
634: ($token,$parstack,$safeeval,keys(%tic_defaults));
635: if ($constructtag) {
636: $result = &Apache::edit::rebuild_tag($token);
637: }
638: }
639: return $result;
640: }
641:
642: sub end_xtics {
643: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
644: my $result = '';
645: if ($target eq 'web' || $target eq 'tex') {
646: } elsif ($target eq 'edit') {
647: $result.=&Apache::edit::tag_end($target,$token);
648: }
649: return $result;
650: }
651:
652: ##--------------------------------------------------------------- ytics
653: sub start_ytics {
654: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
655: my $result='';
656: if ($target eq 'web' || $target eq 'tex') {
657: &get_attributes(\%ytics,\%tic_defaults,$parstack,$safeeval,
658: $tagstack->[-1]);
659: } elsif ($target eq 'edit') {
660: $result .= &Apache::edit::tag_start($target,$token,'ytics');
661: $result .= &edit_attributes($target,$token,\%tic_defaults,
662: \@tic_edit_order);
663: } elsif ($target eq 'modified') {
664: my $constructtag=&Apache::edit::get_new_args
665: ($token,$parstack,$safeeval,keys(%tic_defaults));
666: if ($constructtag) {
667: $result = &Apache::edit::rebuild_tag($token);
668: }
669: }
670: return $result;
671: }
672:
673: sub end_ytics {
674: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
675: my $result = '';
676: if ($target eq 'web' || $target eq 'tex') {
677: } elsif ($target eq 'edit') {
678: $result.=&Apache::edit::tag_end($target,$token);
679: }
680: return $result;
681: }
682:
683: ##-----------------------------------------------------------------font
684: my %font_properties =
685: (
686: 'classic' => {
687: face => 'classic',
688: file => 'DejaVuSansMono-Bold',
689: printname => 'Helvetica',
690: },
691: 'sans-serif' => {
692: face => 'sans-serif',
693: file => 'DejaVuSans',
694: printname => 'DejaVuSans',
695: },
696: 'serif' => {
697: face => 'serif',
698: file => 'DejaVuSerif',
699: printname => 'DejaVuSerif',
700: },
701: );
702:
703: sub get_font {
704: my ($size, $selected_font);
705:
706: if ( $Apache::lonplot::plot{'font'} =~ /^(small|medium|large)/) {
707: $selected_font = $font_properties{'classic'};
708: if ( $Apache::lonplot::plot{'font'} eq 'small') {
709: $size = '5';
710: } elsif ( $Apache::lonplot::plot{'font'} eq 'medium') {
711: $size = '9';
712: } elsif ( $Apache::lonplot::plot{'font'} eq 'large') {
713: $size = '15';
714: } else {
715: $size = '9';
716: }
717: } else {
718: $selected_font = $font_properties{$Apache::lonplot::plot{'fontface'}};
719: }
720: return ($size, $selected_font);
721: }
722:
723: ##----------------------------------------------------------------- key
724: sub start_key {
725: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
726: my $result='';
727: if ($target eq 'web' || $target eq 'tex') {
728: &get_attributes(\%key,\%key_defaults,$parstack,$safeeval,
729: $tagstack->[-1]);
730: } elsif ($target eq 'edit') {
731: $result .= &Apache::edit::tag_start($target,$token,'Plot Key');
732: $result .= &edit_attributes($target,$token,\%key_defaults);
733: } elsif ($target eq 'modified') {
734: my $constructtag=&Apache::edit::get_new_args
735: ($token,$parstack,$safeeval,keys(%key_defaults));
736: if ($constructtag) {
737: $result = &Apache::edit::rebuild_tag($token);
738: }
739: }
740: return $result;
741: }
742:
743: sub end_key {
744: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
745: my $result = '';
746: if ($target eq 'web' || $target eq 'tex') {
747: } elsif ($target eq 'edit') {
748: $result.=&Apache::edit::tag_end($target,$token);
749: }
750: return $result;
751: }
752:
753: ##------------------------------------------------------------------- title
754: sub start_title {
755: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
756: my $result='';
757: if ($target eq 'web' || $target eq 'tex') {
758: $title = &Apache::lonxml::get_all_text("/title",$parser,$style);
759: $title=&Apache::run::evaluate($title,$safeeval,$$parstack[-1]);
760: $title =~ s/\n/ /g;
761: if (length($title) > $max_str_len) {
762: $title = substr($title,0,$max_str_len);
763: }
764: } elsif ($target eq 'edit') {
765: $result.=&Apache::edit::tag_start($target,$token,'Plot Title');
766: my $text=&Apache::lonxml::get_all_text("/title",$parser,$style);
767: $result.=&Apache::edit::editline('',$text,'',60);
768: } elsif ($target eq 'modified') {
769: $result.=&Apache::edit::rebuild_tag($token);
770: $result.=&Apache::edit::modifiedfield("/title",$parser);
771: }
772: return $result;
773: }
774:
775: sub end_title {
776: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
777: my $result = '';
778: if ($target eq 'web' || $target eq 'tex') {
779: } elsif ($target eq 'edit') {
780: $result.=&Apache::edit::tag_end($target,$token);
781: }
782: return $result;
783: }
784: ##------------------------------------------------------------------- xlabel
785: sub start_xlabel {
786: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
787: my $result='';
788: if ($target eq 'web' || $target eq 'tex') {
789: $xlabel = &Apache::lonxml::get_all_text("/xlabel",$parser,$style);
790: $xlabel=&Apache::run::evaluate($xlabel,$safeeval,$$parstack[-1]);
791: $xlabel =~ s/\n/ /g;
792: if (length($xlabel) > $max_str_len) {
793: $xlabel = substr($xlabel,0,$max_str_len);
794: }
795: } elsif ($target eq 'edit') {
796: $result.=&Apache::edit::tag_start($target,$token,'Plot Xlabel');
797: my $text=&Apache::lonxml::get_all_text("/xlabel",$parser,$style);
798: $result.=&Apache::edit::editline('',$text,'',60);
799: } elsif ($target eq 'modified') {
800: $result.=&Apache::edit::rebuild_tag($token);
801: $result.=&Apache::edit::modifiedfield("/xlabel",$parser);
802: }
803: return $result;
804: }
805:
806: sub end_xlabel {
807: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
808: my $result = '';
809: if ($target eq 'web' || $target eq 'tex') {
810: } elsif ($target eq 'edit') {
811: $result.=&Apache::edit::tag_end($target,$token);
812: }
813: return $result;
814: }
815:
816: ##------------------------------------------------------------------- ylabel
817: sub start_ylabel {
818: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
819: my $result='';
820: if ($target eq 'web' || $target eq 'tex') {
821: $ylabel = &Apache::lonxml::get_all_text("/ylabel",$parser,$style);
822: $ylabel = &Apache::run::evaluate($ylabel,$safeeval,$$parstack[-1]);
823: $ylabel =~ s/\n/ /g;
824: if (length($ylabel) > $max_str_len) {
825: $ylabel = substr($ylabel,0,$max_str_len);
826: }
827: } elsif ($target eq 'edit') {
828: $result .= &Apache::edit::tag_start($target,$token,'Plot Ylabel');
829: my $text = &Apache::lonxml::get_all_text("/ylabel",$parser,$style);
830: $result .= &Apache::edit::editline('',$text,'',60);
831: } elsif ($target eq 'modified') {
832: $result.=&Apache::edit::rebuild_tag($token);
833: $result.=&Apache::edit::modifiedfield("/ylabel",$parser);
834: }
835: return $result;
836: }
837:
838: sub end_ylabel {
839: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
840: my $result = '';
841: if ($target eq 'web' || $target eq 'tex') {
842: } elsif ($target eq 'edit') {
843: $result.=&Apache::edit::tag_end($target,$token);
844: }
845: return $result;
846: }
847:
848: ##------------------------------------------------------------------- label
849: sub start_label {
850: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
851: my $result='';
852: if ($target eq 'web' || $target eq 'tex') {
853: my %label;
854: &get_attributes(\%label,\%label_defaults,$parstack,$safeeval,
855: $tagstack->[-1]);
856: my $text = &Apache::lonxml::get_all_text("/label",$parser,$style);
857: $text = &Apache::run::evaluate($text,$safeeval,$$parstack[-1]);
858: $text =~ s/\n/ /g;
859: $text = substr($text,0,$max_str_len) if (length($text) > $max_str_len);
860: $label{'text'} = $text;
861: push(@labels,\%label);
862: } elsif ($target eq 'edit') {
863: $result .= &Apache::edit::tag_start($target,$token,'Plot Label');
864: $result .= &edit_attributes($target,$token,\%label_defaults);
865: my $text = &Apache::lonxml::get_all_text("/label",$parser,$style);
866: $result .= &Apache::edit::end_row().
867: &Apache::edit::start_spanning_row().
868: &Apache::edit::editline('',$text,'',60);
869: } elsif ($target eq 'modified') {
870: &Apache::edit::get_new_args
871: ($token,$parstack,$safeeval,keys(%label_defaults));
872: $result.=&Apache::edit::rebuild_tag($token);
873: $result.=&Apache::edit::modifiedfield("/label",$parser);
874: }
875: return $result;
876: }
877:
878: sub end_label {
879: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
880: my $result = '';
881: if ($target eq 'web' || $target eq 'tex') {
882: } elsif ($target eq 'edit') {
883: $result.=&Apache::edit::tag_end($target,$token);
884: }
885: return $result;
886: }
887:
888: ##------------------------------------------------------------------- curve
889: sub start_curve {
890: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
891: my $result='';
892: &Apache::lonxml::register('Apache::lonplot',('function','data'));
893: push (@Apache::lonxml::namespace,'curve');
894: if ($target eq 'web' || $target eq 'tex') {
895: my %curve;
896: &get_attributes(\%curve,\%curve_defaults,$parstack,$safeeval,
897: $tagstack->[-1]);
898: push (@curves,\%curve);
899: } elsif ($target eq 'edit') {
900: $result .= &Apache::edit::tag_start($target,$token,'Curve');
901: $result .= &edit_attributes($target,$token,\%curve_defaults,
902: \@curve_edit_order)
903: .&Apache::edit::end_row()
904: .&Apache::edit::start_spanning_row();
905:
906: } elsif ($target eq 'modified') {
907: my $constructtag=&Apache::edit::get_new_args
908: ($token,$parstack,$safeeval,keys(%curve_defaults));
909: if ($constructtag) {
910: $result = &Apache::edit::rebuild_tag($token);
911: }
912: }
913: return $result;
914: }
915:
916: sub end_curve {
917: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
918: my $result = '';
919: pop @Apache::lonxml::namespace;
920: &Apache::lonxml::deregister('Apache::lonplot',('function','data'));
921: if ($target eq 'web' || $target eq 'tex') {
922: } elsif ($target eq 'edit') {
923: $result.=&Apache::edit::tag_end($target,$token);
924: }
925: return $result;
926: }
927:
928: ##------------------------------------------------------------ curve function
929: sub start_function {
930: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
931: my $result='';
932: if ($target eq 'web' || $target eq 'tex') {
933: if (exists($curves[-1]->{'data'})) {
934: &Apache::lonxml::warning
935: ('Use of the <b>curve function</b> tag precludes use of '.
936: ' the <b>curve data</b> tag. '.
937: 'The curve data tag will be omitted in favor of the '.
938: 'curve function declaration.');
939: delete $curves[-1]->{'data'} ;
940: }
941: my $function = &Apache::lonxml::get_all_text("/function",$parser,
942: $style);
943: $function = &Apache::run::evaluate($function,$safeeval,$$parstack[-1]);
944: $curves[-1]->{'function'} = $function;
945: } elsif ($target eq 'edit') {
946: $result .= &Apache::edit::tag_start($target,$token,'Gnuplot compatible curve function');
947: my $text = &Apache::lonxml::get_all_text("/function",$parser,$style);
948: $result .= &Apache::edit::editline('',$text,'',60);
949: } elsif ($target eq 'modified') {
950: $result.=&Apache::edit::rebuild_tag($token);
951: $result.=&Apache::edit::modifiedfield("/function",$parser);
952: }
953: return $result;
954: }
955:
956: sub end_function {
957: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
958: my $result = '';
959: if ($target eq 'web' || $target eq 'tex') {
960: } elsif ($target eq 'edit') {
961: $result .= &Apache::edit::end_table();
962: }
963: return $result;
964: }
965:
966: ##------------------------------------------------------------ curve data
967: sub start_data {
968: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
969: my $result='';
970: if ($target eq 'web' || $target eq 'tex') {
971: if (exists($curves[-1]->{'function'})) {
972: &Apache::lonxml::warning
973: ('Use of the <b>curve function</b> tag precludes use of '.
974: ' the <b>curve data</b> tag. '.
975: 'The curve function tag will be omitted in favor of the '.
976: 'curve data declaration.');
977: delete($curves[-1]->{'function'});
978: }
979: my $datatext = &Apache::lonxml::get_all_text("/data",$parser,$style);
980: $datatext=&Apache::run::evaluate($datatext,$safeeval,$$parstack[-1]);
981: # Deal with cases where we're given an array...
982: if ($datatext =~ /^\@/) {
983: $datatext = &Apache::run::run('return "'.$datatext.'"',
984: $safeeval,1);
985: }
986: $datatext =~ s/\s+/ /g;
987: # Need to do some error checking on the @data array -
988: # make sure it's all numbers and make sure each array
989: # is of the same length.
990: my @data;
991: if ($datatext =~ /,/) { # comma deliminated
992: @data = split /,/,$datatext;
993: } else { # Assume it's space separated.
994: @data = split / /,$datatext;
995: }
996: for (my $i=0;$i<=$#data;$i++) {
997: # Check that it's non-empty
998: if (! defined($data[$i])) {
999: &Apache::lonxml::warning(
1000: 'undefined curve data value. Replacing with '.
1001: ' pi/e = 1.15572734979092');
1002: $data[$i] = 1.15572734979092;
1003: }
1004: # Check that it's a number
1005: if (! &$real_test($data[$i]) & ! &$int_test($data[$i])) {
1006: &Apache::lonxml::warning(
1007: 'Bad curve data value of '.$data[$i].' Replacing with '.
1008: ' pi/e = 1.15572734979092');
1009: $data[$i] = 1.15572734979092;
1010: }
1011: }
1012: # complain if the number of data points is not the same as
1013: # in previous sets of data.
1014: if (($curves[-1]->{'data'}) && ($#data != $#{@{$curves[-1]->{'data'}->[0]}})){
1015: &Apache::lonxml::warning
1016: ('Number of data points is not consistent with previous '.
1017: 'number of data points');
1018: }
1019: push @{$curves[-1]->{'data'}},\@data;
1020: } elsif ($target eq 'edit') {
1021: $result .= &Apache::edit::tag_start($target,$token,'Comma or space deliminated curve data');
1022: my $text = &Apache::lonxml::get_all_text("/data",$parser,$style);
1023: $result .= &Apache::edit::editline('',$text,'',60);
1024: } elsif ($target eq 'modified') {
1025: $result.=&Apache::edit::rebuild_tag($token);
1026: $result.=&Apache::edit::modifiedfield("/data",$parser);
1027: }
1028: return $result;
1029: }
1030:
1031: sub end_data {
1032: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1033: my $result = '';
1034: if ($target eq 'web' || $target eq 'tex') {
1035: } elsif ($target eq 'edit') {
1036: $result .= &Apache::edit::end_table();
1037: }
1038: return $result;
1039: }
1040:
1041: ##------------------------------------------------------------------- axis
1042: sub start_axis {
1043: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1044: my $result='';
1045: if ($target eq 'web' || $target eq 'tex') {
1046: &get_attributes(\%axis,\%axis_defaults,$parstack,$safeeval,
1047: $tagstack->[-1]);
1048: } elsif ($target eq 'edit') {
1049: $result .= &Apache::edit::tag_start($target,$token,'Plot Axes');
1050: $result .= &edit_attributes($target,$token,\%axis_defaults,
1051: \@axis_edit_order);
1052: } elsif ($target eq 'modified') {
1053: my $constructtag=&Apache::edit::get_new_args
1054: ($token,$parstack,$safeeval,keys(%axis_defaults));
1055: if ($constructtag) {
1056: $result = &Apache::edit::rebuild_tag($token);
1057: }
1058: }
1059: return $result;
1060: }
1061:
1062: sub end_axis {
1063: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1064: my $result = '';
1065: if ($target eq 'web' || $target eq 'tex') {
1066: } elsif ($target eq 'edit') {
1067: $result.=&Apache::edit::tag_end($target,$token);
1068: } elsif ($target eq 'modified') {
1069: }
1070: return $result;
1071: }
1072:
1073: ###################################################################
1074: ## ##
1075: ## Utility Functions ##
1076: ## ##
1077: ###################################################################
1078:
1079: ##----------------------------------------------------------- set_defaults
1080: sub set_defaults {
1081: my ($var,$defaults) = @_;
1082: my $key;
1083: foreach $key (keys(%$defaults)) {
1084: $var->{$key} = $defaults->{$key}->{'default'};
1085: }
1086: }
1087:
1088: ##------------------------------------------------------------------- misc
1089: sub get_attributes{
1090: my ($values,$defaults,$parstack,$safeeval,$tag) = @_;
1091: foreach my $attr (keys(%{$defaults})) {
1092: if ($attr eq 'texwidth' || $attr eq 'texfont') {
1093: $values->{$attr} =
1094: &Apache::lonxml::get_param($attr,$parstack,$safeeval,undef,1);
1095: } else {
1096: $values->{$attr} =
1097: &Apache::lonxml::get_param($attr,$parstack,$safeeval);
1098: }
1099: if ($values->{$attr} eq '' | !defined($values->{$attr})) {
1100: $values->{$attr} = $defaults->{$attr}->{'default'};
1101: next;
1102: }
1103: my $test = $defaults->{$attr}->{'test'};
1104: if (! &$test($values->{$attr})) {
1105: &Apache::lonxml::warning
1106: ($tag.':'.$attr.': Bad value.'.'Replacing your value with : '
1107: .$defaults->{$attr}->{'default'} );
1108: $values->{$attr} = $defaults->{$attr}->{'default'};
1109: }
1110: }
1111: return ;
1112: }
1113:
1114: ##------------------------------------------------------- write_gnuplot_file
1115: sub write_gnuplot_file {
1116: my ($tmpdir,$filename,$target)= @_;
1117: my ($fontsize, $font_properties) = &get_font();
1118: my $gnuplot_input = '';
1119: my $curve;
1120: my $pt = $Apache::lonplot::plot{'texfont'};
1121: #
1122: # Check to be sure we do not have any empty curves
1123: my @curvescopy;
1124: foreach my $curve (@curves) {
1125: if (exists($curve->{'function'})) {
1126: if ($curve->{'function'} !~ /^\s*$/) {
1127: push(@curvescopy,$curve);
1128: }
1129: } elsif (exists($curve->{'data'})) {
1130: foreach my $data (@{$curve->{'data'}}) {
1131: if (scalar(@$data) > 0) {
1132: push(@curvescopy,$curve);
1133: last;
1134: }
1135: }
1136: }
1137: }
1138: @curves = @curvescopy;
1139: # Collect all the colors
1140: my @Colors;
1141: push @Colors, $Apache::lonplot::plot{'bgcolor'};
1142: push @Colors, $Apache::lonplot::plot{'fgcolor'};
1143: push @Colors, (defined($axis{'color'})?$axis{'color'}:$Apache::lonplot::plot{'fgcolor'});
1144: foreach $curve (@curves) {
1145: push @Colors, ($curve->{'color'} ne '' ?
1146: $curve->{'color'} :
1147: $Apache::lonplot::plot{'fgcolor'} );
1148: }
1149: # set term
1150: if ($target eq 'web') {
1151: $gnuplot_input .= 'set terminal png enhanced nocrop ';
1152: $gnuplot_input .= 'transparent ' if ($Apache::lonplot::plot{'transparent'} eq 'on');
1153: $gnuplot_input .= 'font "'.$Apache::lonnet::perlvar{'lonFontsDir'}.
1154: '/'.$font_properties->{'file'}.'.ttf" ';
1155: $gnuplot_input .= $fontsize;
1156: $gnuplot_input .= ' size '.$Apache::lonplot::plot{'width'}.','.$Apache::lonplot::plot{'height'}.' ';
1157: $gnuplot_input .= "@Colors\n";
1158: # set output
1159: $gnuplot_input .= "set output\n";
1160: } elsif ($target eq 'tex') {
1161: $gnuplot_input .= "set term postscript eps enhanced $Apache::lonplot::plot{'plotcolor'} solid ";
1162: $gnuplot_input .=
1163: 'fontfile "'.$Apache::lonnet::perlvar{'lonFontsDir'}.
1164: '/'.$font_properties->{'file'}.'.pfb" ';
1165: $gnuplot_input .= ' "'.$font_properties->{'printname'}.'" ';
1166: $gnuplot_input .= $fontsize;
1167: $gnuplot_input .= "\nset output \"/home/httpd/perl/tmp/".
1168: &unescape($filename).".eps\"\n";
1169: }
1170: # cartesian or polar plot?
1171: if (lc($Apache::lonplot::plot{'plottype'}) eq 'polar') {
1172: $gnuplot_input .= 'set polar'.$/;
1173: } else {
1174: # Assume Cartesian
1175: }
1176: # cartesian or polar grid?
1177: if (lc($Apache::lonplot::plot{'gridtype'}) eq 'polar') {
1178: $gnuplot_input .= 'set grid polar'.$/;
1179: } elsif (lc($Apache::lonplot::plot{'gridtype'}) eq 'linear-log') {
1180: $gnuplot_input .= 'set logscale x'.$/;
1181: } elsif (lc($Apache::lonplot::plot{'gridtype'}) eq 'log-linear') {
1182: $gnuplot_input .= 'set logscale y'.$/;
1183: } elsif (lc($Apache::lonplot::plot{'gridtype'}) eq 'log-log') {
1184: $gnuplot_input .= 'set logscale x'.$/;
1185: $gnuplot_input .= 'set logscale y'.$/;
1186: } else {
1187: # Assume Cartesian
1188: }
1189: # solid or pattern for boxes?
1190: if (lc($Apache::lonplot::plot{'fillstyle'}) eq 'solid') {
1191: $gnuplot_input .= 'set style fill solid '.
1192: $Apache::lonplot::plot{'solid'}.$Apache::lonplot::plot{'box_border'}.$/;
1193: } elsif (lc($Apache::lonplot::plot{'fillstyle'}) eq 'pattern') {
1194: $gnuplot_input .= 'set style fill pattern '.$Apache::lonplot::plot{'pattern'}.$Apache::lonplot::plot{'box_border'}.$/;
1195: } elsif (lc($Apache::lonplot::plot{'fillstyle'}) eq 'empty') {
1196: }
1197: # margin
1198: if (lc($Apache::lonplot::plot{'lmargin'}) ne 'default') {
1199: $gnuplot_input .= 'set lmargin '.$Apache::lonplot::plot{'lmargin'}.$/;
1200: }
1201: if (lc($Apache::lonplot::plot{'rmargin'}) ne 'default') {
1202: $gnuplot_input .= 'set rmargin '.$Apache::lonplot::plot{'rmargin'}.$/;
1203: }
1204: if (lc($Apache::lonplot::plot{'tmargin'}) ne 'default') {
1205: $gnuplot_input .= 'set tmargin '.$Apache::lonplot::plot{'tmargin'}.$/;
1206: }
1207: if (lc($Apache::lonplot::plot{'bmargin'}) ne 'default') {
1208: $gnuplot_input .= 'set bmargin '.$Apache::lonplot::plot{'bmargin'}.$/;
1209: }
1210: # tic scales
1211: $gnuplot_input .= 'set ticscale '.
1212: $Apache::lonplot::plot{'major_ticscale'}.' '.$Apache::lonplot::plot{'minor_ticscale'}.$/;
1213: #boxwidth
1214: if (lc($Apache::lonplot::plot{'boxwidth'}) ne '') {
1215: $gnuplot_input .= 'set boxwidth '.$Apache::lonplot::plot{'boxwidth'}.$/;
1216: }
1217: # gridlayer
1218: $gnuplot_input .= 'set grid noxtics noytics front '.$/
1219: if ($Apache::lonplot::plot{'gridlayer'} eq 'on');
1220:
1221: # grid
1222: $gnuplot_input .= 'set grid'.$/ if ($Apache::lonplot::plot{'grid'} eq 'on');
1223: # border
1224: $gnuplot_input .= ($Apache::lonplot::plot{'border'} eq 'on'?
1225: 'set border'.$/ :
1226: 'set noborder'.$/ );
1227: # sampling rate for non-data curves
1228: $gnuplot_input .= "set samples $Apache::lonplot::plot{'samples'}\n";
1229: # title, xlabel, ylabel
1230: # titles
1231: if ($target eq 'tex') {
1232: $gnuplot_input .= "set title \"$title\" font \"".$font_properties->{'printname'}.",".$pt."pt\"\n" if (defined($title)) ;
1233: $gnuplot_input .= "set xlabel \"$xlabel\" font \"".$font_properties->{'printname'}.",".$pt."pt\"\n" if (defined($xlabel));
1234: $gnuplot_input .= "set ylabel \"$ylabel\" font \"".$font_properties->{'printname'}.",".$pt."pt\"\n" if (defined($ylabel));
1235: } else {
1236: $gnuplot_input .= "set title \"$title\" \n" if (defined($title)) ;
1237: $gnuplot_input .= "set xlabel \"$xlabel\" \n" if (defined($xlabel));
1238: $gnuplot_input .= "set ylabel \"$ylabel\" \n" if (defined($ylabel));
1239: }
1240: # tics
1241: if (%xtics) {
1242: $gnuplot_input .= "set xtics $xtics{'location'} ";
1243: $gnuplot_input .= ( $xtics{'mirror'} eq 'on'?"mirror ":"nomirror ");
1244: $gnuplot_input .= "$xtics{'start'}, ";
1245: $gnuplot_input .= "$xtics{'increment'}, ";
1246: $gnuplot_input .= "$xtics{'end'}\n";
1247: if ($xtics{'minorfreq'} != 0) {
1248: $gnuplot_input .= "set mxtics ".$xtics{'minorfreq'}."\n";
1249: }
1250: }
1251: if (%ytics) {
1252: $gnuplot_input .= "set ytics $ytics{'location'} ";
1253: $gnuplot_input .= ( $ytics{'mirror'} eq 'on'?"mirror ":"nomirror ");
1254: $gnuplot_input .= "$ytics{'start'}, ";
1255: $gnuplot_input .= "$ytics{'increment'}, ";
1256: $gnuplot_input .= "$ytics{'end'}\n";
1257: if ($ytics{'minorfreq'} != 0) {
1258: $gnuplot_input .= "set mytics ".$ytics{'minorfreq'}."\n";
1259: }
1260: }
1261: # axis
1262: if (%axis) {
1263: $gnuplot_input .= "set xrange \[$axis{'xmin'}:$axis{'xmax'}\]\n";
1264: $gnuplot_input .= "set yrange \[$axis{'ymin'}:$axis{'ymax'}\]\n";
1265: }
1266: # Key
1267: if (%key) {
1268: $gnuplot_input .= 'set key '.$key{'pos'}.' ';
1269: if ($key{'title'} ne '') {
1270: $gnuplot_input .= 'title "'.$key{'title'}.'" ';
1271: }
1272: $gnuplot_input .= ($key{'box'} eq 'on' ? 'box ' : 'nobox ').$/;
1273: } else {
1274: $gnuplot_input .= 'set nokey'.$/;
1275: }
1276: # labels
1277: my $label;
1278: foreach $label (@labels) {
1279: $gnuplot_input .= 'set label "'.$label->{'text'}.'" at '.
1280: $label->{'xpos'}.','.$label->{'ypos'}.' '.$label->{'justify'};
1281: if ($target eq 'tex') {
1282: $gnuplot_input .=' font "'.$font_properties->{'printname'}.','.$pt.'pt"' ;
1283: }
1284: $gnuplot_input .= $/;
1285: }
1286: if ($target eq 'tex') {
1287: $gnuplot_input .="set size 1,".$Apache::lonplot::plot{'height'}/$Apache::lonplot::plot{'width'}*1.38;
1288: $gnuplot_input .="\n";
1289: }
1290: # curves
1291: $gnuplot_input .= 'plot ';
1292: for (my $i = 0;$i<=$#curves;$i++) {
1293: $curve = $curves[$i];
1294: $gnuplot_input.= ', ' if ($i > 0);
1295: if ($target eq 'tex') {
1296: $curve->{'linewidth'} *= 2;
1297: }
1298: if (exists($curve->{'function'})) {
1299: $gnuplot_input.=
1300: $curve->{'function'}.' title "'.
1301: $curve->{'name'}.'" with '.
1302: $curve->{'linestyle'};
1303: $gnuplot_input.= ' linewidth '.$curve->{'linewidth'};
1304:
1305: if (($curve->{'linestyle'} eq 'points') ||
1306: ($curve->{'linestyle'} eq 'linespoints') ||
1307: ($curve->{'linestyle'} eq 'errorbars') ||
1308: ($curve->{'linestyle'} eq 'xerrorbars') ||
1309: ($curve->{'linestyle'} eq 'yerrorbars') ||
1310: ($curve->{'linestyle'} eq 'xyerrorbars')) {
1311: $gnuplot_input.=' pointtype '.$curve->{'pointtype'};
1312: $gnuplot_input.=' pointsize '.$curve->{'pointsize'};
1313: } elsif ($curve->{'linestyle'} eq 'filledcurves') {
1314: $gnuplot_input.= ' '.$curve->{'limit'};
1315: }
1316: } elsif (exists($curve->{'data'})) {
1317: # Store data values in $datatext
1318: my $datatext = '';
1319: # get new filename
1320: my $datafilename = "$tmpdir/$filename.data.$i";
1321: my $fh=Apache::File->new(">$datafilename");
1322: # Compile data
1323: my @Data = @{$curve->{'data'}};
1324: my @Data0 = @{$Data[0]};
1325: for (my $i =0; $i<=$#Data0; $i++) {
1326: my $dataset;
1327: foreach $dataset (@Data) {
1328: $datatext .= $dataset->[$i] . ' ';
1329: }
1330: $datatext .= $/;
1331: }
1332: # write file
1333: print $fh $datatext;
1334: close($fh);
1335: # generate gnuplot text
1336: $gnuplot_input.= '"'.$datafilename.'" title "'.
1337: $curve->{'name'}.'" with '.
1338: $curve->{'linestyle'};
1339: $gnuplot_input.= ' linewidth '.$curve->{'linewidth'};
1340: if (($curve->{'linestyle'} eq 'points') ||
1341: ($curve->{'linestyle'} eq 'linespoints') ||
1342: ($curve->{'linestyle'} eq 'errorbars') ||
1343: ($curve->{'linestyle'} eq 'xerrorbars') ||
1344: ($curve->{'linestyle'} eq 'yerrorbars') ||
1345: ($curve->{'linestyle'} eq 'xyerrorbars')) {
1346: $gnuplot_input.=' pointtype '.$curve->{'pointtype'};
1347: $gnuplot_input.=' pointsize '.$curve->{'pointsize'};
1348: } elsif ($curve->{'linestyle'} eq 'filledcurves') {
1349: $gnuplot_input.= ' '.$curve->{'limit'};
1350: }
1351: }
1352: }
1353: # Write the output to a file.
1354: my $fh=Apache::File->new(">$tmpdir$filename.data");
1355: print $fh $gnuplot_input;
1356: close($fh);
1357: # That's all folks.
1358: return ;
1359: }
1360:
1361: #---------------------------------------------- check_inputs
1362: sub check_inputs {
1363: ## Note: no inputs, no outputs - this acts only on global variables.
1364: ## Make sure we have all the input we need:
1365: if (! %Apache::lonplot::plot) { &set_defaults(\%Apache::lonplot::plot,\%gnuplot_defaults); }
1366: if (! %key ) {} # No key for this plot, thats okay
1367: # if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }
1368: if (! defined($title )) {} # No title for this plot, thats okay
1369: if (! defined($xlabel)) {} # No xlabel for this plot, thats okay
1370: if (! defined($ylabel)) {} # No ylabel for this plot, thats okay
1371: if ($#labels < 0) { } # No labels for this plot, thats okay
1372: if ($#curves < 0) {
1373: &Apache::lonxml::warning("No curves specified for plot!!!!");
1374: return '';
1375: }
1376: my $curve;
1377: foreach $curve (@curves) {
1378: if (!defined($curve->{'function'})&&!defined($curve->{'data'})){
1379: &Apache::lonxml::warning("One of the curves specified did not contain any curve data or curve function declarations\n");
1380: return '';
1381: }
1382: }
1383: }
1384:
1385: #------------------------------------------------ make_edit
1386: sub edit_attributes {
1387: my ($target,$token,$defaults,$keys) = @_;
1388: my ($result,@keys);
1389: if ($keys && ref($keys) eq 'ARRAY') {
1390: @keys = @$keys;
1391: } else {
1392: @keys = sort(keys(%$defaults));
1393: }
1394: foreach my $attr (@keys) {
1395: # append a ' ' to the description if it doesn't have one already.
1396: my $description = $defaults->{$attr}->{'description'};
1397: $description .= ' ' if ($description !~ / $/);
1398: if ($defaults->{$attr}->{'edit_type'} eq 'entry') {
1399: $result .= &Apache::edit::text_arg
1400: ($description,$attr,$token,
1401: $defaults->{$attr}->{'size'});
1402: } elsif ($defaults->{$attr}->{'edit_type'} eq 'choice') {
1403: $result .= &Apache::edit::select_or_text_arg
1404: ($description,$attr,$defaults->{$attr}->{'choices'},$token);
1405: } elsif ($defaults->{$attr}->{'edit_type'} eq 'onoff') {
1406: $result .= &Apache::edit::select_or_text_arg
1407: ($description,$attr,['on','off'],$token);
1408: }
1409: $result .= '<br />';
1410: }
1411: return $result;
1412: }
1413:
1414:
1415: ###################################################################
1416: ## ##
1417: ## Insertion functions for editing plots ##
1418: ## ##
1419: ###################################################################
1420:
1421: sub insert_gnuplot {
1422: my $result = '';
1423: # plot attributes
1424: $result .= "\n<gnuplot ";
1425: foreach my $attr (keys(%gnuplot_defaults)) {
1426: $result .= "\n $attr=\"$gnuplot_defaults{$attr}->{'default'}\"";
1427: }
1428: $result .= ">";
1429: # Add the components (most are commented out for simplicity)
1430: # $result .= &insert_key();
1431: # $result .= &insert_axis();
1432: # $result .= &insert_title();
1433: # $result .= &insert_xlabel();
1434: # $result .= &insert_ylabel();
1435: $result .= &insert_curve();
1436: # close up the <gnuplot>
1437: $result .= "\n</gnuplot>";
1438: return $result;
1439: }
1440:
1441: sub insert_tics {
1442: my $result;
1443: $result .= &insert_xtics() . &insert_ytics;
1444: return $result;
1445: }
1446:
1447: sub insert_xtics {
1448: my $result;
1449: $result .= "\n <xtics ";
1450: foreach my $attr (keys(%tic_defaults)) {
1451: $result .= "\n $attr=\"$tic_defaults{$attr}->{'default'}\" ";
1452: }
1453: $result .= "/>";
1454: return $result;
1455: }
1456:
1457: sub insert_ytics {
1458: my $result;
1459: $result .= "\n <ytics ";
1460: foreach my $attr (keys(%tic_defaults)) {
1461: $result .= "\n $attr=\"$tic_defaults{$attr}->{'default'}\" ";
1462: }
1463: $result .= "/>";
1464: return $result;
1465: }
1466:
1467: sub insert_key {
1468: my $result;
1469: $result .= "\n <key ";
1470: foreach my $attr (keys(%key_defaults)) {
1471: $result .= "\n $attr=\"$key_defaults{$attr}->{'default'}\"";
1472: }
1473: $result .= " />";
1474: return $result;
1475: }
1476:
1477: sub insert_axis{
1478: my $result;
1479: $result .= "\n <axis ";
1480: foreach my $attr (keys(%axis_defaults)) {
1481: $result .= "\n $attr=\"$axis_defaults{$attr}->{'default'}\"";
1482: }
1483: $result .= " />";
1484: return $result;
1485: }
1486:
1487: sub insert_title { return "\n <title></title>"; }
1488: sub insert_xlabel { return "\n <xlabel></xlabel>"; }
1489: sub insert_ylabel { return "\n <ylabel></ylabel>"; }
1490:
1491: sub insert_label {
1492: my $result;
1493: $result .= "\n <label ";
1494: foreach my $attr (keys(%label_defaults)) {
1495: $result .= "\n $attr=\"".
1496: $label_defaults{$attr}->{'default'}."\"";
1497: }
1498: $result .= "></label>";
1499: return $result;
1500: }
1501:
1502: sub insert_curve {
1503: my $result;
1504: $result .= "\n <curve ";
1505: foreach my $attr (keys(%curve_defaults)) {
1506: $result .= "\n $attr=\"".
1507: $curve_defaults{$attr}->{'default'}."\"";
1508: }
1509: $result .= " >";
1510: $result .= &insert_data().&insert_data()."\n </curve>";
1511: }
1512:
1513: sub insert_function {
1514: my $result;
1515: $result .= "\n <function></function>";
1516: return $result;
1517: }
1518:
1519: sub insert_data {
1520: my $result;
1521: $result .= "\n <data></data>";
1522: return $result;
1523: }
1524:
1525: ##----------------------------------------------------------------------
1526: 1;
1527: __END__
1528:
1529:
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