Import of old code back from february to actually make it work.
authorDobrica Pavlinusic <dpavlin@rot13.org>
Tue, 28 Dec 2004 00:43:04 +0000 (00:43 +0000)
committerDobrica Pavlinusic <dpavlin@rot13.org>
Tue, 28 Dec 2004 00:43:04 +0000 (00:43 +0000)
git-svn-id: file:///home/dpavlin/svn/Biblio-Isis/trunk@1 4670fa4d-42ec-0310-ab5b-a66af6943492

Changes [new file with mode: 0644]
IsisDB.pm [new file with mode: 0644]
LICENSE [new file with mode: 0644]
MANIFEST [new file with mode: 0644]
Makefile.PL [new file with mode: 0644]
README [new file with mode: 0644]
t/001_load.t [new file with mode: 0755]

diff --git a/Changes b/Changes
new file mode 100644 (file)
index 0000000..72c1999
--- /dev/null
+++ b/Changes
@@ -0,0 +1,6 @@
+Revision history for Perl module IsisDB
+
+0.01 Tue Dec 28 00:41:44 2004
+       - original version; created by ExtUtils::ModuleMaker 0.32
+
+
diff --git a/IsisDB.pm b/IsisDB.pm
new file mode 100644 (file)
index 0000000..444fa0e
--- /dev/null
+++ b/IsisDB.pm
@@ -0,0 +1,706 @@
+package IsisDB;
+use strict;
+
+use Carp;
+use Data::Dumper;
+
+BEGIN {
+       use Exporter ();
+       use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+       $VERSION     = 0.01;
+       @ISA         = qw (Exporter);
+       #Give a hoot don't pollute, do not export more than needed by default
+       @EXPORT      = qw ();
+       @EXPORT_OK   = qw ();
+       %EXPORT_TAGS = ();
+
+}
+
+=head1 NAME
+
+IsisDB - Read CDS/ISIS database
+
+=head1 SYNOPSIS
+
+  use IsisDB
+  my $isis = new IsisDB(
+       isisdb => './cds/cds',
+  );
+
+=head1 DESCRIPTION
+
+This module will read CDS/ISIS databases and create hash values out of it.
+It can be used as perl-only alternative to OpenIsis module.
+
+=head1 METHODS
+
+=cut
+
+#  my $ORDN;           # Nodes Order
+#  my $ORDF;           # Leafs Order
+#  my $N;              # Number of Memory buffers for nodes
+#  my $K;              # Number of buffers for first level index
+#  my $LIV;            # Current number of Index Levels
+#  my $POSRX;          # Pointer to Root Record in N0x
+#  my $NMAXPOS;                # Next Available position in N0x
+#  my $FMAXPOS;                # Next available position in L0x
+#  my $ABNORMAL;       # Formal BTree normality indicator
+
+#
+# some binary reads
+#
+
+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);
+}
+
+=head2 new
+
+Open CDS/ISIS database
+
+ my $isis = new IsisDB(
+       isisdb => './cds/cds',
+       read_fdt => 1,
+       debug => 1,
+ );
+
+=item isisdb
+
+Prefix path to CDS/ISIS. It should contain full or relative path to database
+and common prefix of C<.FDT>, C<.MST>, C<.CNT>, C<.XRF> and C<.MST> files.
+
+=item read_fdt
+
+Boolean flag to specify if field definition table should be read. It's off
+by default.
+
+=item debug
+
+Dump a C<lot> of debugging output.
+
+=cut
+
+sub new {
+       my $class = shift;
+       my $self = {};
+       bless($self, $class);
+
+       $self->{isisdb} = {@_}->{isisdb} || croak "new needs database name as argument!";
+
+       $self->{debug} = {@_}->{debug} || 1;    # XXX remove debug always!
+
+       # if you want to read .FDT file use read_fdt argument when creating class!
+       if ({@_}->{read_fdt} && -e $self->{isisdb}.".FDT") {
+
+               # read the $db.FDT file for tags
+               my $fieldzone=0;
+
+               open(fileFDT, $self->{isisdb}.".FDT") || croak "can't read '$self->{isisdb}.FDT': $!";
+
+               while (<fileFDT>) {
+                       chomp;
+                       if ($fieldzone) {
+                               my $name=substr($_,0,30);
+                               my $tag=substr($_,50,3);
+
+                               $name =~ s/\s+$//;
+                               $tag =~ s/\s+$//;
+
+                               $self->{'TagName'}->{$tag}=$name;  
+                       }
+
+                       if (/^\*\*\*/) {
+                               $fieldzone=1;
+                       }
+               }
+               
+               close(fileFDT);
+       }
+
+       # Get the Maximum MFN from $db.MST
+
+       open(fileMST,$self->{isisdb}.".MST") || croak "can't read '$self->{isisdb}.MST': $!";
+
+       # MST format:   (* = 32 bit signed)
+       # CTLMFN*       always 0
+       # NXTMFN*       MFN to be assigned to the next record created
+       # 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(fileMST,4,0);
+       $self->{'NXTMFN'}=$self->Read32(\*fileMST) || carp "NXTNFN is zero";
+
+       close(fileMST);
+
+       # Get the index information from $db.CNT
+   
+       open(fileCNT, $self->{isisdb}.".CNT") || croak "can't read '$self->{isisdb}.CNT': $!";
+
+       # 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);
+
+               my $IDTYPE = shift @arr;
+               foreach (@flds) {
+                       $self->{$IDTYPE}->{$_} = abs(shift @arr);
+               }
+       }
+
+       my $buff;
+       read(fileCNT, $buff, 26);
+       $self->unpack_cnt($buff);
+
+       read(fileCNT, $buff, 26);
+       $self->unpack_cnt($buff);
+
+
+       close(fileCNT);
+
+       print Dumper($self) if ($self->{debug});
+
+       $self ? return $self : return undef;
+}
+
+
+# Get a record from the MFN
+# Return the number of fields in the record.
+# Return -1 if the record is marked for deletion
+# The record is then extracted with call to GETs
+
+sub GetMFN {
+       my $self = shift;
+
+       my $mfn = shift || croak "GetMFN needs MFN as argument!";
+
+       print "GetMFN: $mfn\n" if ($self->{debug});
+
+       open(fileXRF, $self->{isisdb}.".XRF") || croak "can't open '$self->{isisdb}.XRF': $!";
+
+       # XXX check this?
+       my $mfnpos=($mfn+int(($mfn-1)/127))*4;
+
+       print "seeking to $mfnpos in file '$self->{isisdb}.XRF'\n" if ($self->{debug});
+       seek(fileXRF,$mfnpos,0);
+
+       # read XRFMFB abd XRFMFP
+       my $pointer=$self->Read32(\*fileXRF);
+
+       my $XRFMFB = int($pointer/2048);
+       my $XRFMFP = $pointer - ($XRFMFB*2048);
+
+       print "XRFMFB: $XRFMFB XRFMFP: $XRFMFP\n" if ($self->{debug});
+
+       # XXX fix this to be more readable!!
+       # e.g. (XRFMFB - 1) * 512 + XRFMFP
+
+       my $offset = $pointer;
+       my $offset2=int($offset/2048)-1;
+       my $offset22=int($offset/4096);
+       my $offset3=$offset-($offset22*4096);
+       if ($offset3>512) {
+               $offset3=$offset3-2048;
+       }
+       my $offset4=($offset2*512)+$offset3;
+
+       print "$offset - $offset2 - $offset3 - $offset4\n" if ($self->{debug});
+
+       close(fileXRF);
+
+       # Get Record Information
+
+       open(fileMST, $self->{isisdb}.".MST") || croak "can't open '$self->{isisdb}.MST': $!";
+
+       seek(fileMST,$offset4,0);
+
+       my $value=$self->Read32(\*fileMST);
+
+       if ($value!=$mfn) {
+print ("Error: The MFN:".$mfn." is not found in MST(".$value.")");    
+               return -1;      # XXX deleted record?
+       }
+
+#      $MFRL=$self->Read16($fileMST);
+#      $MFBWB=$self->Read32($fileMST);
+#      $MFBWP=$self->Read16($fileMST);
+#      $BASE=$self->Read16($fileMST);
+#      $NVF=$self->Read16($fileMST);
+#      $STATUS=$self->Read16($fileMST);
+
+       my $buff;
+       read(fileMST, $buff, 14);
+
+       my ($MFRL,$MFBWB,$MFBWP,$BASE,$NVF,$STATUS) = unpack("slssss", $buff);
+
+       print "MFRL: $MFRL MFBWB: $MFBWB MFBWP: $MFBWP BASE: $BASE NVF: $NVF STATUS: $STATUS\n" if ($self->{debug});
+
+       # Get Directory Format
+
+       my @FieldPOS;
+       my @FieldLEN;
+       my @FieldTAG;
+
+       for (my $i = 0 ; $i < $NVF ; $i++) {
+
+#              $TAG=$self->Read16($fileMST);
+#              $POS=$self->Read16($fileMST);
+#              $LEN=$self->Read16($fileMST);
+
+               read(fileMST, $buff, 6);
+               my ($TAG,$POS,$LEN) = unpack("sss", $buff);
+
+               print "TAG: $TAG POS: $POS LEN: $LEN\n" if ($self->{debug});
+
+               # The TAG does not exists in .FDT so we set it to 0.
+               #
+               # XXX This is removed from perl version; .FDT file is updated manually, so
+               # you will often have fields in .MST file which aren't in .FDT. On the other
+               # hand, IsisMarc doesn't use .FDT files at all!
+
+               #if (! $self->{TagName}->{$TAG}) {
+               #       $TAG=0;
+               #}
+
+               push @FieldTAG,$TAG;
+               push @FieldPOS,$POS;
+               push @FieldLEN,$LEN;
+       }
+
+       # Get Variable Fields
+
+       for (my $i = 0 ; $i < $NVF ; $i++) {
+               my $rec;
+               read(fileMST,$rec,$FieldLEN[$i]);
+               $self->{record}->{$FieldTAG[$i]} = $rec;
+       }
+       close(fileMST);
+
+       # The record is marked for deletion
+       if ($STATUS==1) {
+               return -1;
+       }
+
+       print Dumper($self) if ($self->{debug});
+
+       return $NVF;
+}
+
+=begin php
+
+  # Load the dictionary from the $db.L0x files.
+  # 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);
+
+    } While (!feof($fileL01));
+
+    fclose($fileL01);
+  }
+
+  # self function search through the tree and returns an array of pointers to IFP
+  # The function must be recursive
+
+  sub SearchTree($search,$fileNB,$PUNT)
+  {       
+      $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;
+  }
+
+  # Search ISIS for record containing search
+  # Return a sorted array of MFN
+
+  sub Search($search)
+  {
+
+  $search=strtoupper($search);
+#print "Searching....".$search." - ".$self->{POSRX}->{1}."<br>";
+    # 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;
+  }
+
+=cut
+
+#
+# XXX porting from php left-over:
+#
+# do I *REALLY* need those methods, or should I use
+# $self->{something} directly?
+#
+# Probably direct usage is better!
+#
+
+sub GetFieldName {
+       my $self = shift;
+       return $self->{FieldName};
+}
+
+sub GetTagName {
+       my $self = shift;
+       return $self->{TagName};
+}
+
+sub GetFieldTag {
+       my $self = shift;
+       return $self->{FieldTAG};
+}
+
+sub GetNextMFN {
+       my $self = shift;
+       return $self->{NXTMFN};
+}
+
+sub GetMFNArray {
+       my $self = shift;
+       return $self->{MFNArray};
+}
+=begin php
+
+  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.")";
+
+    return $value;   
+  }
+
+  sub Read24($fileNB)
+  {
+    $B1=ord(fread($fileNB,1));
+    $B2=ord(fread($fileNB,1));
+    $B3=ord(fread($fileNB,1));
+
+    $value=$B1+$B2*256+$B3*65536;
+
+#    print "(".$B1.",".$B2.",".$B3.":".$value.")";
+
+    return $value;   
+  }
+
+  sub Read16($fileNB)
+  {
+    $B1=ord(fread($fileNB,1));
+    $B2=ord(fread($fileNB,1));
+
+    $value=$B1+$B2*256;
+#    print "(".$B1.",".$B2.":".$value.")";
+
+    return $value;  
+  }
+
+  sub Read8($fileNB)
+  {
+    $B1=ord(fread($fileNB,1));
+
+    $value=$B1;
+#    print "(".$value.")";
+
+    return $value;  
+  }
+
+  sub Not8($value)
+  { 
+    $value=decbin($value);
+    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;
+  }
+}
+
+=cut
+
+1;
+__END__
+
+=head1 BUGS
+
+This module has been very lightly tested. Use with caution and report bugs.
+
+=head1 AUTHOR
+
+       Dobrica Pavlinusic
+       CPAN ID: DPAVLIN
+       dpavlin@rot13.org
+       http://www.rot13.org/~dpavlin/
+
+This module is based heavily on code from LIBISIS.PHP - Library to read ISIS files V0.1.1
+written in php and (c) 2000 Franck Martin - <franck@sopac.org> released under LGPL.
+
+=head1 COPYRIGHT
+
+This program is free software; you can redistribute
+it and/or modify it under the same terms as Perl itself.
+
+The full text of the license can be found in the
+LICENSE file included with this module.
+
+
+=head1 SEE ALSO
+
+L<http://www.openisis.org|OpenIsis>, perl(1).
+
diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..9d0305b
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,383 @@
+Terms of Perl itself
+
+a) the GNU General Public License as published by the Free
+   Software Foundation; either version 1, or (at your option) any
+   later version, or
+b) the "Artistic License"
+
+---------------------------------------------------------------------------
+
+The General Public License (GPL)
+Version 2, June 1991
+
+Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave,
+Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute
+verbatim copies of this license document, but changing it is not allowed.
+
+Preamble
+
+The licenses for most software are designed to take away your freedom to share
+and change it. By contrast, the GNU General Public License is intended to
+guarantee your freedom to share and change free software--to make sure the
+software is free for all its users. This General Public License applies to most of
+the Free Software Foundation's software and to any other program whose
+authors commit to using it. (Some other Free Software Foundation software is
+covered by the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+When we speak of free software, we are referring to freedom, not price. Our
+General Public Licenses are designed to make sure that you have the freedom
+to distribute copies of free software (and charge for this service if you wish), that
+you receive source code or can get it if you want it, that you can change the
+software or use pieces of it in new free programs; and that you know you can do
+these things.
+
+To protect your rights, we need to make restrictions that forbid anyone to deny
+you these rights or to ask you to surrender the rights. These restrictions
+translate to certain responsibilities for you if you distribute copies of the
+software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether gratis or for a
+fee, you must give the recipients all the rights that you have. You must make
+sure that they, too, receive or can get the source code. And you must show
+them these terms so they know their rights.
+
+We protect your rights with two steps: (1) copyright the software, and (2) offer
+you this license which gives you legal permission to copy, distribute and/or
+modify the software.
+
+Also, for each author's protection and ours, we want to make certain that
+everyone understands that there is no warranty for this free software. If the
+software is modified by someone else and passed on, we want its recipients to
+know that what they have is not the original, so that any problems introduced by
+others will not reflect on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software patents. We wish
+to avoid the danger that redistributors of a free program will individually obtain
+patent licenses, in effect making the program proprietary. To prevent this, we
+have made it clear that any patent must be licensed for everyone's free use or
+not licensed at all.
+
+The precise terms and conditions for copying, distribution and modification
+follow.
+
+GNU GENERAL PUBLIC LICENSE
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
+MODIFICATION
+
+0. This License applies to any program or other work which contains a notice
+placed by the copyright holder saying it may be distributed under the terms of
+this General Public License. The "Program", below, refers to any such program
+or work, and a "work based on the Program" means either the Program or any
+derivative work under copyright law: that is to say, a work containing the
+Program or a portion of it, either verbatim or with modifications and/or translated
+into another language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not covered by
+this License; they are outside its scope. The act of running the Program is not
+restricted, and the output from the Program is covered only if its contents
+constitute a work based on the Program (independent of having been made by
+running the Program). Whether that is true depends on what the Program does.
+
+1. You may copy and distribute verbatim copies of the Program's source code as
+you receive it, in any medium, provided that you conspicuously and appropriately
+publish on each copy an appropriate copyright notice and disclaimer of warranty;
+keep intact all the notices that refer to this License and to the absence of any
+warranty; and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and you may at
+your option offer warranty protection in exchange for a fee.
+
+2. You may modify your copy or copies of the Program or any portion of it, thus
+forming a work based on the Program, and copy and distribute such
+modifications or work under the terms of Section 1 above, provided that you also
+meet all of these conditions:
+
+a) You must cause the modified files to carry prominent notices stating that you
+changed the files and the date of any change.
+
+b) You must cause any work that you distribute or publish, that in whole or in
+part contains or is derived from the Program or any part thereof, to be licensed
+as a whole at no charge to all third parties under the terms of this License.
+
+c) If the modified program normally reads commands interactively when run, you
+must cause it, when started running for such interactive use in the most ordinary
+way, to print or display an announcement including an appropriate copyright
+notice and a notice that there is no warranty (or else, saying that you provide a
+warranty) and that users may redistribute the program under these conditions,
+and telling the user how to view a copy of this License. (Exception: if the
+Program itself is interactive but does not normally print such an announcement,
+your work based on the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If identifiable
+sections of that work are not derived from the Program, and can be reasonably
+considered independent and separate works in themselves, then this License,
+and its terms, do not apply to those sections when you distribute them as
+separate works. But when you distribute the same sections as part of a whole
+which is a work based on the Program, the distribution of the whole must be on
+the terms of this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest your rights to
+work written entirely by you; rather, the intent is to exercise the right to control
+the distribution of derivative or collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program with the
+Program (or with a work based on the Program) on a volume of a storage or
+distribution medium does not bring the other work under the scope of this
+License.
+
+3. You may copy and distribute the Program (or a work based on it, under
+Section 2) in object code or executable form under the terms of Sections 1 and 2
+above provided that you also do one of the following:
+
+a) Accompany it with the complete corresponding machine-readable source
+code, which must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange; or,
+
+b) Accompany it with a written offer, valid for at least three years, to give any
+third party, for a charge no more than your cost of physically performing source
+distribution, a complete machine-readable copy of the corresponding source
+code, to be distributed under the terms of Sections 1 and 2 above on a medium
+customarily used for software interchange; or,
+
+c) Accompany it with the information you received as to the offer to distribute
+corresponding source code. (This alternative is allowed only for noncommercial
+distribution and only if you received the program in object code or executable
+form with such an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for making
+modifications to it. For an executable work, complete source code means all the
+source code for all modules it contains, plus any associated interface definition
+files, plus the scripts used to control compilation and installation of the
+executable. However, as a special exception, the source code distributed need
+not include anything that is normally distributed (in either source or binary form)
+with the major components (compiler, kernel, and so on) of the operating system
+on which the executable runs, unless that component itself accompanies the
+executable.
+
+If distribution of executable or object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the source
+code from the same place counts as distribution of the source code, even though
+third parties are not compelled to copy the source along with the object code.
+
+4. You may not copy, modify, sublicense, or distribute the Program except as
+expressly provided under this License. Any attempt otherwise to copy, modify,
+sublicense or distribute the Program is void, and will automatically terminate
+your rights under this License. However, parties who have received copies, or
+rights, from you under this License will not have their licenses terminated so long
+as such parties remain in full compliance.
+
+5. You are not required to accept this License, since you have not signed it.
+However, nothing else grants you permission to modify or distribute the Program
+or its derivative works. These actions are prohibited by law if you do not accept
+this License. Therefore, by modifying or distributing the Program (or any work
+based on the Program), you indicate your acceptance of this License to do so,
+and all its terms and conditions for copying, distributing or modifying the
+Program or works based on it.
+
+6. Each time you redistribute the Program (or any work based on the Program),
+the recipient automatically receives a license from the original licensor to copy,
+distribute or modify the Program subject to these terms and conditions. You
+may not impose any further restrictions on the recipients' exercise of the rights
+granted herein. You are not responsible for enforcing compliance by third parties
+to this License.
+
+7. If, as a consequence of a court judgment or allegation of patent infringement
+or for any other reason (not limited to patent issues), conditions are imposed on
+you (whether by court order, agreement or otherwise) that contradict the
+conditions of this License, they do not excuse you from the conditions of this
+License. If you cannot distribute so as to satisfy simultaneously your obligations
+under this License and any other pertinent obligations, then as a consequence
+you may not distribute the Program at all. For example, if a patent license would
+not permit royalty-free redistribution of the Program by all those who receive
+copies directly or indirectly through you, then the only way you could satisfy
+both it and this License would be to refrain entirely from distribution of the
+Program.
+
+If any portion of this section is held invalid or unenforceable under any particular
+circumstance, the balance of the section is intended to apply and the section as
+a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any patents or other
+property right claims or to contest validity of any such claims; this section has
+the sole purpose of protecting the integrity of the free software distribution
+system, which is implemented by public license practices. Many people have
+made generous contributions to the wide range of software distributed through
+that system in reliance on consistent application of that system; it is up to the
+author/donor to decide if he or she is willing to distribute software through any
+other system and a licensee cannot impose that choice.
+
+This section is intended to make thoroughly clear what is believed to be a
+consequence of the rest of this License.
+
+8. If the distribution and/or use of the Program is restricted in certain countries
+either by patents or by copyrighted interfaces, the original copyright holder who
+places the Program under this License may add an explicit geographical
+distribution limitation excluding those countries, so that distribution is permitted
+only in or among countries not thus excluded. In such case, this License
+incorporates the limitation as if written in the body of this License.
+
+9. The Free Software Foundation may publish revised and/or new versions of the
+General Public License from time to time. Such new versions will be similar in
+spirit to the present version, but may differ in detail to address new problems or
+concerns.
+
+Each version is given a distinguishing version number. If the Program specifies a
+version number of this License which applies to it and "any later version", you
+have the option of following the terms and conditions either of that version or of
+any later version published by the Free Software Foundation. If the Program does
+not specify a version number of this License, you may choose any version ever
+published by the Free Software Foundation.
+
+10. If you wish to incorporate parts of the Program into other free programs
+whose distribution conditions are different, write to the author to ask for
+permission. For software which is copyrighted by the Free Software Foundation,
+write to the Free Software Foundation; we sometimes make exceptions for this.
+Our decision will be guided by the two goals of preserving the free status of all
+derivatives of our free software and of promoting the sharing and reuse of
+software generally.
+
+NO WARRANTY
+
+11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS
+NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
+COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM
+"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
+IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
+ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
+YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
+
+12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED
+TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY
+WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS
+PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM
+(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY
+OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS
+BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+END OF TERMS AND CONDITIONS
+
+
+---------------------------------------------------------------------------
+
+The Artistic License
+
+Preamble
+
+The intent of this document is to state the conditions under which a Package
+may be copied, such that the Copyright Holder maintains some semblance of
+artistic control over the development of the package, while giving the users of the
+package the right to use and distribute the Package in a more-or-less customary
+fashion, plus the right to make reasonable modifications.
+
+Definitions:
+
+-    "Package" refers to the collection of files distributed by the Copyright
+     Holder, and derivatives of that collection of files created through textual
+     modification. 
+-    "Standard Version" refers to such a Package if it has not been modified,
+     or has been modified in accordance with the wishes of the Copyright
+     Holder. 
+-    "Copyright Holder" is whoever is named in the copyright or copyrights for
+     the package. 
+-    "You" is you, if you're thinking about copying or distributing this Package.
+-    "Reasonable copying fee" is whatever you can justify on the basis of
+     media cost, duplication charges, time of people involved, and so on. (You
+     will not be required to justify it to the Copyright Holder, but only to the
+     computing community at large as a market that must bear the fee.) 
+-    "Freely Available" means that no fee is charged for the item itself, though
+     there may be fees involved in handling the item. It also means that
+     recipients of the item may redistribute it under the same conditions they
+     received it. 
+
+1. You may make and give away verbatim copies of the source form of the
+Standard Version of this Package without restriction, provided that you duplicate
+all of the original copyright notices and associated disclaimers.
+
+2. You may apply bug fixes, portability fixes and other modifications derived from
+the Public Domain or from the Copyright Holder. A Package modified in such a
+way shall still be considered the Standard Version.
+
+3. You may otherwise modify your copy of this Package in any way, provided
+that you insert a prominent notice in each changed file stating how and when
+you changed that file, and provided that you do at least ONE of the following:
+
+     a) place your modifications in the Public Domain or otherwise
+     make them Freely Available, such as by posting said modifications
+     to Usenet or an equivalent medium, or placing the modifications on
+     a major archive site such as ftp.uu.net, or by allowing the
+     Copyright Holder to include your modifications in the Standard
+     Version of the Package.
+
+     b) use the modified Package only within your corporation or
+     organization.
+
+     c) rename any non-standard executables so the names do not
+     conflict with standard executables, which must also be provided,
+     and provide a separate manual page for each non-standard
+     executable that clearly documents how it differs from the Standard
+     Version.
+
+     d) make other distribution arrangements with the Copyright Holder.
+
+4. You may distribute the programs of this Package in object code or executable
+form, provided that you do at least ONE of the following:
+
+     a) distribute a Standard Version of the executables and library
+     files, together with instructions (in the manual page or equivalent)
+     on where to get the Standard Version.
+
+     b) accompany the distribution with the machine-readable source of
+     the Package with your modifications.
+
+     c) accompany any non-standard executables with their
+     corresponding Standard Version executables, giving the
+     non-standard executables non-standard names, and clearly
+     documenting the differences in manual pages (or equivalent),
+     together with instructions on where to get the Standard Version.
+
+     d) make other distribution arrangements with the Copyright Holder.
+
+5. You may charge a reasonable copying fee for any distribution of this Package.
+You may charge any fee you choose for support of this Package. You may not
+charge a fee for this Package itself. However, you may distribute this Package in
+aggregate with other (possibly commercial) programs as part of a larger
+(possibly commercial) software distribution provided that you do not advertise
+this Package as a product of your own.
+
+6. The scripts and library files supplied as input to or produced as output from
+the programs of this Package do not automatically fall under the copyright of this
+Package, but belong to whomever generated them, and may be sold
+commercially, and may be aggregated with this Package.
+
+7. C or perl subroutines supplied by you and linked into this Package shall not
+be considered part of this Package.
+
+8. Aggregation of this Package with a commercial distribution is always permitted
+provided that the use of this Package is embedded; that is, when no overt attempt
+is made to make this Package's interfaces visible to the end user of the
+commercial distribution. Such use shall not be construed as a distribution of
+this Package.
+
+9. The name of the Copyright Holder may not be used to endorse or promote
+products derived from this software without specific prior written permission.
+
+10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.
+
+The End
+
+
diff --git a/MANIFEST b/MANIFEST
new file mode 100644 (file)
index 0000000..27cdc3c
--- /dev/null
+++ b/MANIFEST
@@ -0,0 +1,8 @@
+MANIFEST
+LICENSE
+README
+Todo
+Changes
+IsisDB.pm
+t/001_load.t
+Makefile.PL
diff --git a/Makefile.PL b/Makefile.PL
new file mode 100644 (file)
index 0000000..4c892e2
--- /dev/null
@@ -0,0 +1,12 @@
+use ExtUtils::MakeMaker;
+# See lib/ExtUtils/MakeMaker.pm for details of how to influence
+# the contents of the Makefile that is written.
+WriteMakefile(
+       NAME => 'IsisDB',
+       VERSION_FROM => 'IsisDB.pm', # finds $VERSION
+       AUTHOR => 'Dobrica Pavlinusic (dpavlin@rot13.org)',
+       ABSTRACT => 'Read CDS/ISIS database',
+       PREREQ_PM => {
+               'Test::Simple' => 0.44,
+       },
+);
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..ec00568
--- /dev/null
+++ b/README
@@ -0,0 +1,11 @@
+Perl-only implementation of CDS/ISIS reader.
+
+Install module with:
+
+perl Makefile.PL
+make
+make test
+make install
+
+
+If you are on a windows box you should use 'nmake' rather than 'make'.
diff --git a/t/001_load.t b/t/001_load.t
new file mode 100755 (executable)
index 0000000..51a937d
--- /dev/null
@@ -0,0 +1,16 @@
+#!/usr/bin/perl -w
+
+use strict;
+use blib;
+
+use Test::More tests => 2;
+
+BEGIN { use_ok( 'IsisDB' ); }
+
+my $object = IsisDB->new (
+       isisdb => '/data/isis_data/ps/LIBRI/LIBRI',
+
+);
+isa_ok ($object, 'IsisDB');
+
+