--- trunk/IsisDB.pm 2005/01/05 15:46:26 32 +++ trunk/lib/Biblio/Isis.pm 2006/07/08 16:03:52 56 @@ -1,15 +1,13 @@ -package IsisDB; +package Biblio::Isis; use strict; use Carp; use File::Glob qw(:globally :nocase); -use Data::Dumper; - BEGIN { use Exporter (); use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS); - $VERSION = 0.09; + $VERSION = 0.20; @ISA = qw (Exporter); #Give a hoot don't pollute, do not export more than needed by default @EXPORT = qw (); @@ -20,13 +18,13 @@ =head1 NAME -IsisDB - Read CDS/ISIS, WinISIS and IsisMarc database +Biblio::Isis - Read CDS/ISIS, WinISIS and IsisMarc database =head1 SYNOPSIS - use IsisDB; + use Biblio::Isis; - my $isis = new IsisDB( + my $isis = new Biblio::Isis( isisdb => './cds/cds', ); @@ -81,7 +79,7 @@ Open ISIS database - my $isis = new IsisDB( + my $isis = new Biblio::Isis( isisdb => './cds/cds', read_fdt => 1, include_deleted => 1, @@ -119,7 +117,7 @@ =item debug -Dump a B of debugging output. +Dump a B of debugging output even at level 1. For even more increase level. =back @@ -147,10 +145,22 @@ push @must_exist, "fdt" if ($self->{read_fdt}); foreach my $ext (@must_exist) { - croak "missing ",uc($ext)," file in ",$self->{isisdb} unless ($self->{$ext."_file"}); + unless ($self->{$ext."_file"}) { + carp "missing ",uc($ext)," file in ",$self->{isisdb}; + return; + } } - print STDERR "## using files: ",join(" ",@isis_files),"\n" if ($self->{debug}); + if ($self->{debug}) { + print STDERR "## using files: ",join(" ",@isis_files),"\n"; + eval "use Data::Dump"; + + if (! $@) { + *Dumper = *Data::Dump::dump; + } else { + use Data::Dumper; + } + } # if you want to read .FDT file use read_fdt argument when creating class! if ($self->{read_fdt} && -e $self->{fdt_file}) { @@ -158,9 +168,10 @@ # read the $db.FDT file for tags my $fieldzone=0; - open(fileFDT, $self->{fdt_file}) || croak "can't read '$self->{fdt_file}': $!"; + open(my $fileFDT, $self->{fdt_file}) || croak "can't read '$self->{fdt_file}': $!"; + binmode($fileFDT); - while () { + while (<$fileFDT>) { chomp; if ($fieldzone) { my $name=substr($_,0,30); @@ -177,12 +188,13 @@ } } - close(fileFDT); + close($fileFDT); } # Get the Maximum MFN from $db.MST open($self->{'fileMST'}, $self->{mst_file}) || croak "can't open '$self->{mst_file}': $!"; + binmode($self->{'fileMST'}); # MST format: (* = 32 bit signed) # CTLMFN* always 0 @@ -190,20 +202,18 @@ # NXTMFB* last block allocated to master file # NXTMFP offset to next available position in last block # MFTYPE always 0 for user db file (1 for system) - seek($self->{'fileMST'},4,0); + seek($self->{'fileMST'},4,0) || croak "can't seek to offset 0 in MST: $!"; my $buff; - read($self->{'fileMST'}, $buff, 4); - $self->{'NXTMFN'}=unpack("l",$buff) || carp "NXTNFN is zero"; - + read($self->{'fileMST'}, $buff, 4) || croak "can't read NXTMFN from MST: $!"; + $self->{'NXTMFN'}=unpack("V",$buff) || croak "NXTNFN is zero"; - - - print STDERR Dumper($self),"\n" if ($self->{debug}); + print STDERR "## self ",Dumper($self),"\n" if ($self->{debug}); # open files for later open($self->{'fileXRF'}, $self->{xrf_file}) || croak "can't open '$self->{xrf_file}': $!"; + binmode($self->{'fileXRF'}); $self ? return $self : return undef; } @@ -221,79 +231,6 @@ return $self->{'NXTMFN'} - 1; } -=head2 read_cnt - -Read content of C<.CNT> file and return hash containing it. - - print Dumper($isis->read_cnt); - -This function is not used by module (C<.CNT> files are not required for this -module to work), but it can be useful to examine your index (while debugging -for example). - -=cut - -sub read_cnt { - my $self = shift; - - croak "missing CNT file in ",$self->{isisdb} unless ($self->{cnt_file}); - - # Get the index information from $db.CNT - - open(fileCNT, $self->{cnt_file}) || croak "can't read '$self->{cnt_file}': $!"; - - my $buff; - - read(fileCNT, $buff, 26); - $self->unpack_cnt($buff); - - read(fileCNT, $buff, 26); - $self->unpack_cnt($buff); - - close(fileCNT); - - return $self->{cnt}; -} - -=head2 unpack_cnt - -Unpack one of two 26 bytes fixed length record in C<.CNT> file. - -Here is definition of record: - - off key description size - 0: IDTYPE BTree type s - 2: ORDN Nodes Order s - 4: ORDF Leafs Order s - 6: N Number of Memory buffers for nodes s - 8: K Number of buffers for first level index s - 10: LIV Current number of Index Levels s - 12: POSRX Pointer to Root Record in N0x l - 16: NMAXPOS Next Available position in N0x l - 20: FMAXPOS Next available position in L0x l - 24: ABNORMAL Formal BTree normality indicator s - length: 26 bytes - -This will fill C<$self> object under C with hash. It's used by C. - -=cut - -sub unpack_cnt { - my $self = shift; - - my @flds = qw(ORDN ORDF N K LIV POSRX NMAXPOS FMAXPOS ABNORMAL); - - my $buff = shift || return; - my @arr = unpack("ssssssllls", $buff); - - print STDERR "unpack_cnt: ",join(" ",@arr),"\n" if ($self->{'debug'}); - - my $IDTYPE = shift @arr; - foreach (@flds) { - $self->{cnt}->{$IDTYPE}->{$_} = abs(shift @arr); - } -} - =head2 fetch Read record with selected MFN @@ -334,16 +271,25 @@ # read XRFMFB abd XRFMFP read($self->{'fileXRF'}, $buff, 4); - my $pointer=unpack("l",$buff) || carp "pointer is null"; + my $pointer=unpack("V",$buff); + if (! $pointer) { + if ($self->{include_deleted}) { + return; + } else { + warn "pointer for MFN $mfn is null\n"; + return; + } + } # check for logically deleted record - if ($pointer < 0) { + if ($pointer & 0x80000000) { print STDERR "## record $mfn is logically deleted\n" if ($self->{debug}); $self->{deleted} = $mfn; return unless $self->{include_deleted}; - $pointer = abs($pointer); + # abs + $pointer = ($pointer ^ 0xffffffff) + 1; } my $XRFMFB = int($pointer/2048); @@ -358,10 +304,10 @@ # Get Record Information - seek($self->{'fileMST'},$blk_off,0); + seek($self->{'fileMST'},$blk_off,0) || croak "can't seek to $blk_off: $!"; - read($self->{'fileMST'}, $buff, 4); - my $value=unpack("l",$buff); + read($self->{'fileMST'}, $buff, 4) || croak "can't read 4 bytes at offset $blk_off from MST file: $!"; + my $value=unpack("V",$buff); print STDERR "## offset for rowid $value is $blk_off (blk $XRFMFB off $XRFMFP)\n" if ($self->{debug}); @@ -378,7 +324,7 @@ read($self->{'fileMST'}, $buff, 14); - my ($MFRL,$MFBWB,$MFBWP,$BASE,$NVF,$STATUS) = unpack("slssss", $buff); + my ($MFRL,$MFBWB,$MFBWP,$BASE,$NVF,$STATUS) = unpack("vVvvvv", $buff); print STDERR "## MFRL: $MFRL MFBWB: $MFBWB MFBWP: $MFBWP BASE: $BASE NVF: $NVF STATUS: $STATUS\n" if ($self->{debug}); @@ -398,7 +344,7 @@ for (my $i = 0 ; $i < $NVF ; $i++) { - my ($TAG,$POS,$LEN) = unpack("sss", substr($buff,$i * 6, 6)); + my ($TAG,$POS,$LEN) = unpack("vvv", substr($buff,$i * 6, 6)); print STDERR "## TAG: $TAG POS: $POS LEN: $LEN\n" if ($self->{debug}); @@ -439,6 +385,24 @@ return $self->{'record'}; } +=head2 mfn + +Returns current MFN position + + my $mfn = $isis->mfn; + +=cut + +# This function should be simple return $self->{current_mfn}, +# but if new is called with _hack_mfn it becomes setter. +# It's useful in tests when setting $isis->{record} directly + +sub mfn { + my $self = shift; + return $self->{current_mfn}; +}; + + =head2 to_ascii Returns ASCII output of record with specified MFN @@ -462,7 +426,7 @@ my $mfn = shift || croak "need MFN"; - my $rec = $self->fetch($mfn); + my $rec = $self->fetch($mfn) || return; my $out = "0\t$mfn"; @@ -518,25 +482,49 @@ } ], +In case there are repeatable subfields in record, this will create +following structure: + + '900' => [ { + 'a' => [ 'foo', 'bar', 'baz' ], + }] + This method will also create additional field C<000> with MFN. +There is also more elaborative way to call C like this: + + my $hash = $isis->to_hash({ + mfn => 42, + include_empty_subfields => 1, + }); + =cut sub to_hash { my $self = shift; + my $mfn = shift || confess "need mfn!"; + my $arg; + + if (ref($mfn) eq 'HASH') { + $arg = $mfn; + $mfn = $arg->{mfn} || confess "need mfn in arguments"; + } # init record to include MFN as field 000 my $rec = { '000' => [ $mfn ] }; - my $row = $self->fetch($mfn); + my $row = $self->fetch($mfn) || return; foreach my $k (keys %{$row}) { foreach my $l (@{$row->{$k}}) { # filter output - $l = $self->{'hash_filter'}->($l) if ($self->{'hash_filter'}); + if ($self->{'hash_filter'}) { + $l = $self->{'hash_filter'}->($l); + next unless defined($l); + } my $val; @@ -547,7 +535,21 @@ if ($l =~ m/\^/) { foreach my $t (split(/\^/,$l)) { next if (! $t); - $val->{substr($t,0,1)} = substr($t,1); + my ($sf,$v) = (substr($t,0,1), substr($t,1)); + # FIXME make this option ! + next unless ($v); +# warn "### $k^$sf:$v",$/ if ($self->{debug} > 1); + + # FIXME array return optional, by default unroll to ' ; ' + if (ref( $val->{$sf} ) eq 'ARRAY') { + + push @{ $val->{$sf} }, $v; + } elsif (defined( $val->{$sf} )) { + # convert scalar field to array + $val->{$sf} = [ $val->{$sf}, $v ]; + } else { + $val->{$sf} = $v; + } } } else { $val = $l; @@ -574,6 +576,81 @@ return $self->{'TagName'}->{$tag} || $tag; } + +=head2 read_cnt + +Read content of C<.CNT> file and return hash containing it. + + print Dumper($isis->read_cnt); + +This function is not used by module (C<.CNT> files are not required for this +module to work), but it can be useful to examine your index (while debugging +for example). + +=cut + +sub read_cnt { + my $self = shift; + + croak "missing CNT file in ",$self->{isisdb} unless ($self->{cnt_file}); + + # Get the index information from $db.CNT + + open(my $fileCNT, $self->{cnt_file}) || croak "can't read '$self->{cnt_file}': $!"; + binmode($fileCNT); + + my $buff; + + read($fileCNT, $buff, 26) || croak "can't read first table from CNT: $!"; + $self->unpack_cnt($buff); + + read($fileCNT, $buff, 26) || croak "can't read second table from CNT: $!"; + $self->unpack_cnt($buff); + + close($fileCNT); + + return $self->{cnt}; +} + +=head2 unpack_cnt + +Unpack one of two 26 bytes fixed length record in C<.CNT> file. + +Here is definition of record: + + off key description size + 0: IDTYPE BTree type s + 2: ORDN Nodes Order s + 4: ORDF Leafs Order s + 6: N Number of Memory buffers for nodes s + 8: K Number of buffers for first level index s + 10: LIV Current number of Index Levels s + 12: POSRX Pointer to Root Record in N0x l + 16: NMAXPOS Next Available position in N0x l + 20: FMAXPOS Next available position in L0x l + 24: ABNORMAL Formal BTree normality indicator s + length: 26 bytes + +This will fill C<$self> object under C with hash. It's used by C. + +=cut + +sub unpack_cnt { + my $self = shift; + + my @flds = qw(ORDN ORDF N K LIV POSRX NMAXPOS FMAXPOS ABNORMAL); + + my $buff = shift || return; + my @arr = unpack("vvvvvvVVVv", $buff); + + print STDERR "unpack_cnt: ",join(" ",@arr),"\n" if ($self->{'debug'}); + + my $IDTYPE = shift @arr; + foreach (@flds) { + $self->{cnt}->{$IDTYPE}->{$_} = abs(shift @arr); + } +} + 1; =head1 BUGS @@ -591,6 +668,19 @@ tested this against ouput of one C-based application, but I don't know any details about it's version. +=head1 VERSIONS + +You can find version dependencies documented here + +=over 8 + +=item 0.20 + +Added C<< $isis->mfn >>, support for repeatable subfields and +C<< $isis->to_hash({ mfn => 42, ... }) >> calling convention + +=back + =head1 AUTHOR Dobrica Pavlinusic