lib/WebPAC/Lookup.pm

package WebPAC::Lookup;

use warnings;
use strict;

use WebPAC::Common;

use base qw/WebPAC::Common/;
use File::Slurp;
use Data::Dumper;

my $LOOKUP_REGEX = 'lookup{[^\{\}]+}';
my $LOOKUP_REGEX_SAVE = 'lookup{([^\{\}]+)}';

=head1 NAME

WebPAC::Lookup - simple normalisation plugin to produce lookup

=head1 VERSION

Version 0.01

=cut

our $VERSION = '0.01';

=head1 SYNOPSIS

This module will produce in-memory lookups for easy resolution of lookups
to different records in source files. This will enable you to resolve
relational data in source format.

It can also be use with C<WebPAC::Tree> to produce tree hierarchies.

Lookups are defined in C<conf/lookup/isis.pm>.

C<lookup> argument is an array of lookups to create. Each lookup must have C<key> and
C<val>. Optional parametar C<eval> is perl code to evaluate before storing
value in lookup.

 @lookup = [
  { 'key' => 'd:v900', 'val' => 'v250^a' },
  { 'eval' => '"v901^a" eq "Podruèje"',
    'key' => 'pa:v561^4:v562^4:v461^1',
    'val' => 'v900' },
 ];


=head1 FUNCTIONS

=head2 new

Create new lookup object.

  my $lookup = new WebPAC::Lookup(
        lookup_file => '/path/to/conf/lookup/lookup.pm',
  );

=cut

sub new {
        my $class = shift;
        my $self = {@_};
        bless($self, $class);

        my $log = $self->_get_logger();

        my $lookup_file = $self->{'lookup_file'} || $log->logconfess("need path to lookup file in lookup_file parametar");

        my $lookup_code = read_file($lookup_file) || $log->logconfess("can't read lookup file $lookup_file: $!");

        {
                no strict 'vars';
                do $lookup_file or $log->logdie("Failed to read configuration parameters '$lookup_file' $! $@");
                $self->{'lookup_def'} = \@lookup || $log->logdie("lookup config $lookup_file doesn't produce \@lookup array");
        }

        $log->logconfess("lookup config file isn't ARRAY", sub { Dumper( $self->{'lookup_def'} ) }) if ($self->{'lookup_def'} !~ /ARRAY/o);

        $self ? return $self : return undef;
}

=head2 add

Create lookup from record using lookup definition.

 $self->add($rec);

Returns true if this record produced lookup.

=cut

sub add($) {
        my $self = shift;

        my $log = $self->_get_logger();

        my $rec = shift || $log->logconfess("need record to create lookup");
        $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);
        $log->logconfess("need HASH as first argument!") if ($self->{'lookup_def'} !~ /ARRAY/o);

        my $n = 0;

        foreach my $i (@{ $self->{'lookup_def'} }) {
                $log->logconfess("need key") unless defined($i->{'key'});
                $log->logconfess("need val") unless defined($i->{'val'});

                $n++;

                if (defined($i->{'eval'})) {
                        # eval first, so we can skip fill_in for key and val
                        my $eval = $self->fill_in($rec,$i->{'eval'}) || next;
                        if ($self->_eval($eval)) {
                                my $key = $self->fill_in($rec,$i->{'key'}) || next;
                                my @val = $self->fill_in($rec,$i->{'val'}) || next;
                                $log->debug("stored $key = ",sub { join(" | ",@val) });
                                push @{$self->{'lookup'}->{$key}}, @val;
                        }
                } else {
                        my $key = $self->fill_in($rec,$i->{'key'}) || next;
                        my @val = $self->fill_in($rec,$i->{'val'}) || next;
                        $log->debug("stored $key = ",sub { join(" | ",@val) });
                        push @{$self->{'lookup'}->{$key}}, @val;
                }
        }

        return $n;
}

=head2 lookup

Perform lookups on format supplied to it.

 my $text = $lookup->lookup('[v900]');

Lookups can be nested (like C<[d:[a:[v900]]]>).

=cut

sub lookup {
        my $self = shift;

        my $log = $self->_get_logger();

        my $tmp = shift || $log->logconfess("need format");

        if ($tmp =~ /$LOOKUP_REGEX/o) {
                my @in = ( $tmp );

                $log->debug("lookup for: ",$tmp);

                my @out;
                while (my $f = shift @in) {
                        if ($f =~ /$LOOKUP_REGEX_SAVE/o) {
                                my $k = $1;
                                if ($self->{'lookup'}->{$k}) {
                                        foreach my $nv (@{$self->{'lookup'}->{$k}}) {
                                                my $tmp2 = $f;
                                                $tmp2 =~ s/lookup{$k}/$nv/g;
                                                push @in, $tmp2;
                                        }
                                } else {
                                        undef $f;
                                }
                        } elsif ($f) {
                                push @out, $f;
                        }
                }
                $log->logconfess("return is array and it's not expected!") unless wantarray;
                return @out;
        } else {
                return $tmp;
        }
}

=head1 AUTHOR

Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>

=head1 COPYRIGHT & LICENSE

Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut

1; # End of WebPAC::Lookup
1	dpavlin	4	package WebPAC::Lookup;
2	dpavlin	3
3			use warnings;
4			use strict;
5
6			use WebPAC::Common;
7
8			use base qw/WebPAC::Common/;
9			use File::Slurp;
10	dpavlin	4	use Data::Dumper;
11	dpavlin	3
12	dpavlin	7	my $LOOKUP_REGEX = 'lookup{[^\{\}]+}';
13			my $LOOKUP_REGEX_SAVE = 'lookup{([^\{\}]+)}';
14
15	dpavlin	3	=head1 NAME
16
17	dpavlin	4	WebPAC::Lookup - simple normalisation plugin to produce lookup
18	dpavlin	3
19			=head1 VERSION
20
21			Version 0.01
22
23			=cut
24
25			our $VERSION = '0.01';
26
27			=head1 SYNOPSIS
28
29			This module will produce in-memory lookups for easy resolution of lookups
30	dpavlin	4	to different records in source files. This will enable you to resolve
31			relational data in source format.
32	dpavlin	3
33	dpavlin	4	It can also be use with C<WebPAC::Tree> to produce tree hierarchies.
34	dpavlin	3
35	dpavlin	4	Lookups are defined in C<conf/lookup/isis.pm>.
36
37	dpavlin	3	C<lookup> argument is an array of lookups to create. Each lookup must have C<key> and
38			C<val>. Optional parametar C<eval> is perl code to evaluate before storing
39	dpavlin	4	value in lookup.
40	dpavlin	3
41	dpavlin	4	@lookup = [
42	dpavlin	3	{ 'key' => 'd:v900', 'val' => 'v250^a' },
43			{ 'eval' => '"v901^a" eq "Podruèje"',
44			'key' => 'pa:v561^4:v562^4:v461^1',
45			'val' => 'v900' },
46			];
47
48
49			=head1 FUNCTIONS
50
51			=head2 new
52
53			Create new lookup object.
54
55	dpavlin	4	my $lookup = new WebPAC::Lookup(
56			lookup_file => '/path/to/conf/lookup/lookup.pm',
57	dpavlin	3	);
58
59			=cut
60
61			sub new {
62			my $class = shift;
63			my $self = {@_};
64			bless($self, $class);
65
66			my $log = $self->_get_logger();
67
68	dpavlin	4	my $lookup_file = $self->{'lookup_file'} \|\| $log->logconfess("need path to lookup file in lookup_file parametar");
69	dpavlin	3
70	dpavlin	4	my $lookup_code = read_file($lookup_file) \|\| $log->logconfess("can't read lookup file $lookup_file: $!");
71	dpavlin	3
72			{
73			no strict 'vars';
74	dpavlin	4	do $lookup_file or $log->logdie("Failed to read configuration parameters '$lookup_file' $! $@");
75			$self->{'lookup_def'} = \@lookup \|\| $log->logdie("lookup config $lookup_file doesn't produce \@lookup array");
76	dpavlin	3	}
77
78	dpavlin	4	$log->logconfess("lookup config file isn't ARRAY", sub { Dumper( $self->{'lookup_def'} ) }) if ($self->{'lookup_def'} !~ /ARRAY/o);
79	dpavlin	3
80			$self ? return $self : return undef;
81			}
82
83	dpavlin	4	=head2 add
84	dpavlin	3
85			Create lookup from record using lookup definition.
86
87	dpavlin	7	$self->add($rec);
88	dpavlin	3
89	dpavlin	4	Returns true if this record produced lookup.
90	dpavlin	3
91			=cut
92
93	dpavlin	4	sub add($) {
94	dpavlin	3	my $self = shift;
95
96			my $log = $self->_get_logger();
97
98			my $rec = shift \|\| $log->logconfess("need record to create lookup");
99			$log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);
100	dpavlin	4	$log->logconfess("need HASH as first argument!") if ($self->{'lookup_def'} !~ /ARRAY/o);
101	dpavlin	3
102	dpavlin	4	my $n = 0;
103
104			foreach my $i (@{ $self->{'lookup_def'} }) {
105	dpavlin	3	$log->logconfess("need key") unless defined($i->{'key'});
106			$log->logconfess("need val") unless defined($i->{'val'});
107
108	dpavlin	4	$n++;
109
110	dpavlin	3	if (defined($i->{'eval'})) {
111			# eval first, so we can skip fill_in for key and val
112			my $eval = $self->fill_in($rec,$i->{'eval'}) \|\| next;
113			if ($self->_eval($eval)) {
114			my $key = $self->fill_in($rec,$i->{'key'}) \|\| next;
115			my @val = $self->fill_in($rec,$i->{'val'}) \|\| next;
116			$log->debug("stored $key = ",sub { join(" \| ",@val) });
117			push @{$self->{'lookup'}->{$key}}, @val;
118			}
119			} else {
120			my $key = $self->fill_in($rec,$i->{'key'}) \|\| next;
121			my @val = $self->fill_in($rec,$i->{'val'}) \|\| next;
122			$log->debug("stored $key = ",sub { join(" \| ",@val) });
123			push @{$self->{'lookup'}->{$key}}, @val;
124			}
125			}
126	dpavlin	4
127			return $n;
128	dpavlin	3	}
129
130	dpavlin	7	=head2 lookup
131
132			Perform lookups on format supplied to it.
133
134			my $text = $lookup->lookup('[v900]');
135
136			Lookups can be nested (like C<[d:[a:[v900]]]>).
137
138			=cut
139
140			sub lookup {
141			my $self = shift;
142
143			my $log = $self->_get_logger();
144
145			my $tmp = shift \|\| $log->logconfess("need format");
146
147			if ($tmp =~ /$LOOKUP_REGEX/o) {
148			my @in = ( $tmp );
149
150			$log->debug("lookup for: ",$tmp);
151
152			my @out;
153			while (my $f = shift @in) {
154			if ($f =~ /$LOOKUP_REGEX_SAVE/o) {
155			my $k = $1;
156			if ($self->{'lookup'}->{$k}) {
157			foreach my $nv (@{$self->{'lookup'}->{$k}}) {
158			my $tmp2 = $f;
159			$tmp2 =~ s/lookup{$k}/$nv/g;
160			push @in, $tmp2;
161			}
162			} else {
163			undef $f;
164			}
165			} elsif ($f) {
166			push @out, $f;
167			}
168			}
169			$log->logconfess("return is array and it's not expected!") unless wantarray;
170			return @out;
171			} else {
172			return $tmp;
173			}
174			}
175
176	dpavlin	3	=head1 AUTHOR
177
178			Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>
179
180			=head1 COPYRIGHT & LICENSE
181
182			Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.
183
184			This program is free software; you can redistribute it and/or modify it
185			under the same terms as Perl itself.
186
187			=cut
188
189	dpavlin	4	1; # End of WebPAC::Lookup