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