7 |
|
|
8 |
use WebPAC::Common; |
use WebPAC::Common; |
9 |
use base qw/WebPAC::Common/; |
use base qw/WebPAC::Common/; |
10 |
use Data::Dumper; |
use Data::Dump qw/dump/; |
11 |
use Encode qw/from_to/; |
use Encode qw/from_to/; |
12 |
|
|
13 |
=head1 NAME |
=head1 NAME |
16 |
|
|
17 |
=head1 VERSION |
=head1 VERSION |
18 |
|
|
19 |
Version 0.13 |
Version 0.16 |
20 |
|
|
21 |
=cut |
=cut |
22 |
|
|
23 |
our $VERSION = '0.13'; |
our $VERSION = '0.16'; |
24 |
|
|
25 |
=head1 SYNOPSIS |
=head1 SYNOPSIS |
26 |
|
|
43 |
|
|
44 |
my $db = WebPAC::Input->new( |
my $db = WebPAC::Input->new( |
45 |
module => 'WebPAC::Input::ISIS', |
module => 'WebPAC::Input::ISIS', |
|
low_mem => 1, |
|
46 |
); |
); |
47 |
|
|
48 |
$db->open( path => '/path/to/database' ); |
$db->open( path => '/path/to/database' ); |
62 |
my $db = new WebPAC::Input( |
my $db = new WebPAC::Input( |
63 |
module => 'WebPAC::Input::MARC', |
module => 'WebPAC::Input::MARC', |
64 |
encoding => 'ISO-8859-2', |
encoding => 'ISO-8859-2', |
|
low_mem => 1, |
|
65 |
recode => 'char pairs', |
recode => 'char pairs', |
66 |
no_progress_bar => 1, |
no_progress_bar => 1, |
67 |
); |
); |
73 |
used internally). This should probably be your terminal encoding, and by |
used internally). This should probably be your terminal encoding, and by |
74 |
default, it C<ISO-8859-2>. |
default, it C<ISO-8859-2>. |
75 |
|
|
|
Default is not to use C<low_mem> options (see L<MEMORY USAGE> below). |
|
|
|
|
76 |
C<recode> is optional string constisting of character or words pairs that |
C<recode> is optional string constisting of character or words pairs that |
77 |
should be replaced in input stream. |
should be replaced in input stream. |
78 |
|
|
92 |
|
|
93 |
$log->logconfess("code_page argument is not suppored any more. change it to encoding") if ($self->{lookup}); |
$log->logconfess("code_page argument is not suppored any more. change it to encoding") if ($self->{lookup}); |
94 |
$log->logconfess("lookup argument is not suppored any more. rewrite call to lookup_ref") if ($self->{lookup}); |
$log->logconfess("lookup argument is not suppored any more. rewrite call to lookup_ref") if ($self->{lookup}); |
95 |
|
$log->logconfess("low_mem argument is not suppored any more. rewrite it to load_row and save_row") if ($self->{low_mem}); |
96 |
|
|
97 |
$log->logconfess("specify low-level file format module") unless ($self->{module}); |
$log->logconfess("specify low-level file format module") unless ($self->{module}); |
98 |
my $module = $self->{module}; |
my $module_path = $self->{module}; |
99 |
$module =~ s#::#/#g; |
$module_path =~ s#::#/#g; |
100 |
$module .= '.pm'; |
$module_path .= '.pm'; |
101 |
$log->debug("require low-level module $self->{module} from $module"); |
$log->debug("require low-level module $self->{module} from $module_path"); |
|
|
|
|
require $module; |
|
|
#eval $self->{module} .'->import'; |
|
|
|
|
|
# check if required subclasses are implemented |
|
|
foreach my $subclass (qw/open_db fetch_rec init dump_rec/) { |
|
|
my $n = $self->{module} . '::' . $subclass; |
|
|
if (! defined &{ $n }) { |
|
|
my $missing = "missing $subclass in $self->{module}"; |
|
|
$self->{$subclass} = sub { $log->logwarn($missing) }; |
|
|
} else { |
|
|
$self->{$subclass} = \&{ $n }; |
|
|
} |
|
|
} |
|
102 |
|
|
103 |
if ($self->{init}) { |
require $module_path; |
|
$log->debug("calling init"); |
|
|
$self->{init}->($self, @_); |
|
|
} |
|
104 |
|
|
105 |
$self->{'encoding'} ||= 'ISO-8859-2'; |
$self->{'encoding'} ||= 'ISO-8859-2'; |
106 |
|
|
|
# running with low_mem flag? well, use DBM::Deep then. |
|
|
if ($self->{'low_mem'}) { |
|
|
$log->info("running with low_mem which impacts performance (<32 Mb memory usage)"); |
|
|
|
|
|
my $db_file = "data.db"; |
|
|
|
|
|
if (-e $db_file) { |
|
|
unlink $db_file or $log->logdie("can't remove '$db_file' from last run"); |
|
|
$log->debug("removed '$db_file' from last run"); |
|
|
} |
|
|
|
|
|
require DBM::Deep; |
|
|
|
|
|
my $db = new DBM::Deep $db_file; |
|
|
|
|
|
$log->logdie("DBM::Deep error: $!") unless ($db); |
|
|
|
|
|
if ($db->error()) { |
|
|
$log->logdie("can't open '$db_file' under low_mem: ",$db->error()); |
|
|
} else { |
|
|
$log->debug("using file '$db_file' for DBM::Deep"); |
|
|
} |
|
|
|
|
|
$self->{'db'} = $db; |
|
|
} |
|
|
|
|
107 |
$self ? return $self : return undef; |
$self ? return $self : return undef; |
108 |
} |
} |
109 |
|
|
111 |
|
|
112 |
This function will read whole database in memory and produce lookups. |
This function will read whole database in memory and produce lookups. |
113 |
|
|
114 |
|
my $store; # simple in-memory hash |
115 |
|
|
116 |
$input->open( |
$input->open( |
117 |
path => '/path/to/database/file', |
path => '/path/to/database/file', |
118 |
code_page => 'cp852', |
code_page => 'cp852', |
128 |
901 => { '*' => { '^b' => ' ; ' } }, |
901 => { '*' => { '^b' => ' ; ' } }, |
129 |
}, |
}, |
130 |
modify_file => 'conf/modify/mapping.map', |
modify_file => 'conf/modify/mapping.map', |
131 |
|
save_row => sub { |
132 |
|
my $a = shift; |
133 |
|
$store->{ $a->{id} } = $a->{row}; |
134 |
|
}, |
135 |
|
load_row => sub { |
136 |
|
my $a = shift; |
137 |
|
return defined($store->{ $a->{id} }) && |
138 |
|
$store->{ $a->{id} }; |
139 |
|
}, |
140 |
|
|
141 |
); |
); |
142 |
|
|
143 |
By default, C<code_page> is assumed to be C<cp852>. |
By default, C<code_page> is assumed to be C<cp852>. |
158 |
(hopefully) simplier sintax than YAML or perl (see L</modify_file_regex>). This option |
(hopefully) simplier sintax than YAML or perl (see L</modify_file_regex>). This option |
159 |
overrides C<modify_records> if both exists for same input. |
overrides C<modify_records> if both exists for same input. |
160 |
|
|
161 |
|
C<save_row> and C<load_row> are low-level implementation of store engine. Calling convention |
162 |
|
is documented in example above. |
163 |
|
|
164 |
Returns size of database, regardless of C<offset> and C<limit> |
Returns size of database, regardless of C<offset> and C<limit> |
165 |
parametars, see also C<size>. |
parametars, see also C<size>. |
166 |
|
|
187 |
$self->{$v} = $arg->{$v} if ($arg->{$v}); |
$self->{$v} = $arg->{$v} if ($arg->{$v}); |
188 |
} |
} |
189 |
|
|
190 |
|
if ($arg->{load_row} || $arg->{save_row}) { |
191 |
|
$log->logconfess("save_row and load_row must be defined in pair and be CODE") unless ( |
192 |
|
ref($arg->{load_row}) eq 'CODE' && |
193 |
|
ref($arg->{save_row}) eq 'CODE' |
194 |
|
); |
195 |
|
$self->{load_row} = $arg->{load_row}; |
196 |
|
$self->{save_row} = $arg->{save_row}; |
197 |
|
$log->debug("using load_row and save_row instead of in-memory hash"); |
198 |
|
} |
199 |
|
|
200 |
my $filter_ref; |
my $filter_ref; |
201 |
my $recode_regex; |
my $recode_regex; |
202 |
my $recode_map; |
my $recode_map; |
224 |
$log->debug("using modify_file $p"); |
$log->debug("using modify_file $p"); |
225 |
$rec_regex = $self->modify_file_regexps( $p ); |
$rec_regex = $self->modify_file_regexps( $p ); |
226 |
} elsif (my $h = $arg->{modify_records}) { |
} elsif (my $h = $arg->{modify_records}) { |
227 |
$log->debug("using modify_records ", Dumper( $h )); |
$log->debug("using modify_records ", sub { dump( $h ) }); |
228 |
$rec_regex = $self->modify_record_regexps(%{ $h }); |
$rec_regex = $self->modify_record_regexps(%{ $h }); |
229 |
} |
} |
230 |
$log->debug("rec_regex: ", Dumper($rec_regex)) if ($rec_regex); |
$log->debug("rec_regex: ", sub { dump($rec_regex) }) if ($rec_regex); |
231 |
|
|
232 |
my ($db, $size) = $self->{open_db}->( $self, |
my $class = $self->{module} || $log->logconfess("can't get low-level module name!"); |
233 |
|
|
234 |
|
my $ll_db = $class->new( |
235 |
path => $arg->{path}, |
path => $arg->{path}, |
236 |
# filter => sub { |
# filter => sub { |
237 |
# my ($l,$f_nr) = @_; |
# my ($l,$f_nr) = @_; |
243 |
%{ $arg }, |
%{ $arg }, |
244 |
); |
); |
245 |
|
|
246 |
unless (defined($db)) { |
unless (defined($ll_db)) { |
247 |
$log->logwarn("can't open database $arg->{path}, skipping..."); |
$log->logwarn("can't open database $arg->{path}, skipping..."); |
248 |
return; |
return; |
249 |
} |
} |
250 |
|
|
251 |
|
my $size = $ll_db->size; |
252 |
|
|
253 |
unless ($size) { |
unless ($size) { |
254 |
$log->logwarn("no records in database $arg->{path}, skipping..."); |
$log->logwarn("no records in database $arg->{path}, skipping..."); |
255 |
return; |
return; |
281 |
|
|
282 |
$log->debug("position: $pos\n"); |
$log->debug("position: $pos\n"); |
283 |
|
|
284 |
my $rec = $self->{fetch_rec}->($self, $pos, sub { |
my $rec = $ll_db->fetch_rec($pos, sub { |
285 |
my ($l,$f_nr) = @_; |
my ($l,$f_nr) = @_; |
286 |
# return unless defined($l); |
# return unless defined($l); |
287 |
# return $l unless ($rec_regex && $f_nr); |
# return $l unless ($rec_regex && $f_nr); |
310 |
return $l; |
return $l; |
311 |
}); |
}); |
312 |
|
|
313 |
$log->debug(sub { Dumper($rec) }); |
$log->debug(sub { dump($rec) }); |
314 |
|
|
315 |
if (! $rec) { |
if (! $rec) { |
316 |
$log->warn("record $pos empty? skipping..."); |
$log->warn("record $pos empty? skipping..."); |
318 |
} |
} |
319 |
|
|
320 |
# store |
# store |
321 |
if ($self->{low_mem}) { |
if ($self->{save_row}) { |
322 |
$self->{db}->put($pos, $rec); |
$self->{save_row}->({ |
323 |
|
id => $pos, |
324 |
|
row => $rec, |
325 |
|
}); |
326 |
} else { |
} else { |
327 |
$self->{data}->{$pos} = $rec; |
$self->{data}->{$pos} = $rec; |
328 |
} |
} |
334 |
if ($self->{stats}) { |
if ($self->{stats}) { |
335 |
|
|
336 |
# fetch clean record with regexpes applied for statistics |
# fetch clean record with regexpes applied for statistics |
337 |
my $rec = $self->{fetch_rec}->($self, $pos); |
my $rec = $ll_db->fetch_rec($pos); |
338 |
|
|
339 |
foreach my $fld (keys %{ $rec }) { |
foreach my $fld (keys %{ $rec }) { |
340 |
$self->{_stats}->{fld}->{ $fld }++; |
$self->{_stats}->{fld}->{ $fld }++; |
371 |
$self->{max_pos} = $to_rec; |
$self->{max_pos} = $to_rec; |
372 |
$log->debug("max_pos: $to_rec"); |
$log->debug("max_pos: $to_rec"); |
373 |
|
|
374 |
|
# save for dump |
375 |
|
$self->{ll_db} = $ll_db; |
376 |
|
|
377 |
return $size; |
return $size; |
378 |
} |
} |
379 |
|
|
413 |
|
|
414 |
my $rec; |
my $rec; |
415 |
|
|
416 |
if ($self->{low_mem}) { |
if ($self->{load_row}) { |
417 |
$rec = $self->{db}->get($mfn); |
$rec = $self->{load_row}->({ id => $mfn }); |
418 |
} else { |
} else { |
419 |
$rec = $self->{data}->{$mfn}; |
$rec = $self->{data}->{$mfn}; |
420 |
} |
} |
530 |
} sort { $a cmp $b } keys %{ $s->{fld} } |
} sort { $a cmp $b } keys %{ $s->{fld} } |
531 |
); |
); |
532 |
|
|
533 |
$log->debug( sub { Dumper($s) } ); |
$log->debug( sub { dump($s) } ); |
534 |
|
|
535 |
return $out; |
return $out; |
536 |
} |
} |
537 |
|
|
538 |
=head2 dump |
=head2 dump_ascii |
539 |
|
|
540 |
Display humanly readable dump of record |
Display humanly readable dump of record |
541 |
|
|
542 |
=cut |
=cut |
543 |
|
|
544 |
sub dump { |
sub dump_ascii { |
545 |
my $self = shift; |
my $self = shift; |
546 |
|
|
547 |
return $self->{dump_rec}->($self, $self->{pos}); |
return unless $self->{ll_db}; |
548 |
|
|
549 |
|
if ($self->{ll_db}->can('dump_rec')) { |
550 |
|
return $self->{ll_db}->dump_ascii( $self->{pos} ); |
551 |
|
} else { |
552 |
|
return dump( $self->{ll_db}->fetch_rec( $self->{pos} ) ); |
553 |
|
} |
554 |
} |
} |
555 |
|
|
556 |
=head2 modify_record_regexps |
=head2 modify_record_regexps |
566 |
|
|
567 |
sub _get_regex { |
sub _get_regex { |
568 |
my ($sf,$from,$to) = @_; |
my ($sf,$from,$to) = @_; |
569 |
|
if ($from =~ m/^regex:(.+)$/) { |
570 |
|
$from = $1; |
571 |
|
} else { |
572 |
|
$from = '\Q' . $from . '\E'; |
573 |
|
} |
574 |
if ($sf =~ /^\^/) { |
if ($sf =~ /^\^/) { |
575 |
return |
return |
576 |
's/\Q'. $sf .'\E([^\^]*?)\Q'. $from .'\E([^\^]*?)/'. $sf .'$1'. $to .'$2/'; |
's/\Q'. $sf .'\E([^\^]*?)'. $from .'([^\^]*?)/'. $sf .'$1'. $to .'$2/'; |
577 |
} else { |
} else { |
578 |
return |
return |
579 |
's/\Q'. $from .'\E/'. $to .'/g'; |
's/'. $from .'/'. $to .'/g'; |
580 |
} |
} |
581 |
} |
} |
582 |
|
|
669 |
return $regexpes; |
return $regexpes; |
670 |
} |
} |
671 |
|
|
|
=head1 MEMORY USAGE |
|
|
|
|
|
C<low_mem> options is double-edged sword. If enabled, WebPAC |
|
|
will run on memory constraint machines (which doesn't have enough |
|
|
physical RAM to create memory structure for whole source database). |
|
|
|
|
|
If your machine has 512Mb or more of RAM and database is around 10000 records, |
|
|
memory shouldn't be an issue. If you don't have enough physical RAM, you |
|
|
might consider using virtual memory (if your operating system is handling it |
|
|
well, like on FreeBSD or Linux) instead of dropping to L<DBM::Deep> to handle |
|
|
parsed structure of ISIS database (this is what C<low_mem> option does). |
|
|
|
|
|
Hitting swap at end of reading source database is probably o.k. However, |
|
|
hitting swap before 90% will dramatically decrease performance and you will |
|
|
be better off with C<low_mem> and using rest of availble memory for |
|
|
operating system disk cache (Linux is particuallary good about this). |
|
|
However, every access to database record will require disk access, so |
|
|
generation phase will be slower 10-100 times. |
|
|
|
|
|
Parsed structures are essential - you just have option to trade RAM memory |
|
|
(which is fast) for disk space (which is slow). Be sure to have planty of |
|
|
disk space if you are using C<low_mem> and thus L<DBM::Deep>. |
|
|
|
|
|
However, when WebPAC is running on desktop machines (or laptops :-), it's |
|
|
highly undesireable for system to start swapping. Using C<low_mem> option can |
|
|
reduce WecPAC memory usage to around 64Mb for same database with lookup |
|
|
fields and sorted indexes which stay in RAM. Performance will suffer, but |
|
|
memory usage will really be minimal. It might be also more confortable to |
|
|
run WebPAC reniced on those machines. |
|
|
|
|
|
|
|
672 |
=head1 AUTHOR |
=head1 AUTHOR |
673 |
|
|
674 |
Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >> |
Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >> |