]>
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 | ||
aa99b349 DM |
17 | my $fileinfo = {}; |
18 | ||
19 | my $start_env = []; | |
20 | foreach my $e (keys %$environments) { | |
21 | push @$start_env, $e if $environments->{$e}; | |
22 | } | |
23 | ||
24 | my $env_stack = [$start_env]; | |
25 | my $env_name_stack = []; | |
26 | ||
27 | sub reset_environment_stack { | |
28 | $env_stack = [$start_env]; | |
29 | $env_name_stack = []; | |
30 | } | |
31 | ||
32 | sub 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 | ||
56 | sub 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 | ||
69 | sub 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 | ||
79 | sub 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 DM |
92 | sub register_title { |
93 | my ($filename, $env, $doctype, $title) = @_; | |
94 | ||
95 | # fixme: what about other macros? | |
96 | $title =~ s/\{pve\}/Proxmox VE/g; | |
97 | $title =~ s!http://\S+\[(.*?)\]!$1!g; | |
98 | ||
99 | $fileinfo->{titles}->{$env}->{$filename} = $title; | |
edc73653 DM |
100 | |
101 | if (defined($doctype)) { | |
102 | $fileinfo->{doctype}->{$env}->{$filename} = $doctype; | |
103 | } else { | |
104 | die "unable to change title (no doctype)" | |
105 | if !defined($fileinfo->{doctype}->{$env}->{$filename}); | |
106 | } | |
34d7f485 DM |
107 | |
108 | if (defined($doctype) && ($env eq 'manvolnum') && ($doctype == 0)) { | |
109 | if ($title =~ m/.*\(([1-8])\)\s*$/) { | |
110 | $fileinfo->{mansection}->{$env}->{$filename} = $1; | |
111 | } | |
112 | } | |
152b10fb DM |
113 | } |
114 | ||
aa99b349 DM |
115 | sub scan_adoc_file { |
116 | my ($filename) = @_; | |
117 | ||
118 | reset_environment_stack(); | |
74b0334e | 119 | |
aa99b349 DM |
120 | # print "SCAN $filename\n"; |
121 | ||
122 | my $fh = IO::File->new("$filename", "r") or | |
123 | die "unable to open file '$filename' - $!\n"; | |
124 | ||
125 | my $env_last_line = {}; | |
74b0334e | 126 | |
aa99b349 DM |
127 | while (defined (my $line = <$fh>)) { |
128 | if ($line =~ m/^if(n?)def::(\S+)\[(.*)\]\s*$/) { | |
74b0334e | 129 | my ($not, $env, $text) = ($1, $2, $3); |
aa99b349 DM |
130 | die "unsuported ifdef usage - implement me" if $text; |
131 | push_environment($env, $not); | |
132 | next; | |
133 | } elsif ($line =~ m/^endif::(\S+)\[(.*)\]\s*$/) { | |
134 | my ($env, $text) = ($1, $2); | |
135 | die "unsuported ifdef usage - implement me" if $text; | |
136 | pop_environment($env); | |
137 | next; | |
138 | } elsif ($line =~ m/^include::(\S+)\[.*\]\s*$/) { | |
139 | register_include($filename, $1, $env_stack->[-1]); | |
140 | next; | |
141 | } | |
142 | ||
143 | # try to detect titles | |
144 | foreach my $e (@{$env_stack->[-1]}) { | |
145 | my $title = $fileinfo->{titles}->{$e}->{$filename}; | |
146 | next if defined($title); | |
147 | ||
0142692a | 148 | if ($line =~ m/^=====+$/) { |
152b10fb | 149 | register_title($filename, $e, 0, $env_last_line->{$e}); |
0142692a | 150 | } elsif ($line =~ m/^-----+$/) { |
152b10fb | 151 | register_title($filename, $e, 1, $env_last_line->{$e}); |
0142692a | 152 | } elsif ($line =~ m/^= +(\S.*?)( +=)?$/) { |
152b10fb | 153 | register_title($filename, $e, 0, $1); |
0142692a | 154 | } elsif ($line =~ m/^== +(\S.*?)( +==)?$/) { |
152b10fb | 155 | register_title($filename, $e, 1, $1); |
aa99b349 | 156 | } |
0142692a | 157 | |
aa99b349 DM |
158 | $env_last_line->{$e} = $line; |
159 | chomp $env_last_line->{$e}; | |
160 | } | |
74b0334e | 161 | |
5f09af76 DM |
162 | if ($line =~ m/^:(\S+?):\s*(.*\S)?\s*$/) { |
163 | my ($key, $value) = ($1, $2); | |
164 | if ($key eq 'pve-toplevel') { | |
5e625ed3 | 165 | |
5f09af76 DM |
166 | foreach my $e (@{$env_stack->[-1]}) { |
167 | my $title = $fileinfo->{titles}->{$e}->{$filename}; | |
168 | die "not title for toplevel file '$filename' (env=$e)\n" | |
169 | if !defined($title); | |
170 | $fileinfo->{toplevel}->{$e}->{$filename} = 1; | |
171 | } | |
edc73653 DM |
172 | } elsif ($key eq 'title') { |
173 | foreach my $e (@{$env_stack->[-1]}) { | |
174 | register_title($filename, $e, undef, $value); | |
175 | } | |
5f09af76 DM |
176 | } |
177 | } | |
178 | ||
aa99b349 DM |
179 | if ($line =~ m/^\[\[(.*)\]\]\s*$/) { |
180 | my $blockid = $1; | |
181 | die "implement me" if $blockid =~m/,/; | |
45930831 DM |
182 | my $reftext = ''; |
183 | register_blockid($filename, $blockid, $reftext, $env_stack->[-1]); | |
aa99b349 | 184 | } |
a0ba8b4c DM |
185 | # fixme: "anchor:" |
186 | # bibliography anchors | |
187 | if ($line =~ m/\[\[\[([^\]]*)\]\]\]/) { | |
188 | my $blockid = $1; | |
189 | die "implement me" if $blockid =~m/,/; | |
45930831 | 190 | register_blockid($filename, $blockid, "[$blockid]", $env_stack->[-1]); |
a0ba8b4c | 191 | } |
74b0334e | 192 | } |
aa99b349 DM |
193 | } |
194 | ||
195 | my $scanned_files = {}; | |
196 | while (my $filename = shift) { | |
197 | next if $filename !~ m/\.adoc$/; # skip attributes.txt | |
198 | next if $scanned_files->{$filename}; | |
199 | ||
200 | scan_adoc_file($filename); | |
201 | $scanned_files->{$filename} = 1; | |
202 | } | |
203 | ||
204 | sub resolve_link_target { | |
205 | my ($env, $filename) = @_; | |
206 | ||
207 | my $include_hash = $fileinfo->{include}->{$env}; | |
208 | ||
209 | my $repeat = 1; | |
210 | ||
211 | while ($repeat) { | |
212 | $repeat = 0; | |
213 | foreach my $fn (keys %$include_hash) { | |
5e625ed3 | 214 | next if $fn eq 'pve-admin-guide.adoc'; |
aa99b349 DM |
215 | if ($include_hash->{$fn}->{$filename}) { |
216 | $filename = $fn; | |
217 | $repeat = 1; | |
218 | last; | |
219 | } | |
220 | } | |
221 | } | |
74b0334e | 222 | |
aa99b349 DM |
223 | return $filename; |
224 | } | |
225 | ||
226 | # now resolve blockids | |
227 | foreach my $e (@$start_env) { | |
228 | my $blockid_hash = $fileinfo->{blockid}->{$e}; | |
229 | foreach my $blockid (keys %$blockid_hash) { | |
230 | my $fn = resolve_link_target($e, $blockid_hash->{$blockid}); | |
231 | if ($e eq 'wiki') { | |
232 | my $title = $fileinfo->{titles}->{$e}->{$fn}; | |
0e1bf0da | 233 | $title =~ s/\s/_/g; |
aa99b349 DM |
234 | die "found not title for '$fn' in env '$e'" if !$title; |
235 | $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/wiki/$title#$blockid"; | |
5e625ed3 DM |
236 | } elsif ($e eq 'default') { |
237 | my $realfn = "chapter-$fn"; | |
238 | $realfn =~ s/\.adoc/.html/; | |
239 | $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/pve-docs/$realfn#$blockid"; | |
aa99b349 DM |
240 | } else { |
241 | $fileinfo->{blockid_target}->{$e}->{$blockid} = $fn; | |
242 | } | |
243 | } | |
244 | } | |
245 | ||
246 | ||
247 | print to_json($fileinfo, { pretty => 1 } ); |