--- trunk/IsisDB.pm 2004/12/31 07:16:02 26 +++ trunk/IsisDB.pm 2005/01/06 00:40:07 34 @@ -9,7 +9,7 @@ BEGIN { use Exporter (); use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS); - $VERSION = 0.08; + $VERSION = 0.09; @ISA = qw (Exporter); #Give a hoot don't pollute, do not export more than needed by default @EXPORT = qw (); @@ -30,14 +30,15 @@ isisdb => './cds/cds', ); - for(my $mfn = 1; $mfn <= $isis->{'maxmfn'}; $mfn++) { + for(my $mfn = 1; $mfn <= $isis->count; $mfn++) { print $isis->to_ascii($mfn),"\n"; } =head1 DESCRIPTION This module will read ISIS databases created by DOS CDS/ISIS, WinIsis or -IsisMarc. It can be used as perl-only alternative to OpenIsis module. +IsisMarc. It can be used as perl-only alternative to OpenIsis module which +seems to depriciate it's old C bindings for perl. It can create hash values from data in ISIS database (using C), ASCII dump (using C) or just hash with field names and packed @@ -50,7 +51,7 @@ It also has support for identifiers (only if ISIS database is created by IsisMarc), see C. -This will module will always be slower than OpenIsis module which use C +This module will always be slower than OpenIsis module which use C library. However, since it's written in perl, it's platform independent (so you don't need C compiler), and can be easily modified. I hope that it creates data structures which are easier to use than ones created by @@ -122,8 +123,6 @@ =back -It will also set C<$isis-E{'maxmfn'}> which is maximum MFN stored in database. - =cut sub new { @@ -159,9 +158,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); @@ -178,12 +178,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 @@ -191,34 +192,45 @@ # 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"; - - # save maximum MFN - $self->{'maxmfn'} = $self->{'NXTMFN'} - 1; - - - + 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}); # 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; } +=head2 count + +Return number of records in database + + print $isis->count; + +=cut + +sub count { + my $self = shift; + return $self->{'NXTMFN'} - 1; +} + =head2 read_cnt -This function is not really used by module, but can be useful to find info -about your index (if debugging it for example). +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 { @@ -228,51 +240,61 @@ # Get the index information from $db.CNT - open(fileCNT, $self->{cnt_file}) || croak "can't read '$self->{cnt_file}': $!"; - - # There is two 26 Bytes fixed lenght records - - # 0: IDTYPE BTree type 16 - # 2: ORDN Nodes Order 16 - # 4: ORDF Leafs Order 16 - # 6: N Number of Memory buffers for nodes 16 - # 8: K Number of buffers for first level index 16 - # 10: LIV Current number of Index Levels 16 - # 12: POSRX* Pointer to Root Record in N0x 32 - # 16: NMAXPOS* Next Available position in N0x 32 - # 20: FMAXPOS* Next available position in L0x 32 - # 24: ABNORMAL Formal BTree normality indicator 16 - # length: 26 bytes - - 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); - } - } + open(my $fileCNT, $self->{cnt_file}) || croak "can't read '$self->{cnt_file}': $!"; + binmode($fileCNT); my $buff; - read(fileCNT, $buff, 26); + read($fileCNT, $buff, 26) || croak "can't read first table from CNT: $!"; $self->unpack_cnt($buff); - read(fileCNT, $buff, 26); + read($fileCNT, $buff, 26) || croak "can't read second table from CNT: $!"; $self->unpack_cnt($buff); - close(fileCNT); + 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); + } +} + =head2 fetch Read record with selected MFN @@ -313,16 +335,17 @@ # read XRFMFB abd XRFMFP read($self->{'fileXRF'}, $buff, 4); - my $pointer=unpack("l",$buff) || carp "pointer is null"; + my $pointer=unpack("V",$buff) || croak "pointer is null"; # 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); @@ -337,10 +360,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}); @@ -357,7 +380,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}); @@ -377,7 +400,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}); @@ -420,11 +443,11 @@ =head2 to_ascii -Dump ASCII output of record with specified MFN +Returns ASCII output of record with specified MFN print $isis->to_ascii(42); -It outputs something like this: +This outputs something like this: 210 ^aNew York^cNew York University press^dcop. 1988 990 2140 @@ -461,7 +484,7 @@ my $hash = $isis->to_hash($mfn); -It has ability to convert characters (using C from ISIS +It has ability to convert characters (using C) from ISIS database before creating structures enabling character re-mapping or quick fix-up of data. @@ -557,7 +580,18 @@ =head1 BUGS -This module has been very lightly tested. Use with caution and report bugs. +Some parts of CDS/ISIS documentation are not detailed enough to exmplain +some variations in input databases which has been tested with this module. +When I was in doubt, I assumed that OpenIsis's implementation was right +(except for obvious bugs). + +However, every effort has been made to test this module with as much +databases (and programs that create them) as possible. + +I would be very greatful for success or failure reports about usage of this +module with databases from programs other than WinIsis and IsisMarc. I had +tested this against ouput of one C-based application, but I don't +know any details about it's version. =head1 AUTHOR