--- trunk/lib/WebPAC/Parser.pm 2006/09/24 21:13:40 692 +++ trunk/lib/WebPAC/Parser.pm 2006/09/29 18:55:31 724 @@ -9,7 +9,7 @@ use Data::Dump qw/dump/; use File::Slurp; -use base qw/WebPAC::Common WebPAC::Normalize/; +use base qw/WebPAC::Common/; =head1 NAME @@ -17,14 +17,24 @@ =head1 VERSION -Version 0.03 +Version 0.06 =cut -our $VERSION = '0.03'; +our $VERSION = '0.06'; =head1 SYNOPSIS +This module will parse L directives and generate source +to produce lookups and normalization. + +It's written using L, pure-perl parser for perl and heavily influenced by +reading about LISP. It might be a bit over-the board, but at least it removed +separate configuration files for lookups. + +This is experimental code, but it replaces all older formats which where, +at one point in time, available in WebPAC. + FIXME =head1 FUNCTIONS @@ -51,87 +61,195 @@ $log->logdie("can't iterate_inputs over this config object") unless ($self->{config}->can('iterate_inputs')); - $self->read_sources; - - $self->{config}->iterate_inputs( sub { - my ($input, $database) = @_; - return unless $self->valid_database_input($database, $input->{name}); - $self->parse_lookups($database,$input->{name}); - } ); + $self->_read_sources; $self ? return $self : return undef; } -=head2 read_sources +=head2 valid_database + + my $ok = $parse->valid_database('key'); + +=cut + +sub valid_database { + my $self = shift; + + my $database = shift || return; + + return defined($self->{valid_inputs}->{ _q($database) }); +} + +=head2 valid_database_input + + my $ok = $parse->valid_database('database_key','input_name'); + +=cut + +sub valid_database_input { + my $self = shift; + my ($database,$input) = @_; + $input = _input_name($input); + return defined($self->{valid_inputs}->{ _q($database) }->{ _q($input) }); +} + +=head2 depends + +Return all databases and inputs on which specified one depends + + $depends_on = $parser->depends('database','input'); + +=cut + +sub depends { + my $self = shift; + my ($database,$input) = @_; + $input = _input_name($input); + $self->_get_logger->debug("depends($database,$input)"); + return unless ( + defined( $self->{depends}->{ _q($database) } ) && + defined( $self->{depends}->{ _q($database) }->{ _q($input) } ) + ); + return $self->{depends}->{ _q($database) }->{ _q($input) }; +} + +=head2 have_lookup_create + + my @keys = $parser->have_lookup_create($database, $input); + +=cut + +sub have_lookup_create { + my $self = shift; + my ($database,$input) = @_; + $input = _input_name($input); + return unless ( + defined( $self->{_lookup_create_key}->{ _q($database) } ) && + defined( $self->{_lookup_create_key}->{ _q($database) }->{ _q($input) } ) + ); + return keys %{ $self->{_lookup_create_key}->{ _q($database) }->{ _q($input) } }; +} + + +=head2 lookup_create_rules + + my $source = $parser->lookup_create_rules($database, $input); + +=cut + +sub lookup_create_rules { + my $self = shift; + my ($database,$input) = @_; + $input = _input_name($input); + return unless ( + defined( $self->{_lookup_create}->{ _q($database) } ) && + defined( $self->{_lookup_create}->{ _q($database) }->{ _q($input) } ) + ); + return $self->{_lookup_create}->{ _q($database) }->{ _q($input) }; +} + +=head2 normalize_rules + + my $source = $parser->normalize_rules($database, $input); + +=cut + +sub normalize_rules { + my $self = shift; + my ($database,$input) = @_; + $input = _input_name($input); + return unless ( + defined( $self->{_normalize_source}->{ _q($database) } ) && + defined( $self->{_normalize_source}->{ _q($database) }->{ _q($input) } ) + ); + return $self->{_normalize_source}->{ _q($database) }->{ _q($input) }; +} + +=head1 PRIVATE + +=head2 _read_sources - my $source_files = $parser->read_sources; + my $source_files = $parser->_read_sources; Called by L. =cut -sub read_sources { +sub _read_sources { my $self = shift; my $log = $self->_get_logger(); my $nr = 0; + my @lookups; + $self->{config}->iterate_inputs( sub { my ($input, $database) = @_; - my $path = $input->{normalize}->{path} || return; - my $full = $self->{base_path} ? $self->{base_path} . '/' . $path : $path; + $log->debug("database: $database input = ", dump($input)); - $log->logdie("normalization input $full doesn't exist") unless (-e $full); + foreach my $normalize (@{ $input->{normalize} }) { - my $s = read_file( $full ) || $log->logdie("can't read $full: $!"); + my $path = $normalize->{path}; + return unless($path); + my $full = $self->{base_path} ? $self->{base_path} . '/' . $path : $path; - my $input_name = $input->{name} || $log->logdie("can't deduce name of input: ", dump( $input )); + $log->logdie("normalization input $full doesn't exist") unless (-e $full); - $log->debug("$database/$input_name: adding $path"); + my $s = read_file( $full ) || $log->logdie("can't read $full: $!"); - $self->{valid_inputs}->{$database}->{$input_name} = { - source => $s, - path => $full, - usage => 0, - } unless defined($self->{valid_inputs}->{$database}->{$input_name}); + my $input_name = _input_name($input) || $log->logdie("can't deduce name of input: ", dump( $input )); - $self->{valid_inputs}->{$database}->{$input_name}->{usage}++; + $log->debug("$database/$input_name: adding $path"); - $nr++; + $self->{valid_inputs}->{$database}->{$input_name}++; + + push @lookups, sub { + $self->_parse_lookups( $database, $input_name, $full, $s ); + }; + + $nr++; + } } ); $log->debug("found $nr source files"); + # parse all lookups + $_->() foreach (@lookups); + return $nr; } -=head2 parse_lookups +=head2 _parse_lookups + + $parser->_parse_lookups($database,$input,$path,$source); - $parser->parse_lookups($database,$input); +Called for each normalize source (rules) in each input by L + +It will report invalid databases and inputs in error log after parsing. =cut -sub parse_lookups { +sub _parse_lookups { my $self = shift; - my ($database, $input) = @_; + my ($database, $input, $path, $source) = @_; + + $input = _input_name($input); my $log = $self->_get_logger(); $log->logdie("invalid database $database" ) unless $self->valid_database( $database ); $log->logdie("invalid input $input of database $database", ) unless $self->valid_database_input( $database, $input ); - my $source = $self->{valid_inputs}->{$database}->{$input}->{source}; - my $path = $self->{valid_inputs}->{$database}->{$input}->{path}; - $log->logdie("no source found for database $database input $input path $path") unless ($source); - $log->info("parsing lookups for $database/$input from $path"); + $log->info("parsing lookups for $database/$input from $path (",length($source)," bytes)"); my $Document = PPI::Document->new( \$source ) || $log->logdie("can't parse source:\n", $self->{source}); $Document->prune('PPI::Token::Whitespace'); + $Document->prune('PPI::Token::Comment'); #$Document->prune('PPI::Token::Operator'); # Find all the named subroutines @@ -196,20 +314,26 @@ $log->debug("key = $key"); - my $create = ' - $coderef = ' . $e[7] . $e[8] . '; - foreach my $v ($coderef->()) { - next unless (defined($v) && $v ne \'\'); - push @{ $lookup->{\'' . $key . '\'}->{$v} }, $mfn; - } - '; + return $self->_lookup_error("invalid database $e[3] in $path" ) unless $self->valid_database( $e[3] ); + return $self->_lookup_error("invalid input $e[5] of database $e[3] in $path", ) unless $self->valid_database_input( $e[3], $e[5] ); + + my $create = qq{ + save_into_lookup($e[3],$e[5],'$key', $e[7] $e[8] ); + }; $log->debug("create: $create"); - return $self->_lookup_error("invalid database $e[3] in $path" ) unless $self->valid_database( $e[3] ); - return $self->_lookup_error("invalid input $e[5] of database $e[3] in $path", ) unless $self->valid_database_input( $e[3], $e[5] ); + # save code to create this lookup + $self->{_lookup_create}->{ _q($e[3]) }->{ _q($e[5]) } .= $create; + $self->{_lookup_create_key}->{ _q($e[3]) }->{ _q($e[5]) }->{ _q($key) }++; - $self->add_lookup_create( $e[3], $e[5], $create ); + + if (defined( $self->{depends}->{ $database }->{ $input }->{ _q($e[3]) }->{ _q($e[5]) }->{ $key } )) { + $log->warn("dependency of $database/$input on $e[3]/$e[5] with $key allready recorded"); + } + + # save this dependency + $self->{depends}->{ $database }->{ $input }->{ _q($e[3]) }->{ _q($e[5]) }->{$key}++; if ($#e < 10) { $e[8]->insert_after( $e[8]->clone ); @@ -225,11 +349,11 @@ $log->debug(">>> ", $Element->snext_sibling); }); - my $source = $Document->serialize; + my $normalize_source = $Document->serialize; $log->debug("create: ", dump($self->{_lookup_create}) ); - $log->debug("normalize: $source"); + $log->debug("normalize: $normalize_source"); - $self->{_normalize_source}->{$database}->{$input} = $source; + $self->{_normalize_source}->{$database}->{$input} .= $normalize_source; if ($self->{debug}) { my $Dumper = PPI::Dumper->new( $Document ); @@ -241,50 +365,41 @@ return 1; } -=head2 add_lookup_create - $parse->add_lookup_create($database,$input,$source); +=head2 _q -=cut - -sub add_lookup_create { - my $self = shift; - my ($database,$input,$source) = @_; - $self->{_lookup_create}->{$database}->{$input} .= $source; -} +Strip single or double quotes around value - -=head2 valid_database - - my $ok = $parse->valid_database('key'); + _q(qq/'foo'/) -> foo =cut -sub valid_database { - my $self = shift; - - my $database = shift || return; - $database =~ s/['"]//g; - - return defined($self->{valid_inputs}->{$database}); +sub _q { + my $v = shift || return; + $v =~ s/^['"]*//g; + $v =~ s/['"]*$//g; + return $v; } -=head2 valid_database_input +=head2 _input_name - my $ok = $parse->valid_database('database_key','input_name'); +Return C value if HASH or arg if scalar -=cut + _input_name($input) -sub valid_database_input { - my $self = shift; - - my ($database,$input) = @_; - $database =~ s/['"]//g; - $input =~ s/['"]//g; +=cut - return defined($self->{valid_inputs}->{$database}->{$input}); +sub _input_name { + my $input = shift || return; + if (ref($input) eq 'HASH') { + die "can't find 'name' value in ", dump($input) unless defined($input->{name}); + return $input->{name}; + } else { + return $input; + } } + =head1 AUTHOR Dobrica Pavlinusic, C<< >>