5 use File::Glob qw(:globally :nocase);
11 use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
14 #Give a hoot don't pollute, do not export more than needed by default
23 IsisDB - Read CDS/ISIS, WinISIS and IsisMarc database
29 my $isis = new IsisDB(
30 isisdb => './cds/cds',
33 for(my $mfn = 1; $mfn <= $isis->count; $mfn++) {
34 print $isis->to_ascii($mfn),"\n";
39 This module will read ISIS databases created by DOS CDS/ISIS, WinIsis or
40 IsisMarc. It can be used as perl-only alternative to OpenIsis module which
41 seems to depriciate it's old C<XS> bindings for perl.
43 It can create hash values from data in ISIS database (using C<to_hash>),
44 ASCII dump (using C<to_ascii>) or just hash with field names and packed
45 values (like C<^asomething^belse>).
47 Unique feature of this module is ability to C<include_deleted> records.
48 It will also skip zero sized fields (OpenIsis has a bug in XS bindings, so
49 fields which are zero sized will be filled with random junk from memory).
51 It also has support for identifiers (only if ISIS database is created by
52 IsisMarc), see C<to_hash>.
54 This module will always be slower than OpenIsis module which use C
55 library. However, since it's written in perl, it's platform independent (so
56 you don't need C compiler), and can be easily modified. I hope that it
57 creates data structures which are easier to use than ones created by
58 OpenIsis, so reduced time in other parts of the code should compensate for
59 slower performance of this module (speed of reading ISIS database is
66 # my $ORDN; # Nodes Order
67 # my $ORDF; # Leafs Order
68 # my $N; # Number of Memory buffers for nodes
69 # my $K; # Number of buffers for first level index
70 # my $LIV; # Current number of Index Levels
71 # my $POSRX; # Pointer to Root Record in N0x
72 # my $NMAXPOS; # Next Available position in N0x
73 # my $FMAXPOS; # Next available position in L0x
74 # my $ABNORMAL; # Formal BTree normality indicator
84 my $isis = new IsisDB(
85 isisdb => './cds/cds',
95 Options are described below:
101 This is full or relative path to ISIS database files which include
102 common prefix of C<.MST>, and C<.XRF> and optionally C<.FDT> (if using
103 C<read_fdt> option) files.
105 In this example it uses C<./cds/cds.MST> and related files.
109 Boolean flag to specify if field definition table should be read. It's off
112 =item include_deleted
114 Don't skip logically deleted records in ISIS.
118 Filter code ref which will be used before data is converted to hash.
122 Dump a B<lot> of debugging output.
131 bless($self, $class);
133 croak "new needs database name (isisdb) as argument!" unless ({@_}->{isisdb});
135 foreach my $v (qw{isisdb debug include_deleted hash_filter}) {
136 $self->{$v} = {@_}->{$v};
139 my @isis_files = grep(/\.(FDT|MST|XRF|CNT)$/i,glob($self->{isisdb}."*"));
141 foreach my $f (@isis_files) {
142 my $ext = $1 if ($f =~ m/\.(\w\w\w)$/);
143 $self->{lc($ext)."_file"} = $f;
146 my @must_exist = qw(mst xrf);
147 push @must_exist, "fdt" if ($self->{read_fdt});
149 foreach my $ext (@must_exist) {
150 croak "missing ",uc($ext)," file in ",$self->{isisdb} unless ($self->{$ext."_file"});
153 print STDERR "## using files: ",join(" ",@isis_files),"\n" if ($self->{debug});
155 # if you want to read .FDT file use read_fdt argument when creating class!
156 if ($self->{read_fdt} && -e $self->{fdt_file}) {
158 # read the $db.FDT file for tags
161 open(fileFDT, $self->{fdt_file}) || croak "can't read '$self->{fdt_file}': $!";
166 my $name=substr($_,0,30);
167 my $tag=substr($_,50,3);
172 $self->{'TagName'}->{$tag}=$name;
183 # Get the Maximum MFN from $db.MST
185 open($self->{'fileMST'}, $self->{mst_file}) || croak "can't open '$self->{mst_file}': $!";
187 # MST format: (* = 32 bit signed)
189 # NXTMFN* MFN to be assigned to the next record created
190 # NXTMFB* last block allocated to master file
191 # NXTMFP offset to next available position in last block
192 # MFTYPE always 0 for user db file (1 for system)
193 seek($self->{'fileMST'},4,0);
197 read($self->{'fileMST'}, $buff, 4);
198 $self->{'NXTMFN'}=unpack("l",$buff) || carp "NXTNFN is zero";
203 print STDERR Dumper($self),"\n" if ($self->{debug});
205 # open files for later
206 open($self->{'fileXRF'}, $self->{xrf_file}) || croak "can't open '$self->{xrf_file}': $!";
208 $self ? return $self : return undef;
213 Return number of records in database
221 return $self->{'NXTMFN'} - 1;
226 Read content of C<.CNT> file and return hash containing it.
228 print Dumper($isis->read_cnt);
230 This function is not used by module (C<.CNT> files are not required for this
231 module to work), but it can be useful to examine your index (while debugging
239 croak "missing CNT file in ",$self->{isisdb} unless ($self->{cnt_file});
241 # Get the index information from $db.CNT
243 open(fileCNT, $self->{cnt_file}) || croak "can't read '$self->{cnt_file}': $!";
247 read(fileCNT, $buff, 26);
248 $self->unpack_cnt($buff);
250 read(fileCNT, $buff, 26);
251 $self->unpack_cnt($buff);
260 Unpack one of two 26 bytes fixed length record in C<.CNT> file.
262 Here is definition of record:
264 off key description size
265 0: IDTYPE BTree type s
266 2: ORDN Nodes Order s
267 4: ORDF Leafs Order s
268 6: N Number of Memory buffers for nodes s
269 8: K Number of buffers for first level index s
270 10: LIV Current number of Index Levels s
271 12: POSRX Pointer to Root Record in N0x l
272 16: NMAXPOS Next Available position in N0x l
273 20: FMAXPOS Next available position in L0x l
274 24: ABNORMAL Formal BTree normality indicator s
277 This will fill C<$self> object under C<cnt> with hash. It's used by C<read_cnt>.
284 my @flds = qw(ORDN ORDF N K LIV POSRX NMAXPOS FMAXPOS ABNORMAL);
286 my $buff = shift || return;
287 my @arr = unpack("ssssssllls", $buff);
289 print STDERR "unpack_cnt: ",join(" ",@arr),"\n" if ($self->{'debug'});
291 my $IDTYPE = shift @arr;
293 $self->{cnt}->{$IDTYPE}->{$_} = abs(shift @arr);
299 Read record with selected MFN
301 my $rec = $isis->fetch(55);
303 Returns hash with keys which are field names and values are unpacked values
304 for that field like this:
307 '210' => [ '^aNew York^cNew York University press^dcop. 1988' ],
308 '990' => [ '2140', '88', 'HAY' ],
316 my $mfn = shift || croak "fetch needs MFN as argument!";
318 # is mfn allready in memory?
319 my $old_mfn = $self->{'current_mfn'} || -1;
320 return $self->{record} if ($mfn == $old_mfn);
322 print STDERR "## fetch: $mfn\n" if ($self->{debug});
325 my $mfnpos=($mfn+int(($mfn-1)/127))*4;
327 print STDERR "## seeking to $mfnpos in file '$self->{xrf_file}'\n" if ($self->{debug});
328 seek($self->{'fileXRF'},$mfnpos,0);
333 delete $self->{record};
335 # read XRFMFB abd XRFMFP
336 read($self->{'fileXRF'}, $buff, 4);
337 my $pointer=unpack("l",$buff) || carp "pointer is null";
339 # check for logically deleted record
341 print STDERR "## record $mfn is logically deleted\n" if ($self->{debug});
342 $self->{deleted} = $mfn;
344 return unless $self->{include_deleted};
346 $pointer = abs($pointer);
349 my $XRFMFB = int($pointer/2048);
350 my $XRFMFP = $pointer - ($XRFMFB*2048);
352 # (XRFMFB - 1) * 512 + XRFMFP
353 # why do i have to do XRFMFP % 1024 ?
355 my $blk_off = (($XRFMFB - 1) * 512) + ($XRFMFP % 512);
357 print STDERR "## pointer: $pointer XRFMFB: $XRFMFB XRFMFP: $XRFMFP offset: $blk_off\n" if ($self->{'debug'});
359 # Get Record Information
361 seek($self->{'fileMST'},$blk_off,0);
363 read($self->{'fileMST'}, $buff, 4);
364 my $value=unpack("l",$buff);
366 print STDERR "## offset for rowid $value is $blk_off (blk $XRFMFB off $XRFMFP)\n" if ($self->{debug});
370 print STDERR "## record $mfn is physically deleted\n" if ($self->{debug});
371 $self->{deleted} = $mfn;
375 carp "Error: MFN ".$mfn." not found in MST file, found $value";
379 read($self->{'fileMST'}, $buff, 14);
381 my ($MFRL,$MFBWB,$MFBWP,$BASE,$NVF,$STATUS) = unpack("slssss", $buff);
383 print STDERR "## MFRL: $MFRL MFBWB: $MFBWB MFBWP: $MFBWP BASE: $BASE NVF: $NVF STATUS: $STATUS\n" if ($self->{debug});
385 warn "MFRL $MFRL is not even number" unless ($MFRL % 2 == 0);
387 warn "BASE is not 18+6*NVF" unless ($BASE == 18 + 6 * $NVF);
389 # Get Directory Format
395 read($self->{'fileMST'}, $buff, 6 * $NVF);
399 for (my $i = 0 ; $i < $NVF ; $i++) {
401 my ($TAG,$POS,$LEN) = unpack("sss", substr($buff,$i * 6, 6));
403 print STDERR "## TAG: $TAG POS: $POS LEN: $LEN\n" if ($self->{debug});
405 # The TAG does not exists in .FDT so we set it to 0.
407 # XXX This is removed from perl version; .FDT file is updated manually, so
408 # you will often have fields in .MST file which aren't in .FDT. On the other
409 # hand, IsisMarc doesn't use .FDT files at all!
411 #if (! $self->{TagName}->{$TAG}) {
422 # Get Variable Fields
424 read($self->{'fileMST'},$buff,$rec_len);
426 print STDERR "## rec_len: $rec_len poc: ",tell($self->{'fileMST'})."\n" if ($self->{debug});
428 for (my $i = 0 ; $i < $NVF ; $i++) {
429 # skip zero-sized fields
430 next if ($FieldLEN[$i] == 0);
432 push @{$self->{record}->{$FieldTAG[$i]}}, substr($buff,$FieldPOS[$i],$FieldLEN[$i]);
435 $self->{'current_mfn'} = $mfn;
437 print STDERR Dumper($self),"\n" if ($self->{debug});
439 return $self->{'record'};
444 Returns ASCII output of record with specified MFN
446 print $isis->to_ascii(42);
448 This outputs something like this:
450 210 ^aNew York^cNew York University press^dcop. 1988
455 If C<read_fdt> is specified when calling C<new> it will display field names
456 from C<.FDT> file instead of numeric tags.
463 my $mfn = shift || croak "need MFN";
465 my $rec = $self->fetch($mfn);
469 foreach my $f (sort keys %{$rec}) {
470 my $fn = $self->tag_name($f);
471 $out .= "\n$fn\t".join("\n$fn\t",@{$self->{record}->{$f}});
481 Read record with specified MFN and convert it to hash
483 my $hash = $isis->to_hash($mfn);
485 It has ability to convert characters (using C<hash_filter>) from ISIS
486 database before creating structures enabling character re-mapping or quick
489 This function returns hash which is like this:
494 'c' => 'New York University press',
506 You can later use that hash to produce any output from ISIS data.
508 If database is created using IsisMarc, it will also have to special fields
509 which will be used for identifiers, C<i1> and C<i2> like this:
516 'f' => 'Valdo D\'Arienzo',
517 'e' => 'tipografie e tipografi nel XVI secolo',
521 This method will also create additional field C<000> with MFN.
528 my $mfn = shift || confess "need mfn!";
530 # init record to include MFN as field 000
531 my $rec = { '000' => [ $mfn ] };
533 my $row = $self->fetch($mfn);
535 foreach my $k (keys %{$row}) {
536 foreach my $l (@{$row->{$k}}) {
539 $l = $self->{'hash_filter'}->($l) if ($self->{'hash_filter'});
544 ($val->{'i1'},$val->{'i2'}) = ($1,$2) if ($l =~ s/^([01 #])([01 #])\^/\^/);
548 foreach my $t (split(/\^/,$l)) {
550 $val->{substr($t,0,1)} = substr($t,1);
556 push @{$rec->{$k}}, $val;
565 Return name of selected tag
567 print $isis->tag_name('200');
573 my $tag = shift || return;
574 return $self->{'TagName'}->{$tag} || $tag;
581 Some parts of CDS/ISIS documentation are not detailed enough to exmplain
582 some variations in input databases which has been tested with this module.
583 When I was in doubt, I assumed that OpenIsis's implementation was right
584 (except for obvious bugs).
586 However, every effort has been made to test this module with as much
587 databases (and programs that create them) as possible.
589 I would be very greatful for success or failure reports about usage of this
590 module with databases from programs other than WinIsis and IsisMarc. I had
591 tested this against ouput of one C<isis.dll>-based application, but I don't
592 know any details about it's version.
599 http://www.rot13.org/~dpavlin/
601 This module is based heavily on code from C<LIBISIS.PHP> library to read ISIS files V0.1.1
602 written in php and (c) 2000 Franck Martin <franck@sopac.org> and released under LGPL.
606 This program is free software; you can redistribute
607 it and/or modify it under the same terms as Perl itself.
609 The full text of the license can be found in the
610 LICENSE file included with this module.
615 OpenIsis web site L<http://www.openisis.org>
617 perl4lib site L<http://perl4lib.perl.org>