File:
[LON-CAPA] /
loncom /
build /
lpml_parse.pl
Revision
1.57:
download - view:
text,
annotated -
select for diffs
Fri Mar 25 22:55:06 2011 UTC (13 years, 1 month ago) by
raeburn
Branches:
MAIN
CVS tags:
version_2_10_X,
version_2_10_1,
version_2_10_0,
language_hyphenation_merge,
language_hyphenation,
HEAD,
BZ4492-merge,
BZ4492-feature_horizontal_radioresponse,
BZ4492-feature_Support_horizontal_radioresponse,
BZ4492-Support_horizontal_radioresponse
- system shell can be passed to lpml_parse.pl as an optional 6th arg.
- shell to be used for "make build" needs to be /bin/bash
(to avoid errors when running tthperl/commands, e.g., with /bin/dash in Debian 6.
1: #!/usr/bin/perl
2:
3: # -------------------------------------------------------- Documentation notice
4: # Run "perldoc ./lpml_parse.pl" in order to best view the software
5: # documentation internalized in this program.
6:
7: # --------------------------------------------------------- Distribution notice
8: # This script is distributed with the LPML software project available at
9: # http://lpml.sourceforge.net
10:
11: # --------------------------------------------------------- License Information
12: # The LearningOnline Network with CAPA
13: # lpml_parse.pl - Linux Packaging Markup Language parser
14: #
15: # $Id: lpml_parse.pl,v 1.57 2011/03/25 22:55:06 raeburn Exp $
16: #
17: # Written by Scott Harrison, codeharrison@yahoo.com
18: #
19: # Copyright Michigan State University Board of Trustees
20: #
21: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
22: #
23: # LON-CAPA is free software; you can redistribute it and/or modify
24: # it under the terms of the GNU General Public License as published by
25: # the Free Software Foundation; either version 2 of the License, or
26: # (at your option) any later version.
27: #
28: # LON-CAPA is distributed in the hope that it will be useful,
29: # but WITHOUT ANY WARRANTY; without even the implied warranty of
30: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31: # GNU General Public License for more details.
32: #
33: # You should have received a copy of the GNU General Public License
34: # along with LON-CAPA; if not, write to the Free Software
35: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
36: #
37: # /home/httpd/html/adm/gpl.txt
38: #
39: # http://www.lon-capa.org/
40: #
41: # YEAR=2001
42: # May 2001
43: # 06/19/2001,06/20,06/24 - Scott Harrison
44: # 9/5/2001,9/6,9/7,9/8 - Scott Harrison
45: # 9/17,9/18 - Scott Harrison
46: # 11/4,11/5,11/6,11/7,11/16,11/17 - Scott Harrison
47: # 12/2,12/3,12/4,12/5,12/6,12/13,12/19,12/29 - Scott Harrison
48: # YEAR=2002
49: # 1/8,1/9,1/29,1/31,2/5,3/21,4/8,4/12 - Scott Harrison
50: # 4/21,4/26,5/19,5/23,10/13 - Scott Harrison
51: #
52: ###
53:
54: ###############################################################################
55: ## ##
56: ## ORGANIZATION OF THIS PERL SCRIPT ##
57: ## 1. Notes ##
58: ## 2. Get command line arguments ##
59: ## 3. First pass through (grab distribution-specific information) ##
60: ## 4. Second pass through (parse out what is not necessary) ##
61: ## 5. Third pass through (translate markup according to specified mode) ##
62: ## 6. Functions (most all just format contents of different markup tags) ##
63: ## 7. POD (plain old documentation, CPAN style) ##
64: ## ##
65: ###############################################################################
66:
67: # ----------------------------------------------------------------------- Notes
68: #
69: # I am using a multiple pass-through approach to parsing
70: # the lpml file. This saves memory and makes sure the server
71: # will never be overloaded.
72: #
73: # This is meant to parse files meeting the lpml document type.
74: # See lpml.dtd. LPML=Linux Packaging Markup Language.
75:
76: use HTML::TokeParser;
77:
78: my $usage=<<END;
79: **** ERROR ERROR ERROR ERROR ****
80: Usage is for lpml file to come in through standard input.
81: 1st argument is the mode of parsing:
82: install,configinstall,build,rpm,dpkg,htmldoc,textdoc,status
83: 2nd argument is the category permissions to use:
84: typical choices: runtime,development
85: 3rd argument is the distribution:
86: typical choices: default,redhat6.2,debian2.2,redhat7
87: 4th argument is to manually specify a sourceroot.
88: 5th argument is to manually specify a targetroot.
89: 6th argument is to manually specify a shell.
90:
91: Only the 1st argument is mandatory for the program to run.
92:
93: Example:
94:
95: cat ../../doc/loncapafiles.lpml |\\
96: perl lpml_parse.pl html development default /home/sherbert/loncapa /tmp/install
97:
98: For more information, type "perldoc lpml_parse.pl".
99: END
100:
101: # ------------------------------------------------- Grab command line arguments
102:
103: my $mode='';
104: if (@ARGV == 6 || @ARGV == 5) {
105: $mode = shift @ARGV;
106: }
107: else {
108: @ARGV=();shift @ARGV;
109: while(<>){} # throw away the input to avoid broken pipes
110: print $usage;
111: exit -1; # exit with error status
112: }
113:
114: my $categorytype='';
115: if (@ARGV) {
116: $categorytype = shift @ARGV;
117: }
118:
119: my $dist='';
120: if (@ARGV) {
121: $dist = shift @ARGV;
122: }
123:
124: my $targetroot='';
125: my $sourceroot='';
126: my $targetrootarg='';
127: my $sourcerootarg='';
128: if (@ARGV) {
129: $sourceroot = shift @ARGV;
130: }
131: if (@ARGV) {
132: $targetroot = shift @ARGV;
133: }
134: $sourceroot=~s/\/$//; # remove trailing directory slash
135: $targetroot=~s/\/$//; # remove trailing directory slash
136: $sourcerootarg=$sourceroot;
137: $targetrootarg=$targetroot;
138:
139: my $shell = 'sh';
140: if (@ARGV) {
141: $shell = shift @ARGV;
142: }
143:
144: my $logcmd='| tee -a WARNINGS';
145:
146: my $invocation; # Record how the program was invoked
147: # --------------------------------------------------- Record program invocation
148: if ($mode eq 'install' or $mode eq 'configinstall' or $mode eq 'build') {
149: $invocation=(<<END);
150: # Invocation: STDINPUT | lpml_parse.pl
151: # 1st argument (mode) is: $mode
152: # 2nd argument (category type) is: $categorytype
153: # 3rd argument (distribution) is: $dist
154: # 4th argument (sourceroot) is: described below
155: # 5th argument (targetroot) is: described below
156: # 6th argument (shell) is: $shell
157: END
158: }
159:
160: # -------------------------- Start first pass through (just gather information)
161: my @parsecontents=<>;
162: my $parsestring=join('',@parsecontents);
163:
164: # Need to make a pass through and figure out what defaults are
165: # overrided. Top-down overriding strategy (tree leaves don't know
166: # about distant tree leaves).
167:
168: my @hierarchy;
169: $hierarchy[0]=0;
170: my $hloc=0;
171: my $token;
172: $parser = HTML::TokeParser->new(\$parsestring) or
173: die('can\'t create TokeParser object');
174: $parser->xml_mode('1');
175: my %setting;
176:
177: # Values for the %setting hash
178: my $defaultset=1; # a default setting exists for a key
179: my $distset=2; # a distribution setting exists for a key
180: # (overrides default setting)
181:
182: my $key=''; # this is a unique key identifier (the token name with its
183: # coordinates inside the hierarchy)
184: while ($token = $parser->get_token()) { # navigate through $parsestring
185: if ($token->[0] eq 'S') {
186: $hloc++;
187: $hierarchy[$hloc]++;
188: $key=$token->[1].join(',',@hierarchy[0..($hloc-1)]);
189: my $thisdist=' '.$token->[2]{'dist'}.' ';
190: if ($thisdist eq ' default ') {
191: $setting{$key}=$defaultset;
192: }
193: elsif (length($dist)>0 &&
194: $setting{$key}==$defaultset &&
195: $thisdist=~/\s$dist\s/) {
196: $setting{$key}=$distset;
197: # disregard default setting for this key if
198: # there is a directly requested distribution match
199: # (in other words, there must first be a default
200: # setting for a key in order for it to be overridden)
201: }
202: }
203: if ($token->[0] eq 'E') {
204: $hloc--;
205: }
206: }
207:
208: # - Start second pass through (clean up the string to allow for easy rendering)
209:
210: # The string is cleaned up so that there is no white-space surrounding any
211: # XML tag. White-space inside text 'T' elements is preserved.
212:
213: # Clear up memory
214: undef($hloc);
215: undef(@hierarchy);
216: undef($parser);
217: $hierarchy[0]=0; # initialize hierarchy
218: $parser = HTML::TokeParser->new(\$parsestring) or
219: die('can\'t create TokeParser object');
220: $parser->xml_mode('1');
221: my $cleanstring; # contains the output of the second step
222: while ($token = $parser->get_token()) { # navigate through $parsestring
223: if ($token->[0] eq 'S') { # a start tag
224: $hloc++;
225: $hierarchy[$hloc]++;
226: $key=$token->[1].join(',',@hierarchy[0..($hloc-1)]);
227:
228: # Surround tagdist (the dist attribute of an XML tag)
229: # with white-space to allow for uniform searching a few
230: # lines below here.
231: my $tagdist=' '.$token->[2]{'dist'}.' ';
232:
233: # This conditional clause is set up to ignore two sets
234: # of invalid conditions before accepting entry into
235: # $cleanstring.
236:
237: # Condition #1: Ignore this part of the string if the tag
238: # has a superior distribution-specific setting and the tag
239: # being evaluated has a dist setting something other than
240: # blank or $dist.
241: if ($setting{$key}==$distset and
242: !($tagdist eq ' ' or $tagdist =~/\s$dist\s/)) {
243: if ($token->[4]!~/\/>$/) {
244: $parser->get_tag('/'.$token->[1]);
245: $hloc--;
246: }
247: }
248: # Condition #2: Ignore this part of the string if the tag has
249: # is not blank and does not equal dist and
250: # either does not equal default or it has a prior $dist-specific
251: # setting.
252: elsif ($tagdist ne ' ' and $tagdist!~/\s$dist\s/ and
253: !($tagdist eq ' default ' and $setting{$key}!=$distset)) {
254: if ($token->[4]!~/\/>$/) {
255: $parser->get_tag('/'.$token->[1]);
256: $hloc--;
257: }
258: }
259: # In other words, output to $cleanstring if the tag is dist=default
260: # or if the tag is set to dist=$dist for the first time. And, always
261: # output when dist='' is not present.
262: else {
263: $cleanstring.=$token->[4];
264: }
265: }
266: # Note: this loop DOES work with <tag /> style markup as well as
267: # <tag></tag> style markup since I always check for $token->[4] ending
268: # with "/>".
269: if ($token->[0] eq 'E') { # an end tag
270: $cleanstring.=$token->[2];
271: $hloc--;
272: }
273: if ($token->[0] eq 'T') { # text contents inside tags
274: $cleanstring.=$token->[1];
275: }
276: }
277: $cleanstring=&trim($cleanstring);
278: $cleanstring=~s/\>\s*\n\s*\</\>\</g;
279:
280: # -------------------------------------------- Start final (third) pass through
281:
282: # storage variables
283: my $lpml;
284: my $categories;
285: my @categorynamelist;
286: my $category;
287: my $category_att_name;
288: my $category_att_type;
289: my $chown;
290: my $chmod;
291: my $abbreviation; # space-free abbreviation; esp. for image names
292: my $rpm;
293: my $rpmSummary;
294: my $rpmName;
295: my $rpmVersion;
296: my $rpmRelease;
297: my $rpmVendor;
298: my $rpmBuildRoot;
299: my $rpmCopyright;
300: my $rpmGroup;
301: my $rpmSource;
302: my $rpmAutoReqProv;
303: my $rpmdescription;
304: my $rpmpre;
305: my $directories;
306: my $directory;
307: my $targetdirs;
308: my $targetdir;
309: my $protectionlevel;
310: my $categoryname;
311: my $description;
312: my $files;
313: my $fileglobs;
314: my $links;
315: my $file;
316: my $link;
317: my $fileglob;
318: my $sourcedir;
319: my $targets;
320: my $target;
321: my $source;
322: my $note;
323: my $installscript;
324: my $build;
325: my $buildlink;
326: my $commands;
327: my $command;
328: my $status;
329: my $dependencies;
330: my $dependency;
331: my @links;
332: my %categoryhash;
333: my $dpathlength;
334: my %fab; # file category abbreviation
335: my $directory_count;
336: my $file_count;
337: my $link_count;
338: my $fileglob_count;
339: my $fileglobnames_count;
340: my %categorycount;
341:
342: my @buildall;
343: my @buildinfo;
344:
345: my @configall;
346:
347: # Make new parser with distribution specific input
348: undef $parser;
349: $parser = HTML::TokeParser->new(\$cleanstring) or
350: die('can\'t create TokeParser object');
351: $parser->xml_mode('1');
352:
353: # Define handling methods for mode-dependent text rendering
354:
355: $parser->{textify}={
356: specialnotices => \&format_specialnotices,
357: specialnotice => \&format_specialnotice,
358: targetroot => \&format_targetroot,
359: sourceroot => \&format_sourceroot,
360: categories => \&format_categories,
361: category => \&format_category,
362: abbreviation => \&format_abbreviation,
363: targetdir => \&format_targetdir,
364: protectionlevel => \&format_protectionlevel,
365: chown => \&format_chown,
366: chmod => \&format_chmod,
367: rpm => \&format_rpm,
368: rpmSummary => \&format_rpmSummary,
369: rpmName => \&format_rpmName,
370: rpmVersion => \&format_rpmVersion,
371: rpmRelease => \&format_rpmRelease,
372: rpmVendor => \&format_rpmVendor,
373: rpmBuildRoot => \&format_rpmBuildRoot,
374: rpmCopyright => \&format_rpmCopyright,
375: rpmGroup => \&format_rpmGroup,
376: rpmSource => \&format_rpmSource,
377: rpmAutoReqProv => \&format_rpmAutoReqProv,
378: rpmdescription => \&format_rpmdescription,
379: rpmpre => \&format_rpmpre,
380: rpmRequires => \&format_rpmRequires,
381: directories => \&format_directories,
382: directory => \&format_directory,
383: categoryname => \&format_categoryname,
384: description => \&format_description,
385: files => \&format_files,
386: file => \&format_file,
387: fileglob => \&format_fileglob,
388: links => \&format_links,
389: link => \&format_link,
390: linkto => \&format_linkto,
391: source => \&format_source,
392: target => \&format_target,
393: note => \&format_note,
394: build => \&format_build,
395: installscript => \&format_installscript,
396: status => \&format_status,
397: dependencies => \&format_dependencies,
398: privatedependencies => \&format_privatedependencies,
399: buildlink => \&format_buildlink,
400: glob => \&format_glob,
401: sourcedir => \&format_sourcedir,
402: filenames => \&format_filenames,
403: };
404:
405: my $text;
406: my $token;
407: undef $hloc;
408: undef @hierarchy;
409: my $hloc;
410: my @hierarchy2;
411: while ($token = $parser->get_tag('lpml')) {
412: &format_lpml(@{$token});
413: $text = &trim($parser->get_text('/lpml'));
414: $token = $parser->get_tag('/lpml');
415: print $lpml;
416: print "\n";
417: # $text=~s/\s*\n\s*\n\s*/\n/g;
418: print $text;
419: print "\n";
420: print &end();
421: }
422: exit;
423:
424: # ---------- Functions (most all just format contents of different markup tags)
425:
426: # ------------------------ Final output at end of markup parsing and formatting
427: sub end {
428: if ($mode eq 'html') {
429: return "<br /> <br />".
430: "<a name='summary' /><font size='+2'>Summary of Source Repository".
431: "</font>".
432: "<br /> <br />".
433: "<table border='1' cellpadding='5'>".
434: "<caption>Files, Directories, and Symbolic Links</caption>".
435: "<tr><td>Files (not referenced by globs)</td><td>$file_count</td>".
436: "</tr>".
437: "<tr><td>Files (referenced by globs)</td>".
438: "<td>$fileglobnames_count</td>".
439: "</tr>".
440: "<tr><td>Total Files</td>".
441: "<td>".($fileglobnames_count+$file_count)."</td>".
442: "</tr>".
443: "<tr><td>File globs</td>".
444: "<td>".$fileglob_count."</td>".
445: "</tr>".
446: "<tr><td>Directories</td>".
447: "<td>".$directory_count."</td>".
448: "</tr>".
449: "<tr><td>Symbolic links</td>".
450: "<td>".$link_count."</td>".
451: "</tr>".
452: "</table>".
453: "<table border='1' cellpadding='5'>".
454: "<caption>File Category Count</caption>".
455: "<tr><th>Icon</th><th>Name</th><th>Number of Occurrences</th>".
456: "<th>Number of Incorrect Counts</th>".
457: "</tr>".
458: join("\n",(map {"<tr><td><img src='$fab{$_}.gif' ".
459: "alt='$_ icon' /></td>".
460: "<td>$_</td><td>$categorycount{$_}</td>".
461: "<td><!-- POSTEVALINLINE $_ --></td></tr>"}
462: @categorynamelist)).
463: "</table>".
464: "</body></html>\n";
465:
466: }
467: if ($mode eq 'install') {
468: return '';
469: }
470: }
471:
472: # ----------------------- Take in string to parse and the separation expression
473: sub extract_array {
474: my ($stringtoparse,$sepexp) = @_;
475: my @a=split(/$sepexp/,$stringtoparse);
476: return \@a;
477: }
478:
479: # --------------------------------------------------------- Format lpml section
480: sub format_lpml {
481: my (@tokeninfo)=@_;
482: my $date=`date`; chop $date;
483: if ($mode eq 'html') {
484: $lpml=<<END;
485: <html>
486: <head>
487: <title>LPML Description Page
488: (dist=$dist, categorytype=$categorytype, $date)</title>
489: </head>
490: <body>
491: END
492: $lpml .= "<br /><font size='+2'>LPML Description Page (dist=$dist, ".
493: "categorytype=$categorytype, $date)".
494: "</font>";
495: $lpml .=<<END;
496: <ul>
497: <li><a href='#about'>About this file</a></li>
498: <li><a href='#ownperms'>File Type Ownership and Permissions
499: Descriptions</a></li>
500: <li><a href='#package'>Software Package Description</a></li>
501: <li><a href='#directories'>Directory Structure</a></li>
502: <li><a href='#files'>Files</a></li>
503: <li><a href='#summary'>Summary of Source Repository</a></li>
504: </ul>
505: END
506: $lpml .=<<END;
507: <br /> <br /><a name='about' />
508: <font size='+2'>About this file</font>
509: <p>
510: This file is generated dynamically by <tt>lpml_parse.pl</tt> as
511: part of a development compilation process.</p>
512: <p>LPML written by Scott Harrison (harris41\@msu.edu).
513: </p>
514: END
515: }
516: elsif ($mode eq 'text') {
517: $lpml = "LPML Description Page (dist=$dist, $date)";
518: $lpml .=<<END;
519:
520: * About this file
521: * Software Package Description
522: * Directory Structure
523: * File Type Ownership and Permissions
524: * Files
525: END
526: $lpml .=<<END;
527:
528: About this file
529:
530: This file is generated dynamically by lpml_parse.pl as
531: part of a development compilation process. Author: Scott
532: Harrison (harris41\@msu.edu).
533:
534: END
535: }
536: elsif ($mode eq 'install') {
537: print '# LPML install targets. Linux Packaging Markup Language,';
538: print ' by Scott Harrison 2001'."\n";
539: print '# This file was automatically generated on '.`date`;
540: print "\n".$invocation;
541: $lpml .= "\n";
542: }
543: elsif ($mode eq 'configinstall') {
544: print '# LPML configuration file targets (configinstall).'."\n";
545: print '# Linux Packaging Markup Language,';
546: print ' by Scott Harrison 2001'."\n";
547: print '# This file was automatically generated on '.`date`;
548: print "\n".$invocation;
549: $lpml .= "\n";
550: }
551: elsif ($mode eq 'build') {
552: $lpml = "# LPML build targets. Linux Packaging Markup Language,";
553: $lpml .= ' by Scott Harrison 2001'."\n";
554: $lpml .= '# This file was automatically generated on '.`date`;
555: $lpml .= "\n".$invocation;
556: $lpml .= "\n";
557: }
558: else {
559: return '';
560: }
561: }
562: # --------------------------------------------------- Format targetroot section
563: sub format_targetroot {
564: my $text=&trim($parser->get_text('/targetroot'));
565: $text=$targetroot if $targetroot;
566: $parser->get_tag('/targetroot');
567: if ($mode eq 'html') {
568: return $targetroot="\n<br />TARGETROOT: $text";
569: }
570: elsif ($mode eq 'install' or $mode eq 'build' or
571: $mode eq 'configinstall') {
572: return '# TARGET INSTALL LOCATION is "'.$targetroot."\"\n";
573: }
574: else {
575: return '';
576: }
577: }
578: # --------------------------------------------------- Format sourceroot section
579: sub format_sourceroot {
580: my $text=&trim($parser->get_text('/sourceroot'));
581: $text=$sourceroot if $sourceroot;
582: $parser->get_tag('/sourceroot');
583: if ($mode eq 'html') {
584: return $sourceroot="\n<br />SOURCEROOT: $text";
585: }
586: elsif ($mode eq 'install' or $mode eq 'build' or
587: $mode eq 'configinstall') {
588: return '# SOURCE CODE LOCATION IS "'.$sourceroot."\"\n";;
589: }
590: else {
591: return '';
592: }
593: }
594: # --------------------------------------------------- Format categories section
595: sub format_categories {
596: my $text=&trim($parser->get_text('/categories'));
597: $parser->get_tag('/categories');
598: if ($mode eq 'html') {
599: return $categories="\n<br /> <br />".
600: "\n<a name='ownperms'>".
601: "\n<font size='+2'>File Type Ownership and Permissions".
602: " Descriptions</font>".
603: "\n<p>This table shows what permissions and ownership settings ".
604: "correspond to each category.</p>".
605: "\n<table border='1' cellpadding='5' width='60%'>\n".
606: "<tr>".
607: "<th align='left' bgcolor='#ffffff'>Icon</th>".
608: "<th align='left' bgcolor='#ffffff'>Category Name</th>".
609: "<th align='left' bgcolor='#ffffff'>Permissions ".
610: "($categorytype)</th>".
611: "</tr>".
612: "\n$text\n".
613: "</table>\n";
614: }
615: elsif ($mode eq 'text') {
616: return $categories="\n".
617: "\nFile Type Ownership and Permissions".
618: " Descriptions".
619: "\n$text".
620: "\n";
621: }
622: else {
623: return '';
624: }
625: }
626: # --------------------------------------------------- Format categories section
627: sub format_category {
628: my (@tokeninfo)=@_;
629: $category_att_name=$tokeninfo[2]->{'name'};
630: $category_att_type=$tokeninfo[2]->{'type'};
631: $abbreviation=''; $chmod='';$chown='';
632: $parser->get_text('/category');
633: $parser->get_tag('/category');
634: $fab{$category_att_name}=$abbreviation;
635: if ($mode eq 'html') {
636: if ($category_att_type eq $categorytype) {
637: push @categorynamelist,$category_att_name;
638: $categoryhash{$category_att_name}="$chmod $chown";
639: return $category="<tr>".
640: "<td><img src='$abbreviation.gif' ".
641: "alt='${category_att_name}' /></td>\n".
642: "<td>${category_att_name}</td>\n".
643: "<td>$chmod $chown</td>\n".
644: "</tr>".
645: "\n";
646: # return $category="\n<br />CATEGORY $category_att_name ".
647: # "$category_att_type $chmod $chown";
648: }
649: }
650: else {
651: if ($category_att_type eq $categorytype) {
652: my ($user,$group)=split(/\:/,$chown);
653: $categoryhash{$category_att_name}='-o '.$user.' -g '.$group.
654: ' -m '.$chmod;
655: $categoryhash{"chmod.".$category_att_name}=$chmod;
656: $categoryhash{"chown.".$category_att_name}=$chown;
657: }
658: return '';
659: }
660: }
661: # --------------------------------------------------- Format categories section
662: sub format_abbreviation {
663: my @tokeninfo=@_;
664: $abbreviation='';
665: my $text=&trim($parser->get_text('/abbreviation'));
666: if ($text) {
667: $parser->get_tag('/abbreviation');
668: $abbreviation=$text;
669: }
670: return '';
671: }
672: # -------------------------------------------------------- Format chown section
673: sub format_chown {
674: my @tokeninfo=@_;
675: $chown='';
676: my $text=&trim($parser->get_text('/chown'));
677: if ($text) {
678: $parser->get_tag('/chown');
679: $chown=$text;
680: }
681: return '';
682: }
683: # -------------------------------------------------------- Format chmod section
684: sub format_chmod {
685: my @tokeninfo=@_;
686: $chmod='';
687: my $text=&trim($parser->get_text('/chmod'));
688: if ($text) {
689: $parser->get_tag('/chmod');
690: $chmod=$text;
691: }
692: return '';
693: }
694: # ---------------------------------------------------------- Format rpm section
695: sub format_rpm {
696: my $text=&trim($parser->get_text('/rpm'));
697: $parser->get_tag('/rpm');
698: if ($mode eq 'html') {
699: return $rpm=<<END;
700: <br /> <br />
701: <a name='package' />
702: <font size='+2'>Software Package Description</font>
703: <p>
704: <table bgcolor='#ffffff' border='0' cellpadding='10' cellspacing='0'>
705: <tr><td><pre>
706: $text
707: </pre></td></tr>
708: </table>
709: END
710: }
711: elsif ($mode eq 'make_rpm') {
712: return $text;
713: }
714: elsif ($mode eq 'text') {
715: return $rpm=<<END;
716: Software Package Description
717:
718: $text
719: END
720: }
721: else {
722: return '';
723: }
724: }
725: # --------------------------------------------------- Format rpmSummary section
726: sub format_rpmSummary {
727: my $text=&trim($parser->get_text('/rpmSummary'));
728: $parser->get_tag('/rpmSummary');
729: if ($mode eq 'html') {
730: return $rpmSummary="\nSummary : $text";
731: }
732: elsif ($mode eq 'text') {
733: return $rpmSummary="\nSummary : $text";
734: }
735: elsif ($mode eq 'make_rpm') {
736: return <<END;
737: <summary>$text</summary>
738: END
739: }
740: else {
741: return '';
742: }
743: }
744: # ------------------------------------------------------ Format rpmName section
745: sub format_rpmName {
746: my $text=&trim($parser->get_text('/rpmName'));
747: $parser->get_tag('/rpmName');
748: if ($mode eq 'html') {
749: return $rpmName="\nName : $text";
750: }
751: elsif ($mode eq 'text') {
752: return $rpmName="\nName : $text";
753: }
754: elsif ($mode eq 'make_rpm') {
755: return <<END;
756: <name>$text</name>
757: END
758: }
759: else {
760: return '';
761: }
762: }
763: # --------------------------------------------------- Format rpmVersion section
764: sub format_rpmVersion {
765: my $text=$parser->get_text('/rpmVersion');
766: $parser->get_tag('/rpmVersion');
767: if ($mode eq 'html') {
768: return $rpmVersion="\nVersion : $text";
769: }
770: elsif ($mode eq 'text') {
771: return $rpmVersion="\nVersion : $text";
772: }
773: else {
774: return '';
775: }
776: }
777: # --------------------------------------------------- Format rpmRelease section
778: sub format_rpmRelease {
779: my $text=$parser->get_text('/rpmRelease');
780: $parser->get_tag('/rpmRelease');
781: if ($mode eq 'html') {
782: return $rpmRelease="\nRelease : $text";
783: }
784: elsif ($mode eq 'text') {
785: return $rpmRelease="\nRelease : $text";
786: }
787: else {
788: return '';
789: }
790: }
791: # ---------------------------------------------------- Format rpmVendor section
792: sub format_rpmVendor {
793: my $text=$parser->get_text('/rpmVendor');
794: $parser->get_tag('/rpmVendor');
795: if ($mode eq 'html') {
796: return $rpmVendor="\nVendor : $text";
797: }
798: elsif ($mode eq 'text') {
799: return $rpmVendor="\nVendor : $text";
800: }
801: elsif ($mode eq 'make_rpm') {
802: return <<END;
803: <vendor>$text</vendor>
804: END
805: }
806: else {
807: return '';
808: }
809: }
810: # ------------------------------------------------- Format rpmBuildRoot section
811: sub format_rpmBuildRoot {
812: my $text=$parser->get_text('/rpmBuildRoot');
813: $parser->get_tag('/rpmBuildRoot');
814: if ($mode eq 'html') {
815: return $rpmBuildRoot="\nBuild Root : $text";
816: }
817: elsif ($mode eq 'text') {
818: return $rpmBuildRoot="\nBuild Root : $text";
819: }
820: else {
821: return '';
822: }
823: }
824: # ------------------------------------------------- Format rpmCopyright section
825: sub format_rpmCopyright {
826: my $text=$parser->get_text('/rpmCopyright');
827: $parser->get_tag('/rpmCopyright');
828: if ($mode eq 'html') {
829: return $rpmCopyright="\nLicense : $text";
830: }
831: elsif ($mode eq 'text') {
832: return $rpmCopyright="\nLicense : $text";
833: }
834: elsif ($mode eq 'make_rpm') {
835: return <<END;
836: <copyright>$text</copyright>
837: END
838: }
839: else {
840: return '';
841: }
842: }
843: # ----------------------------------------------------- Format rpmGroup section
844: sub format_rpmGroup {
845: my $text=$parser->get_text('/rpmGroup');
846: $parser->get_tag('/rpmGroup');
847: if ($mode eq 'html') {
848: return $rpmGroup="\nGroup : $text";
849: }
850: elsif ($mode eq 'text') {
851: return $rpmGroup="\nGroup : $text";
852: }
853: elsif ($mode eq 'make_rpm') {
854: return <<END;
855: <group>Utilities/System</group>
856: END
857: }
858: else {
859: return '';
860: }
861: }
862: # ---------------------------------------------------- Format rpmSource section
863: sub format_rpmSource {
864: my $text=$parser->get_text('/rpmSource');
865: $parser->get_tag('/rpmSource');
866: if ($mode eq 'html') {
867: return $rpmSource="\nSource : $text";
868: }
869: elsif ($mode eq 'text') {
870: return $rpmSource="\nSource : $text";
871: }
872: else {
873: return '';
874: }
875: }
876: # ----------------------------------------------- Format rpmAutoReqProv section
877: sub format_rpmAutoReqProv {
878: my $text=$parser->get_text('/rpmAutoReqProv');
879: $parser->get_tag('/rpmAutoReqProv');
880: if ($mode eq 'html') {
881: return $rpmAutoReqProv="\nAutoReqProv : $text";
882: }
883: elsif ($mode eq 'text') {
884: return $rpmAutoReqProv="\nAutoReqProv : $text";
885: }
886: elsif ($mode eq 'make_rpm') {
887: return <<END;
888: <AutoReqProv>$text</AutoReqProv>
889: END
890: }
891: else {
892: return '';
893: }
894: }
895: # ----------------------------------------------- Format rpmdescription section
896: sub format_rpmdescription {
897: my $text=$parser->get_text('/rpmdescription');
898: $parser->get_tag('/rpmdescription');
899: if ($mode eq 'html') {
900: $text=~s/\n//g;
901: $text=~s/\\n/\n/g;
902: return $rpmdescription="\nDescription : $text";
903: }
904: elsif ($mode eq 'text') {
905: $text=~s/\n//g;
906: $text=~s/\\n/\n/g;
907: return $rpmdescription="\nDescription : $text";
908: }
909: elsif ($mode eq 'make_rpm') {
910: $text=~s/\n//g;
911: $text=~s/\\n/\n/g;
912: return <<END;
913: <description>$text</description>
914: END
915: }
916: else {
917: return '';
918: }
919: }
920: # ------------------------------------------------------- Format rpmpre section
921: sub format_rpmpre {
922: my $text=$parser->get_text('/rpmpre');
923: $parser->get_tag('/rpmpre');
924: if ($mode eq 'html') {
925: # return $rpmpre="\n<br />RPMPRE $text";
926: return '';
927: }
928: elsif ($mode eq 'make_rpm') {
929: return <<END;
930: <pre>$text</pre>
931: END
932: }
933: else {
934: return '';
935: }
936: }
937: # -------------------------------------------------- Format requires section
938: sub format_rpmRequires {
939: my @tokeninfo=@_;
940: my $aref;
941: my $text;
942: if ($mode eq 'make_rpm') {
943: while ($aref=$parser->get_token()) {
944: if ($aref->[0] eq 'E' && $aref->[1] eq 'rpmRequires') {
945: last;
946: }
947: elsif ($aref->[0] eq 'S') {
948: $text.=$aref->[4];
949: }
950: elsif ($aref->[0] eq 'E') {
951: $text.=$aref->[2];
952: }
953: else {
954: $text.=$aref->[1];
955: }
956: }
957: }
958: else {
959: $parser->get_tag('/rpmRequires');
960: return '';
961: }
962: return '<rpmRequires>'.$text.'</rpmRequires>';
963: }
964: # -------------------------------------------------- Format directories section
965: sub format_directories {
966: my $text=$parser->get_text('/directories');
967: $parser->get_tag('/directories');
968: if ($mode eq 'html') {
969: $text=~s/\[\{\{\{\{\{DPATHLENGTH\}\}\}\}\}\]/$dpathlength/g;
970: return $directories="\n<br /> <br />".
971: "<a name='directories' />".
972: "<font size='+2'>Directory Structure</font>".
973: "\n<br /> <br />".
974: "<table border='1' cellpadding='3' cellspacing='0'>\n".
975: "<tr><th bgcolor='#ffffff'>Category</th>".
976: "<th bgcolor='#ffffff'>Status</th>\n".
977: "<th bgcolor='#ffffff'>Expected Permissions & Ownership</th>\n".
978: "<th bgcolor='#ffffff' colspan='$dpathlength'>Target Directory ".
979: "Path</th></tr>\n".
980: "\n$text\n</table><br />"."\n";
981: }
982: elsif ($mode eq 'text') {
983: return $directories="\nDirectory Structure\n$text\n".
984: "\n";
985: }
986: elsif ($mode eq 'install') {
987: return "\n".'directories:'."\n".$text;
988: }
989: elsif ($mode eq 'rpm_file_list') {
990: return $text;
991: }
992: elsif ($mode eq 'uninstall_shell_commands') {
993: return $text;
994: }
995: else {
996: return '';
997: }
998: }
999: # ---------------------------------------------------- Format directory section
1000: sub format_directory {
1001: my (@tokeninfo)=@_;
1002: $targetdir='';$categoryname='';$description='';$protectionlevel='';
1003: $parser->get_text('/directory');
1004: $parser->get_tag('/directory');
1005: $directory_count++;
1006: $categorycount{$categoryname}++;
1007: if ($mode eq 'html') {
1008: my @a;
1009: @a=($targetdir=~/\//g);
1010: my $d=scalar(@a)+1;
1011: $dpathlength=$d if $d>$dpathlength;
1012: my $thtml=$targetdir;
1013: $thtml=~s/\//\<\/td\>\<td bgcolor='#ffffff'\>/g;
1014: my ($chmod,$chown)=split(/\s/,$categoryhash{$categoryname});
1015: return $directory="\n<tr><td rowspan='2' bgcolor='#ffffff'>".
1016: "$categoryname</td>".
1017: "<td rowspan='2' bgcolor='#ffffff'><!-- POSTEVAL [$categoryname] ".
1018: "verify.pl directory /$targetdir $categoryhash{$categoryname} -->".
1019: " </td>".
1020: "<td rowspan='2' bgcolor='#ffffff'>$chmod<br />$chown</td>".
1021: "<td bgcolor='#ffffff'>$thtml</td></tr>".
1022: "<tr><td bgcolor='#ffffff' colspan='[{{{{{DPATHLENGTH}}}}}]'>".
1023: "$description</td></tr>";
1024: }
1025: if ($mode eq 'text') {
1026: return $directory="\nDIRECTORY $targetdir $categoryname ".
1027: "$description";
1028: }
1029: elsif ($mode eq 'install') {
1030: return "\t".'install '.$categoryhash{$categoryname}.' -d '.
1031: $targetroot.'/'.$targetdir."\n";
1032: }
1033: elsif ($mode eq 'rpm_file_list') {
1034: return $targetroot.'/'.$targetdir."\n";
1035: }
1036: elsif ($mode eq 'uninstall_shell_commands') {
1037: if ($protectionlevel eq 'never_delete') {
1038: return 'echo "LEAVING BEHIND '.$targetroot.'/'.$targetdir.
1039: ' which may have important data worth saving"'."\n";
1040: }
1041: elsif ($protectionlevel eq 'weak_delete') {
1042: if ($targetdir!~/\w/) {
1043: die("targetdir=\"$targetdir\"! NEVER EVER DELETE THE WHOLE ".
1044: "FILESYSTEM"."\n");
1045: }
1046: return 'rm -Rvf -i '.$targetroot.'/'.$targetdir."\n";
1047: }
1048: elsif ($protectionlevel =~ /never/) {
1049: die("CONFUSING PROTECTION LEVEL \"$protectionlevel\" FOUND ".
1050: "FOR directory $targetdir"."\n");
1051: }
1052: elsif ($protectionlevel !~
1053: /^never_delete|weak_delete|modest_delete|strong_delete|absolute_delete$/) {
1054: die("CONFUSING OR MISSING PROTECTION LEVEL \"$protectionlevel\" ".
1055: "FOUND FOR directory $targetdir\n");
1056: }
1057: else {
1058: if ($targetdir!~/\w/) {
1059: die("targetdir=\"$targetdir\"! NEVER EVER DELETE THE WHOLE ".
1060: "FILESYSTEM"."\n");
1061: }
1062: return 'rm -Rvf '.$targetroot.'/'.$targetdir.
1063: "| grep 'removed directory'"."\n";
1064: }
1065: }
1066: else {
1067: return '';
1068: }
1069: }
1070: # ---------------------------------------------------- Format targetdir section
1071: sub format_targetdir {
1072: my @tokeninfo=@_;
1073: $targetdir='';
1074: my $text=&trim($parser->get_text('/targetdir'));
1075: if ($text) {
1076: $parser->get_tag('/targetdir');
1077: $targetdir=$text;
1078: }
1079: return '';
1080: }
1081: # ---------------------------------------------- Format protectionlevel section
1082: sub format_protectionlevel {
1083: my @tokeninfo=@_;
1084: $protectionlevel='';
1085: my $text=&trim($parser->get_text('/protectionlevel'));
1086: if ($text) {
1087: $parser->get_tag('/protectionlevel');
1088: $protectionlevel=$text;
1089: }
1090: return '';
1091: }
1092: # ------------------------------------------------- Format categoryname section
1093: sub format_categoryname {
1094: my @tokeninfo=@_;
1095: $categoryname='';
1096: my $text=&trim($parser->get_text('/categoryname'));
1097: if ($text) {
1098: $parser->get_tag('/categoryname');
1099: $categoryname=$text;
1100: }
1101: return '';
1102: }
1103: # -------------------------------------------------- Format description section
1104: sub format_description {
1105: my @tokeninfo=@_;
1106: $description='';
1107: my $text=&htmlsafe(&trim($parser->get_text('/description')));
1108: if ($text) {
1109: $parser->get_tag('/description');
1110: $description=$text;
1111: }
1112: return '';
1113: }
1114: # -------------------------------------------------------- Format files section
1115: sub format_files {
1116: my $text=$parser->get_text('/files');
1117: $parser->get_tag('/files');
1118: if ($mode eq 'MANIFEST') {
1119: return $text;
1120: }
1121: elsif ($mode eq 'html') {
1122: return $directories="\n<br /> <br />".
1123: "<a name='files' />".
1124: "<font size='+2'>Files</font><br /> <br />".
1125: "<p>All source and target locations are relative to the ".
1126: "sourceroot and targetroot values at the beginning of this ".
1127: "document.</p>".
1128: "\n<table border='1' cellpadding='5'>".
1129: "<tr><th>Status</th><th colspan='2'>Category</th>".
1130: "<th>Name/Location</th>".
1131: "<th>Description</th><th>Notes</th></tr>".
1132: "$text</table>\n".
1133: "\n";
1134: }
1135: elsif ($mode eq 'text') {
1136: return $directories="\n".
1137: "File and Directory Structure".
1138: "\n$text\n".
1139: "\n";
1140: }
1141: elsif ($mode eq 'install') {
1142: return "\n".'files:'."\n".$text.
1143: "\n".'links:'."\n".join('',@links);
1144: }
1145: elsif ($mode eq 'configinstall') {
1146: return "\n".'configfiles: '.
1147: join(' ',@configall).
1148: "\n\n".$text.
1149: "\n\nalwaysrun:\n\n";
1150: }
1151: elsif ($mode eq 'build') {
1152: my $binfo;
1153: my $tword;
1154: my $command2;
1155: my @deps;
1156: foreach my $bi (@buildinfo) {
1157: my ($target,$source,$command,$trigger,@deps)=split(/\;/,$bi);
1158: $tword=''; $tword=' alwaysrun' if $trigger eq 'always run';
1159: if ($command!~/\s/) {
1160: $command=~s/\/([^\/]*)$//;
1161: $command2="cd $command; $shell ./$1;\\";
1162: }
1163: else {
1164: $command=~s/(.*?\/)([^\/]+\s+.*)$/$1/;
1165: $command2="cd $command; $shell ./$2;\\";
1166: }
1167: my $depstring;
1168: my $depstring2="\t\t\@echo '';\\\n";
1169: my $olddep;
1170: foreach my $dep (@deps) {
1171: unless ($olddep) {
1172: $olddep=$deps[$#deps];
1173: }
1174: $depstring.="\telif !(test -r $command/$dep);\\\n";
1175: $depstring.="\t\tthen echo ".
1176: "\"**** WARNING **** missing the file: ".
1177: "$command/$dep\"$logcmd;\\\n";
1178: $depstring.="\t\ttest -e $source || test -e $target || echo ".
1179: "'**** ERROR **** neither source=$source nor target=".
1180: "$target exist and they cannot be built'$logcmd;\\\n";
1181: $depstring.="\t\tmake -f Makefile.build ${source}___DEPS;\\\n";
1182: if ($olddep) {
1183: $depstring2.="\t\tECODE=0;\\\n";
1184: $depstring2.="\t\t! test -e $source && test -r $command/$olddep &&".
1185: " { perl filecompare.pl -b2 $command/$olddep $target || ECODE=\$\$?; } && { [ \$\$ECODE != \"2\" ] || echo \"**** WARNING **** dependency $command/$olddep is newer than target file $target; SOMETHING MAY BE WRONG\"$logcmd; };\\\n";
1186: }
1187: $olddep=$dep;
1188: }
1189: $binfo.="$source: $tword\n".
1190: "\t\@if !(echo \"\");\\\n\t\tthen echo ".
1191: "\"**** WARNING **** Strange shell. ".
1192: "Check your path settings.\"$logcmd;\\\n".
1193: $depstring.
1194: "\telse \\\n\t\t$command2\n\tfi\n\n";
1195: $binfo.="${source}___DEPS:\n".$depstring2."\t\tECODE=0;\n\n";
1196: }
1197: return 'all: '.join(' ',@buildall)."\n\n".
1198: $text.
1199: $binfo."\n".
1200: "alwaysrun:\n\n";
1201: }
1202: elsif ($mode eq 'rpm_file_list') {
1203: return $text;
1204: }
1205: else {
1206: return '';
1207: }
1208: }
1209: # ---------------------------------------------------- Format fileglobs section
1210: sub format_fileglobs {
1211:
1212: }
1213: # -------------------------------------------------------- Format links section
1214: # deprecated.. currently <link></link>'s are included in <files></files>
1215: sub format_links {
1216: my $text=$parser->get_text('/links');
1217: $parser->get_tag('/links');
1218: if ($mode eq 'html') {
1219: return $links="\n<br />BEGIN LINKS\n$text\n<br />END LINKS\n";
1220: }
1221: elsif ($mode eq 'install') {
1222: return "\n".'links:'."\n\t".$text;
1223: }
1224: else {
1225: return '';
1226: }
1227: }
1228: # --------------------------------------------------------- Format file section
1229: sub format_file {
1230: my @tokeninfo=@_;
1231: $file=''; $source=''; $target=''; $categoryname=''; $description='';
1232: $note=''; $build=''; $status=''; $dependencies=''; $installscript='';
1233: my $text=&trim($parser->get_text('/file'));
1234: my $buildtest;
1235: $file_count++;
1236: $categorycount{$categoryname}++;
1237: if ($source) {
1238: $parser->get_tag('/file');
1239: if ($mode eq 'MANIFEST') {
1240: my $command=$build;
1241: if ($command!~/\s/) {
1242: $command=~s/\/([^\/]*)$//;
1243: }
1244: else {
1245: $command=~s/(.*?\/)([^\/]+\s+.*)$/$1/;
1246: }
1247: $command=~s/^$sourceroot\///;
1248: my (@deps)=split(/\;/,$dependencies);
1249: my $retval=join("\n",($source,
1250: (map {"$command$_"} @deps)));
1251: if ($tokeninfo[2]{type} eq 'private') {
1252: return "\n";
1253: }
1254: return $retval."\n";
1255: }
1256: elsif ($mode eq 'html') {
1257: return ($file="\n<!-- FILESORT:$target -->".
1258: "<tr>".
1259: "<td><!-- POSTEVAL [$categoryname] verify.pl file '$sourcerootarg' ".
1260: "'$targetrootarg' ".
1261: "'$source' '$target' ".
1262: "$categoryhash{$categoryname} --> </td><td>".
1263: "<img src='$fab{$categoryname}.gif' ".
1264: "alt='$categoryname icon' /></td>".
1265: "<td>$categoryname<br /><font size='-1'>".
1266: $categoryhash{$categoryname}."</font></td>".
1267: "<td>SOURCE: $source<br />TARGET: $target</td>".
1268: "<td>$description</td>".
1269: "<td>$note</td>".
1270: "</tr>");
1271: # return ($file="\n<br />BEGIN FILE\n".
1272: # "$source $target $categoryname $description $note " .
1273: # "$build $status $dependencies" .
1274: # "\nEND FILE");
1275: }
1276: elsif (($mode eq 'install') && (($categoryname ne 'conf') &&
1277: ($categoryname ne 'www conf'))) {
1278: if ($build) {
1279: my $bi=$sourceroot.'/'.$source.';'.$build.';'.
1280: $dependencies;
1281: my ($source2,$command,$trigger,@deps)=split(/\;/,$bi);
1282: $tword=''; $tword=' alwaysrun' if $trigger eq 'always run';
1283: $command=~s/\/([^\/]*)$//;
1284: $command2="cd $command; $shell ./$1;\\";
1285: my $depstring;
1286: foreach my $dep (@deps) {
1287: $depstring.=<<END;
1288: ECODE=0; DEP=''; \\
1289: test -e $dep || (echo '**** WARNING **** cannot evaluate status of dependency $dep (for building ${sourceroot}/${source} with)'$logcmd); DEP="1"; \\
1290: [ -n DEP ] && { perl filecompare.pl -b2 $dep ${targetroot}/${target} || ECODE=\$\$?; } || DEP="1"; \\
1291: case "\$\$ECODE" in \\
1292: 2) echo "**** WARNING **** dependency $dep is newer than target file ${targetroot}/${target}; you may want to run make build"$logcmd;; \\
1293: esac; \\
1294: END
1295: }
1296: chomp $depstring;
1297: $buildtest=<<END;
1298: \@if !(test -e "${sourceroot}/${source}") && !(test -e "${targetroot}/${target}"); then \\
1299: echo "**** ERROR **** ${sourceroot}/${source} is missing and is also not present at target location ${targetroot}/${target}; you must run make build"$logcmd; exit; \\
1300: END
1301: $buildtest.=<<END if $depstring;
1302: elif !(test -e "${sourceroot}/${source}"); then \\
1303: $depstring
1304: END
1305: $buildtest.=<<END;
1306: fi
1307: END
1308: }
1309: if ($installscript) {
1310: my $dir = $sourceroot.'/'.$source;
1311: $dir =~ s|/([^/]*)$||;
1312: my $result ="
1313: $buildtest cd $dir ; $shell $installscript";
1314: if ($categoryname
1315: && exists($categoryhash{"chmod.$categoryname"}) ) {
1316: $result .="\\\n";
1317: $result .=<<"END"
1318: chmod -R $categoryhash{"chmod.$categoryname"} ${targetroot}/${target} \\
1319: chown -R $categoryhash{"chown.$categoryname"} ${targetroot}/${target}
1320: END
1321: } else {
1322: $result.="\n";
1323: }
1324: return $result;
1325: }
1326: my $bflag='-b1';
1327: $bflag='-b3' if $dependencies or $buildlink;
1328: return <<END;
1329: $buildtest \@if !(test -e "${sourceroot}/${source}") && !(test -e "${targetroot}/${target}"); then \\
1330: echo "**** ERROR **** CVS source file does not exist: ${sourceroot}/${source} and neither does target: ${targetroot}/${target}"$logcmd; \\
1331: elif !(test -e "${sourceroot}/${source}"); then \\
1332: echo "**** WARNING **** CVS source file does not exist: ${sourceroot}/${source}"$logcmd; \\
1333: perl verifymodown.pl ${targetroot}/${target} "$categoryhash{$categoryname}"$logcmd; \\
1334: else \\
1335: ECODE=0; \\
1336: perl filecompare.pl $bflag ${sourceroot}/${source} ${targetroot}/${target} || ECODE=\$\$?; \\
1337: case "\$\$ECODE" in \\
1338: 1) echo "${targetroot}/${target} is unchanged";; \\
1339: 2) echo "**** WARNING **** target file ${targetroot}/${target} is newer than CVS source; saving current (old) target file to ${targetroot}/${target}.lpmlsave and then overwriting"$logcmd && install -o www -g www -m 0600 ${targetroot}/${target} ${targetroot}/${target}.lpmlsave && install $categoryhash{$categoryname} ${sourceroot}/${source} ${targetroot}/${target};; \\
1340: 0) echo "install $categoryhash{$categoryname} ${sourceroot}/${source} ${targetroot}/${target}" && install $categoryhash{$categoryname} ${sourceroot}/${source} ${targetroot}/${target};; \\
1341: esac; \\
1342: perl verifymodown.pl ${targetroot}/${target} "$categoryhash{$categoryname}"$logcmd; \\
1343: fi
1344: END
1345: }
1346: elsif ($mode eq 'configinstall' && (($categoryname eq 'conf') ||
1347: ($categoryname eq 'www conf'))) {
1348: push @configall,$targetroot.'/'.$target;
1349: return $targetroot.'/'.$target.': alwaysrun'."\n".
1350: "\t".'@# Compare source with target and intelligently respond'.
1351: "\n\t\n\t\n".
1352:
1353:
1354: "\t".'@echo -n ""; ECODE=0 && { perl filecompare.pl -b4 \\'.
1355: "\n\t".$sourceroot.'/'.$source." \\\n\t".
1356: $targetroot.'/'.$target." \\\n\t".
1357: ' || ECODE=$$?; } && '."\\\n\t"."\\\n\t"."\\\n\t".
1358:
1359:
1360: '{ [ $$ECODE != "2" ] || '." \\\n\t".'(install '.
1361: $categoryhash{$categoryname}." \\\n\t\t".
1362: $sourceroot.'/'.$source." \\\n\t\t".
1363: $targetroot.'/'.$target.'.lpmlnew'." \\\n\t\t".
1364: ' && echo "**** NOTE: CONFIGURATION FILE CHANGE ****"'.
1365: " \\\n\t\t".$logcmd.' && '." \\\n\t\t"."echo -n \"".
1366: 'You likely need to compare contents of "'."\\\n\t\t\t".
1367: '&& echo -n "'.$targetroot.'/'.$target.'"'."\\\n\t\t".
1368: '&& echo -n " with the new "'."\\\n\t\t\t".
1369: '&& echo "'.$targetroot.'/'.$target.'.lpmlnew"'."\\\n\t\t".
1370: "$logcmd); } && "." \\\n\t"."\\\n\t"."\\\n\t".
1371:
1372:
1373: '{ [ $$ECODE != "3" ] || '."\\\n\t".
1374: '(install '.
1375: $categoryhash{$categoryname}."\\\n\t\t".
1376: $sourceroot.'/'.$source."\\\n\t\t".
1377: $targetroot.'/'.$target."\\\n\t\t".
1378: ' && echo "**** WARNING: NEW CONFIGURATION FILE ADDED ****"'.
1379: "\\\n\t\t".$logcmd.' && '."\\\n\t\t".
1380: 'echo -n "'.
1381: 'You likely need to review the contents of "'."\\\n\t\t\t".
1382: '&& echo -n "'.
1383: $targetroot.'/'.$target.'"'."\\\n\t\t\t".
1384: '&& echo -n "'.
1385: ' to make sure its "'."\\\n\t\t".
1386: '&& echo "'.
1387: 'settings are compatible with your overall system"'."\\\n\t\t".
1388: "$logcmd); } && "."\\\n\t"."\\\n\t"."\\\n\t".
1389:
1390:
1391: '{ [ $$ECODE != "1" ] || ('."\\\n\t\t".
1392: 'echo "**** ERROR ****"'.$logcmd.' && '."\\\n\t\t".'echo -n "'.
1393: 'Configuration source file does not exist "'."\\\n\t\t".
1394: '&& echo -n "'.$sourceroot.'/'.$source.'"'."\\\n\t\t".
1395: "$logcmd); } && "."\\\n\t\t".
1396: "perl verifymodown.pl ${targetroot}/${target} "."\\\n\t\t\t".
1397: "\"$categoryhash{$categoryname}\""."\\\n\t\t\t".
1398: "$logcmd;\n\n";
1399: }
1400: elsif ($mode eq 'build' && $build) {
1401: push @buildall,$sourceroot.'/'.$source;
1402: push @buildinfo,$targetroot.'/'.$target.';'.$sourceroot.'/'.
1403: $source.';'.$build.';'.
1404: $dependencies;
1405: # return '# need to build '.$source.";
1406: }
1407: elsif ($mode eq 'rpm_file_list') {
1408: if ($categoryname eq 'doc') {
1409: return $targetroot.'/'.$target.' # doc'."\n";
1410: }
1411: elsif ($categoryname eq 'conf') {
1412: return $targetroot.'/'.$target.' # config'."\n";
1413: }
1414: else {
1415: return $targetroot.'/'.$target."\n";
1416: }
1417: }
1418: else {
1419: return '';
1420: }
1421: }
1422: return '';
1423: }
1424: # --------------------------------------------------------- Format link section
1425: sub format_link {
1426: my @tokeninfo=@_;
1427: $link=''; $linkto=''; $source=''; $target=''; $categoryname='';
1428: $description=''; $note=''; $build=''; $status=''; $dependencies='';
1429: my $text=&trim($parser->get_text('/link'));
1430: if ($linkto) {
1431: $parser->get_tag('/link');
1432: if ($mode eq 'html') {
1433: my @targets=map {s/^\s*//;s/\s$//;$_} split(/\;/,$target);
1434: $link_count+=scalar(@targets);
1435: foreach my $tgt (@targets) {
1436: $categorycount{$categoryname}++;
1437: push @links,("\n<!-- FILESORT:$tgt -->".
1438: "<tr>".
1439: "<td><!-- POSTEVAL [$categoryname] verify.pl link ".
1440: "'/$targetrootarg$linkto' '/$targetrootarg$tgt' ".
1441: "$categoryhash{$categoryname} --> </td><td>".
1442: "<img src='$fab{$categoryname}.gif' ".
1443: "alt='$categoryname icon' /></td>".
1444: "<td><font size='-1'>$categoryname</font></td>".
1445: "<td>LINKTO: $linkto<br />TARGET: $tgt</td>".
1446: "<td>$description</td>".
1447: "<td>$note</td>".
1448: "</tr>");
1449: # push @links,"\t".'ln -fs /'.$linkto.' /'.$targetroot.$tgt.
1450: # "\n";
1451: }
1452: return join('',@links);
1453: # return ($link="\n<!-- FILESORT:$target -->".
1454: # "<tr>".
1455: # "<td> </td><td><img src='$fab{$categoryname}.gif' ".
1456: # "alt='$categoryname icon' /></td>".
1457: # "<td>$categoryname</td>".
1458: # "<td>LINKTO: $linkto<br />TARGET: $target</td>".
1459: # "<td>$description</td>".
1460: # "<td>$note</td>".
1461: # "</tr>");
1462: # return $link="\n<tr><td colspan='6'>BEGIN LINK\n".
1463: # "$linkto $target $categoryname $description $note " .
1464: # "$build $status $dependencies" .
1465: # "\nEND LINK</td></tr>";
1466: }
1467: elsif ($mode eq 'install') {
1468: my @targets=map {s/^\s*//;s/\s$//;$_} split(/\;/,$target);
1469: foreach my $tgt (@targets) {
1470: push @links,"\t".'ln -fs /'.$linkto.' '.$targetroot.'/'.$tgt.
1471: "\n";
1472: }
1473: # return join('',@links);
1474: return '';
1475: }
1476: elsif ($mode eq 'rpm_file_list') {
1477: my @linklocs;
1478: my @targets=map {s/^\s*//;s/\s$//;$_} split(/\;/,$target);
1479: foreach my $tgt (@targets) {
1480: push @linklocs,''.$targetroot.'/'.$tgt."\n";
1481: }
1482: return join('',@linklocs);
1483: }
1484: else {
1485: return '';
1486: }
1487: }
1488: return '';
1489: }
1490: # ----------------------------------------------------- Format fileglob section
1491: sub format_fileglob {
1492: my @tokeninfo=@_;
1493: $fileglob=''; $glob=''; $sourcedir='';
1494: $targetdir=''; $categoryname=''; $description='';
1495: $note=''; $build=''; $status=''; $dependencies='';
1496: $filenames='';
1497: my $text=&trim($parser->get_text('/fileglob'));
1498: my $filenames2=$filenames;$filenames2=~s/\s//g;
1499: $fileglob_count++;
1500: my @semi=($filenames2=~/(\;)/g);
1501: $fileglobnames_count+=scalar(@semi)+1;
1502: $categorycount{$categoryname}+=scalar(@semi)+1;
1503: if ($sourcedir) {
1504: $parser->get_tag('/fileglob');
1505: if ($mode eq 'MANIFEST') {
1506: return join("\n",(map {"$sourcedir$_"} split(/\;/,$filenames2)))."\n";
1507: }
1508: elsif ($mode eq 'html') {
1509: return $fileglob="\n<tr>".
1510: "<td><!-- POSTEVAL [$categoryname] verify.pl fileglob '$sourcerootarg' ".
1511: "'$targetrootarg' ".
1512: "'$glob' '$sourcedir' '$filenames2' '$targetdir' ".
1513: "$categoryhash{$categoryname} --> </td>".
1514: "<td>"."<img src='$fab{$categoryname}.gif' ".
1515: "alt='$categoryname icon' /></td>".
1516: "<td>$categoryname<br />".
1517: "<font size='-1'>".$categoryhash{$categoryname}."</font></td>".
1518: "<td>SOURCEDIR: $sourcedir<br />".
1519: "TARGETDIR: $targetdir<br />".
1520: "GLOB: $glob<br />".
1521: "FILENAMES: $filenames".
1522: "</td>".
1523: "<td>$description</td>".
1524: "<td>$note</td>".
1525: "</tr>";
1526: # return $fileglob="\n<tr><td colspan='6'>BEGIN FILEGLOB\n".
1527: # "$glob sourcedir $targetdir $categoryname $description $note ".
1528: # "$build $status $dependencies $filenames" .
1529: # "\nEND FILEGLOB</td></tr>";
1530: }
1531: elsif ($mode eq 'install') {
1532: my $eglob=$glob;
1533: if ($glob eq '*') {
1534: $eglob='[^C][^V][^S]'.$glob;
1535: }
1536: return "\t".'install '.
1537: $categoryhash{$categoryname}.' '.
1538: $sourceroot.'/'.$sourcedir.$eglob.' '.
1539: $targetroot.'/'.$targetdir.'.'."\n";
1540: }
1541: elsif ($mode eq 'rpm_file_list') {
1542: my $eglob=$glob;
1543: if ($glob eq '*') {
1544: $eglob='[^C][^V][^S]'.$glob;
1545: }
1546: my $targetdir2=$targetdir;$targetdir2=~s/\/$//;
1547: my @gfiles=map {s/^.*\///;"$targetroot/$targetdir2/$_\n"}
1548: glob("$sourceroot/$sourcedir/$eglob");
1549: return join('',@gfiles);
1550: }
1551: else {
1552: return '';
1553: }
1554: }
1555: return '';
1556: }
1557: # ---------------------------------------------------- Format sourcedir section
1558: sub format_sourcedir {
1559: my @tokeninfo=@_;
1560: $sourcedir='';
1561: my $text=&trim($parser->get_text('/sourcedir'));
1562: if ($text) {
1563: $parser->get_tag('/sourcedir');
1564: $sourcedir=$text;
1565: }
1566: return '';
1567: }
1568: # ------------------------------------------------------- Format target section
1569: sub format_target {
1570: my @tokeninfo=@_;
1571: $target='';
1572: my $text=&trim($parser->get_text('/target'));
1573: if ($text) {
1574: $parser->get_tag('/target');
1575: $target=$text;
1576: }
1577: return '';
1578: }
1579: # ------------------------------------------------------- Format source section
1580: sub format_source {
1581: my @tokeninfo=@_;
1582: $source='';
1583: my $text=&trim($parser->get_text('/source'));
1584: if ($text) {
1585: $parser->get_tag('/source');
1586: $source=$text;
1587: }
1588: return '';
1589: }
1590: # --------------------------------------------------------- Format note section
1591: sub format_note {
1592: my @tokeninfo=@_;
1593: $note='';
1594: # my $text=&trim($parser->get_text('/note'));
1595: my $aref;
1596: my $text;
1597: while ($aref=$parser->get_token()) {
1598: if ($aref->[0] eq 'E' && $aref->[1] eq 'note') {
1599: last;
1600: }
1601: elsif ($aref->[0] eq 'S') {
1602: $text.=$aref->[4];
1603: }
1604: elsif ($aref->[0] eq 'E') {
1605: $text.=$aref->[2];
1606: }
1607: else {
1608: $text.=$aref->[1];
1609: }
1610: }
1611: if ($text) {
1612: # $parser->get_tag('/note');
1613: $note=$text;
1614: }
1615: return '';
1616:
1617: }
1618: # -------------------------------------------------------- Format build section
1619: sub format_build {
1620: my @tokeninfo=@_;
1621: $build='';
1622: my $text=&trim($parser->get_text('/build'));
1623: if ($text) {
1624: $parser->get_tag('/build');
1625: $build=$sourceroot.'/'.$text.';'.$tokeninfo[2]{'trigger'};
1626: $build=~s/([^\\])\\\s+/$1/g; # allow for lines split onto new lines
1627: }
1628: return '';
1629: }
1630: # ------------------------------------------------ Format installscript section
1631: sub format_installscript {
1632: my @tokeninfo=@_;
1633: $installscript= &trim($parser->get_text('/installscript'));
1634: if ($installscript) {
1635: $parser->get_tag('/installscript');
1636: $installscript=~s/([^\\])\\\s+/$1/g; # allow for lines split onto new lines
1637: }
1638: return '';
1639: }
1640: # -------------------------------------------------------- Format build section
1641: sub format_buildlink {
1642: my @tokeninfo=@_;
1643: $buildlink='';
1644: my $text=&trim($parser->get_text('/buildlink'));
1645: if ($text) {
1646: $parser->get_tag('/buildlink');
1647: $buildlink=$sourceroot.'/'.$text;
1648: }
1649: return '';
1650: }
1651: # ------------------------------------------------------- Format status section
1652: sub format_status {
1653: my @tokeninfo=@_;
1654: $status='';
1655: my $text=&trim($parser->get_text('/status'));
1656: if ($text) {
1657: $parser->get_tag('/status');
1658: $status=$text;
1659: }
1660: return '';
1661: }
1662: # ------------------------------------------------- Format dependencies section
1663: sub format_dependencies {
1664: my @tokeninfo=@_;
1665: #$dependencies='';
1666: my $text=&trim($parser->get_text('/dependencies'));
1667: if ($text) {
1668: $parser->get_tag('/dependencies');
1669: $dependencies=join(';',((map {s/^\s*//;s/\s$//;$_} split(/\;/,$text)),$dependencies));
1670: $dependencies=~s/;$//;
1671: }
1672: return '';
1673: }
1674: sub format_privatedependencies {
1675: my @tokeninfo=@_;
1676: #$dependencies='';
1677: my $text=&trim($parser->get_text('/privatedependencies'));
1678: if ($text) {
1679: $parser->get_tag('/privatedependencies');
1680: if ($mode eq 'MANIFEST') { return ''; }
1681: $dependencies=join(';',((map {s/^\s*//;s/\s$//;$_} split(/\;/,$text)),$dependencies));
1682: $dependencies=~s/;$//;
1683: }
1684: return '';
1685: }
1686: # --------------------------------------------------------- Format glob section
1687: sub format_glob {
1688: my @tokeninfo=@_;
1689: $glob='';
1690: my $text=&trim($parser->get_text('/glob'));
1691: if ($text) {
1692: $parser->get_tag('/glob');
1693: $glob=$text;
1694: }
1695: return '';
1696: }
1697: # ---------------------------------------------------- Format filenames section
1698: sub format_filenames {
1699: my @tokeninfo=@_;
1700: my $text=&trim($parser->get_text('/filenames'));
1701: if ($text) {
1702: $parser->get_tag('/filenames');
1703: $filenames=$text;
1704: }
1705: return '';
1706: }
1707: # ----------------------------------------------- Format specialnotices section
1708: sub format_specialnotices {
1709: $parser->get_tag('/specialnotices');
1710: return '';
1711: }
1712: # ------------------------------------------------ Format specialnotice section
1713: sub format_specialnotice {
1714: $parser->get_tag('/specialnotice');
1715: return '';
1716: }
1717: # ------------------------------------------------------- Format linkto section
1718: sub format_linkto {
1719: my @tokeninfo=@_;
1720: my $text=&trim($parser->get_text('/linkto'));
1721: if ($text) {
1722: $parser->get_tag('/linkto');
1723: $linkto=$text;
1724: }
1725: return '';
1726: }
1727: # ------------------------------------- Render less-than and greater-than signs
1728: sub htmlsafe {
1729: my $text=@_[0];
1730: $text =~ s/</</g;
1731: $text =~ s/>/>/g;
1732: return $text;
1733: }
1734: # --------------------------------------- remove starting and ending whitespace
1735: sub trim {
1736: my ($s)=@_; $s=~s/^\s*//; $s=~s/\s*$//; return $s;
1737: }
1738:
1739: # ----------------------------------- POD (plain old documentation, CPAN style)
1740:
1741: =pod
1742:
1743: =head1 NAME
1744:
1745: lpml_parse.pl - This is meant to parse files meeting the lpml document type.
1746:
1747: =head1 SYNOPSIS
1748:
1749: <STDIN> | perl lpml_parse.pl <MODE> <CATEGORY> <DIST> <SOURCE> <TARGET>
1750:
1751: Usage is for the lpml file to come in through standard input.
1752:
1753: =over 4
1754:
1755: =item *
1756:
1757: 1st argument is the mode of parsing.
1758:
1759: =item *
1760:
1761: 2nd argument is the category permissions to use (runtime or development)
1762:
1763: =item *
1764:
1765: 3rd argument is the distribution
1766: (default,redhat6.2,debian2.2,redhat7.1,etc).
1767:
1768: =item *
1769:
1770: 4th argument is to manually specify a sourceroot.
1771:
1772: =item *
1773:
1774: 5th argument is to manually specify a targetroot.
1775:
1776: =back
1777:
1778: Only the 1st argument is mandatory for the program to run.
1779:
1780: Example:
1781:
1782: cat ../../doc/loncapafiles.lpml |\\
1783: perl lpml_parse.pl html runtime default /home/sherbert/loncapa /tmp/install
1784:
1785: =head1 DESCRIPTION
1786:
1787: The general flow of the script is to get command line arguments, run through
1788: the XML document three times, and output according to any desired mode:
1789: install, configinstall, build, rpm, dpkg, htmldoc, textdoc, and status.
1790:
1791: A number of coding decisions are made according to the following principle:
1792: installation software must be stand-alone. Therefore, for instance, I try
1793: not to use the GetOpt::Long module or any other perl modules. (I do however
1794: use HTML::TokeParser.) I also have tried to keep all the MODES of
1795: parsing inside this file. Therefore, format_TAG subroutines are fairly
1796: lengthy with their conditional logic. A more "elegant" solution might
1797: be to dynamically register the parsing mode and subroutines, or maybe even work
1798: with stylesheets. However, in order to make this the installation back-bone
1799: of choice, there are advantages for HAVING EVERYTHING IN ONE FILE.
1800: This way, the LPML installation software does not have to rely on OTHER
1801: installation software (a chicken versus the egg problem). Besides, I would
1802: suggest the modes of parsing are fairly constant: install, configinstall,
1803: build, rpm, dpkg, htmldoc, textdoc, and status.
1804:
1805: Another coding decision is about using a multiple pass-through approach to
1806: parsing the lpml file. This saves memory and makes sure the server will never
1807: be overloaded. During the first pass-through, the script gathers information
1808: specific as to resolving what tags with what 'dist=' attributes are to be used.
1809: During the second pass-through, the script cleans up white-space surrounding
1810: the XML tags, and filters through the tags based on information regarding the
1811: 'dist=' attributes (information gathered in the first pass-through).
1812: The third and final pass-through involves formatting and rendering the XML
1813: into whatever XML mode is chosen: install, configinstall, build, rpm, dpkg,
1814: htmldoc, textdoc, and status.
1815:
1816: The hierarchy mandated by the DTD does not always correspond to the hierarchy
1817: that is sensible for a Makefile. For instance, in a Makefile it is sensible
1818: that soft-links are installed after files. However, in an LPML document, it
1819: is sensible that files and links be considered together and the writer of the
1820: LPML document should be free to place things in whatever order makes best
1821: sense in terms of LOOKING at the information. The complication that arises
1822: is that the parser needs to have a memory for passing values from
1823: leaves on the XML tree to higher-up branches. Currently, this memory is
1824: hard-coded (like with the @links array), but it may benefit from a more
1825: formal approach in the future.
1826:
1827: =head1 README
1828:
1829: This parses an LPML file to generate information useful for
1830: source to target installation, compilation, filesystem status
1831: checking, RPM and Debian software packaging, and documentation.
1832:
1833: More information on LPML is available at http://lpml.sourceforge.net.
1834:
1835: =head1 PREREQUISITES
1836:
1837: HTML::TokeParser
1838:
1839: =head1 COREQUISITES
1840:
1841: =head1 OSNAMES
1842:
1843: linux
1844:
1845: =head1 SCRIPT CATEGORIES
1846:
1847: UNIX/System_administration
1848:
1849: =head1 AUTHOR
1850:
1851: Scott Harrison
1852: codeharrison@yahoo.com
1853:
1854: Please let me know how/if you are finding this script useful and
1855: any/all suggestions. -Scott
1856:
1857: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lpml_parse.pl CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / build