/[webpac2]/trunk/lib/WebPAC/Parser.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /trunk/lib/WebPAC/Parser.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 689 by dpavlin, Sun Sep 24 18:52:35 2006 UTC revision 720 by dpavlin, Fri Sep 29 12:27:36 2006 UTC
# Line 3  package WebPAC::Parser; Line 3  package WebPAC::Parser;
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/;
13    
14  =head1 NAME  =head1 NAME
15    
# Line 17  WebPAC::Parser - parse perl normalizatio Line 17  WebPAC::Parser - parse perl normalizatio
17    
18  =head1 VERSION  =head1 VERSION
19    
20  Version 0.02  Version 0.06
21    
22  =cut  =cut
23    
24  our $VERSION = '0.02';  our $VERSION = '0.06';
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
# Line 51  sub new { Line 61  sub new {
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 valid_database
70    
71      my $ok = $parse->valid_database('key');
72    
73    =cut
74    
75    sub valid_database {
76            my $self = shift;
77    
78            my $database = shift || return;
79    
80            return defined($self->{valid_inputs}->{ _q($database) });
81    }
82    
83    =head2 valid_database_input
84    
85      my $ok = $parse->valid_database('database_key','input_name');
86    
87    =cut
88    
89    sub valid_database_input {
90            my $self = shift;
91            my ($database,$input) = @_;
92            $input = _input_name($input);
93            return defined($self->{valid_inputs}->{ _q($database) }->{ _q($input) });
94    }
95    
96    =head2 depends
97    
98    Return all databases and inputs on which specified one depends
99    
100      $depends_on = $parser->depends('database','input');
101    
102    =cut
103    
104    sub depends {
105            my $self = shift;
106            my ($database,$input) = @_;
107            $input = _input_name($input);
108            $self->_get_logger->debug("depends($database,$input)");
109            return unless (
110                    defined( $self->{depends}->{ _q($database) } ) &&
111                    defined( $self->{depends}->{ _q($database) }->{ _q($input) } )
112            );
113            return $self->{depends}->{ _q($database) }->{ _q($input) };
114    }
115    
116    =head2 have_lookup_create
117    
118      my @keys = $parser->have_lookup_create($database, $input);
119    
120    =cut
121    
122    sub have_lookup_create {
123            my $self = shift;
124            my ($database,$input) = @_;
125            $input = _input_name($input);
126            return unless (
127                    defined( $self->{_lookup_create_key}->{ _q($database) } ) &&
128                    defined( $self->{_lookup_create_key}->{ _q($database) }->{ _q($input) } )
129            );
130            return keys %{ $self->{_lookup_create_key}->{ _q($database) }->{ _q($input) } };
131    }
132    
133    
134    =head2 lookup_create_rules
135    
136      my $source = $parser->lookup_create_rules($database, $input);
137    
138    =cut
139    
140    sub lookup_create_rules {
141            my $self = shift;
142            my ($database,$input) = @_;
143            $input = _input_name($input);
144            return unless (
145                    defined( $self->{_lookup_create}->{ _q($database) } ) &&
146                    defined( $self->{_lookup_create}->{ _q($database) }->{ _q($input) } )
147            );
148            return $self->{_lookup_create}->{ _q($database) }->{ _q($input) };
149    }
150    
151    =head2 normalize_rules
152    
153      my $source = $parser->normalize_rules($database, $input);
154    
155    =cut
156    
157    sub normalize_rules {
158            my $self = shift;
159            my ($database,$input) = @_;
160            $input = _input_name($input);
161            return unless (
162                    defined( $self->{_normalize_source}->{ _q($database) } ) &&
163                    defined( $self->{_normalize_source}->{ _q($database) }->{ _q($input) } )
164            );
165            return $self->{_normalize_source}->{ _q($database) }->{ _q($input) };
166    }
167    
168    =head1 PRIVATE
169    
170    =head2 _read_sources
171    
172      my $source_files = $parser->_read_sources;
173    
174    Called by L</new>.
175    
176    =cut
177    
178    sub _read_sources {
179            my $self = shift;
180    
181            my $log = $self->_get_logger();
182    
183            my $nr = 0;
184    
185            my @lookups;
186    
187          $self->{config}->iterate_inputs( sub {          $self->{config}->iterate_inputs( sub {
188                  my ($input, $database) = @_;                  my ($input, $database) = @_;
189                  my $path = $input->{normalize}->{path} || return;  
190                  my $full = $self->{base_path} ? $self->{base_path} . '/' . $path : $path;                  $log->debug("database: $database input = ", dump($input));
191                  $log->logdie("normalization input $full doesn't exist") unless (-e $full);  
192                  my $s = read_file( $full ) || $log->logdie("can't read $full: $!");                  foreach my $normalize (@{ $input->{normalize} }) {
193                  my $input_name = $input->{name} || $log->logdie("can't deduce name of input: ", dump( $input ));  
194                  $log->debug("$database/$input_name: adding $path to parser [",length($s)," bytes]");                          my $path = $normalize->{path};
195                  $source .= $s;                          return unless($path);
196                  $self->{valid_inputs}->{$database}->{$input_name}++;                          my $full = $self->{base_path} ? $self->{base_path} . '/' . $path : $path;
197    
198                            $log->logdie("normalization input $full doesn't exist") unless (-e $full);
199    
200                            my $s = read_file( $full ) || $log->logdie("can't read $full: $!");
201    
202                            my $input_name = _input_name($input) || $log->logdie("can't deduce name of input: ", dump( $input ));
203    
204                            $log->debug("$database/$input_name: adding $path");
205    
206                            $self->{valid_inputs}->{$database}->{$input_name}++;
207    
208                            push @lookups, sub {
209                                    $self->_parse_lookups( $database, $input_name, $full, $s );
210                            };
211    
212                            $nr++;
213                    }
214          } );          } );
215    
216          $log->debug("collected ", length($source), " bytes of source");          $log->debug("found $nr source files");
217    
218          $self->{source} = $source;          # parse all lookups
219            $_->() foreach (@lookups);
220    
221          $self ? return $self : return undef;          return $nr;
222  }  }
223    
224  =head2 parse  =head2 _parse_lookups
225    
226      $parser->_parse_lookups($database,$input,$path,$source);
227    
228    Called for each normalize source (rules) in each input by L</_read_sources>
229    
230    It will report invalid databases and inputs in error log after parsing.
231    
232  =cut  =cut
233    
234  sub parse {  sub _parse_lookups {
235          my $self = shift;          my $self = shift;
236            my ($database, $input, $path, $source) = @_;
237    
238            $input = _input_name($input);
239    
240          my $log = $self->_get_logger();          my $log = $self->_get_logger();
241    
242          $log->logdie('no source found in object') unless ($self->{source});          $log->logdie("invalid database $database" ) unless $self->valid_database( $database );
243            $log->logdie("invalid input $input of database $database", ) unless $self->valid_database_input( $database, $input );
244    
245          $log->debug("valid_inputs = ", dump( $self->{valid_inputs} ));          $log->logdie("no source found for database $database input $input path $path") unless ($source);
246    
247          my $Document = PPI::Document->new( \$self->{source} ) || $log->logdie("can't parse source:\n", $self->{source});          $log->info("parsing lookups for $database/$input from $path (",length($source)," bytes)");
248    
249            my $Document = PPI::Document->new( \$source ) || $log->logdie("can't parse source:\n", $self->{source});
250    
251          $Document->prune('PPI::Token::Whitespace');          $Document->prune('PPI::Token::Whitespace');
252          #$Document->prune('PPI::Token::Operator');          #$Document->prune('PPI::Token::Operator');
253    
254          # Find all the named subroutines          # Find all the named subroutines
255    
256          my $eval_create;          $self->{_lookup_errors} = ();
257    
258            sub _lookup_error {
259                    my $self = shift;
260                    my $msg = shift;
261                    $self->_get_logger->logconfess("error without message?") unless ($msg);
262                    push @{ $self->{_lookup_errors} }, $msg;
263                    return '';
264            }
265    
266          $Document->find( sub {          $Document->find( sub {
267                          my ($Document,$Element) = @_;                          my ($Document,$Element) = @_;
# Line 144  sub parse { Line 313  sub parse {
313    
314                          $log->debug("key = $key");                          $log->debug("key = $key");
315    
316                          my $create = '                          return $self->_lookup_error("invalid database $e[3] in $path" ) unless $self->valid_database( $e[3] );
317                                  $coderef = ' . $e[7] . $e[8] . ';                          return $self->_lookup_error("invalid input $e[5] of database $e[3] in $path", ) unless $self->valid_database_input( $e[3], $e[5] );
318                                  foreach my $v ($coderef->()) {  
319                                          next unless (defined($v) && $v ne \'\');                          my $create = qq{
320                                          push @{ $lookup->{\'' . $key . '\'}->{$v} }, $mfn;                                  save_into_lookup($e[3],$e[5],'$key', $e[7] $e[8] );
321                                  }                          };
                         ';  
322    
323                          $log->debug("create: $create");                          $log->debug("create: $create");
324    
325                          $log->logdie("invalid database $e[3]" ) unless $self->valid_database( $e[3] );                          # save code to create this lookup
326                          $log->logdie("invalid input $e[5] of database $e[3]", ) unless $self->valid_database_input( $e[3], $e[5] );                          $self->{_lookup_create}->{ _q($e[3]) }->{ _q($e[5]) } .= $create;
327                            $self->{_lookup_create_key}->{ _q($e[3]) }->{ _q($e[5]) }->{ _q($key) }++;
328    
329                          $eval_create->{ $e[3] }->{ $e[5] } .= $create;  
330                            if (defined( $self->{depends}->{ $database }->{ $input }->{ _q($e[3]) }->{ _q($e[5]) }->{ $key } )) {
331                                    $log->warn("dependency of $database/$input on $e[3]/$e[5] with $key allready recorded");
332                            }
333    
334                            # save this dependency
335                            $self->{depends}->{ $database }->{ $input }->{ _q($e[3]) }->{ _q($e[5]) }->{$key}++;
336    
337                          if ($#e < 10) {                          if ($#e < 10) {
338                                  $e[8]->insert_after( $e[8]->clone );                                  $e[8]->insert_after( $e[8]->clone );
# Line 173  sub parse { Line 348  sub parse {
348                          $log->debug(">>> ", $Element->snext_sibling);                          $log->debug(">>> ", $Element->snext_sibling);
349          });          });
350    
351          $log->info("create: ", dump($eval_create) );          my $normalize_source = $Document->serialize;
352          $log->info("lookup: ", $Document->serialize );          $log->debug("create: ", dump($self->{_lookup_create}) );
353            $log->debug("normalize: $normalize_source");
354    
355            $self->{_normalize_source}->{$database}->{$input} .= $normalize_source;
356    
357          if ($self->{debug}) {          if ($self->{debug}) {
358                  my $Dumper = PPI::Dumper->new( $Document );                  my $Dumper = PPI::Dumper->new( $Document );
359                  $Dumper->print;                  $Dumper->print;
360          }          }
361    
362            $log->error("Parser errors:\n", join("\n",@{ $self->{_lookup_errors} }) ) if ($self->{_lookup_errors});
363    
364          return 1;          return 1;
365  }  }
366    
 =head2 valid_database  
367    
368    my $ok = $parse->valid_database('key');  =head2 _q
369    
370  =cut  Strip single or double quotes around value
371    
372  sub valid_database {    _q(qq/'foo'/) -> foo
         my $self = shift;  
373    
374          my $database = shift || return;  =cut
         $database =~ s/['"]//g;  
375    
376          return defined($self->{valid_inputs}->{$database});  sub _q {
377            my $v = shift || return;
378            $v =~ s/^['"]*//g;
379            $v =~ s/['"]*$//g;
380            return $v;
381  }  }
382    
383  =head2 valid_database_input  =head2 _input_name
   
   my $ok = $parse->valid_database('database_key','input_name');  
384    
385  =cut  Return C<name> value if HASH or arg if scalar
386    
387  sub valid_database_input {    _input_name($input)
         my $self = shift;  
388    
389          my ($database,$input) = @_;  =cut
         $database =~ s/['"]//g;  
         $input =~ s/['"]//g;  
390    
391          return defined($self->{valid_inputs}->{$database}->{$input});  sub _input_name {
392            my $input = shift || return;
393            if (ref($input) eq 'HASH') {
394                    die "can't find 'name' value in ", dump($input) unless defined($input->{name});
395                    return $input->{name};
396            } else {
397                    return $input;
398            }
399  }  }
400    
401    
402  =head1 AUTHOR  =head1 AUTHOR
403    
404  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>
Legend:
Removed from v.689  
changed lines
  Added in v.720
  ViewVC Help
Powered by ViewVC 1.1.26