/[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 34 by dpavlin, Thu Jan 6 00:40:07 2005 UTC trunk/lib/Biblio/Isis.pm revision 39 by dpavlin, Thu Jan 27 22:01:17 2005 UTC
# Line 1  Line 1 
1  package IsisDB;  package Biblio::Isis;
2  use strict;  use strict;
3    
4  use Carp;  use Carp;
# Line 9  use Data::Dumper; Line 9  use Data::Dumper;
9  BEGIN {  BEGIN {
10          use Exporter ();          use Exporter ();
11          use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);          use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
12          $VERSION     = 0.09;          $VERSION     = 0.12;
13          @ISA         = qw (Exporter);          @ISA         = qw (Exporter);
14          #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
15          @EXPORT      = qw ();          @EXPORT      = qw ();
# Line 20  BEGIN { Line 20  BEGIN {
20    
21  =head1 NAME  =head1 NAME
22    
23  IsisDB - Read CDS/ISIS, WinISIS and IsisMarc database  Biblio::Isis - Read CDS/ISIS, WinISIS and IsisMarc database
24    
25  =head1 SYNOPSIS  =head1 SYNOPSIS
26    
27    use IsisDB;    use Biblio::Isis;
28    
29    my $isis = new IsisDB(    my $isis = new Biblio::Isis(
30          isisdb => './cds/cds',          isisdb => './cds/cds',
31    );    );
32    
# Line 81  rarely an issue). Line 81  rarely an issue).
81    
82  Open ISIS database  Open ISIS database
83    
84   my $isis = new IsisDB(   my $isis = new Biblio::Isis(
85          isisdb => './cds/cds',          isisdb => './cds/cds',
86          read_fdt => 1,          read_fdt => 1,
87          include_deleted => 1,          include_deleted => 1,
# Line 147  sub new { Line 147  sub new {
147          push @must_exist, "fdt" if ($self->{read_fdt});          push @must_exist, "fdt" if ($self->{read_fdt});
148    
149          foreach my $ext (@must_exist) {          foreach my $ext (@must_exist) {
150                  croak "missing ",uc($ext)," file in ",$self->{isisdb} unless ($self->{$ext."_file"});                  unless ($self->{$ext."_file"}) {
151                            carp "missing ",uc($ext)," file in ",$self->{isisdb};
152                            return;
153                    }
154          }          }
155    
156          print STDERR "## using files: ",join(" ",@isis_files),"\n" if ($self->{debug});          print STDERR "## using files: ",join(" ",@isis_files),"\n" if ($self->{debug});
# Line 221  sub count { Line 224  sub count {
224          return $self->{'NXTMFN'} - 1;          return $self->{'NXTMFN'} - 1;
225  }  }
226    
 =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<cnt> with hash. It's used by C<read_cnt>.  
   
 =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);  
         }  
 }  
   
227  =head2 fetch  =head2 fetch
228    
229  Read record with selected MFN  Read record with selected MFN
# Line 576  sub tag_name { Line 505  sub tag_name {
505          return $self->{'TagName'}->{$tag} || $tag;          return $self->{'TagName'}->{$tag} || $tag;
506  }  }
507    
508    
509    =head2 read_cnt
510    
511    Read content of C<.CNT> file and return hash containing it.
512    
513      print Dumper($isis->read_cnt);
514    
515    This function is not used by module (C<.CNT> files are not required for this
516    module to work), but it can be useful to examine your index (while debugging
517    for example).
518    
519    =cut
520    
521    sub read_cnt  {
522            my $self = shift;
523    
524            croak "missing CNT file in ",$self->{isisdb} unless ($self->{cnt_file});
525    
526            # Get the index information from $db.CNT
527      
528            open(my $fileCNT, $self->{cnt_file}) || croak "can't read '$self->{cnt_file}': $!";
529            binmode($fileCNT);
530    
531            my $buff;
532    
533            read($fileCNT, $buff, 26) || croak "can't read first table from CNT: $!";
534            $self->unpack_cnt($buff);
535    
536            read($fileCNT, $buff, 26) || croak "can't read second table from CNT: $!";
537            $self->unpack_cnt($buff);
538    
539            close($fileCNT);
540    
541            return $self->{cnt};
542    }
543    
544    =head2 unpack_cnt
545    
546    Unpack one of two 26 bytes fixed length record in C<.CNT> file.
547    
548    Here is definition of record:
549    
550     off key        description                             size
551      0: IDTYPE     BTree type                              s
552      2: ORDN       Nodes Order                             s
553      4: ORDF       Leafs Order                             s
554      6: N          Number of Memory buffers for nodes      s
555      8: K          Number of buffers for first level index s
556     10: LIV        Current number of Index Levels          s
557     12: POSRX      Pointer to Root Record in N0x           l
558     16: NMAXPOS    Next Available position in N0x          l
559     20: FMAXPOS    Next available position in L0x          l
560     24: ABNORMAL   Formal BTree normality indicator        s
561     length: 26 bytes
562    
563    This will fill C<$self> object under C<cnt> with hash. It's used by C<read_cnt>.
564    
565    =cut
566    
567    sub unpack_cnt {
568            my $self = shift;
569    
570            my @flds = qw(ORDN ORDF N K LIV POSRX NMAXPOS FMAXPOS ABNORMAL);
571    
572            my $buff = shift || return;
573            my @arr = unpack("vvvvvvVVVv", $buff);
574    
575            print STDERR "unpack_cnt: ",join(" ",@arr),"\n" if ($self->{'debug'});
576    
577            my $IDTYPE = shift @arr;
578            foreach (@flds) {
579                    $self->{cnt}->{$IDTYPE}->{$_} = abs(shift @arr);
580            }
581    }
582    
583  1;  1;
584    
585  =head1 BUGS  =head1 BUGS
Legend:
Removed from v.34  
changed lines
  Added in v.39
  ViewVC Help
Powered by ViewVC 1.1.26