]>
Commit | Line | Data |
---|---|---|
aa99b349 DM |
1 | #!/usr/bin/perl |
2 | ||
3 | use strict; | |
4 | use warnings; | |
5 | use IO::File; | |
6 | use JSON; | |
7 | ||
8 | use Data::Dumper; | |
9 | ||
10 | my $environments = { | |
11 | default => 1, | |
12 | wiki => 1, | |
13 | manvolnum => 1, | |
14 | pvelogo => 0, # ignore | |
15 | }; | |
16 | ||
fe38a7e7 DM |
17 | my $fileinfo = { |
18 | outfile => { | |
19 | default => { | |
20 | "pve-admin-guide.adoc" => "pve-admin-guide.html", | |
21 | "datacenter.cfg.adoc" => "datacenter.cfg.5.html", | |
22 | "ha-manager.adoc" => "chapter-ha-manager.html", | |
23 | "pct.adoc" => "chapter-pct.html", | |
24 | "pve-bibliography.adoc" => "chapter-pve-bibliography.html", | |
25 | "pve-firewall.adoc" => "chapter-pve-firewall.html", | |
26 | "pve-installation.adoc" => "chapter-pve-installation.html", | |
27 | "pvecm.adoc" => "chapter-pvecm.html", | |
28 | "pvesm.adoc" => "chapter-pvesm.html", | |
29 | "pveum.adoc" => "chapter-pveum.html", | |
30 | "qm.adoc" => "chapter-qm.html", | |
31 | "sysadmin.adoc" => "chapter-sysadmin.html", | |
32 | "vzdump.adoc" => "chapter-vzdump.html", | |
33 | "pmxcfs.adoc" => "chapter-pmxcfs.html", | |
34 | "pve-faq.adoc" => "chapter-pve-faq.html", | |
35 | }, | |
fe38a7e7 DM |
36 | }, |
37 | }; | |
aa99b349 DM |
38 | |
39 | my $start_env = []; | |
40 | foreach my $e (keys %$environments) { | |
41 | push @$start_env, $e if $environments->{$e}; | |
42 | } | |
43 | ||
44 | my $env_stack = [$start_env]; | |
45 | my $env_name_stack = []; | |
46 | ||
47 | sub reset_environment_stack { | |
48 | $env_stack = [$start_env]; | |
49 | $env_name_stack = []; | |
50 | } | |
51 | ||
52 | sub push_environment { | |
53 | my ($env, $not) = @_; | |
54 | ||
55 | die "undefined environment '$env'\n" if !defined($environments->{$env}); | |
56 | ||
835dd63b | 57 | # FIXME: this seems wrong (nested env?)? |
aa99b349 | 58 | return if !$environments->{$env}; # do not track |
74b0334e | 59 | |
aa99b349 DM |
60 | if ($not) { |
61 | my $new_env = []; | |
62 | foreach my $e (@{$env_stack->[-1]}) { | |
63 | if ($e ne $env) { | |
64 | push @$new_env, $e; | |
65 | } | |
66 | } | |
67 | die "empty environment" if !scalar($new_env); | |
68 | push @$env_stack, $new_env; | |
69 | } else { | |
70 | push @$env_stack, [$env]; | |
71 | } | |
74b0334e | 72 | |
aa99b349 DM |
73 | push @$env_name_stack, $env; |
74 | } | |
75 | ||
76 | sub pop_environment { | |
77 | my ($env) = @_; | |
78 | ||
79 | die "undefined environment '$env'\n" if !defined($environments->{$env}); | |
74b0334e | 80 | |
aa99b349 DM |
81 | return if !$environments->{$env}; # do not track |
82 | ||
83 | pop @$env_stack; | |
84 | my $res = pop @$env_name_stack; | |
74b0334e | 85 | |
aa99b349 DM |
86 | die "environment missmatch ($res != $env)\n" if $res ne $env; |
87 | } | |
88 | ||
89 | sub register_include { | |
90 | my ($filename, $include_filename, $env_list) = @_; | |
91 | ||
92 | return if $include_filename !~ m/\.adoc$/; # skip attributes.txt | |
93 | ||
94 | foreach my $e (@$env_list) { | |
95 | $fileinfo->{include}->{$e}->{$filename}->{$include_filename} = 1; | |
96 | } | |
97 | } | |
98 | ||
99 | sub register_blockid { | |
45930831 | 100 | my ($filename, $blockid, $reftext, $env_list) = @_; |
aa99b349 DM |
101 | |
102 | foreach my $e (@$env_list) { | |
103 | my $fn = $fileinfo->{blockid}->{$e}->{$blockid}; | |
74b0334e | 104 | die "blockid '$blockid' already defined in $fn" |
aa99b349 DM |
105 | if defined($fn); |
106 | $fileinfo->{blockid}->{$e}->{$blockid} = $filename; | |
45930831 DM |
107 | $fileinfo->{reftext}->{$e}->{$blockid} = $reftext |
108 | if defined($reftext); | |
aa99b349 DM |
109 | } |
110 | } | |
111 | ||
152b10fb | 112 | sub register_title { |
86f28451 | 113 | my ($filename, $env, $doctype, $title, $blockid) = @_; |
152b10fb DM |
114 | |
115 | # fixme: what about other macros? | |
116 | $title =~ s/\{pve\}/Proxmox VE/g; | |
117 | $title =~ s!http://\S+\[(.*?)\]!$1!g; | |
118 | ||
86f28451 DM |
119 | # register document title (onyl once) |
120 | if (!defined($fileinfo->{titles}->{$env}->{$filename})) { | |
edc73653 | 121 | |
86f28451 | 122 | $fileinfo->{titles}->{$env}->{$filename} = $title; |
34d7f485 | 123 | |
86f28451 DM |
124 | if (defined($doctype)) { |
125 | $fileinfo->{doctype}->{$env}->{$filename} = $doctype; | |
126 | } else { | |
127 | die "unable to change title (no doctype)" | |
128 | if !defined($fileinfo->{doctype}->{$env}->{$filename}); | |
34d7f485 | 129 | } |
86f28451 DM |
130 | |
131 | if (defined($doctype) && ($env eq 'manvolnum') && ($doctype == 0)) { | |
132 | if ($title =~ m/.*\(([1-8])\)\s*$/) { | |
133 | $fileinfo->{mansection}->{$env}->{$filename} = $1; | |
134 | } | |
135 | } | |
136 | } | |
137 | ||
138 | if ($blockid) { | |
139 | die "internal error" | |
140 | if !defined($fileinfo->{blockid}->{$env}->{$blockid}); | |
141 | $fileinfo->{reftitle}->{$env}->{$blockid} = $title; | |
34d7f485 | 142 | } |
152b10fb DM |
143 | } |
144 | ||
aa99b349 DM |
145 | sub scan_adoc_file { |
146 | my ($filename) = @_; | |
147 | ||
148 | reset_environment_stack(); | |
74b0334e | 149 | |
aa99b349 DM |
150 | # print "SCAN $filename\n"; |
151 | ||
152 | my $fh = IO::File->new("$filename", "r") or | |
153 | die "unable to open file '$filename' - $!\n"; | |
154 | ||
155 | my $env_last_line = {}; | |
86f28451 | 156 | my $env_last_blockid = {}; |
74b0334e | 157 | |
aa99b349 DM |
158 | while (defined (my $line = <$fh>)) { |
159 | if ($line =~ m/^if(n?)def::(\S+)\[(.*)\]\s*$/) { | |
74b0334e | 160 | my ($not, $env, $text) = ($1, $2, $3); |
aa99b349 DM |
161 | die "unsuported ifdef usage - implement me" if $text; |
162 | push_environment($env, $not); | |
163 | next; | |
164 | } elsif ($line =~ m/^endif::(\S+)\[(.*)\]\s*$/) { | |
165 | my ($env, $text) = ($1, $2); | |
166 | die "unsuported ifdef usage - implement me" if $text; | |
167 | pop_environment($env); | |
168 | next; | |
169 | } elsif ($line =~ m/^include::(\S+)\[.*\]\s*$/) { | |
170 | register_include($filename, $1, $env_stack->[-1]); | |
171 | next; | |
172 | } | |
173 | ||
174 | # try to detect titles | |
175 | foreach my $e (@{$env_stack->[-1]}) { | |
0142692a | 176 | if ($line =~ m/^=====+$/) { |
86f28451 DM |
177 | register_title($filename, $e, 0, $env_last_line->{$e}, |
178 | $env_last_blockid->{$e}); | |
0142692a | 179 | } elsif ($line =~ m/^-----+$/) { |
86f28451 DM |
180 | register_title($filename, $e, 1, $env_last_line->{$e}, |
181 | $env_last_blockid->{$e}); | |
182 | } elsif ($line =~ m/^~~~~~+$/) { | |
183 | register_title($filename, $e, 2, $env_last_line->{$e}, | |
184 | $env_last_blockid->{$e}); | |
185 | } elsif ($line =~ m/^\^\^\^\^\^+$/) { | |
186 | register_title($filename, $e, 3, $env_last_line->{$e}, | |
187 | $env_last_blockid->{$e}); | |
0142692a | 188 | } elsif ($line =~ m/^= +(\S.*?)( +=)?$/) { |
86f28451 | 189 | register_title($filename, $e, 0, $1, $env_last_blockid->{$e}); |
0142692a | 190 | } elsif ($line =~ m/^== +(\S.*?)( +==)?$/) { |
86f28451 DM |
191 | register_title($filename, $e, 1, $1, $env_last_blockid->{$e}); |
192 | } elsif ($line =~ m/^=== +(\S.*?)( +===)?$/) { | |
193 | register_title($filename, $e, 2, $1, $env_last_blockid->{$e}); | |
194 | } elsif ($line =~ m/^==== +(\S.*?)( +====)?$/) { | |
195 | register_title($filename, $e, 3, $1, $env_last_blockid->{$e}); | |
aa99b349 | 196 | } |
0142692a | 197 | |
aa99b349 DM |
198 | $env_last_line->{$e} = $line; |
199 | chomp $env_last_line->{$e}; | |
200 | } | |
74b0334e | 201 | |
5f09af76 DM |
202 | if ($line =~ m/^:(\S+?):\s*(.*\S)?\s*$/) { |
203 | my ($key, $value) = ($1, $2); | |
204 | if ($key eq 'pve-toplevel') { | |
5e625ed3 | 205 | |
5f09af76 DM |
206 | foreach my $e (@{$env_stack->[-1]}) { |
207 | my $title = $fileinfo->{titles}->{$e}->{$filename}; | |
208 | die "not title for toplevel file '$filename' (env=$e)\n" | |
209 | if !defined($title); | |
210 | $fileinfo->{toplevel}->{$e}->{$filename} = 1; | |
211 | } | |
edc73653 DM |
212 | } elsif ($key eq 'title') { |
213 | foreach my $e (@{$env_stack->[-1]}) { | |
214 | register_title($filename, $e, undef, $value); | |
215 | } | |
5f09af76 DM |
216 | } |
217 | } | |
218 | ||
aa99b349 DM |
219 | if ($line =~ m/^\[\[(.*)\]\]\s*$/) { |
220 | my $blockid = $1; | |
221 | die "implement me" if $blockid =~m/,/; | |
45930831 DM |
222 | my $reftext = ''; |
223 | register_blockid($filename, $blockid, $reftext, $env_stack->[-1]); | |
86f28451 DM |
224 | foreach my $e (@{$env_stack->[-1]}) { |
225 | $env_last_blockid->{$e} = $blockid; | |
226 | } | |
aa99b349 | 227 | } |
86f28451 DM |
228 | |
229 | if ($line =~ m/^\s*$/) { | |
230 | foreach my $e (@{$env_stack->[-1]}) { | |
231 | delete $env_last_blockid->{$e}; | |
232 | } | |
233 | } | |
234 | ||
a0ba8b4c DM |
235 | # fixme: "anchor:" |
236 | # bibliography anchors | |
237 | if ($line =~ m/\[\[\[([^\]]*)\]\]\]/) { | |
238 | my $blockid = $1; | |
239 | die "implement me" if $blockid =~m/,/; | |
45930831 | 240 | register_blockid($filename, $blockid, "[$blockid]", $env_stack->[-1]); |
a0ba8b4c | 241 | } |
74b0334e | 242 | } |
aa99b349 DM |
243 | } |
244 | ||
245 | my $scanned_files = {}; | |
246 | while (my $filename = shift) { | |
247 | next if $filename !~ m/\.adoc$/; # skip attributes.txt | |
248 | next if $scanned_files->{$filename}; | |
249 | ||
250 | scan_adoc_file($filename); | |
251 | $scanned_files->{$filename} = 1; | |
252 | } | |
253 | ||
254 | sub resolve_link_target { | |
255 | my ($env, $filename) = @_; | |
256 | ||
257 | my $include_hash = $fileinfo->{include}->{$env}; | |
258 | ||
259 | my $repeat = 1; | |
260 | ||
261 | while ($repeat) { | |
262 | $repeat = 0; | |
263 | foreach my $fn (keys %$include_hash) { | |
aa99b349 | 264 | if ($include_hash->{$fn}->{$filename}) { |
fe38a7e7 DM |
265 | next if ($fn eq 'pve-admin-guide.adoc') && |
266 | $fileinfo->{outfile}->{$env}->{$filename}; | |
aa99b349 DM |
267 | $filename = $fn; |
268 | $repeat = 1; | |
269 | last; | |
270 | } | |
271 | } | |
272 | } | |
74b0334e | 273 | |
aa99b349 DM |
274 | return $filename; |
275 | } | |
276 | ||
f3c27fb1 DM |
277 | |
278 | # try to generate output file mapping | |
279 | foreach my $e (@$start_env) { | |
280 | my $toplevel_hash = $fileinfo->{toplevel}->{$e}; | |
281 | foreach my $fn (sort keys %$toplevel_hash) { | |
282 | my $mansection = $fileinfo->{mansection}->{manvolnum}->{$fn}; | |
283 | if ($e eq 'wiki') { | |
284 | my $realfn = $fn; | |
285 | $realfn =~ s/\.adoc$//; | |
286 | if (defined($mansection) && ($mansection == 5)) { | |
287 | $realfn .= ".$mansection"; | |
288 | } | |
cb32a49b DM |
289 | $realfn = "$realfn-plain.html"; |
290 | $fileinfo->{outfile}->{$e}->{$fn} = $realfn; | |
291 | } elsif ($e eq 'manvolnum') { | |
292 | my $realfn = $fn; | |
293 | $realfn =~ s/\.adoc$//; | |
294 | die "toplevel file '$fn' is marhes as manual page!" if !$mansection; | |
295 | $realfn .= ".$mansection"; | |
f3c27fb1 DM |
296 | $fileinfo->{outfile}->{$e}->{$fn} = $realfn; |
297 | } | |
298 | } | |
299 | } | |
300 | ||
aa99b349 DM |
301 | # now resolve blockids |
302 | foreach my $e (@$start_env) { | |
303 | my $blockid_hash = $fileinfo->{blockid}->{$e}; | |
304 | foreach my $blockid (keys %$blockid_hash) { | |
305 | my $fn = resolve_link_target($e, $blockid_hash->{$blockid}); | |
306 | if ($e eq 'wiki') { | |
307 | my $title = $fileinfo->{titles}->{$e}->{$fn}; | |
0e1bf0da | 308 | $title =~ s/\s/_/g; |
aa99b349 DM |
309 | die "found not title for '$fn' in env '$e'" if !$title; |
310 | $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/wiki/$title#$blockid"; | |
f3c27fb1 DM |
311 | |
312 | # we do not produce wiki pages for all content | |
313 | #my $realfn = $fileinfo->{outfile}->{$e}->{$fn}; | |
314 | #warn "no output file mapping for '$fn' ($e)\n" if !$realfn; | |
315 | ||
5e625ed3 | 316 | } elsif ($e eq 'default') { |
fe38a7e7 DM |
317 | my $realfn = $fileinfo->{outfile}->{$e}->{$fn} || |
318 | die "no output file mapping for '$fn'\n"; | |
5e625ed3 | 319 | $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/pve-docs/$realfn#$blockid"; |
fe38a7e7 DM |
320 | } elsif ($e eq 'manvolnum') { |
321 | # we do not produce manpages for all content | |
322 | # my $realfn = $fileinfo->{outfile}->{$e}->{$fn} || | |
323 | # warn "no output file mapping for '$fn'\n"; | |
aa99b349 DM |
324 | $fileinfo->{blockid_target}->{$e}->{$blockid} = $fn; |
325 | } | |
326 | } | |
327 | } | |
328 | ||
329 | ||
86f28451 | 330 | print to_json($fileinfo, { pretty => 1, canonical => 1 } ); |