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},
                );

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

                $log->info("working on input '$input->{name}' in $input->{path} [type: $input->{type}] using $input_module 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
                );

                my $n = new WebPAC::Normalize::XML(
                #       filter => { 'foo' => sub { shift } },
                        db => $db,
                        lookup_regex => $lookup->regex,
                        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_hash,
                                );

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