webpac2/trunk/run.pl

#!/usr/bin/perl -w

use strict;

use Cwd qw/abs_path/;
use File::Temp qw/tempdir/;
use Data::Dumper;
use lib './lib';

use WebPAC::Common 0.02;
use WebPAC::Lookup;
use WebPAC::Input 0.03;
use WebPAC::Store 0.03;
use WebPAC::Normalize::XML;
use WebPAC::Normalize::Set;
use WebPAC::Output::TT;
use WebPAC::Validate;
use YAML qw/LoadFile/;
use Getopt::Long;
use File::Path;
use Time::HiRes qw/time/;
use File::Slurp;

=head1 NAME

run.pl - start WebPAC indexing

B<this command will probably go away. Don't get used to it!>

Options:

=over 4

=item --offset 42

start loading (all) databases at offset 42

=item --limit 100

limit loading to 100 records

=item --clean

remove database and Hyper Estraier index before indexing

=item --only=database_name/input_filter

reindex just single database (legacy name is --one)

C</input_filter> is optional part which can be C<name>
or C<type> from input

=item --config conf/config.yml

path to YAML configuration file

=item --force-set

force conversion C<< normalize->path >> in C<config.yml> from
C<.xml> to C<.pl>

=item --stats

disable indexing and dump statistics about field and subfield
usage for each input

=item --validate path/to/validation_file

turn on extra validation of imput records, see L<WebPAC::Validation>

=back

=cut

my $offset;
my $limit;

my $clean = 0;
my $config = 'conf/config.yml';
my $debug = 0;
my $only_filter;
my $force_set = 0;
my $stats = 0;
my $validate_path;

GetOptions(
        "limit=i" => \$limit,
        "offset=i" => \$offset,
        "clean" => \$clean,
        "one=s" => \$only_filter,
        "only=s" => \$only_filter,
        "config" => \$config,
        "debug" => \$debug,
        "force-set" => \$force_set,
        "stats" => \$stats,
        "validate=s" => \$validate_path,
);

$config = LoadFile($config);

print "config = ",Dumper($config) if ($debug);

die "no databases in config file!\n" unless ($config->{databases});

my $log = _new WebPAC::Common()->_get_logger();
$log->info( "-" x 79 );

my $validate;
$validate = new WebPAC::Validate(
        path => $validate_path,
) if ($validate_path);

my $use_indexer = $config->{use_indexer} || 'hyperestraier';
if ($stats) {
        $log->debug("option --stats disables update of indexing engine...");
        $use_indexer = undef;
} else {
        $log->info("using $use_indexer indexing engine...");
}

my $total_rows = 0;
my $start_t = time();

while (my ($database, $db_config) = each %{ $config->{databases} }) {

        my ($only_database,$only_input) = split(m#/#, $only_filter) if ($only_filter);
        next if ($only_database && $database !~ m/$only_database/i);

        my $indexer;

        if ($use_indexer) {
                my $indexer_config = $config->{$use_indexer} || $log->logdie("can't find '$use_indexer' part in confguration");
                $indexer_config->{database} = $database;
                $indexer_config->{clean} = $clean;
                $indexer_config->{label} = $db_config->{name};

                if ($use_indexer eq 'hyperestraier') {

                        # open Hyper Estraier database
                        use WebPAC::Output::Estraier '0.10';
                        $indexer = new WebPAC::Output::Estraier( %{ $indexer_config } );
                
                } elsif ($use_indexer eq 'kinosearch') {

                        # open KinoSearch
                        use WebPAC::Output::KinoSearch;
                        $indexer_config->{clean} = 1 unless (-e $indexer_config->{index_path});
                        $indexer = new WebPAC::Output::KinoSearch( %{ $indexer_config } );

                } else {
                        $log->logdie("unknown use_indexer: $use_indexer");
                }

                $log->logide("can't continue without valid indexer") unless ($indexer);
        }


        #
        # now WebPAC::Store
        #
        my $abs_path = abs_path($0);
        $abs_path =~ s#/[^/]*$#/#;

        my $db_path = $config->{webpac}->{db_path} . '/' . $database;

        if ($clean) {
                $log->info("creating new database '$database' in $db_path");
                rmtree( $db_path ) || $log->warn("can't remove $db_path: $!");
        } else {
                $log->info("working on database '$database' in $db_path");
        }

        my $db = new WebPAC::Store(
                path => $db_path,
                database => $database,
                debug => $debug,
        );


        #
        # now, iterate through input formats
        #

        my @inputs;
        if (ref($db_config->{input}) eq 'ARRAY') {
                @inputs = @{ $db_config->{input} };
        } elsif ($db_config->{input}) {
                push @inputs, $db_config->{input};
        } else {
                $log->info("database $database doesn't have inputs defined");
        }

        my @supported_inputs = keys %{ $config->{webpac}->{inputs} };

        foreach my $input (@inputs) {

                next if ($only_input && ($input->{name} !~ m#$only_input#i && $input->{type} !~ m#$only_input#i));

                my $type = lc($input->{type});

                die "I know only how to handle input types ", join(",", @supported_inputs), " not '$type'!\n" unless (grep(/$type/, @supported_inputs));

                my $lookup = new WebPAC::Lookup(
                        lookup_file => $input->{lookup},
                ) if ($input->{lookup});

                my $input_module = $config->{webpac}->{inputs}->{$type};

                $log->info("working on input '$input->{name}' in $input->{path} [type: $input->{type}] using $input_module",
                        $input->{lookup} ? "lookup '$input->{lookup}'" : ""
                );

                my $input_db = new WebPAC::Input(
                        module => $input_module,
                        code_page => $config->{webpac}->{webpac_encoding},
                        limit => $limit || $input->{limit},
                        offset => $offset,
                        lookup => $lookup,
                        recode => $input->{recode},
                        stats => $stats,
                );
                $log->logdie("can't create input using $input_module") unless ($input);

                my $maxmfn = $input_db->open(
                        path => $input->{path},
                        code_page => $input->{encoding},        # database encoding
                        %{ $input },
                );

                my $n = new WebPAC::Normalize::XML(
                #       filter => { 'foo' => sub { shift } },
                        db => $db,
                        lookup_regex => $lookup ? $lookup->regex : undef,
                        lookup => $lookup,
                        prefix => $input->{name},
                );

                my $rules;
                my $normalize_path = $input->{normalize}->{path};

                if ($force_set) {
                        my $new_norm_path = $normalize_path;
                        $new_norm_path =~ s/\.xml$/.pl/;
                        if (-e $new_norm_path) {
                                $log->debug("--force-set replaced $normalize_path with $new_norm_path");
                                $normalize_path = $new_norm_path;
                        } else {
                                $log->debug("--force-set failed on $new_norm_path, fallback to $normalize_path");
                        }
                }

                if ($normalize_path =~ m/\.xml$/i) {
                        $n->open(
                                tag => $input->{normalize}->{tag},
                                xml_file => $normalize_path,
                        );
                } elsif ($normalize_path =~ m/\.(?:yml|yaml)$/i) {
                        $n->open_yaml(
                                path => $normalize_path,
                                tag => $input->{normalize}->{tag},
                        );
                } elsif ($normalize_path =~ m/\.(?:pl)$/i) {
                        $n = undef;
                        $log->info("using WebPAC::Normalize::Set to process $normalize_path");
                        $rules = read_file( $normalize_path ) or die "can't open $normalize_path: $!";
                }

                foreach my $pos ( 0 ... $input_db->size ) {

                        my $row = $input_db->fetch || next;

                        my $mfn = $row->{'000'}->[0];

                        if (! $mfn || $mfn !~ m#^\d+$#) {
                                $log->warn("record $pos doesn't have valid MFN but '$mfn', using $pos");
                                $mfn = $pos;
                                push @{ $row->{'000'} }, $pos;
                        }


                        if ($validate) {
                                my @errors = $validate->validate_errors( $row );
                                $log->error( "MFN $mfn validation errors:\n", join("\n", @errors) ) if (@errors);
                        }

                                
                        my $ds;
                        if ($n) {
                                $ds = $n->data_structure($row);
                        } else {
                                $ds = WebPAC::Normalize::Set::data_structure(
                                        row => $row,
                                        rules => $rules,
                                        lookup => $lookup ? $lookup->lookup_hash : undef,
                                );

                                $db->save_ds(
                                        id => $mfn,
                                        ds => $ds,
                                        prefix => $input->{name},
                                ) if ($ds && !$stats);
                        }

                        $indexer->add(
                                id => $input->{name} . "/" . $mfn,
                                ds => $ds,
                                type => $config->{$use_indexer}->{type},
                        ) if ($indexer);

                        $total_rows++;
                }

                $log->info("statistics of fields usage:\n", $input_db->stats) if ($stats);

        };

        eval { $indexer->finish } if ($indexer && $indexer->can('finish'));

        my $dt = time() - $start_t;
        $log->info("$total_rows records ", $indexer ? "indexed " : "",
                sprintf("in %.2f sec [%.2f rec/sec]",
                        $dt, ($total_rows / $dt)
                )
        );

        #
        # add Hyper Estraier links to other databases
        #
        if (ref($db_config->{links}) eq 'ARRAY') {
                foreach my $link (@{ $db_config->{links} }) {
                        if ($use_indexer eq 'hyperestraier') {
                                $log->info("adding link $database -> $link->{to} [$link->{credit}]");
                                $indexer->add_link(
                                        from => $database,
                                        to => $link->{to},
                                        credit => $link->{credit},
                                );
                        } else {
                                $log->warn("NOT IMPLEMENTED WITH $use_indexer: adding link $database -> $link->{to} [$link->{credit}]");
                        }
                }
        }

}

1	dpavlin	74	#!/usr/bin/perl -w
2
3			use strict;
4
5			use Cwd qw/abs_path/;
6			use File::Temp qw/tempdir/;
7			use Data::Dumper;
8			use lib './lib';
9
10	dpavlin	255	use WebPAC::Common 0.02;
11	dpavlin	74	use WebPAC::Lookup;
12	dpavlin	287	use WebPAC::Input 0.03;
13	dpavlin	209	use WebPAC::Store 0.03;
14	dpavlin	74	use WebPAC::Normalize::XML;
15	dpavlin	492	use WebPAC::Normalize::Set;
16	dpavlin	74	use WebPAC::Output::TT;
17	dpavlin	516	use WebPAC::Validate;
18	dpavlin	141	use YAML qw/LoadFile/;
19	dpavlin	301	use Getopt::Long;
20			use File::Path;
21	dpavlin	389	use Time::HiRes qw/time/;
22	dpavlin	492	use File::Slurp;
23	dpavlin	74
24	dpavlin	301	=head1 NAME
25	dpavlin	76
26	dpavlin	301	run.pl - start WebPAC indexing
27	dpavlin	141
28	dpavlin	301	B<this command will probably go away. Don't get used to it!>
29	dpavlin	141
30	dpavlin	301	Options:
31
32			=over 4
33
34			=item --offset 42
35
36			start loading (all) databases at offset 42
37
38			=item --limit 100
39
40			limit loading to 100 records
41
42			=item --clean
43
44			remove database and Hyper Estraier index before indexing
45
46	dpavlin	510	=item --only=database_name/input_filter
47	dpavlin	335
48	dpavlin	423	reindex just single database (legacy name is --one)
49	dpavlin	335
50	dpavlin	510	C</input_filter> is optional part which can be C<name>
51			or C<type> from input
52
53	dpavlin	301	=item --config conf/config.yml
54
55			path to YAML configuration file
56
57	dpavlin	492	=item --force-set
58
59	dpavlin	508	force conversion C<< normalize->path >> in C<config.yml> from
60	dpavlin	492	C<.xml> to C<.pl>
61
62	dpavlin	507	=item --stats
63
64	dpavlin	509	disable indexing and dump statistics about field and subfield
65			usage for each input
66	dpavlin	507
67	dpavlin	516	=item --validate path/to/validation_file
68
69			turn on extra validation of imput records, see L<WebPAC::Validation>
70
71	dpavlin	301	=back
72
73			=cut
74
75			my $offset;
76			my $limit;
77
78			my $clean = 0;
79			my $config = 'conf/config.yml';
80			my $debug = 0;
81	dpavlin	510	my $only_filter;
82	dpavlin	492	my $force_set = 0;
83	dpavlin	507	my $stats = 0;
84	dpavlin	516	my $validate_path;
85	dpavlin	301
86			GetOptions(
87			"limit=i" => \$limit,
88			"offset=i" => \$offset,
89			"clean" => \$clean,
90	dpavlin	510	"one=s" => \$only_filter,
91			"only=s" => \$only_filter,
92	dpavlin	301	"config" => \$config,
93			"debug" => \$debug,
94	dpavlin	492	"force-set" => \$force_set,
95	dpavlin	507	"stats" => \$stats,
96	dpavlin	516	"validate=s" => \$validate_path,
97	dpavlin	301	);
98
99			$config = LoadFile($config);
100
101			print "config = ",Dumper($config) if ($debug);
102
103	dpavlin	210	die "no databases in config file!\n" unless ($config->{databases});
104	dpavlin	431
105			my $log = _new WebPAC::Common()->_get_logger();
106	dpavlin	509	$log->info( "-" x 79 );
107	dpavlin	431
108	dpavlin	516	my $validate;
109			$validate = new WebPAC::Validate(
110			path => $validate_path,
111			) if ($validate_path);
112
113	dpavlin	430	my $use_indexer = $config->{use_indexer} \|\| 'hyperestraier';
114	dpavlin	509	if ($stats) {
115			$log->debug("option --stats disables update of indexing engine...");
116			$use_indexer = undef;
117			} else {
118			$log->info("using $use_indexer indexing engine...");
119			}
120	dpavlin	141
121	dpavlin	213	my $total_rows = 0;
122	dpavlin	389	my $start_t = time();
123	dpavlin	213
124	dpavlin	210	while (my ($database, $db_config) = each %{ $config->{databases} }) {
125	dpavlin	141
126	dpavlin	512	my ($only_database,$only_input) = split(m#/#, $only_filter) if ($only_filter);
127	dpavlin	510	next if ($only_database && $database !~ m/$only_database/i);
128	dpavlin	335
129	dpavlin	430	my $indexer;
130	dpavlin	255
131	dpavlin	509	if ($use_indexer) {
132			my $indexer_config = $config->{$use_indexer} \|\| $log->logdie("can't find '$use_indexer' part in confguration");
133			$indexer_config->{database} = $database;
134			$indexer_config->{clean} = $clean;
135			$indexer_config->{label} = $db_config->{name};
136	dpavlin	431
137	dpavlin	509	if ($use_indexer eq 'hyperestraier') {
138	dpavlin	255
139	dpavlin	509	# open Hyper Estraier database
140			use WebPAC::Output::Estraier '0.10';
141			$indexer = new WebPAC::Output::Estraier( %{ $indexer_config } );
142
143			} elsif ($use_indexer eq 'kinosearch') {
144	dpavlin	430
145	dpavlin	509	# open KinoSearch
146			use WebPAC::Output::KinoSearch;
147			$indexer_config->{clean} = 1 unless (-e $indexer_config->{index_path});
148			$indexer = new WebPAC::Output::KinoSearch( %{ $indexer_config } );
149	dpavlin	431
150	dpavlin	509	} else {
151			$log->logdie("unknown use_indexer: $use_indexer");
152			}
153
154			$log->logide("can't continue without valid indexer") unless ($indexer);
155	dpavlin	430	}
156
157
158	dpavlin	255	#
159			# now WebPAC::Store
160			#
161	dpavlin	210	my $abs_path = abs_path($0);
162			$abs_path =~ s#/[^/]*$#/#;
163	dpavlin	141
164	dpavlin	210	my $db_path = $config->{webpac}->{db_path} . '/' . $database;
165	dpavlin	74
166	dpavlin	301	if ($clean) {
167	dpavlin	511	$log->info("creating new database '$database' in $db_path");
168	dpavlin	301	rmtree( $db_path ) \|\| $log->warn("can't remove $db_path: $!");
169			} else {
170	dpavlin	511	$log->info("working on database '$database' in $db_path");
171	dpavlin	301	}
172	dpavlin	255
173	dpavlin	210	my $db = new WebPAC::Store(
174			path => $db_path,
175	dpavlin	217	database => $database,
176	dpavlin	301	debug => $debug,
177	dpavlin	210	);
178	dpavlin	74
179	dpavlin	233
180	dpavlin	213	#
181			# now, iterate through input formats
182			#
183	dpavlin	74
184	dpavlin	213	my @inputs;
185			if (ref($db_config->{input}) eq 'ARRAY') {
186			@inputs = @{ $db_config->{input} };
187	dpavlin	255	} elsif ($db_config->{input}) {
188			push @inputs, $db_config->{input};
189	dpavlin	213	} else {
190	dpavlin	255	$log->info("database $database doesn't have inputs defined");
191	dpavlin	213	}
192	dpavlin	74
193	dpavlin	286	my @supported_inputs = keys %{ $config->{webpac}->{inputs} };
194
195	dpavlin	213	foreach my $input (@inputs) {
196	dpavlin	233
197	dpavlin	512	next if ($only_input && ($input->{name} !~ m#$only_input#i && $input->{type} !~ m#$only_input#i));
198	dpavlin	510
199	dpavlin	233	my $type = lc($input->{type});
200
201	dpavlin	286	die "I know only how to handle input types ", join(",", @supported_inputs), " not '$type'!\n" unless (grep(/$type/, @supported_inputs));
202	dpavlin	233
203			my $lookup = new WebPAC::Lookup(
204			lookup_file => $input->{lookup},
205	dpavlin	520	) if ($input->{lookup});
206	dpavlin	233
207	dpavlin	286	my $input_module = $config->{webpac}->{inputs}->{$type};
208	dpavlin	74
209	dpavlin	523	$log->info("working on input '$input->{name}' in $input->{path} [type: $input->{type}] using $input_module",
210			$input->{lookup} ? "lookup '$input->{lookup}'" : ""
211			);
212	dpavlin	286
213	dpavlin	287	my $input_db = new WebPAC::Input(
214			module => $input_module,
215	dpavlin	213	code_page => $config->{webpac}->{webpac_encoding},
216	dpavlin	301	limit => $limit \|\| $input->{limit},
217			offset => $offset,
218	dpavlin	251	lookup => $lookup,
219	dpavlin	416	recode => $input->{recode},
220	dpavlin	507	stats => $stats,
221	dpavlin	287	);
222	dpavlin	286	$log->logdie("can't create input using $input_module") unless ($input);
223	dpavlin	113
224	dpavlin	287	my $maxmfn = $input_db->open(
225	dpavlin	285	path => $input->{path},
226	dpavlin	213	code_page => $input->{encoding}, # database encoding
227	dpavlin	523	%{ $input },
228	dpavlin	213	);
229	dpavlin	113
230	dpavlin	213	my $n = new WebPAC::Normalize::XML(
231			# filter => { 'foo' => sub { shift } },
232			db => $db,
233	dpavlin	520	lookup_regex => $lookup ? $lookup->regex : undef,
234	dpavlin	213	lookup => $lookup,
235	dpavlin	221	prefix => $input->{name},
236	dpavlin	213	);
237	dpavlin	113
238	dpavlin	492	my $rules;
239	dpavlin	269	my $normalize_path = $input->{normalize}->{path};
240	dpavlin	210
241	dpavlin	492	if ($force_set) {
242			my $new_norm_path = $normalize_path;
243			$new_norm_path =~ s/\.xml$/.pl/;
244			if (-e $new_norm_path) {
245	dpavlin	493	$log->debug("--force-set replaced $normalize_path with $new_norm_path");
246	dpavlin	492	$normalize_path = $new_norm_path;
247			} else {
248	dpavlin	493	$log->debug("--force-set failed on $new_norm_path, fallback to $normalize_path");
249	dpavlin	492	}
250			}
251
252	dpavlin	269	if ($normalize_path =~ m/\.xml$/i) {
253			$n->open(
254			tag => $input->{normalize}->{tag},
255	dpavlin	492	xml_file => $normalize_path,
256	dpavlin	269	);
257			} elsif ($normalize_path =~ m/\.(?:yml\|yaml)$/i) {
258			$n->open_yaml(
259			path => $normalize_path,
260			tag => $input->{normalize}->{tag},
261			);
262	dpavlin	492	} elsif ($normalize_path =~ m/\.(?:pl)$/i) {
263			$n = undef;
264			$log->info("using WebPAC::Normalize::Set to process $normalize_path");
265			$rules = read_file( $normalize_path ) or die "can't open $normalize_path: $!";
266	dpavlin	269	}
267
268	dpavlin	290	foreach my $pos ( 0 ... $input_db->size ) {
269	dpavlin	210
270	dpavlin	287	my $row = $input_db->fetch \|\| next;
271	dpavlin	213
272	dpavlin	291	my $mfn = $row->{'000'}->[0];
273	dpavlin	213
274	dpavlin	291	if (! $mfn \|\| $mfn !~ m#^\d+$#) {
275	dpavlin	290	$log->warn("record $pos doesn't have valid MFN but '$mfn', using $pos");
276			$mfn = $pos;
277	dpavlin	291	push @{ $row->{'000'} }, $pos;
278	dpavlin	290	}
279
280	dpavlin	516
281			if ($validate) {
282			my @errors = $validate->validate_errors( $row );
283			$log->error( "MFN $mfn validation errors:\n", join("\n", @errors) ) if (@errors);
284			}
285
286	dpavlin	508
287			my $ds;
288			if ($n) {
289			$ds = $n->data_structure($row);
290			} else {
291			$ds = WebPAC::Normalize::Set::data_structure(
292	dpavlin	492	row => $row,
293			rules => $rules,
294	dpavlin	520	lookup => $lookup ? $lookup->lookup_hash : undef,
295	dpavlin	492	);
296	dpavlin	213
297	dpavlin	508	$db->save_ds(
298			id => $mfn,
299			ds => $ds,
300			prefix => $input->{name},
301	dpavlin	509	) if ($ds && !$stats);
302	dpavlin	508	}
303
304	dpavlin	430	$indexer->add(
305	dpavlin	291	id => $input->{name} . "/" . $mfn,
306	dpavlin	213	ds => $ds,
307	dpavlin	430	type => $config->{$use_indexer}->{type},
308	dpavlin	509	) if ($indexer);
309	dpavlin	213
310			$total_rows++;
311			}
312
313	dpavlin	507	$log->info("statistics of fields usage:\n", $input_db->stats) if ($stats);
314
315	dpavlin	210	};
316
317	dpavlin	509	eval { $indexer->finish } if ($indexer && $indexer->can('finish'));
318	dpavlin	434
319	dpavlin	389	my $dt = time() - $start_t;
320	dpavlin	511	$log->info("$total_rows records ", $indexer ? "indexed " : "",
321			sprintf("in %.2f sec [%.2f rec/sec]",
322	dpavlin	389	$dt, ($total_rows / $dt)
323			)
324			);
325	dpavlin	255
326	dpavlin	431	#
327			# add Hyper Estraier links to other databases
328			#
329			if (ref($db_config->{links}) eq 'ARRAY') {
330			foreach my $link (@{ $db_config->{links} }) {
331			if ($use_indexer eq 'hyperestraier') {
332	dpavlin	430	$log->info("adding link $database -> $link->{to} [$link->{credit}]");
333			$indexer->add_link(
334			from => $database,
335			to => $link->{to},
336			credit => $link->{credit},
337			);
338	dpavlin	431	} else {
339			$log->warn("NOT IMPLEMENTED WITH $use_indexer: adding link $database -> $link->{to} [$link->{credit}]");
340	dpavlin	430	}
341	dpavlin	255	}
342			}
343
344	dpavlin	210	}
345