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