/[Biblio-Isis]/trunk/lib/Biblio/Isis.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /trunk/lib/Biblio/Isis.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

trunk/IsisDB.pm revision 2 by dpavlin, Tue Dec 28 01:41:45 2004 UTC trunk/lib/Biblio/Isis.pm revision 62 by dpavlin, Mon Jul 10 12:01:04 2006 UTC
# Line 1  Line 1 
1  package IsisDB;  package Biblio::Isis;
2  use strict;  use strict;
3    
4  use Carp;  use Carp;
5  use Data::Dumper;  use File::Glob qw(:globally :nocase);
6    
7  BEGIN {  BEGIN {
8          use Exporter ();          use Exporter ();
9          use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);          use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
10          $VERSION     = 0.01;          $VERSION     = 0.22_2;
11          @ISA         = qw (Exporter);          @ISA         = qw (Exporter);
12          #Give a hoot don't pollute, do not export more than needed by default          #Give a hoot don't pollute, do not export more than needed by default
13          @EXPORT      = qw ();          @EXPORT      = qw ();
# Line 18  BEGIN { Line 18  BEGIN {
18    
19  =head1 NAME  =head1 NAME
20    
21  IsisDB - Read CDS/ISIS database  Biblio::Isis - Read CDS/ISIS, WinISIS and IsisMarc database
22    
23  =head1 SYNOPSIS  =head1 SYNOPSIS
24    
25    use IsisDB    use Biblio::Isis;
26    my $isis = new IsisDB(  
27      my $isis = new Biblio::Isis(
28          isisdb => './cds/cds',          isisdb => './cds/cds',
29    );    );
30    
31      for(my $mfn = 1; $mfn <= $isis->count; $mfn++) {
32            print $isis->to_ascii($mfn),"\n";
33      }
34    
35  =head1 DESCRIPTION  =head1 DESCRIPTION
36    
37  This module will read CDS/ISIS databases and create hash values out of it.  This module will read ISIS databases created by DOS CDS/ISIS, WinIsis or
38  It can be used as perl-only alternative to OpenIsis module.  IsisMarc. It can be used as perl-only alternative to OpenIsis module which
39    seems to depriciate it's old C<XS> bindings for perl.
40    
41    It can create hash values from data in ISIS database (using C<to_hash>),
42    ASCII dump (using C<to_ascii>) or just hash with field names and packed
43    values (like C<^asomething^belse>).
44    
45    Unique feature of this module is ability to C<include_deleted> records.
46    It will also skip zero sized fields (OpenIsis has a bug in XS bindings, so
47    fields which are zero sized will be filled with random junk from memory).
48    
49    It also has support for identifiers (only if ISIS database is created by
50    IsisMarc), see C<to_hash>.
51    
52    This module will always be slower than OpenIsis module which use C
53    library. However, since it's written in perl, it's platform independent (so
54    you don't need C compiler), and can be easily modified. I hope that it
55    creates data structures which are easier to use than ones created by
56    OpenIsis, so reduced time in other parts of the code should compensate for
57    slower performance of this module (speed of reading ISIS database is
58    rarely an issue).
59    
60  =head1 METHODS  =head1 METHODS
61    
# Line 50  It can be used as perl-only alternative Line 75  It can be used as perl-only alternative
75  # some binary reads  # some binary reads
76  #  #
77    
 sub Read32 {  
         my $self = shift;  
   
         my $f = shift || die "Read32 needs file handle";  
         read($$f,$b,4) || die "can't read 4 bytes from $$f from position ".tell($f);  
         return unpack("l",$b);  
 }  
   
78  =head2 new  =head2 new
79    
80  Open CDS/ISIS database  Open ISIS database
81    
82   my $isis = new IsisDB(   my $isis = new Biblio::Isis(
83          isisdb => './cds/cds',          isisdb => './cds/cds',
84          read_fdt => 1,          read_fdt => 1,
85            include_deleted => 1,
86            hash_filter => sub {
87                    my $v = shift;
88                    $v =~ s#foo#bar#g;
89            },
90          debug => 1,          debug => 1,
91            join_subfields_with => ' ; ',
92            regexps => [
93                    's/something/else/g',
94            ],
95   );   );
96    
97  Options are described below:  Options are described below:
# Line 74  Options are described below: Line 100  Options are described below:
100    
101  =item isisdb  =item isisdb
102    
103  Prefix path to CDS/ISIS. It should contain full or relative path to database  This is full or relative path to ISIS database files which include
104  and common prefix of C<.FDT>, C<.MST>, C<.CNT>, C<.XRF> and C<.MST> files.  common prefix of C<.MST>, and C<.XRF> and optionally C<.FDT> (if using
105    C<read_fdt> option) files.
106    
107    In this example it uses C<./cds/cds.MST> and related files.
108    
109  =item read_fdt  =item read_fdt
110    
111  Boolean flag to specify if field definition table should be read. It's off  Boolean flag to specify if field definition table should be read. It's off
112  by default.  by default.
113    
114    =item include_deleted
115    
116    Don't skip logically deleted records in ISIS.
117    
118    =item hash_filter
119    
120    Filter code ref which will be used before data is converted to hash.
121    
122  =item debug  =item debug
123    
124  Dump a C<lot> of debugging output.  Dump a B<lot> of debugging output even at level 1. For even more increase level.
125    
126  =back  =item join_subfields_with
127    
128    Define delimiter which will be used to join repeatable subfields. This
129    option is included to support lagacy application written against version
130    older than 0.21 of this module. By default, it disabled. See L</to_hash>.
131    
132    =item regexpes
133    
134  It will also set C<$isis-E<gt>{'maxmfn'}> which is maximum MFN stored in database.  Define (any number) of regexpes to apply at field values before they are
135    splitted into subfield. This is great place to split subfields in input to
136    mulitple subfields if needed or rename subfields.
137    
138    =back
139    
140  =cut  =cut
141    
# Line 97  sub new { Line 144  sub new {
144          my $self = {};          my $self = {};
145          bless($self, $class);          bless($self, $class);
146    
147          $self->{isisdb} = {@_}->{isisdb} || croak "new needs database name as argument!";          croak "new needs database name (isisdb) as argument!" unless ({@_}->{isisdb});
148    
149            foreach my $v (qw{isisdb debug include_deleted hash_filter}) {
150                    $self->{$v} = {@_}->{$v};
151            }
152    
153            my @isis_files = grep(/\.(FDT|MST|XRF|CNT)$/i,glob($self->{isisdb}."*"));
154    
155            foreach my $f (@isis_files) {
156                    my $ext = $1 if ($f =~ m/\.(\w\w\w)$/);
157                    $self->{lc($ext)."_file"} = $f;
158            }
159    
160          $self->{debug} = {@_}->{debug};          my @must_exist = qw(mst xrf);
161            push @must_exist, "fdt" if ($self->{read_fdt});
162    
163            foreach my $ext (@must_exist) {
164                    unless ($self->{$ext."_file"}) {
165                            carp "missing ",uc($ext)," file in ",$self->{isisdb};
166                            return;
167                    }
168            }
169    
170            if ($self->{debug}) {
171                    print STDERR "## using files: ",join(" ",@isis_files),"\n";
172                    eval "use Data::Dump";
173    
174                    if (! $@) {
175                            *Dumper = *Data::Dump::dump;
176                    } else {
177                            use Data::Dumper;
178                    }
179            }
180    
181          # if you want to read .FDT file use read_fdt argument when creating class!          # if you want to read .FDT file use read_fdt argument when creating class!
182          if ({@_}->{read_fdt} && -e $self->{isisdb}.".FDT") {          if ($self->{read_fdt} && -e $self->{fdt_file}) {
183    
184                  # read the $db.FDT file for tags                  # read the $db.FDT file for tags
185                  my $fieldzone=0;                  my $fieldzone=0;
186    
187                  open(fileFDT, $self->{isisdb}.".FDT") || croak "can't read '$self->{isisdb}.FDT': $!";                  open(my $fileFDT, $self->{fdt_file}) || croak "can't read '$self->{fdt_file}': $!";
188                    binmode($fileFDT);
189    
190                  while (<fileFDT>) {                  while (<$fileFDT>) {
191                          chomp;                          chomp;
192                          if ($fieldzone) {                          if ($fieldzone) {
193                                  my $name=substr($_,0,30);                                  my $name=substr($_,0,30);
# Line 126  sub new { Line 204  sub new {
204                          }                          }
205                  }                  }
206                                    
207                  close(fileFDT);                  close($fileFDT);
208          }          }
209    
210          # Get the Maximum MFN from $db.MST          # Get the Maximum MFN from $db.MST
211    
212          open(fileMST,$self->{isisdb}.".MST") || croak "can't read '$self->{isisdb}.MST': $!";          open($self->{'fileMST'}, $self->{mst_file}) || croak "can't open '$self->{mst_file}': $!";
213            binmode($self->{'fileMST'});
214    
215          # MST format:   (* = 32 bit signed)          # MST format:   (* = 32 bit signed)
216          # CTLMFN*       always 0          # CTLMFN*       always 0
# Line 139  sub new { Line 218  sub new {
218          # NXTMFB*       last block allocated to master file          # NXTMFB*       last block allocated to master file
219          # NXTMFP        offset to next available position in last block          # NXTMFP        offset to next available position in last block
220          # MFTYPE        always 0 for user db file (1 for system)          # MFTYPE        always 0 for user db file (1 for system)
221          seek(fileMST,4,0);          seek($self->{'fileMST'},4,0) || croak "can't seek to offset 0 in MST: $!";
         $self->{'NXTMFN'}=$self->Read32(\*fileMST) || carp "NXTNFN is zero";  
   
         # save maximum MFN  
         $self->{'maxmfn'} = $self->{'NXTMFN'} - 1;  
222    
223          close(fileMST);          my $buff;
224    
225          # Get the index information from $db.CNT          read($self->{'fileMST'}, $buff, 4) || croak "can't read NXTMFN from MST: $!";
226              $self->{'NXTMFN'}=unpack("V",$buff) || croak "NXTNFN is zero";
         open(fileCNT, $self->{isisdb}.".CNT") || croak "can't read '$self->{isisdb}.CNT': $!";  
227    
228          # There is two 26 Bytes fixed lenght records          print STDERR "## self ",Dumper($self),"\n" if ($self->{debug});
229    
230          #  0: IDTYPE    BTree type                              16          # open files for later
231          #  2: ORDN      Nodes Order                             16          open($self->{'fileXRF'}, $self->{xrf_file}) || croak "can't open '$self->{xrf_file}': $!";
232          #  4: ORDF      Leafs Order                             16          binmode($self->{'fileXRF'});
         #  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);  
   
                 my $IDTYPE = shift @arr;  
                 foreach (@flds) {  
                         $self->{$IDTYPE}->{$_} = abs(shift @arr);  
                 }  
         }  
233    
234          my $buff;          $self ? return $self : return undef;
235          read(fileCNT, $buff, 26);  }
         $self->unpack_cnt($buff);  
236    
237          read(fileCNT, $buff, 26);  =head2 count
         $self->unpack_cnt($buff);  
238    
239    Return number of records in database
240    
241          close(fileCNT);    print $isis->count;
242    
243          print Dumper($self) if ($self->{debug});  =cut
244    
245          $self ? return $self : return undef;  sub count {
246            my $self = shift;
247            return $self->{'NXTMFN'} - 1;
248  }  }
249    
250  =head2 GetMFN  =head2 fetch
251    
252  Read record with selected MFN  Read record with selected MFN
253    
254    my $rec = $isis->GetMFN(55);    my $rec = $isis->fetch(55);
255    
256  Returns hash with keys which are field names and values are unpacked values  Returns hash with keys which are field names and values are unpacked values
257  for that field.  for that field like this:
258    
259      $rec = {
260        '210' => [ '^aNew York^cNew York University press^dcop. 1988' ],
261        '990' => [ '2140', '88', 'HAY' ],
262      };
263    
264  =cut  =cut
265    
266  sub GetMFN {  sub fetch {
267          my $self = shift;          my $self = shift;
268    
269          my $mfn = shift || croak "GetMFN needs MFN as argument!";          my $mfn = shift || croak "fetch needs MFN as argument!";
270    
271          print "GetMFN: $mfn\n" if ($self->{debug});          # is mfn allready in memory?
272            my $old_mfn = $self->{'current_mfn'} || -1;
273            return $self->{record} if ($mfn == $old_mfn);
274    
275          open(fileXRF, $self->{isisdb}.".XRF") || croak "can't open '$self->{isisdb}.XRF': $!";          print STDERR "## fetch: $mfn\n" if ($self->{debug});
276    
277          # XXX check this?          # XXX check this?
278          my $mfnpos=($mfn+int(($mfn-1)/127))*4;          my $mfnpos=($mfn+int(($mfn-1)/127))*4;
279    
280          print "seeking to $mfnpos in file '$self->{isisdb}.XRF'\n" if ($self->{debug});          print STDERR "## seeking to $mfnpos in file '$self->{xrf_file}'\n" if ($self->{debug});
281          seek(fileXRF,$mfnpos,0);          seek($self->{'fileXRF'},$mfnpos,0);
282    
283          # read XRFMFB abd XRFMFP          my $buff;
         my $pointer=$self->Read32(\*fileXRF);  
284    
285          my $XRFMFB = int($pointer/2048);          # delete old record
286          my $XRFMFP = $pointer - ($XRFMFB*2048);          delete $self->{record};
287    
288            # read XRFMFB abd XRFMFP
289            read($self->{'fileXRF'}, $buff, 4);
290            my $pointer=unpack("V",$buff);
291            if (! $pointer) {
292                    if ($self->{include_deleted}) {
293                            return;
294                    } else {
295                            warn "pointer for MFN $mfn is null\n";
296                            return;
297                    }
298            }
299    
300          print "XRFMFB: $XRFMFB XRFMFP: $XRFMFP\n" if ($self->{debug});          # check for logically deleted record
301            if ($pointer & 0x80000000) {
302                    print STDERR "## record $mfn is logically deleted\n" if ($self->{debug});
303                    $self->{deleted} = $mfn;
304    
305          # XXX fix this to be more readable!!                  return unless $self->{include_deleted};
         # e.g. (XRFMFB - 1) * 512 + XRFMFP  
306    
307          my $offset = $pointer;                  # abs
308          my $offset2=int($offset/2048)-1;                  $pointer = ($pointer ^ 0xffffffff) + 1;
         my $offset22=int($offset/4096);  
         my $offset3=$offset-($offset22*4096);  
         if ($offset3>512) {  
                 $offset3=$offset3-2048;  
309          }          }
         my $offset4=($offset2*512)+$offset3;  
310    
311          print "$offset - $offset2 - $offset3 - $offset4\n" if ($self->{debug});          my $XRFMFB = int($pointer/2048);
312            my $XRFMFP = $pointer - ($XRFMFB*2048);
313    
314            # (XRFMFB - 1) * 512 + XRFMFP
315            # why do i have to do XRFMFP % 1024 ?
316    
317            my $blk_off = (($XRFMFB - 1) * 512) + ($XRFMFP % 512);
318    
319          close(fileXRF);          print STDERR "## pointer: $pointer XRFMFB: $XRFMFB XRFMFP: $XRFMFP offset: $blk_off\n" if ($self->{'debug'});
320    
321          # Get Record Information          # Get Record Information
322    
323          open(fileMST, $self->{isisdb}.".MST") || croak "can't open '$self->{isisdb}.MST': $!";          seek($self->{'fileMST'},$blk_off,0) || croak "can't seek to $blk_off: $!";
324    
325          seek(fileMST,$offset4,0);          read($self->{'fileMST'}, $buff, 4) || croak "can't read 4 bytes at offset $blk_off from MST file: $!";
326            my $value=unpack("V",$buff);
327    
328          my $value=$self->Read32(\*fileMST);          print STDERR "## offset for rowid $value is $blk_off (blk $XRFMFB off $XRFMFP)\n" if ($self->{debug});
329    
330          if ($value!=$mfn) {          if ($value!=$mfn) {
331  print ("Error: The MFN:".$mfn." is not found in MST(".$value.")");                      if ($value == 0) {
332                  return -1;      # XXX deleted record?                          print STDERR "## record $mfn is physically deleted\n" if ($self->{debug});
333                            $self->{deleted} = $mfn;
334                            return;
335                    }
336    
337                    carp "Error: MFN ".$mfn." not found in MST file, found $value";    
338                    return;
339          }          }
340    
341  #       $MFRL=$self->Read16($fileMST);          read($self->{'fileMST'}, $buff, 14);
 #       $MFBWB=$self->Read32($fileMST);  
 #       $MFBWP=$self->Read16($fileMST);  
 #       $BASE=$self->Read16($fileMST);  
 #       $NVF=$self->Read16($fileMST);  
 #       $STATUS=$self->Read16($fileMST);  
342    
343          my $buff;          my ($MFRL,$MFBWB,$MFBWP,$BASE,$NVF,$STATUS) = unpack("vVvvvv", $buff);
         read(fileMST, $buff, 14);  
344    
345          my ($MFRL,$MFBWB,$MFBWP,$BASE,$NVF,$STATUS) = unpack("slssss", $buff);          print STDERR "## MFRL: $MFRL MFBWB: $MFBWB MFBWP: $MFBWP BASE: $BASE NVF: $NVF STATUS: $STATUS\n" if ($self->{debug});
346    
347          print "MFRL: $MFRL MFBWB: $MFBWB MFBWP: $MFBWP BASE: $BASE NVF: $NVF STATUS: $STATUS\n" if ($self->{debug});          warn "MFRL $MFRL is not even number" unless ($MFRL % 2 == 0);
348    
349            warn "BASE is not 18+6*NVF" unless ($BASE == 18 + 6 * $NVF);
350    
351          # Get Directory Format          # Get Directory Format
352    
# Line 277  print ("Error: The MFN:".$mfn." is not f Line 354  print ("Error: The MFN:".$mfn." is not f
354          my @FieldLEN;          my @FieldLEN;
355          my @FieldTAG;          my @FieldTAG;
356    
357          for (my $i = 0 ; $i < $NVF ; $i++) {          read($self->{'fileMST'}, $buff, 6 * $NVF);
358    
359            my $rec_len = 0;
360    
361  #               $TAG=$self->Read16($fileMST);          for (my $i = 0 ; $i < $NVF ; $i++) {
 #               $POS=$self->Read16($fileMST);  
 #               $LEN=$self->Read16($fileMST);  
362    
363                  read(fileMST, $buff, 6);                  my ($TAG,$POS,$LEN) = unpack("vvv", substr($buff,$i * 6, 6));
                 my ($TAG,$POS,$LEN) = unpack("sss", $buff);  
364    
365                  print "TAG: $TAG POS: $POS LEN: $LEN\n" if ($self->{debug});                  print STDERR "## TAG: $TAG POS: $POS LEN: $LEN\n" if ($self->{debug});
366    
367                  # The TAG does not exists in .FDT so we set it to 0.                  # The TAG does not exists in .FDT so we set it to 0.
368                  #                  #
# Line 301  print ("Error: The MFN:".$mfn." is not f Line 377  print ("Error: The MFN:".$mfn." is not f
377                  push @FieldTAG,$TAG;                  push @FieldTAG,$TAG;
378                  push @FieldPOS,$POS;                  push @FieldPOS,$POS;
379                  push @FieldLEN,$LEN;                  push @FieldLEN,$LEN;
380    
381                    $rec_len += $LEN;
382          }          }
383    
384          # Get Variable Fields          # Get Variable Fields
385    
386          delete $self->{record};          read($self->{'fileMST'},$buff,$rec_len);
387    
388            print STDERR "## rec_len: $rec_len poc: ",tell($self->{'fileMST'})."\n" if ($self->{debug});
389    
390          for (my $i = 0 ; $i < $NVF ; $i++) {          for (my $i = 0 ; $i < $NVF ; $i++) {
391                  my $rec;                  # skip zero-sized fields
392                  read(fileMST,$rec,$FieldLEN[$i]);                  next if ($FieldLEN[$i] == 0);
                 push @{$self->{record}->{$FieldTAG[$i]}}, $rec;  
         }  
         close(fileMST);  
393    
394          # The record is marked for deletion                  push @{$self->{record}->{$FieldTAG[$i]}}, substr($buff,$FieldPOS[$i],$FieldLEN[$i]);
         if ($STATUS==1) {  
                 return -1;  
395          }          }
396    
397          print Dumper($self) if ($self->{debug});          $self->{'current_mfn'} = $mfn;
398    
399            print STDERR Dumper($self),"\n" if ($self->{debug});
400    
401          return $self->{'record'};          return $self->{'record'};
402  }  }
403    
404    =head2 mfn
405    
406    Returns current MFN position
407    
408      my $mfn = $isis->mfn;
409    
410    =cut
411    
412    # This function should be simple return $self->{current_mfn},
413    # but if new is called with _hack_mfn it becomes setter.
414    # It's useful in tests when setting $isis->{record} directly
415    
416    sub mfn {
417            my $self = shift;
418            return $self->{current_mfn};
419    };
420    
421    
422  =head2 to_ascii  =head2 to_ascii
423    
424  Dump ascii output of selected MFN  Returns ASCII output of record with specified MFN
425    
426    print $isis->to_ascii(55);    print $isis->to_ascii(42);
427    
428    This outputs something like this:
429    
430      210   ^aNew York^cNew York University press^dcop. 1988
431      990   2140
432      990   88
433      990   HAY
434    
435    If C<read_fdt> is specified when calling C<new> it will display field names
436    from C<.FDT> file instead of numeric tags.
437    
438  =cut  =cut
439    
# Line 337  sub to_ascii { Line 442  sub to_ascii {
442    
443          my $mfn = shift || croak "need MFN";          my $mfn = shift || croak "need MFN";
444    
445          my $rec = $self->GetMFN($mfn);          my $rec = $self->fetch($mfn) || return;
   
 print STDERR Dumper($rec);  
446    
447          my $out = "0\t$mfn";          my $out = "0\t$mfn";
448    
449          foreach my $f (sort keys %{$rec}) {          foreach my $f (sort keys %{$rec}) {
450                  $out .= "\n$f\t".join("\n$f\t",@{$self->{record}->{$f}});                  my $fn = $self->tag_name($f);
451                    $out .= "\n$fn\t".join("\n$fn\t",@{$self->{record}->{$f}});
452          }          }
453    
454          $out .= "\n";          $out .= "\n";
# Line 352  print STDERR Dumper($rec); Line 456  print STDERR Dumper($rec);
456          return $out;          return $out;
457  }  }
458    
459  ################# old cruft which is not ported from php to perl  =head2 to_hash
460    
461  =begin php  Read record with specified MFN and convert it to hash
462    
463    # Load the dictionary from the $db.L0x files.    my $hash = $isis->to_hash($mfn);
   # Not usefull Yet  
     
   sub LoadDictionary()  
   {  
     $fileL01=fopen($self->{isisdb}.".L01","r");  
     rewind($fileL01);    
   
     do  
     {  
   
       $POS=$self->Read32($fileL01);  
       $OCK=$self->Read16($fileL01);  
       $IT=$self->Read16($fileL01);  
       $PS=$self->Read32($fileL01);  
 print "<br>PS:".$PS." ".$self->{ORDF}->{1}." ";  
       for ($i=0;$i<$OCK;$i++)  
       {  
         $KEY=fread($fileL01,10);  
         
         print $KEY." ### ";  
   
         $INFO1=$self->Read32($fileL01);  
         $INFO2=$self->Read32($fileL01);  
   
         #L01Key->{$key}=array($INFO1,$INFO2);  
       }  
       
       rewind($fileL01);  
       $offset=($PS-1)*(12+$self->{ORDF}->{1}*18*2);  
       fseek($fileL01,$offset);  
464    
465      } While (!feof($fileL01));  It has ability to convert characters (using C<hash_filter>) from ISIS
466    database before creating structures enabling character re-mapping or quick
467    fix-up of data.
468    
469      fclose($fileL01);  This function returns hash which is like this:
   }  
470    
471    # self function search through the tree and returns an array of pointers to IFP    $hash = {
472    # The function must be recursive      '210' => [
473                   {
474                     'c' => 'New York University press',
475                     'a' => 'New York',
476                     'd' => 'cop. 1988'
477                   }
478                 ],
479        '990' => [
480                   '2140',
481                   '88',
482                   'HAY'
483                 ],
484      };
485    
486    sub SearchTree($search,$fileNB,$PUNT)  You can later use that hash to produce any output from ISIS data.
   {        
       $offset=(($PUNT-1)*(8+2*$self->{ORDN}->{1}*14));  
   
         rewind($fileNB1);  
   
         fseek($fileNB,$offset);  
   
         $POS=$self->Read32($fileNB);  
         $OCK=$self->Read16($fileNB);  
         $IT=$self->Read16($fileNB);  
   
 #print "<br>".$POS." - ".$OCK." - ".$IT;  
   
         $OLDPUNT=$POS;  
         $j=0;  
         for ($i=0;$i<$OCK;$i++)  
         {  
           $KEY=fread($fileNB,10);  
         
           $PUNT=$self->Read32($fileNB);  
   
 #print " ## ".chop($KEY)."(".$PUNT."-".$OLDPUNT.") ## ";  
   
           If (strcmp($search,chop($KEY))<0)  
           {  
             break;  
           }  
           $OLDPUNT=$PUNT;    
         }          
 #print $OLDPUNT;  
         Return $OLDPUNT;  
   }  
487    
488    # Search ISIS for record containing search  If database is created using IsisMarc, it will also have to special fields
489    # Return a sorted array of MFN  which will be used for identifiers, C<i1> and C<i2> like this:
490    
491    sub Search($search)    '200' => [
492    {               {
493                   'i1' => '1',
494                   'i2' => ' '
495                   'a' => 'Goa',
496                   'f' => 'Valdo D\'Arienzo',
497                   'e' => 'tipografie e tipografi nel XVI secolo',
498                 }
499               ],
500    
501    $search=strtoupper($search);  In case there are repeatable subfields in record, this will create
502  #print "Searching....".$search." - ".$self->{POSRX}->{1}."<br>";  following structure:
     # first search .x01  
       
   
     # Search in .N01    
   
   
     $fileN01=fopen($self->{isisdb}.".N01","r");  
     $offset=(($self->{POSRX}->{1}-1)*(8+2*$self->{ORDN}->{1}*14));  
   
       do  
       {  
         rewind($fileN01);  
   
         fseek($fileN01,$offset);  
   
         $POS=$self->Read32($fileN01);  
         $OCK=$self->Read16($fileN01);  
         $IT=$self->Read16($fileN01);  
   
 #print "<br>".$POS." - ".$OCK." - ".$IT;  
   
         $OLDPUNT=$POS;  
         for ($i=0;$i<$OCK;$i++)  
         {  
           $KEY=fread($fileN01,10);  
         
           $PUNT=$self->Read32($fileN01);  
   
 #print " ## ".chop($KEY)."(".$PUNT."-".$OLDPUNT.") ## ";  
   
           If (strcmp($search,chop($KEY))<0)  
           {  
             break;  
           }  
           $OLDPUNT=$PUNT;    
         }  
         $offset=(($OLDPUNT-1)*(8+2*$self->{ORDN}->{1}*14));        
       } while ($OLDPUNT>0);  
 #print $OLDPUNT;  
   
   
     fclose($fileN01);  
   
     # Now look for records in .L01 file  
     $fileL01=fopen($self->{isisdb}.".L01","r");  
     rewind($fileL01);  
   
     $offset=(-$OLDPUNT-1)*(12+$self->{ORDF}->{1}*18*2);  
     fseek($fileL01,$offset);  
   
     $POS=$self->Read32($fileL01);  
     $OCK=$self->Read16($fileL01);  
     $IT=$self->Read16($fileL01);  
     $PS=$self->Read32($fileL01);  
 #print "<br>POS:".$POS." ".$self->{ORDF}->{1}." ";  
     for ($i=0;$i<$OCK;$i++)  
     {  
       $KEY=fread($fileL01,10);  
         
 #print $KEY." ### ";  
   
       $INFO1=$self->Read32($fileL01);  
       $INFO2=$self->Read32($fileL01);  
   
       If (strcmp($search,chop($KEY))==0)  
       {  
         break;  
       }  
     }      
   
     fclose($fileL01);  
   
 #print $INFO1."--".$INFO2;  
   
     # Now look in .IFP for the MFN  
     $fileIFP=fopen($self->{isisdb}.".IFP","r");  
     rewind($fileIFP);  
     $offset=($INFO1-1)*512+($INFO2*4);  
     fseek($fileIFP,$offset);    
   
     $IFPBLK=$self->Read32($fileIFP);  
   
     $IFPNXTB=$self->Read32($fileIFP);  
     $IFPNXTP=$self->Read32($fileIFP);  
     $IFPTOTP=$self->Read32($fileIFP);  
     $IFPSEGP=$self->Read32($fileIFP);  
     $IFPSEGC=$self->Read32($fileIFP);  
   
   
 #print "<br>IFP:".$IFPBLK." # ".$IFPNXTB." - ".$IFPNXTP." - ".$IFPTOTP." - ".$IFPSEGP." - ".$IFPSEGC;  
   
     rewind($fileIFP);  
     $offset=($INFO1-1)*512+24+($INFO2*4);  
     fseek($fileIFP,$offset);      
       
     $j=24+($INFO2*4);  
     $k=0;  
     $l=1;  
     $OLDPMFN="";  
     for ($i=0;$i<$IFPSEGP;$i++)  
     {  
       $B1=$self->Read8($fileIFP);  
       $B2=$self->Read8($fileIFP);  
       $B3=$self->Read8($fileIFP);  
       $B4=$self->Read8($fileIFP);  
       $B5=$self->Read8($fileIFP);  
       $B6=$self->Read8($fileIFP);  
       $B7=$self->Read8($fileIFP);  
       $B8=$self->Read8($fileIFP);  
   
       $PMFN=$B1*65536+$B2*256+$B3;  
       $PTAG=$B4*256+$B5;  
       $POCC=$B6;  
       $PCNT=$B7*256+$B8;  
   
       if ($OLDPMFN!=$PMFN)  
       {  
         if ($PMFN!=0)  
         {  
           $self->{MFNArray}->{$l}=$PMFN;  
           $OLDPMFN=$PMFN;  
           $l+=1;  
         }  
       }  
   
       $j=$j+8;  
 #print "<br>".$PMFN."-".$PTAG." - ".$POCC." - ".$PCNT;  
 #print "@@".$j."@@@@";  
       if ($j>=504)  
       {  
         if ($IFPNXTB==0 && $IFPNXTP==0)  
         {  
           $k=$k+1;  
           rewind($fileIFP);  
           $offset=($INFO1-1+$k)*512;    
           fseek($fileIFP,$offset);        
           $B=$self->Read32($fileIFP);  
 #print "<br>-".$B."-<br>";  
           $j=0;  
         } else  
         {  
           rewind($fileIFP);  
           $offset=($IFPNXTB-1)*512;    
           fseek($fileIFP,$offset);  
   
           $OLDIFPNXTB=$IFPNXTB;  
           $OLDIFPNXTP=$IFPNXTP;  
   
           $IFPBLK=$self->Read32($fileIFP);  
   
           $IFPNXTB=$self->Read32($fileIFP);  
           $IFPNXTP=$self->Read32($fileIFP);  
           $IFPTOTP=$self->Read32($fileIFP);  
           $IFPSEGP=$self->Read32($fileIFP);  
           $IFPSEGC=$self->Read32($fileIFP);  
   
           rewind($fileIFP);  
           $offset=($OLDIFPNXTB-1)*512+24+($OLDIFPNXTP*4);  
           fseek($fileIFP,$offset);      
       
           $j=24+($OLDIFPNXTP*4);  
           $k=0;  
           $j=0;  
         }  
       }  
   
     }      
     fclose($fileIFP);  
     return $l-1;  
   }  
503    
504  =cut    '900' => [ {
505            'a' => [ 'foo', 'bar', 'baz' ],
506      }]
507    
508  #  Or in more complex example of
 # XXX porting from php left-over:  
 #  
 # do I *REALLY* need those methods, or should I use  
 # $self->{something} directly?  
 #  
 # Probably direct usage is better!  
 #  
509    
510  sub GetFieldName {    902   ^aa1^aa2^aa3^bb1^aa4^bb2^cc1^aa5
         my $self = shift;  
         return $self->{FieldName};  
 }  
511    
512  sub GetTagName {  it will create
         my $self = shift;  
         return $self->{TagName};  
 }  
513    
514  sub GetFieldTag {    902   => [
515          my $self = shift;          { a => ["a1", "a2", "a3", "a4", "a5"], b => ["b1", "b2"], c => "c1" },
516          return $self->{FieldTAG};    ],
517  }  
518    This behaviour can be changed using C<join_subfields_with> option to L</new>,
519    in which case C<to_hash> will always create single value for each subfield.
520    This will change result to:
521    
522    
523    
524    This method will also create additional field C<000> with MFN.
525    
526    There is also more elaborative way to call C<to_hash> like this:
527    
528      my $hash = $isis->to_hash({
529            mfn => 42,
530            include_subfields => 1,
531            regexps => [
532                    's/something/else/g',
533            ],
534      });
535    
536    Each option controll creation of hash:
537    
538    =over 4
539    
540    =item mfn
541    
542    Specify MFN number of record
543    
544    =item include_subfields
545    
546  sub GetNextMFN {  This option will create additional key in hash called C<subfields> which will
547    have original record subfield order and index to that subfield like this:
548    
549      902   => [ {
550            a => ["a1", "a2", "a3", "a4", "a5"],
551            b => ["b1", "b2"],
552            c => "c1",
553            subfields => ["a", 0, "a", 1, "a", 2, "b", 0, "a", 3, "b", 1, "c", 0, "a", 4],
554      } ],
555    
556    =item join_subfields_with
557    
558    Define delimiter which will be used to join repeatable subfields. You can
559    specify option here instead in L</new> if you want to have per-record control.
560    
561    =item regexpes
562    
563    Override C<regexpes> specified in L</new>.
564    
565    =back
566    
567    =cut
568    
569    sub to_hash {
570          my $self = shift;          my $self = shift;
571          return $self->{NXTMFN};  
572    
573            my $mfn = shift || confess "need mfn!";
574            my $arg;
575    
576            if (ref($mfn) eq 'HASH') {
577                    $arg = $mfn;
578                    $mfn = $arg->{mfn} || confess "need mfn in arguments";
579            }
580    
581            $arg->{regexpes} ||= $self->{regexpes};
582    
583            confess "regexps must be HASH" if ($arg->{regexps} && ref($arg->{regexps}) ne 'HASH');
584    
585            # init record to include MFN as field 000
586            my $rec = { '000' => [ $mfn ] };
587    
588            my $row = $self->fetch($mfn) || return;
589    
590            my $j_rs = $arg->{join_subfields_with};
591            $j_rs = $self->{join_subfields_with} unless(defined($j_rs));
592            my $i_sf = $arg->{include_subfields};
593    
594            foreach my $f_nr (keys %{$row}) {
595                    foreach my $l (@{$row->{$f_nr}}) {
596    
597                            # filter output
598                            if ($self->{'hash_filter'}) {
599                                    $l = $self->{'hash_filter'}->($l);
600                                    next unless defined($l);
601                            }
602    
603                            # apply regexps
604                            if ($arg->{regexps} && defined($arg->{regexps}->{$f_nr})) {
605                                    confess "regexps->{$f_nr} must be ARRAY" if (ref($arg->{regexps}->{$f_nr}) ne 'ARRAY');
606                                    my $c = 0;
607                                    foreach my $r (@{ $arg->{regexps}->{$f_nr} }) {
608                                            while ( eval '$l =~ ' . $r ) { $c++ };
609                                    }
610                                    warn "## field $f_nr triggered $c regexpes\n" if ($c && $self->{debug});
611                            }
612    
613                            my $val;
614                            my $r_sf;       # repeatable subfields in this record
615    
616                            # has identifiers?
617                            ($val->{'i1'},$val->{'i2'}) = ($1,$2) if ($l =~ s/^([01 #])([01 #])\^/\^/);
618    
619                            # has subfields?
620                            if ($l =~ m/\^/) {
621                                    foreach my $t (split(/\^/,$l)) {
622                                            next if (! $t);
623                                            my ($sf,$v) = (substr($t,0,1), substr($t,1));
624                                            # XXX this might be option, but why?
625                                            next unless ($v);
626    #                                       warn "### $f_nr^$sf:$v",$/ if ($self->{debug} > 1);
627    
628                                            if (ref( $val->{$sf} ) eq 'ARRAY') {
629    
630                                                    push @{ $val->{$sf} }, $v;
631    
632                                                    # record repeatable subfield it it's offset
633                                                    push @{ $val->{subfields} }, ( $sf, $#{ $val->{$sf} } ) if (! $j_rs && $i_sf);
634                                                    $r_sf->{$sf}++;
635    
636                                            } elsif (defined( $val->{$sf} )) {
637    
638                                                    # convert scalar field to array
639                                                    $val->{$sf} = [ $val->{$sf}, $v ];
640    
641                                                    push @{ $val->{subfields} }, ( $sf, 1 ) if (! $j_rs && $i_sf);
642                                                    $r_sf->{$sf}++;
643    
644                                            } else {
645                                                    $val->{$sf} = $v;
646                                                    push @{ $val->{subfields} }, ( $sf, 0 ) if ($i_sf);
647                                            }
648                                    }
649                            } else {
650                                    $val = $l;
651                            }
652    
653                            if ($j_rs) {
654                                    map {
655                                            $val->{$_} = join($j_rs, @{ $val->{$_} });
656                                    } keys %$r_sf
657                            }
658    
659                            push @{$rec->{$f_nr}}, $val;
660                    }
661            }
662    
663            return $rec;
664  }  }
665    
666  sub GetMFNArray {  =head2 tag_name
667    
668    Return name of selected tag
669    
670     print $isis->tag_name('200');
671    
672    =cut
673    
674    sub tag_name {
675          my $self = shift;          my $self = shift;
676          return $self->{MFNArray};          my $tag = shift || return;
677            return $self->{'TagName'}->{$tag} || $tag;
678  }  }
 =begin php  
679    
   sub Read32($fileNB)  
   {  
     $B1=ord(fread($fileNB,1));  
     $B2=ord(fread($fileNB,1));  
     $B3=ord(fread($fileNB,1));  
     $B4=ord(fread($fileNB,1));  
   
     if ($B4<=128)  
     {  
       $value=$B1+$B2*256+$B3*65536+$B4*16777216;  
     } else  
     {  
       $value=$self->Not8($B1)+$self->Not8($B2)*256+$self->Not8($B3)*65536+$self->Not8($B4)*16777216;  
       $value=-($value+1);  
     }  
 #    print "(".$B1.",".$B2.",".$B3.",".$B4.":".$value.")";  
680    
681      return $value;    =head2 read_cnt
   }  
682    
683    sub Read24($fileNB)  Read content of C<.CNT> file and return hash containing it.
   {  
     $B1=ord(fread($fileNB,1));  
     $B2=ord(fread($fileNB,1));  
     $B3=ord(fread($fileNB,1));  
684    
685      $value=$B1+$B2*256+$B3*65536;    print Dumper($isis->read_cnt);
686    
687  #    print "(".$B1.",".$B2.",".$B3.":".$value.")";  This function is not used by module (C<.CNT> files are not required for this
688    module to work), but it can be useful to examine your index (while debugging
689    for example).
690    
691      return $value;    =cut
   }  
692    
693    sub Read16($fileNB)  sub read_cnt  {
694    {          my $self = shift;
     $B1=ord(fread($fileNB,1));  
     $B2=ord(fread($fileNB,1));  
695    
696      $value=$B1+$B2*256;          croak "missing CNT file in ",$self->{isisdb} unless ($self->{cnt_file});
 #    print "(".$B1.",".$B2.":".$value.")";  
697    
698      return $value;            # Get the index information from $db.CNT
699    }    
700            open(my $fileCNT, $self->{cnt_file}) || croak "can't read '$self->{cnt_file}': $!";
701            binmode($fileCNT);
702    
703    sub Read8($fileNB)          my $buff;
   {  
     $B1=ord(fread($fileNB,1));  
704    
705      $value=$B1;          read($fileCNT, $buff, 26) || croak "can't read first table from CNT: $!";
706  #    print "(".$value.")";          $self->unpack_cnt($buff);
707    
708      return $value;            read($fileCNT, $buff, 26) || croak "can't read second table from CNT: $!";
709    }          $self->unpack_cnt($buff);
710    
711    sub Not8($value)          close($fileCNT);
712    {  
713      $value=decbin($value);          return $self->{cnt};
     if (strlen($value)<8)  
     {  
       $buffer="";  
       for($i=0;$i<(8-strlen($value));$i++)  
       {  
         $buffer.="0";  
       }  
       $value=$buffer.$value;  
     }  
     $value=ereg_replace("0","3",$value);  
     $value=ereg_replace("1","0",$value);  
     $value=ereg_replace("3","1",$value);  
     $value=bindec($value);  
     return $value;  
   }  
714  }  }
715    
716    =head2 unpack_cnt
717    
718    Unpack one of two 26 bytes fixed length record in C<.CNT> file.
719    
720    Here is definition of record:
721    
722     off key        description                             size
723      0: IDTYPE     BTree type                              s
724      2: ORDN       Nodes Order                             s
725      4: ORDF       Leafs Order                             s
726      6: N          Number of Memory buffers for nodes      s
727      8: K          Number of buffers for first level index s
728     10: LIV        Current number of Index Levels          s
729     12: POSRX      Pointer to Root Record in N0x           l
730     16: NMAXPOS    Next Available position in N0x          l
731     20: FMAXPOS    Next available position in L0x          l
732     24: ABNORMAL   Formal BTree normality indicator        s
733     length: 26 bytes
734    
735    This will fill C<$self> object under C<cnt> with hash. It's used by C<read_cnt>.
736    
737  =cut  =cut
738    
739    sub unpack_cnt {
740            my $self = shift;
741    
742            my @flds = qw(ORDN ORDF N K LIV POSRX NMAXPOS FMAXPOS ABNORMAL);
743    
744            my $buff = shift || return;
745            my @arr = unpack("vvvvvvVVVv", $buff);
746    
747            print STDERR "unpack_cnt: ",join(" ",@arr),"\n" if ($self->{'debug'});
748    
749            my $IDTYPE = shift @arr;
750            foreach (@flds) {
751                    $self->{cnt}->{$IDTYPE}->{$_} = abs(shift @arr);
752            }
753    }
754    
755  1;  1;
 __END__  
756    
757  =head1 BUGS  =head1 BUGS
758    
759  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
760    some variations in input databases which has been tested with this module.
761    When I was in doubt, I assumed that OpenIsis's implementation was right
762    (except for obvious bugs).
763    
764    However, every effort has been made to test this module with as much
765    databases (and programs that create them) as possible.
766    
767    I would be very greatful for success or failure reports about usage of this
768    module with databases from programs other than WinIsis and IsisMarc. I had
769    tested this against ouput of one C<isis.dll>-based application, but I don't
770    know any details about it's version.
771    
772    =head1 VERSIONS
773    
774    As this is young module, new features are added in subsequent version. It's
775    a good idea to specify version when using this module like this:
776    
777      use Biblio::Isis 0.21
778    
779    Below is list of changes in specific version of module (so you can target
780    older versions if you really have to):
781    
782    =over 8
783    
784    =item 0.21
785    
786    Added C<join_subfields_with> to L</new> and L</to_hash>.
787    
788    Added C<include_subfields> to L</to_hash>.
789    
790    =item 0.20
791    
792    Added C<< $isis->mfn >>, support for repeatable subfields and
793    C<< $isis->to_hash({ mfn => 42, ... }) >> calling convention
794    
795    =back
796    
797  =head1 AUTHOR  =head1 AUTHOR
798    
# Line 736  This module has been very lightly tested Line 801  This module has been very lightly tested
801          dpavlin@rot13.org          dpavlin@rot13.org
802          http://www.rot13.org/~dpavlin/          http://www.rot13.org/~dpavlin/
803    
804  This module is based heavily on code from LIBISIS.PHP - Library to read ISIS files V0.1.1  This module is based heavily on code from C<LIBISIS.PHP> library to read ISIS files V0.1.1
805  written in php and (c) 2000 Franck Martin - <franck@sopac.org> released under LGPL.  written in php and (c) 2000 Franck Martin <franck@sopac.org> and released under LGPL.
806    
807  =head1 COPYRIGHT  =head1 COPYRIGHT
808    
# Line 750  LICENSE file included with this module. Line 815  LICENSE file included with this module.
815    
816  =head1 SEE ALSO  =head1 SEE ALSO
817    
818  L<http://www.openisis.org|OpenIsis>, perl(1).  L<Biblio::Isis::Manual> for CDS/ISIS manual appendix F, G and H which describe file format
819    
820    OpenIsis web site L<http://www.openisis.org>
821    
822    perl4lib site L<http://perl4lib.perl.org>
823    

Legend:
Removed from v.2  
changed lines
  Added in v.62

  ViewVC Help
Powered by ViewVC 1.1.26