3 |
use warnings; |
use warnings; |
4 |
use strict; |
use strict; |
5 |
|
|
|
use base qw/WebPAC::Common WebPAC::Normalize/; |
|
6 |
|
|
7 |
use PPI; |
use PPI; |
8 |
use PPI::Dumper; |
use PPI::Dumper; |
9 |
use Data::Dump qw/dump/; |
use Data::Dump qw/dump/; |
10 |
use File::Slurp; |
use File::Slurp; |
11 |
|
|
12 |
|
use base qw/WebPAC::Common WebPAC::Normalize/; |
13 |
|
|
14 |
=head1 NAME |
=head1 NAME |
15 |
|
|
17 |
|
|
18 |
=head1 VERSION |
=head1 VERSION |
19 |
|
|
20 |
Version 0.01 |
Version 0.04 |
21 |
|
|
22 |
=cut |
=cut |
23 |
|
|
24 |
our $VERSION = '0.01'; |
our $VERSION = '0.04'; |
25 |
|
|
26 |
=head1 SYNOPSIS |
=head1 SYNOPSIS |
27 |
|
|
28 |
|
This module will parse L<WebPAC::Normalize/lookup> directives and generate source |
29 |
|
to produce lookups and normalization. |
30 |
|
|
31 |
|
It's written using L<PPI>, pure-perl parser for perl and heavily influenced by |
32 |
|
reading about LISP. It might be a bit over-the board, but at least it removed |
33 |
|
separate configuration files for lookups. |
34 |
|
|
35 |
|
This is experimental code, but it replaces all older formats which where, |
36 |
|
at one point in time, available in WebPAC. |
37 |
|
|
38 |
FIXME |
FIXME |
39 |
|
|
40 |
=head1 FUNCTIONS |
=head1 FUNCTIONS |
61 |
|
|
62 |
$log->logdie("can't iterate_inputs over this config object") unless ($self->{config}->can('iterate_inputs')); |
$log->logdie("can't iterate_inputs over this config object") unless ($self->{config}->can('iterate_inputs')); |
63 |
|
|
64 |
my $source; |
$self->read_sources; |
65 |
|
|
66 |
|
$self ? return $self : return undef; |
67 |
|
} |
68 |
|
|
69 |
|
=head2 read_sources |
70 |
|
|
71 |
|
my $source_files = $parser->read_sources; |
72 |
|
|
73 |
|
Called by L</new>. |
74 |
|
|
75 |
|
=cut |
76 |
|
|
77 |
|
sub read_sources { |
78 |
|
my $self = shift; |
79 |
|
|
80 |
|
my $log = $self->_get_logger(); |
81 |
|
|
82 |
|
my $nr = 0; |
83 |
|
|
84 |
|
my @lookups; |
85 |
|
|
86 |
$self->{config}->iterate_inputs( sub { |
$self->{config}->iterate_inputs( sub { |
87 |
my $input = shift; |
my ($input, $database) = @_; |
88 |
my $path = $input->{normalize}->{path} || return; |
|
89 |
my $full = $self->{base_path} ? $self->{base_path} . '/' . $path : $path; |
$log->debug("database: $database input = ", dump($input)); |
90 |
$log->logdie("normalization input $full doesn't exist") unless (-e $full); |
|
91 |
my $s = read_file( $full ) || $log->logdie("can't read $full: $!"); |
foreach my $normalize (@{ $input->{normalize} }) { |
92 |
$log->debug("adding $path to parser [",length($s)," bytes]"); |
|
93 |
$source .= $s; |
my $path = $normalize->{path}; |
94 |
|
return unless($path); |
95 |
|
my $full = $self->{base_path} ? $self->{base_path} . '/' . $path : $path; |
96 |
|
|
97 |
|
$log->logdie("normalization input $full doesn't exist") unless (-e $full); |
98 |
|
|
99 |
|
my $s = read_file( $full ) || $log->logdie("can't read $full: $!"); |
100 |
|
|
101 |
|
my $input_name = _input_name($input) || $log->logdie("can't deduce name of input: ", dump( $input )); |
102 |
|
|
103 |
|
$log->debug("$database/$input_name: adding $path"); |
104 |
|
|
105 |
|
$self->{valid_inputs}->{$database}->{$input_name}++; |
106 |
|
|
107 |
|
push @lookups, sub { |
108 |
|
$self->parse_lookups( $database, $input_name, $full, $s ); |
109 |
|
}; |
110 |
|
|
111 |
|
$nr++; |
112 |
|
} |
113 |
} ); |
} ); |
114 |
|
|
115 |
$log->debug("collected ", length($source), " bytes of source"); |
$log->debug("found $nr source files"); |
116 |
|
|
117 |
$self->{source} = $source; |
# parse all lookups |
118 |
|
$_->() foreach (@lookups); |
119 |
|
|
120 |
$self ? return $self : return undef; |
return $nr; |
121 |
} |
} |
122 |
|
|
123 |
=head2 parse |
=head2 parse_lookups |
124 |
|
|
125 |
|
$parser->parse_lookups($database,$input,$path,$source); |
126 |
|
|
127 |
|
Called for each normalize source in each input by L</new> |
128 |
|
|
129 |
|
It will report invalid databases and inputs in error log after parsing. |
130 |
|
|
131 |
=cut |
=cut |
132 |
|
|
133 |
sub parse { |
sub parse_lookups { |
134 |
my $self = shift; |
my $self = shift; |
135 |
|
my ($database, $input, $path, $source) = @_; |
136 |
|
|
137 |
|
$input = _input_name($input); |
138 |
|
|
139 |
my $log = $self->_get_logger(); |
my $log = $self->_get_logger(); |
140 |
|
|
141 |
$log->logdie('no source found in object') unless ($self->{source}); |
$log->logdie("invalid database $database" ) unless $self->valid_database( $database ); |
142 |
|
$log->logdie("invalid input $input of database $database", ) unless $self->valid_database_input( $database, $input ); |
143 |
|
|
144 |
|
$log->logdie("no source found for database $database input $input path $path") unless ($source); |
145 |
|
|
146 |
|
$log->info("parsing lookups for $database/$input from $path (",length($source)," bytes)"); |
147 |
|
|
148 |
my $Document = PPI::Document->new( \$self->{source} ) || $log->logdie("can't parse source:\n", $self->{source}); |
my $Document = PPI::Document->new( \$source ) || $log->logdie("can't parse source:\n", $self->{source}); |
149 |
|
|
150 |
$Document->prune('PPI::Token::Whitespace'); |
$Document->prune('PPI::Token::Whitespace'); |
151 |
#$Document->prune('PPI::Token::Operator'); |
#$Document->prune('PPI::Token::Operator'); |
152 |
|
|
153 |
# Find all the named subroutines |
# Find all the named subroutines |
154 |
|
|
155 |
my $eval_create; |
$self->{_lookup_errors} = (); |
156 |
|
|
157 |
|
sub _lookup_error { |
158 |
|
my $self = shift; |
159 |
|
my $msg = shift; |
160 |
|
$self->_get_logger->logconfess("error without message?") unless ($msg); |
161 |
|
push @{ $self->{_lookup_errors} }, $msg; |
162 |
|
return ''; |
163 |
|
} |
164 |
|
|
165 |
$Document->find( sub { |
$Document->find( sub { |
166 |
my ($Document,$Element) = @_; |
my ($Document,$Element) = @_; |
222 |
|
|
223 |
$log->debug("create: $create"); |
$log->debug("create: $create"); |
224 |
|
|
225 |
$create =~ s/\s+/ /gs; |
return $self->_lookup_error("invalid database $e[3] in $path" ) unless $self->valid_database( $e[3] ); |
226 |
$eval_create->{ $e[3] }->{ $e[5] } .= $create; |
return $self->_lookup_error("invalid input $e[5] of database $e[3] in $path", ) unless $self->valid_database_input( $e[3], $e[5] ); |
227 |
|
|
228 |
|
# save code to create this lookup |
229 |
|
$self->{_lookup_create}->{ _q($e[3]) }->{ _q($e[5]) }->{ _q($key) } .= $create; |
230 |
|
|
231 |
|
|
232 |
|
if (defined( $self->{depends}->{ $database }->{ $input }->{ _q($e[3]) }->{ _q($e[5]) } )) { |
233 |
|
my $dep_key = $self->{depends}->{ $database }->{ $input }->{ _q($e[3]) }->{ _q($e[5]) }; |
234 |
|
$log->warn("dependency of $database/$input on $e[3]/$e[5] allready recorded as $dep_key, now changed to $key") if ($dep_key ne $key); |
235 |
|
} |
236 |
|
|
237 |
|
# save this dependency |
238 |
|
$self->{depends}->{ $database }->{ $input }->{ _q($e[3]) }->{ _q($e[5]) } .= $key; |
239 |
|
|
240 |
if ($#e < 10) { |
if ($#e < 10) { |
241 |
$e[8]->insert_after( $e[8]->clone ); |
$e[8]->insert_after( $e[8]->clone ); |
251 |
$log->debug(">>> ", $Element->snext_sibling); |
$log->debug(">>> ", $Element->snext_sibling); |
252 |
}); |
}); |
253 |
|
|
254 |
$log->info("create: ", dump($eval_create) ); |
my $normalize_source = $Document->serialize; |
255 |
$log->info("lookup: ", $Document->serialize ); |
$log->debug("create: ", dump($self->{_lookup_create}) ); |
256 |
|
$log->debug("normalize: $normalize_source"); |
257 |
|
|
258 |
|
$self->{_normalize_source}->{$database}->{$input} = $normalize_source; |
259 |
|
|
260 |
if ($self->{debug}) { |
if ($self->{debug}) { |
261 |
my $Dumper = PPI::Dumper->new( $Document ); |
my $Dumper = PPI::Dumper->new( $Document ); |
262 |
$Dumper->print; |
$Dumper->print; |
263 |
} |
} |
264 |
|
|
265 |
|
$log->error("Parser errors:\n", join("\n",@{ $self->{_lookup_errors} }) ) if ($self->{_lookup_errors}); |
266 |
|
|
267 |
return 1; |
return 1; |
268 |
} |
} |
269 |
|
|
270 |
|
|
271 |
|
=head2 lookup_create_rules |
272 |
|
|
273 |
|
my $source = $parser->lookup_create_rules($database, $input); |
274 |
|
|
275 |
|
=cut |
276 |
|
|
277 |
|
sub lookup_create_rules { |
278 |
|
my $self = shift; |
279 |
|
my ($database,$input) = @_; |
280 |
|
return $self->{_lookup_create}->{ _q($database) }->{ _q($input) }; |
281 |
|
} |
282 |
|
|
283 |
|
=head2 valid_database |
284 |
|
|
285 |
|
my $ok = $parse->valid_database('key'); |
286 |
|
|
287 |
|
=cut |
288 |
|
|
289 |
|
sub valid_database { |
290 |
|
my $self = shift; |
291 |
|
|
292 |
|
my $database = shift || return; |
293 |
|
|
294 |
|
return defined($self->{valid_inputs}->{ _q($database) }); |
295 |
|
} |
296 |
|
|
297 |
|
=head2 valid_database_input |
298 |
|
|
299 |
|
my $ok = $parse->valid_database('database_key','input_name'); |
300 |
|
|
301 |
|
=cut |
302 |
|
|
303 |
|
sub valid_database_input { |
304 |
|
my $self = shift; |
305 |
|
|
306 |
|
my ($database,$input) = @_; |
307 |
|
return defined($self->{valid_inputs}->{ _q($database) }->{ _q($input) }); |
308 |
|
} |
309 |
|
|
310 |
|
=head2 depends |
311 |
|
|
312 |
|
Return all databases and inputs on which specified one depends |
313 |
|
|
314 |
|
$depends_on = $parser->depends('database','input'); |
315 |
|
|
316 |
|
=cut |
317 |
|
|
318 |
|
sub depends { |
319 |
|
my $self = shift; |
320 |
|
my ($database,$input) = @_; |
321 |
|
$self->_get_logger->debug("depends($database,$input)"); |
322 |
|
return unless ( |
323 |
|
defined( $self->{depends}->{ _q($database) } ) && |
324 |
|
defined( $self->{depends}->{ _q($database) }->{ _q($input) } ) |
325 |
|
); |
326 |
|
return $self->{depends}->{ _q($database) }->{ _q($input) }; |
327 |
|
} |
328 |
|
|
329 |
|
=head1 PRIVATE |
330 |
|
|
331 |
|
=head2 _q |
332 |
|
|
333 |
|
Strip single or double quotes around value |
334 |
|
|
335 |
|
_q(qq/'foo'/) -> foo |
336 |
|
|
337 |
|
=cut |
338 |
|
|
339 |
|
sub _q { |
340 |
|
my $v = shift || return; |
341 |
|
$v =~ s/^['"]*//g; |
342 |
|
$v =~ s/['"]*$//g; |
343 |
|
return $v; |
344 |
|
} |
345 |
|
|
346 |
|
=head2 _input_name |
347 |
|
|
348 |
|
Return C<name> value if HASH or arg if scalar |
349 |
|
|
350 |
|
_input_name($input) |
351 |
|
|
352 |
|
=cut |
353 |
|
|
354 |
|
sub _input_name { |
355 |
|
my $input = shift || return; |
356 |
|
if (ref($input) eq 'HASH') { |
357 |
|
die "can't find 'name' value in ", dump($input) unless defined($input->{name}); |
358 |
|
return $input->{name}; |
359 |
|
} else { |
360 |
|
return $input; |
361 |
|
} |
362 |
|
} |
363 |
|
|
364 |
|
|
365 |
=head1 AUTHOR |
=head1 AUTHOR |
366 |
|
|
367 |
Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >> |
Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >> |