Commit | Line | Data |
---|---|---|
3d8876fc | 1 | #!./perl -Ilib -w |
90248788 | 2 | |
53542a37 | 3 | # This file should really be extracted from a .PL file |
54310121 | 4 | |
34aa3576 | 5 | $| = 1; |
3d8876fc | 6 | use strict; |
54310121 | 7 | use Config; # for config options in the makefile |
bddfdacf | 8 | use File::Path qw(remove_tree); |
83c03aa3 | 9 | use File::Spec::Functions qw(rel2abs no_upwards); |
54310121 | 10 | use Getopt::Long; # for command-line parsing |
11 | use Cwd; | |
7e12ee61 JK |
12 | use Pod::Html 1.32; |
13 | use Pod::Html::Util 1.32 qw(anchorify relativize_url); | |
54310121 | 14 | |
54310121 | 15 | =head1 NAME |
16 | ||
17 | installhtml - converts a collection of POD pages to HTML format. | |
18 | ||
19 | =head1 SYNOPSIS | |
20 | ||
555bd962 BG |
21 | installhtml [--help] [--podpath=<name>:...:<name>] [--podroot=<name>] |
22 | [--htmldir=<name>] [--htmlroot=<name>] [--norecurse] [--recurse] | |
23 | [--splithead=<name>,...,<name>] [--splititem=<name>,...,<name>] | |
24 | [--ignore=<name>,...,<name>] [--verbose] | |
54310121 | 25 | |
26 | =head1 DESCRIPTION | |
27 | ||
28 | I<installhtml> converts a collection of POD pages to a corresponding | |
4446c207 JK |
29 | collection of HTML pages. This is used to convert the pod pages found in the |
30 | perl distribution. (It is not intended as a general-purpose | |
31 | converter/installer of POD pages in HTML format. See L<Pod::Html>.) | |
54310121 | 32 | |
33 | =head1 OPTIONS | |
34 | ||
35 | =over 4 | |
36 | ||
37 | =item B<--help> help | |
38 | ||
39 | Displays the usage. | |
40 | ||
3e3baf6d TB |
41 | =item B<--podroot> POD search path base directory |
42 | ||
43 | The base directory to search for all .pod and .pm files to be converted. | |
44 | Default is current directory. | |
45 | ||
54310121 | 46 | =item B<--podpath> POD search path |
47 | ||
e05c04ea | 48 | The list of directories to search for .pod and .pm files to be converted. |
f5e0f10e | 49 | Default is 'podroot/lib'. |
54310121 | 50 | |
3e3baf6d | 51 | =item B<--recurse> recurse on subdirectories |
54310121 | 52 | |
3e3baf6d TB |
53 | Whether or not to convert all .pm and .pod files found in subdirectories |
54 | too. Default is to not recurse. | |
54310121 | 55 | |
56 | =item B<--htmldir> HTML destination directory | |
57 | ||
58 | The base directory which all HTML files will be written to. This should | |
59 | be a path relative to the filesystem, not the resulting URL. | |
60 | ||
61 | =item B<--htmlroot> URL base directory | |
62 | ||
63 | The base directory which all resulting HTML files will be visible at in | |
e1b7525f | 64 | a URL. The default is '/'. |
54310121 | 65 | |
54310121 | 66 | =item B<--splithead> POD files to split on =head directive |
67 | ||
af19f77d | 68 | Comma-separated list of pod files to split by the =head directive. The |
3e3baf6d TB |
69 | .pod suffix is optional. These files should have names specified |
70 | relative to podroot. | |
54310121 | 71 | |
72 | =item B<--splititem> POD files to split on =item directive | |
73 | ||
4446c207 JK |
74 | Comma-separated list of all pod files to split by the =item directive. The |
75 | .pod suffix is optional. I<installhtml> does not do the actual split, rather | |
76 | it invokes I<splitpod>, a separate program in the Perl 5 core distribution, | |
77 | to do the dirty work. As with --splithead, these files should have names | |
78 | specified relative to podroot. | |
3e3baf6d TB |
79 | |
80 | =item B<--splitpod> Directory containing the splitpod program | |
81 | ||
e1b7525f | 82 | The directory containing the splitpod program. The default is 'podroot/pod'. |
54310121 | 83 | |
47ec63d0 RGS |
84 | =item B<--ignore> files to be ignored |
85 | ||
86 | Comma-separated of files that shouldn't be installed, given relative | |
87 | to podroot. | |
88 | ||
54310121 | 89 | =item B<--verbose> verbose output |
90 | ||
91 | Self-explanatory. | |
92 | ||
93 | =back | |
94 | ||
95 | =head1 EXAMPLE | |
96 | ||
97 | The following command-line is an example of the one we use to convert | |
98 | perl documentation: | |
99 | ||
100 | ./installhtml --podpath=lib:ext:pod:vms \ | |
84902520 TB |
101 | --podroot=/usr/src/perl \ |
102 | --htmldir=/perl/nmanual \ | |
103 | --htmlroot=/perl/nmanual \ | |
104 | --splithead=pod/perlipc \ | |
105 | --splititem=pod/perlfunc \ | |
84902520 TB |
106 | --recurse \ |
107 | --verbose | |
54310121 | 108 | |
109 | =head1 AUTHOR | |
110 | ||
111 | Chris Hall E<lt>hallc@cs.colorado.eduE<gt> | |
112 | ||
54310121 | 113 | =cut |
114 | ||
3d8876fc MS |
115 | my $usage; |
116 | ||
54310121 | 117 | $usage =<<END_OF_USAGE; |
118 | Usage: $0 --help --podpath=<name>:...:<name> --podroot=<name> | |
119 | --htmldir=<name> --htmlroot=<name> --norecurse --recurse | |
120 | --splithead=<name>,...,<name> --splititem=<name>,...,<name> | |
6c6fc3be | 121 | --ignore=<name>,...,<name> --verbose |
54310121 | 122 | |
123 | --help - this message | |
124 | --podpath - colon-separated list of directories containing .pod and | |
f5e0f10e | 125 | .pm files to be converted ('lib/' by default). |
54310121 | 126 | --podroot - filesystem base directory from which all relative paths in |
127 | podpath stem (default is .). | |
128 | --htmldir - directory to store resulting html files in relative | |
47ec63d0 | 129 | to the filesystem (\$podroot/html by default). |
54310121 | 130 | --htmlroot - http-server base directory from which all relative paths |
131 | in podpath stem (default is /). | |
54310121 | 132 | --norecurse - don't recurse on those subdirectories listed in podpath. |
133 | (default behavior). | |
134 | --recurse - recurse on those subdirectories listed in podpath | |
135 | --splithead - comma-separated list of .pod or .pm files to split. will | |
e05c04ea | 136 | split each file into several smaller files at every occurrence |
54310121 | 137 | of a pod =head[1-6] directive. |
138 | --splititem - comma-separated list of .pod or .pm files to split using | |
139 | splitpod. | |
3e3baf6d TB |
140 | --splitpod - directory where the program splitpod can be found |
141 | (\$podroot/pod by default). | |
47ec63d0 | 142 | --ignore - comma-separated list of files that shouldn't be installed. |
54310121 | 143 | --verbose - self-explanatory. |
144 | ||
145 | END_OF_USAGE | |
146 | ||
6c6fc3be | 147 | my (@podpath, $podroot, $htmldir, $htmlroot, $recurse, @splithead, |
47ec63d0 | 148 | @splititem, $splitpod, $verbose, $pod2html, @ignore); |
3d8876fc | 149 | |
f5e0f10e | 150 | @podpath = ( "lib" ); # colon-separated list of directories containing .pod |
54310121 | 151 | # and .pm files to be converted. |
152 | $podroot = "."; # assume the pods we want are here | |
153 | $htmldir = ""; # nothing for now... | |
154 | $htmlroot = "/"; # default value | |
155 | $recurse = 0; # default behavior | |
156 | @splithead = (); # don't split any files by default | |
157 | @splititem = (); # don't split any files by default | |
158 | $splitpod = ""; # nothing for now. | |
159 | ||
47ec63d0 | 160 | $verbose = 0; # whether or not to print debugging info |
54310121 | 161 | |
162 | $pod2html = "pod/pod2html"; | |
163 | ||
3e3baf6d | 164 | usage("") unless @ARGV; |
54310121 | 165 | |
c645ec3f | 166 | # Overcome shell's p1,..,p8 limitation. |
af1e27ef | 167 | # See vms/descrip_mms.template -> descrip.mms for invocation. |
c645ec3f GS |
168 | if ( $^O eq 'VMS' ) { @ARGV = split(/\s+/,$ARGV[0]); } |
169 | ||
3d3a0a8a | 170 | our %Options; |
3d8876fc | 171 | |
54310121 | 172 | # parse the command-line |
65b03822 | 173 | my $result = GetOptions( \%Options, qw( |
54310121 | 174 | help |
175 | podpath=s | |
176 | podroot=s | |
177 | htmldir=s | |
178 | htmlroot=s | |
47ec63d0 | 179 | ignore=s |
54310121 | 180 | recurse! |
181 | splithead=s | |
182 | splititem=s | |
183 | splitpod=s | |
184 | verbose | |
185 | )); | |
186 | usage("invalid parameters") unless $result; | |
187 | parse_command_line(); | |
188 | ||
189 | ||
190 | # set these variables to appropriate values if the user didn't specify | |
191 | # values for them. | |
192 | $htmldir = "$htmlroot/html" unless $htmldir; | |
193 | $splitpod = "$podroot/pod" unless $splitpod; | |
194 | ||
195 | ||
196 | # make sure that the destination directory exists | |
197 | (mkdir($htmldir, 0755) || | |
198 | die "$0: cannot make directory $htmldir: $!\n") if ! -d $htmldir; | |
199 | ||
200 | ||
201 | # the following array will eventually contain files that are to be | |
202 | # ignored in the conversion process. these are files that have been | |
203 | # process by splititem or splithead and should not be converted as a | |
204 | # result. | |
3d8876fc | 205 | my @splitdirs; |
54310121 | 206 | |
47ec63d0 RGS |
207 | # split pods. It's important to do this before convert ANY pods because |
208 | # it may affect some of the links | |
54310121 | 209 | @splitdirs = (); # files in these directories won't get an index |
210 | split_on_head($podroot, $htmldir, \@splitdirs, \@ignore, @splithead); | |
3e3baf6d | 211 | split_on_item($podroot, \@splitdirs, \@ignore, @splititem); |
54310121 | 212 | |
213 | ||
214 | # convert the pod pages found in @poddirs | |
215 | #warn "converting files\n" if $verbose; | |
216 | #warn "\@ignore\t= @ignore\n" if $verbose; | |
3d8876fc | 217 | foreach my $dir (@podpath) { |
54310121 | 218 | installdir($dir, $recurse, $podroot, \@splitdirs, \@ignore); |
219 | } | |
220 | ||
221 | ||
222 | # now go through and create master indices for each pod we split | |
3d8876fc | 223 | foreach my $dir (@splititem) { |
54310121 | 224 | print "creating index $htmldir/$dir.html\n" if $verbose; |
225 | create_index("$htmldir/$dir.html", "$htmldir/$dir"); | |
226 | } | |
227 | ||
3d8876fc | 228 | foreach my $dir (@splithead) { |
776d31fe | 229 | (my $pod = $dir) =~ s,^.*/,,; |
54310121 | 230 | $dir .= ".pod" unless $dir =~ /(\.pod|\.pm)$/; |
231 | # let pod2html create the file | |
232 | runpod2html($dir, 1); | |
233 | ||
234 | # now go through and truncate after the index | |
235 | $dir =~ /^(.*?)(\.pod|\.pm)?$/sm; | |
3d8876fc | 236 | my $file = "$htmldir/$1"; |
54310121 | 237 | print "creating index $file.html\n" if $verbose; |
238 | ||
239 | # read in everything until what would have been the first =head | |
240 | # directive, patching the index as we go. | |
1ae6ead9 | 241 | open(H, '<', "$file.html") || |
54310121 | 242 | die "$0: error opening $file.html for input: $!\n"; |
243 | $/ = ""; | |
3d8876fc | 244 | my @data = (); |
54310121 | 245 | while (<H>) { |
0bd1c35e | 246 | last if m!<h1 id="NAME">NAME</h1>!; |
776d31fe | 247 | $_ =~ s{href="#(.*)">}{ |
0bd1c35e Z |
248 | my $url = "$file/@{[anchorify(qq($1))]}.html" ; |
249 | $url = relativize_url( $url, "$file.html" ) | |
776d31fe SH |
250 | if ( ! defined $Options{htmlroot} || $Options{htmlroot} eq '' ); |
251 | "href=\"$url\">" ; | |
252 | }egi; | |
54310121 | 253 | push @data, $_; |
776d31fe | 254 | } |
54310121 | 255 | close(H); |
256 | ||
47ec63d0 | 257 | # now rewrite the file |
1ae6ead9 | 258 | open(H, '>', "$file.html") || |
54310121 | 259 | die "$0: error opening $file.html for output: $!\n"; |
0bd1c35e | 260 | print H @data, "</body>\n\n</html>\n\n\n"; |
54310121 | 261 | close(H); |
262 | } | |
263 | ||
bddfdacf Z |
264 | remove_tree(@splitdirs, {safe=>1}); |
265 | ||
54310121 | 266 | ############################################################################## |
267 | ||
268 | ||
269 | sub usage { | |
270 | warn "$0: @_\n" if @_; | |
271 | die $usage; | |
272 | } | |
273 | ||
274 | ||
275 | sub parse_command_line { | |
65b03822 | 276 | usage() if defined $Options{help}; |
277 | $Options{help} = ""; # make -w shut up | |
54310121 | 278 | |
279 | # list of directories | |
65b03822 | 280 | @podpath = split(":", $Options{podpath}) if defined $Options{podpath}; |
54310121 | 281 | |
282 | # lists of files | |
65b03822 | 283 | @splithead = split(",", $Options{splithead}) if defined $Options{splithead}; |
284 | @splititem = split(",", $Options{splititem}) if defined $Options{splititem}; | |
54310121 | 285 | |
65b03822 | 286 | $htmldir = $Options{htmldir} if defined $Options{htmldir}; |
287 | $htmlroot = $Options{htmlroot} if defined $Options{htmlroot}; | |
288 | $podroot = $Options{podroot} if defined $Options{podroot}; | |
289 | $splitpod = $Options{splitpod} if defined $Options{splitpod}; | |
54310121 | 290 | |
65b03822 | 291 | $recurse = $Options{recurse} if defined $Options{recurse}; |
292 | $verbose = $Options{verbose} if defined $Options{verbose}; | |
47ec63d0 RGS |
293 | |
294 | @ignore = map "$podroot/$_", split(",", $Options{ignore}) if defined $Options{ignore}; | |
54310121 | 295 | } |
296 | ||
297 | ||
298 | sub create_index { | |
299 | my($html, $dir) = @_; | |
df00c672 | 300 | (my $pod = $dir) =~ s,^.*/,,; |
54310121 | 301 | |
302 | # get the list of .html files in this directory | |
303 | opendir(DIR, $dir) || | |
304 | die "$0: error opening directory $dir for reading: $!\n"; | |
e0f13893 | 305 | my @files = sort(grep(/\.html?$/, readdir(DIR))); |
54310121 | 306 | closedir(DIR); |
307 | ||
1ae6ead9 | 308 | open(HTML, '>', $html) || |
54310121 | 309 | die "$0: error opening $html for output: $!\n"; |
310 | ||
311 | # for each .html file in the directory, extract the index | |
312 | # embedded in the file and throw it into the big index. | |
313 | print HTML "<DL COMPACT>\n"; | |
e0f13893 | 314 | foreach my $file (@files) { |
54310121 | 315 | |
e0f13893 | 316 | my $filedata = do { |
1ae6ead9 | 317 | open(my $in, '<', "$dir/$file") || |
e0f13893 Z |
318 | die "$0: error opening $dir/$file for input: $!\n"; |
319 | local $/ = undef; | |
320 | <$in>; | |
321 | }; | |
54310121 | 322 | |
323 | # pull out the NAME section | |
e0f13893 Z |
324 | my($lcp1, $lcp2) = |
325 | ($filedata =~ | |
326 | m#<h1 id="NAME">NAME</h1>\s*<p>\s*(\S+)\s+-\s+(\S.*?\S)</p>#); | |
327 | defined $lcp1 or die "$0: can't find NAME section in $dir/$file\n"; | |
328 | ||
0bd1c35e | 329 | my $url= "$dir/$file" ; |
65b03822 | 330 | if ( ! defined $Options{htmlroot} || $Options{htmlroot} eq '' ) { |
0bd1c35e | 331 | $url = relativize_url( $url, $html ) ; |
29f227c9 BS |
332 | } |
333 | ||
e0f13893 Z |
334 | print HTML qq(<DT><A HREF="$url">); |
335 | print HTML "$lcp1</A></DT><DD>$lcp2</DD>\n"; | |
54310121 | 336 | } |
337 | print HTML "</DL>\n"; | |
338 | ||
339 | close(HTML); | |
340 | } | |
341 | ||
342 | ||
343 | sub split_on_head { | |
344 | my($podroot, $htmldir, $splitdirs, $ignore, @splithead) = @_; | |
345 | my($pod, $dirname, $filename); | |
346 | ||
347 | # split the files specified in @splithead on =head[1-6] pod directives | |
348 | print "splitting files by head.\n" if $verbose && $#splithead >= 0; | |
349 | foreach $pod (@splithead) { | |
350 | # figure out the directory name and filename | |
351 | $pod =~ s,^([^/]*)$,/$1,; | |
df00c672 | 352 | $pod =~ m,(.*)/(.*?)(\.pod)?$,; |
54310121 | 353 | $dirname = $1; |
354 | $filename = "$2.pod"; | |
355 | ||
356 | # since we are splitting this file it shouldn't be converted. | |
357 | push(@$ignore, "$podroot/$dirname/$filename"); | |
358 | ||
359 | # split the pod | |
360 | splitpod("$podroot/$dirname/$filename", "$podroot/$dirname", $htmldir, | |
361 | $splitdirs); | |
362 | } | |
363 | } | |
364 | ||
365 | ||
366 | sub split_on_item { | |
367 | my($podroot, $splitdirs, $ignore, @splititem) = @_; | |
368 | my($pwd, $dirname, $filename); | |
369 | ||
370 | print "splitting files by item.\n" if $verbose && $#splititem >= 0; | |
371 | $pwd = getcwd(); | |
b1124ff0 AP |
372 | my $splitter = rel2abs("$splitpod/splitpod", $pwd); |
373 | my $perl = rel2abs($^X, $pwd); | |
3d8876fc | 374 | foreach my $pod (@splititem) { |
54310121 | 375 | # figure out the directory to split into |
376 | $pod =~ s,^([^/]*)$,/$1,; | |
df00c672 | 377 | $pod =~ m,(.*)/(.*?)(\.pod)?$,; |
54310121 | 378 | $dirname = "$1/$2"; |
379 | $filename = "$2.pod"; | |
380 | ||
381 | # since we are splitting this file it shouldn't be converted. | |
382 | push(@$ignore, "$podroot/$dirname.pod"); | |
383 | ||
384 | # split the pod | |
385 | push(@$splitdirs, "$podroot/$dirname"); | |
bddfdacf Z |
386 | -d "$podroot/$dirname" and remove_tree("$podroot/$dirname", {safe=>1}); |
387 | mkdir("$podroot/$dirname", 0755) || | |
54310121 | 388 | die "$0: error creating directory $podroot/$dirname: $!\n"; |
54310121 | 389 | chdir("$podroot/$dirname") || |
390 | die "$0: error changing to directory $podroot/$dirname: $!\n"; | |
3e3baf6d TB |
391 | die "$splitter not found. Use '-splitpod dir' option.\n" |
392 | unless -f $splitter; | |
ab9905e6 | 393 | system($perl, $splitter, "../$filename") && |
3e3baf6d | 394 | warn "$0: error running '$splitter ../$filename'" |
e05c04ea | 395 | ." from $podroot/$dirname"; |
54310121 | 396 | } |
397 | chdir($pwd); | |
398 | } | |
399 | ||
400 | ||
401 | # | |
402 | # splitpod - splits a .pod file into several smaller .pod files | |
403 | # where a new file is started each time a =head[1-6] pod directive | |
404 | # is encountered in the input file. | |
405 | # | |
406 | sub splitpod { | |
407 | my($pod, $poddir, $htmldir, $splitdirs) = @_; | |
408 | my(@poddata, @filedata, @heads); | |
409 | my($file, $i, $j, $prevsec, $section, $nextsec); | |
410 | ||
411 | print "splitting $pod\n" if $verbose; | |
412 | ||
413 | # read the file in paragraphs | |
414 | $/ = ""; | |
1ae6ead9 | 415 | open(SPLITIN, '<', $pod) || |
54310121 | 416 | die "$0: error opening $pod for input: $!\n"; |
417 | @filedata = <SPLITIN>; | |
418 | close(SPLITIN) || | |
419 | die "$0: error closing $pod: $!\n"; | |
420 | ||
421 | # restore the file internally by =head[1-6] sections | |
422 | @poddata = (); | |
423 | for ($i = 0, $j = -1; $i <= $#filedata; $i++) { | |
424 | $j++ if ($filedata[$i] =~ /^\s*=head[1-6]/); | |
425 | if ($j >= 0) { | |
426 | $poddata[$j] = "" unless defined $poddata[$j]; | |
427 | $poddata[$j] .= "\n$filedata[$i]" if $j >= 0; | |
428 | } | |
429 | } | |
430 | ||
431 | # create list of =head[1-6] sections so that we can rewrite | |
432 | # L<> links as necessary. | |
3d8876fc | 433 | my %heads = (); |
54310121 | 434 | foreach $i (0..$#poddata) { |
776d31fe | 435 | $heads{anchorify($1)} = 1 if $poddata[$i] =~ /=head[1-6]\s+(.*)/; |
54310121 | 436 | } |
437 | ||
438 | # create a directory of a similar name and store all the | |
439 | # files in there | |
440 | $pod =~ s,.*/(.*),$1,; # get the last part of the name | |
3d8876fc | 441 | my $dir = $pod; |
54310121 | 442 | $dir =~ s/\.pod//g; |
443 | push(@$splitdirs, "$poddir/$dir"); | |
bddfdacf | 444 | -d "$poddir/$dir" and remove_tree("$poddir/$dir", {safe=>1}); |
54310121 | 445 | mkdir("$poddir/$dir", 0755) || |
bddfdacf | 446 | die "$0: could not create directory $poddir/$dir: $!\n"; |
54310121 | 447 | |
448 | $poddata[0] =~ /^\s*=head[1-6]\s+(.*)/; | |
449 | $section = ""; | |
450 | $nextsec = $1; | |
451 | ||
452 | # for each section of the file create a separate pod file | |
453 | for ($i = 0; $i <= $#poddata; $i++) { | |
454 | # determine the "prev" and "next" links | |
455 | $prevsec = $section; | |
456 | $section = $nextsec; | |
457 | if ($i < $#poddata) { | |
458 | $poddata[$i+1] =~ /^\s*=head[1-6]\s+(.*)/; | |
459 | $nextsec = $1; | |
460 | } else { | |
461 | $nextsec = ""; | |
462 | } | |
463 | ||
464 | # determine an appropriate filename (this must correspond with | |
465 | # what pod2html will try and guess) | |
466 | # $poddata[$i] =~ /^\s*=head[1-6]\s+(.*)/; | |
776d31fe | 467 | $file = "$dir/" . anchorify($section) . ".pod"; |
54310121 | 468 | |
469 | # create the new .pod file | |
470 | print "\tcreating $poddir/$file\n" if $verbose; | |
1ae6ead9 | 471 | open(SPLITOUT, '>', "$poddir/$file") || |
54310121 | 472 | die "$0: error opening $poddir/$file for output: $!\n"; |
473 | $poddata[$i] =~ s,L<([^<>]*)>, | |
776d31fe SH |
474 | defined $heads{anchorify($1)} ? "L<$dir/$1>" : "L<$1>" |
475 | ,ge; | |
54310121 | 476 | print SPLITOUT $poddata[$i]."\n\n"; |
477 | print SPLITOUT "=over 4\n\n"; | |
478 | print SPLITOUT "=item *\n\nBack to L<$dir/\"$prevsec\">\n\n" if $prevsec; | |
479 | print SPLITOUT "=item *\n\nForward to L<$dir/\"$nextsec\">\n\n" if $nextsec; | |
480 | print SPLITOUT "=item *\n\nUp to L<$dir>\n\n"; | |
481 | print SPLITOUT "=back\n\n"; | |
482 | close(SPLITOUT) || | |
483 | die "$0: error closing $poddir/$file: $!\n"; | |
484 | } | |
485 | } | |
486 | ||
487 | ||
488 | # | |
489 | # installdir - takes care of converting the .pod and .pm files in the | |
490 | # current directory to .html files and then installing those. | |
491 | # | |
492 | sub installdir { | |
493 | my($dir, $recurse, $podroot, $splitdirs, $ignore) = @_; | |
54310121 | 494 | |
8de3880f AP |
495 | my @dirlist; # directories to recurse on |
496 | my @podlist; # .pod files to install | |
497 | my @pmlist; # .pm files to install | |
54310121 | 498 | |
499 | # should files in this directory get an index? | |
8de3880f | 500 | my $doindex = (grep($_ eq "$podroot/$dir", @$splitdirs) ? 0 : 1); |
54310121 | 501 | |
502 | opendir(DIR, "$podroot/$dir") | |
503 | || die "$0: error opening directory $podroot/$dir: $!\n"; | |
504 | ||
83c03aa3 AP |
505 | while(readdir DIR) { |
506 | no_upwards($_) or next; | |
507 | my $is_dir = -d "$podroot/$dir/$_"; | |
508 | next if $is_dir and not $recurse; | |
7e7b3f79 AP |
509 | my $target |
510 | = $is_dir ? \@dirlist | |
511 | : s/\.pod$// ? \@podlist | |
512 | : s/\.pm$// ? \@pmlist | |
513 | : undef | |
514 | ; | |
83c03aa3 AP |
515 | push @$target, "$dir/$_" if $target; |
516 | } | |
54310121 | 517 | |
518 | closedir(DIR); | |
519 | ||
83c03aa3 AP |
520 | if ($^O eq 'VMS') { s/\.dir$//i for @dirlist } |
521 | ||
54310121 | 522 | # recurse on all subdirectories we kept track of |
523 | foreach $dir (@dirlist) { | |
524 | installdir($dir, $recurse, $podroot, $splitdirs, $ignore); | |
525 | } | |
526 | ||
527 | # install all the pods we found | |
3d8876fc | 528 | foreach my $pod (@podlist) { |
54310121 | 529 | # check if we should ignore it. |
47ec63d0 RGS |
530 | next if $pod =~ m(/t/); # comes from a test file |
531 | next if grep($_ eq "$pod.pod", @$ignore); | |
54310121 | 532 | |
533 | # check if a .pm files exists too | |
df00c672 | 534 | if (grep($_ eq $pod, @pmlist)) { |
e1b7525f YO |
535 | print "$0: Warning both '$podroot/$pod.pod' and " |
536 | . "'$podroot/$pod.pm' exist, using pod\n"; | |
54310121 | 537 | push(@ignore, "$pod.pm"); |
538 | } | |
539 | runpod2html("$pod.pod", $doindex); | |
540 | } | |
541 | ||
542 | # install all the .pm files we found | |
3d8876fc | 543 | foreach my $pm (@pmlist) { |
54310121 | 544 | # check if we should ignore it. |
47ec63d0 | 545 | next if $pm =~ m(/t/); # comes from a test file |
54310121 | 546 | next if grep($_ eq "$pm.pm", @ignore); |
547 | ||
548 | runpod2html("$pm.pm", $doindex); | |
549 | } | |
550 | } | |
551 | ||
552 | ||
553 | # | |
554 | # runpod2html - invokes pod2html to convert a .pod or .pm file to a .html | |
555 | # file. | |
556 | # | |
557 | sub runpod2html { | |
558 | my($pod, $doindex) = @_; | |
559 | my($html, $i, $dir, @dirs); | |
560 | ||
561 | $html = $pod; | |
562 | $html =~ s/\.(pod|pm)$/.html/g; | |
563 | ||
564 | # make sure the destination directories exist | |
565 | @dirs = split("/", $html); | |
566 | $dir = "$htmldir/"; | |
567 | for ($i = 0; $i < $#dirs; $i++) { | |
568 | if (! -d "$dir$dirs[$i]") { | |
569 | mkdir("$dir$dirs[$i]", 0755) || | |
570 | die "$0: error creating directory $dir$dirs[$i]: $!\n"; | |
571 | } | |
572 | $dir .= "$dirs[$i]/"; | |
573 | } | |
574 | ||
575 | # invoke pod2html | |
576 | print "$podroot/$pod => $htmldir/$html\n" if $verbose; | |
df00c672 | 577 | Pod::Html::pod2html( |
5a039dd3 | 578 | "--htmldir=$htmldir", |
54310121 | 579 | "--htmlroot=$htmlroot", |
580 | "--podpath=".join(":", @podpath), | |
6c6fc3be | 581 | "--podroot=$podroot", |
7c82de66 | 582 | "--header", |
54310121 | 583 | ($doindex ? "--index" : "--noindex"), |
584 | "--" . ($recurse ? "" : "no") . "recurse", | |
54310121 | 585 | "--infile=$podroot/$pod", "--outfile=$htmldir/$html"); |
586 | die "$0: error running $pod2html: $!\n" if $?; | |
587 | } |