use Data::Dump qw/dump/;
use File::Slurp;
-use base qw/WebPAC::Common WebPAC::Normalize/;
+use base qw/WebPAC::Common/;
=head1 NAME
-WebPAC::Parser - parse perl normalization configuration files and mungle it
+WebPAC::Parser - parse perl normalization configuration files (rules) and mungle it
=head1 VERSION
-Version 0.04
+Version 0.08
=cut
-our $VERSION = '0.04';
+our $VERSION = '0.08';
=head1 SYNOPSIS
This module will parse L<WebPAC::Normalize/lookup> directives and generate source
-to produce lookups and normalization.
+to produce lookups and normalization. It will also parse other parts of
+source to produce some of DWIM (I<Do What I Mean>) magic
+(like producing MARC oputput using L<WebPAC::Output::MARC> if there are C<marc_*>
+rules in normalisation).
It's written using L<PPI>, 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
my $parser = new WebPAC::Parser(
config => new WebPAC::Config(),
base_path => '/optional/path/to/conf',
+ only_database => $only
);
=cut
$log->logdie("can't iterate_inputs over this config object") unless ($self->{config}->can('iterate_inputs'));
- $self->read_sources;
+ $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) };
+}
+
+
+=head2 have_rules
+
+ my $do_marc = $parser->have_rules('marc', $database, $input);
+ my $do_index = $parser->have_rules('search', $database);
+
+This function will return hash containing count of all found C<marc_*> or
+C<search> directives. Input name is optional.
+
+=cut
+
+sub have_rules {
+ my $self = shift;
+
+ my $log = $self->_get_logger();
+ my $type = shift @_ || $log->logconfess("need at least type");
+ my $database = shift @_ || $log->logconfess("database is required");
+ my $input = shift @_;
+
+ $input = _input_name($input);
+
- my $source_files = $parser->read_sources;
+ return unless defined( $self->{_have_rules}->{ _q($database) } );
+
+ my $database_rules = $self->{_have_rules}->{ _q($database ) };
+
+ if (defined($input)) {
+
+ return unless (
+ defined( $database_rules->{ _q($input) } ) &&
+ defined( $database_rules->{ _q($input) }->{ $type } )
+ );
+
+ return $database_rules->{ _q($input) }->{ $type };
+ }
+
+ my $usage;
+
+ foreach my $i (keys %{ $database_rules }) {
+ next unless defined( $database_rules->{$i}->{$type} );
+
+ foreach my $t (keys %{ $database_rules->{ $i }->{$type} }) {
+ $usage->{ $t } += $database_rules->{ $i }->{ $t };
+ }
+ }
+
+ return $usage;
+
+}
+
+
+=head1 PRIVATE
+
+=head2 _read_sources
+
+ my $source_files = $parser->_read_sources;
Called by L</new>.
=cut
-sub read_sources {
+sub _read_sources {
my $self = shift;
my $log = $self->_get_logger();
my $nr = 0;
- my @lookups;
+ my @sources;
+
+ my $lookup_src_cache;
+
+ my $only_database = $self->{only_database};
+ my $only_input = $self->{only_input};
$self->{config}->iterate_inputs( sub {
my ($input, $database) = @_;
+ return if ( $only_database && $database !~ m/$only_database/i );
+ return if ( $only_input && $input->{name} !~ m/$only_input/i );
+
$log->debug("database: $database input = ", dump($input));
foreach my $normalize (@{ $input->{normalize} }) {
$self->{valid_inputs}->{$database}->{$input_name}++;
- push @lookups, sub {
- $self->parse_lookups( $database, $input_name, $full, $s );
+ push @sources, sub {
+ #warn "### $database $input_name, $full ###\n";
+ $self->_parse_source( $database, $input_name, $full, $s );
};
$nr++;
$log->debug("found $nr source files");
- # parse all lookups
- $_->() foreach (@lookups);
+ # parse all sources
+ $_->() foreach (@sources);
return $nr;
}
-=head2 parse_lookups
+=head2 _parse_source
- $parser->parse_lookups($database,$input,$path,$source);
+ $parser->_parse_source($database,$input,$path,$source);
-Called for each normalize source in each input by L</new>
+Called for each normalize source (rules) in each input by L</_read_sources>
It will report invalid databases and inputs in error log after parsing.
=cut
-sub parse_lookups {
+sub _parse_source {
my $self = shift;
my ($database, $input, $path, $source) = @_;
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
my ($Document,$Element) = @_;
$Element->isa('PPI::Token::Word') or return '';
+
+ if ( $Element->content eq 'sub' ) {
+ # repair demage done by prune of whitespace
+ $Element->insert_after( PPI::Token::Whitespace->new(' ') );
+ return '';
+ } elsif ( $Element->content eq 'my' ) {
+ $Element->insert_before( PPI::Token::Whitespace->new(' ') );
+ }
+
$Element->content eq 'lookup' or return '';
$log->debug("expansion: ", $Element->snext_sibling);
$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;
- }
- ';
-
- $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] );
+ my $create = qq{
+ save_into_lookup($e[3],$e[5],'$key', $e[7] $e[8] );
+ };
+
+ $log->debug("create: $create");
+
# save code to create this lookup
- $self->{_lookup_create}->{ _q($e[3]) }->{ _q($e[5]) }->{ _q($key) } .= $create;
+ $self->{_lookup_create}->{ _q($e[3]) }->{ _q($e[5]) } .= $create;
+ $self->{_lookup_create_key}->{ _q($e[3]) }->{ _q($e[5]) }->{ _q($key) }++;
- if (defined( $self->{depends}->{ $database }->{ $input }->{ _q($e[3]) }->{ _q($e[5]) } )) {
- my $dep_key = $self->{depends}->{ $database }->{ $input }->{ _q($e[3]) }->{ _q($e[5]) };
- $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);
+ 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;
+ $self->{depends}->{ $database }->{ $input }->{ _q($e[3]) }->{ _q($e[5]) }->{$key}++;
if ($#e < 10) {
$e[8]->insert_after( $e[8]->clone );
}
$e[7]->remove;
- $e[8]->insert_before( new PPI::Token::Quote::Single( "'$key'" ) );
+ $e[8]->insert_before( PPI::Token::Quote::Single->new( "'$key'" ) );
$e[8]->remove;
$log->debug("create: ", dump($self->{_lookup_create}) );
$log->debug("normalize: $normalize_source");
- $self->{_normalize_source}->{$database}->{$input} = $normalize_source;
+ $self->{_normalize_source}->{$database}->{$input} .= $normalize_source;
if ($self->{debug}) {
my $Dumper = PPI::Dumper->new( $Document );
$log->error("Parser errors:\n", join("\n",@{ $self->{_lookup_errors} }) ) if ($self->{_lookup_errors});
- return 1;
-}
-
-
-=head2 lookup_create_rules
-
- my $source = $parser->lookup_create_rules($database, $input);
-
-=cut
-
-sub lookup_create_rules {
- my $self = shift;
- my ($database,$input) = @_;
- return $self->{_lookup_create}->{ _q($database) }->{ _q($input) };
-}
-
-=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) = @_;
- 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');
+ $Document->find( sub {
+ my ($Document,$Element) = @_;
-=cut
+ $Element->isa('PPI::Token::Word') or return '';
+ if ($Element->content =~ m/^(marc|search)/) {
+ my $what = $1;
+ $log->debug("found $what rules in $database/$input");
+ $self->{_have_rules}->{ $database }->{ $input }->{ $what }->{ $Element->content }++;
+ } else {
+ return '';
+ }
+ });
-sub depends {
- my $self = shift;
- my ($database,$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) };
+ return 1;
}
-=head1 PRIVATE
=head2 _q
projects / webpac2 / blobdiff