lib/DBM/Deep.pm

   1 package DBM::Deep;
   2
   3 ##
   4 # DBM::Deep
   5 #
   6 # Description:
   7 #       Multi-level database module for storing hash trees, arrays and simple
   8 #       key/value pairs into FTP-able, cross-platform binary database files.
   9 #
  10 #       Type `perldoc DBM::Deep` for complete documentation.
  11 #
  12 # Usage Examples:
  13 #       my %db;
  14 #       tie %db, 'DBM::Deep', 'my_database.db'; # standard tie() method
  15 #
  16 #       my $db = new DBM::Deep( 'my_database.db' ); # preferred OO method
  17 #
  18 #       $db->{my_scalar} = 'hello world';
  19 #       $db->{my_hash} = { larry => 'genius', hashes => 'fast' };
  20 #       $db->{my_array} = [ 1, 2, 3, time() ];
  21 #       $db->{my_complex} = [ 'hello', { perl => 'rules' }, 42, 99 ];
  22 #       push @{$db->{my_array}}, 'another value';
  23 #       my @key_list = keys %{$db->{my_hash}};
  24 #       print "This module " . $db->{my_complex}->[1]->{perl} . "!\n";
  25 #
  26 # Copyright:
  27 #       (c) 2002-2005 Joseph Huckaby.  All Rights Reserved.
  28 #       This program is free software; you can redistribute it and/or
  29 #       modify it under the same terms as Perl itself.
  30 ##
  31
  32 use strict;
  33
  34 use Fcntl qw( :DEFAULT :flock :seek );
  35 use Digest::MD5 ();
  36 use Scalar::Util ();
  37
  38 use vars qw( $VERSION );
  39 $VERSION = q(0.97);
  40
  41 ##
  42 # Set to 4 and 'N' for 32-bit offset tags (default).  Theoretical limit of 4 GB per file.
  43 #       (Perl must be compiled with largefile support for files > 2 GB)
  44 #
  45 # Set to 8 and 'Q' for 64-bit offsets.  Theoretical limit of 16 XB per file.
  46 #       (Perl must be compiled with largefile and 64-bit long support)
  47 ##
  48 #my $LONG_SIZE = 4;
  49 #my $LONG_PACK = 'N';
  50
  51 ##
  52 # Set to 4 and 'N' for 32-bit data length prefixes.  Limit of 4 GB for each key/value.
  53 # Upgrading this is possible (see above) but probably not necessary.  If you need
  54 # more than 4 GB for a single key or value, this module is really not for you :-)
  55 ##
  56 #my $DATA_LENGTH_SIZE = 4;
  57 #my $DATA_LENGTH_PACK = 'N';
  58 our ($LONG_SIZE, $LONG_PACK, $DATA_LENGTH_SIZE, $DATA_LENGTH_PACK);
  59
  60 ##
  61 # Maximum number of buckets per list before another level of indexing is done.
  62 # Increase this value for slightly greater speed, but larger database files.
  63 # DO NOT decrease this value below 16, due to risk of recursive reindex overrun.
  64 ##
  65 my $MAX_BUCKETS = 16;
  66
  67 ##
  68 # Better not adjust anything below here, unless you're me :-)
  69 ##
  70
  71 ##
  72 # Setup digest function for keys
  73 ##
  74 our ($DIGEST_FUNC, $HASH_SIZE);
  75 #my $DIGEST_FUNC = \&Digest::MD5::md5;
  76
  77 ##
  78 # Precalculate index and bucket sizes based on values above.
  79 ##
  80 #my $HASH_SIZE = 16;
  81 my ($INDEX_SIZE, $BUCKET_SIZE, $BUCKET_LIST_SIZE);
  82
  83 set_digest();
  84 #set_pack();
  85 #precalc_sizes();
  86
  87 ##
  88 # Setup file and tag signatures.  These should never change.
  89 ##
  90 sub SIG_FILE   () { 'DPDB' }
  91 sub SIG_HASH   () { 'H' }
  92 sub SIG_ARRAY  () { 'A' }
  93 sub SIG_SCALAR () { 'S' }
  94 sub SIG_NULL   () { 'N' }
  95 sub SIG_DATA   () { 'D' }
  96 sub SIG_INDEX  () { 'I' }
  97 sub SIG_BLIST  () { 'B' }
  98 sub SIG_SIZE   () {  1  }
  99
 100 ##
 101 # Setup constants for users to pass to new()
 102 ##
 103 sub TYPE_HASH   () { return SIG_HASH; }
 104 sub TYPE_ARRAY  () { return SIG_ARRAY; }
 105 sub TYPE_SCALAR () { return SIG_SCALAR; }
 106
 107 sub _get_args {
 108     my $proto = shift;
 109
 110     my $args;
 111     if (scalar(@_) > 1) {
 112         if ( @_ % 2 ) {
 113             $proto->_throw_error( "Odd number of parameters to " . (caller(1))[2] );
 114         }
 115         $args = {@_};
 116     }
 117         elsif ( my $type = Scalar::Util::reftype($_[0]) ) {
 118         if ( $type ne 'HASH' ) {
 119             $proto->_throw_error( "Not a hashref in args to " . (caller(1))[2] );
 120         }
 121         $args = $_[0];
 122     }
 123         else {
 124         $args = { file => shift };
 125     }
 126
 127     return $args;
 128 }
 129
 130 sub new {
 131         ##
 132         # Class constructor method for Perl OO interface.
 133         # Calls tie() and returns blessed reference to tied hash or array,
 134         # providing a hybrid OO/tie interface.
 135         ##
 136         my $class = shift;
 137         my $args = $class->_get_args( @_ );
 138
 139         ##
 140         # Check if we want a tied hash or array.
 141         ##
 142         my $self;
 143         if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
 144         $class = 'DBM::Deep::Array';
 145         require DBM::Deep::Array;
 146                 tie @$self, $class, %$args;
 147         }
 148         else {
 149         $class = 'DBM::Deep::Hash';
 150         require DBM::Deep::Hash;
 151                 tie %$self, $class, %$args;
 152         }
 153
 154         return bless $self, $class;
 155 }
 156
 157 sub _init {
 158     ##
 159     # Setup $self and bless into this class.
 160     ##
 161     my $class = shift;
 162     my $args = shift;
 163
 164     # These are the defaults to be optionally overridden below
 165     my $self = bless {
 166         type => TYPE_HASH,
 167         base_offset => length(SIG_FILE),
 168     }, $class;
 169
 170     foreach my $param ( keys %$self ) {
 171         next unless exists $args->{$param};
 172         $self->{$param} = delete $args->{$param}
 173     }
 174
 175     $self->{root} = exists $args->{root}
 176         ? $args->{root}
 177         : DBM::Deep::_::Root->new( $args );
 178
 179     if (!defined($self->fh)) { $self->_open(); }
 180
 181     return $self;
 182 }
 183
 184 sub TIEHASH {
 185     shift;
 186     require DBM::Deep::Hash;
 187     return DBM::Deep::Hash->TIEHASH( @_ );
 188 }
 189
 190 sub TIEARRAY {
 191     shift;
 192     require DBM::Deep::Array;
 193     return DBM::Deep::Array->TIEARRAY( @_ );
 194 }
 195
 196 #XXX Unneeded now ...
 197 #sub DESTROY {
 198 #}
 199
 200 sub _open {
 201         ##
 202         # Open a FileHandle to the database, create if nonexistent.
 203         # Make sure file signature matches DeepDB spec.
 204         ##
 205     my $self = $_[0]->_get_self;
 206
 207         if (defined($self->fh)) { $self->_close(); }
 208
 209     eval {
 210         # Theoretically, adding O_BINARY should remove the need for the binmode
 211         # Of course, testing it is going to be ... interesting.
 212         my $flags = O_RDWR | O_CREAT | O_BINARY;
 213
 214         #XXX Can the mode be anything but r+, w+, or a+??
 215         #XXX ie, it has to be in read-write mode
 216         #XXX So, should we verify that the mode is legitimate?
 217
 218         #XXX Maybe the mode thingy should just go away. There's no good
 219         #XXX reason for it ...
 220         if ( $self->root->{mode} eq 'w+' ) {
 221             $flags |= O_TRUNC;
 222         }
 223
 224         my $fh;
 225         sysopen( $fh, $self->root->{file}, $flags )
 226             or $fh = undef;
 227         $self->root->{fh} = $fh;
 228     }; if ($@ ) { $self->_throw_error( "Received error: $@\n" ); }
 229         if (! defined($self->fh)) {
 230                 return $self->_throw_error("Cannot sysopen file: " . $self->root->{file} . ": $!");
 231         }
 232
 233     my $fh = $self->fh;
 234
 235     #XXX Can we remove this by using the right sysopen() flags?
 236     # Maybe ... q.v. above
 237     binmode $fh; # for win32
 238
 239     if ($self->root->{autoflush}) {
 240         my $old = select $fh;
 241         $|=1;
 242         select $old;
 243     }
 244
 245     # Set the
 246     seek($fh, 0, SEEK_SET);
 247
 248     my $signature;
 249     my $bytes_read = read( $fh, $signature, length(SIG_FILE));
 250
 251     ##
 252     # File is empty -- write signature and master index
 253     ##
 254     if (!$bytes_read) {
 255         seek($fh, 0, SEEK_SET);
 256         print($fh SIG_FILE);
 257         $self->root->{end} = length(SIG_FILE);
 258         $self->_create_tag($self->base_offset, $self->type, chr(0) x $INDEX_SIZE);
 259
 260         my $plain_key = "[base]";
 261         print($fh pack($DATA_LENGTH_PACK, length($plain_key)) . $plain_key );
 262         $self->root->{end} += $DATA_LENGTH_SIZE + length($plain_key);
 263
 264         # Flush the filehandle
 265         my $old_fh = select $fh;
 266         my $old_af = $|;
 267         $| = 1;
 268         $| = $old_af;
 269         select $old_fh;
 270
 271         return 1;
 272     }
 273
 274     ##
 275     # Check signature was valid
 276     ##
 277     unless ($signature eq SIG_FILE) {
 278         $self->_close();
 279         return $self->_throw_error("Signature not found -- file is not a Deep DB");
 280     }
 281
 282     $self->root->{end} = (stat($fh))[7];
 283
 284     ##
 285     # Get our type from master index signature
 286     ##
 287     my $tag = $self->_load_tag($self->base_offset);
 288
 289 #XXX We probably also want to store the hash algorithm name and not assume anything
 290 #XXX The cool thing would be to allow a different hashing algorithm at every level
 291
 292     if (!$tag) {
 293         return $self->_throw_error("Corrupted file, no master index record");
 294     }
 295     if ($self->{type} ne $tag->{signature}) {
 296         return $self->_throw_error("File type mismatch");
 297     }
 298
 299     return 1;
 300 }
 301
 302 sub _close {
 303         ##
 304         # Close database FileHandle
 305         ##
 306     my $self = $_[0]->_get_self;
 307     close $self->root->{fh};
 308     $self->root->{fh} = undef;
 309 }
 310
 311 sub _create_tag {
 312         ##
 313         # Given offset, signature and content, create tag and write to disk
 314         ##
 315         my ($self, $offset, $sig, $content) = @_;
 316         my $size = length($content);
 317
 318     my $fh = $self->fh;
 319
 320         seek($fh, $offset, SEEK_SET);
 321         print($fh $sig . pack($DATA_LENGTH_PACK, $size) . $content );
 322
 323         if ($offset == $self->root->{end}) {
 324                 $self->root->{end} += SIG_SIZE + $DATA_LENGTH_SIZE + $size;
 325         }
 326
 327         return {
 328                 signature => $sig,
 329                 size => $size,
 330                 offset => $offset + SIG_SIZE + $DATA_LENGTH_SIZE,
 331                 content => $content
 332         };
 333 }
 334
 335 sub _load_tag {
 336         ##
 337         # Given offset, load single tag and return signature, size and data
 338         ##
 339         my $self = shift;
 340         my $offset = shift;
 341
 342     my $fh = $self->fh;
 343
 344         seek($fh, $offset, SEEK_SET);
 345         if (eof $fh) { return undef; }
 346
 347         my $sig;
 348         read( $fh, $sig, SIG_SIZE);
 349
 350         my $size;
 351         read( $fh, $size, $DATA_LENGTH_SIZE);
 352         $size = unpack($DATA_LENGTH_PACK, $size);
 353
 354         my $buffer;
 355         read( $fh, $buffer, $size);
 356
 357         return {
 358                 signature => $sig,
 359                 size => $size,
 360                 offset => $offset + SIG_SIZE + $DATA_LENGTH_SIZE,
 361                 content => $buffer
 362         };
 363 }
 364
 365 sub _index_lookup {
 366         ##
 367         # Given index tag, lookup single entry in index and return .
 368         ##
 369         my $self = shift;
 370         my ($tag, $index) = @_;
 371
 372         my $location = unpack($LONG_PACK, substr($tag->{content}, $index * $LONG_SIZE, $LONG_SIZE) );
 373         if (!$location) { return; }
 374
 375         return $self->_load_tag( $location );
 376 }
 377
 378 sub _add_bucket {
 379         ##
 380         # Adds one key/value pair to bucket list, given offset, MD5 digest of key,
 381         # plain (undigested) key and value.
 382         ##
 383         my $self = shift;
 384         my ($tag, $md5, $plain_key, $value) = @_;
 385         my $keys = $tag->{content};
 386         my $location = 0;
 387         my $result = 2;
 388
 389     my $is_dbm_deep = eval { $value->isa( 'DBM::Deep' ) };
 390         my $internal_ref = $is_dbm_deep && ($value->root eq $self->root);
 391
 392     my $fh = $self->fh;
 393
 394         ##
 395         # Iterate through buckets, seeing if this is a new entry or a replace.
 396         ##
 397         for (my $i=0; $i<$MAX_BUCKETS; $i++) {
 398                 my $key = substr($keys, $i * $BUCKET_SIZE, $HASH_SIZE);
 399                 my $subloc = unpack($LONG_PACK, substr($keys, ($i * $BUCKET_SIZE) + $HASH_SIZE, $LONG_SIZE));
 400                 if (!$subloc) {
 401                         ##
 402                         # Found empty bucket (end of list).  Populate and exit loop.
 403                         ##
 404                         $result = 2;
 405
 406             $location = $internal_ref
 407                 ? $value->base_offset
 408                 : $self->root->{end};
 409
 410                         seek($fh, $tag->{offset} + ($i * $BUCKET_SIZE), SEEK_SET);
 411                         print($fh $md5 . pack($LONG_PACK, $location) );
 412                         last;
 413                 }
 414                 elsif ($md5 eq $key) {
 415                         ##
 416                         # Found existing bucket with same key.  Replace with new value.
 417                         ##
 418                         $result = 1;
 419
 420                         if ($internal_ref) {
 421                                 $location = $value->base_offset;
 422                                 seek($fh, $tag->{offset} + ($i * $BUCKET_SIZE), SEEK_SET);
 423                                 print($fh $md5 . pack($LONG_PACK, $location) );
 424                         }
 425                         else {
 426                                 seek($fh, $subloc + SIG_SIZE, SEEK_SET);
 427                                 my $size;
 428                                 read( $fh, $size, $DATA_LENGTH_SIZE); $size = unpack($DATA_LENGTH_PACK, $size);
 429
 430                                 ##
 431                                 # If value is a hash, array, or raw value with equal or less size, we can
 432                                 # reuse the same content area of the database.  Otherwise, we have to create
 433                                 # a new content area at the EOF.
 434                                 ##
 435                                 my $actual_length;
 436                 my $r = Scalar::Util::reftype( $value ) || '';
 437                 if ( $r eq 'HASH' || $r eq 'ARRAY' ) { $actual_length = $INDEX_SIZE; }
 438                                 else { $actual_length = length($value); }
 439
 440                                 if ($actual_length <= $size) {
 441                                         $location = $subloc;
 442                                 }
 443                                 else {
 444                                         $location = $self->root->{end};
 445                                         seek($fh, $tag->{offset} + ($i * $BUCKET_SIZE) + $HASH_SIZE, SEEK_SET);
 446                                         print($fh pack($LONG_PACK, $location) );
 447                                 }
 448                         }
 449                         last;
 450                 }
 451         } # i loop
 452
 453         ##
 454         # If this is an internal reference, return now.
 455         # No need to write value or plain key
 456         ##
 457         if ($internal_ref) {
 458         return $result;
 459     }
 460
 461         ##
 462         # If bucket didn't fit into list, split into a new index level
 463         ##
 464         if (!$location) {
 465                 seek($fh, $tag->{ref_loc}, SEEK_SET);
 466                 print($fh pack($LONG_PACK, $self->root->{end}) );
 467
 468                 my $index_tag = $self->_create_tag($self->root->{end}, SIG_INDEX, chr(0) x $INDEX_SIZE);
 469                 my @offsets = ();
 470
 471                 $keys .= $md5 . pack($LONG_PACK, 0);
 472
 473                 for (my $i=0; $i<=$MAX_BUCKETS; $i++) {
 474                         my $key = substr($keys, $i * $BUCKET_SIZE, $HASH_SIZE);
 475                         if ($key) {
 476                                 my $old_subloc = unpack($LONG_PACK, substr($keys, ($i * $BUCKET_SIZE) + $HASH_SIZE, $LONG_SIZE));
 477                                 my $num = ord(substr($key, $tag->{ch} + 1, 1));
 478
 479                                 if ($offsets[$num]) {
 480                                         my $offset = $offsets[$num] + SIG_SIZE + $DATA_LENGTH_SIZE;
 481                                         seek($fh, $offset, SEEK_SET);
 482                                         my $subkeys;
 483                                         read( $fh, $subkeys, $BUCKET_LIST_SIZE);
 484
 485                                         for (my $k=0; $k<$MAX_BUCKETS; $k++) {
 486                                                 my $subloc = unpack($LONG_PACK, substr($subkeys, ($k * $BUCKET_SIZE) + $HASH_SIZE, $LONG_SIZE));
 487                                                 if (!$subloc) {
 488                                                         seek($fh, $offset + ($k * $BUCKET_SIZE), SEEK_SET);
 489                                                         print($fh $key . pack($LONG_PACK, $old_subloc || $self->root->{end}) );
 490                                                         last;
 491                                                 }
 492                                         } # k loop
 493                                 }
 494                                 else {
 495                                         $offsets[$num] = $self->root->{end};
 496                                         seek($fh, $index_tag->{offset} + ($num * $LONG_SIZE), SEEK_SET);
 497                                         print($fh pack($LONG_PACK, $self->root->{end}) );
 498
 499                                         my $blist_tag = $self->_create_tag($self->root->{end}, SIG_BLIST, chr(0) x $BUCKET_LIST_SIZE);
 500
 501                                         seek($fh, $blist_tag->{offset}, SEEK_SET);
 502                                         print($fh $key . pack($LONG_PACK, $old_subloc || $self->root->{end}) );
 503                                 }
 504                         } # key is real
 505                 } # i loop
 506
 507                 $location ||= $self->root->{end};
 508         } # re-index bucket list
 509
 510         ##
 511         # Seek to content area and store signature, value and plaintext key
 512         ##
 513         if ($location) {
 514                 my $content_length;
 515                 seek($fh, $location, SEEK_SET);
 516
 517                 ##
 518                 # Write signature based on content type, set content length and write actual value.
 519                 ##
 520         my $r = Scalar::Util::reftype($value) || '';
 521                 if ($r eq 'HASH') {
 522                         print($fh TYPE_HASH );
 523                         print($fh pack($DATA_LENGTH_PACK, $INDEX_SIZE) . chr(0) x $INDEX_SIZE );
 524                         $content_length = $INDEX_SIZE;
 525                 }
 526                 elsif ($r eq 'ARRAY') {
 527                         print($fh TYPE_ARRAY );
 528                         print($fh pack($DATA_LENGTH_PACK, $INDEX_SIZE) . chr(0) x $INDEX_SIZE );
 529                         $content_length = $INDEX_SIZE;
 530                 }
 531                 elsif (!defined($value)) {
 532                         print($fh SIG_NULL );
 533                         print($fh pack($DATA_LENGTH_PACK, 0) );
 534                         $content_length = 0;
 535                 }
 536                 else {
 537                         print($fh SIG_DATA );
 538                         print($fh pack($DATA_LENGTH_PACK, length($value)) . $value );
 539                         $content_length = length($value);
 540                 }
 541
 542                 ##
 543                 # Plain key is stored AFTER value, as keys are typically fetched less often.
 544                 ##
 545                 print($fh pack($DATA_LENGTH_PACK, length($plain_key)) . $plain_key );
 546
 547                 ##
 548                 # If value is blessed, preserve class name
 549                 ##
 550                 if ( $self->root->{autobless} ) {
 551             my $value_class = Scalar::Util::blessed($value);
 552             if ( defined $value_class && $value_class ne 'DBM::Deep' ) {
 553                 ##
 554                 # Blessed ref -- will restore later
 555                 ##
 556                 print($fh chr(1) );
 557                 print($fh pack($DATA_LENGTH_PACK, length($value_class)) . $value_class );
 558                 $content_length += 1;
 559                 $content_length += $DATA_LENGTH_SIZE + length($value_class);
 560             }
 561             else {
 562                 print($fh chr(0) );
 563                 $content_length += 1;
 564             }
 565         }
 566
 567                 ##
 568                 # If this is a new content area, advance EOF counter
 569                 ##
 570                 if ($location == $self->root->{end}) {
 571                         $self->root->{end} += SIG_SIZE;
 572                         $self->root->{end} += $DATA_LENGTH_SIZE + $content_length;
 573                         $self->root->{end} += $DATA_LENGTH_SIZE + length($plain_key);
 574                 }
 575
 576                 ##
 577                 # If content is a hash or array, create new child DeepDB object and
 578                 # pass each key or element to it.
 579                 ##
 580                 if ($r eq 'HASH') {
 581                         my $branch = DBM::Deep->new(
 582                                 type => TYPE_HASH,
 583                                 base_offset => $location,
 584                                 root => $self->root,
 585                         );
 586                         foreach my $key (keys %{$value}) {
 587                 #$branch->{$key} = $value->{$key};
 588                 $branch->STORE( $key, $value->{$key} );
 589                         }
 590                 }
 591                 elsif ($r eq 'ARRAY') {
 592                         my $branch = DBM::Deep->new(
 593                                 type => TYPE_ARRAY,
 594                                 base_offset => $location,
 595                                 root => $self->root,
 596                         );
 597                         my $index = 0;
 598                         foreach my $element (@{$value}) {
 599                 #$branch->[$index] = $element;
 600                 $branch->STORE( $index, $element );
 601                                 $index++;
 602                         }
 603                 }
 604
 605                 return $result;
 606         }
 607
 608         return $self->_throw_error("Fatal error: indexing failed -- possibly due to corruption in file");
 609 }
 610
 611 sub _get_bucket_value {
 612         ##
 613         # Fetch single value given tag and MD5 digested key.
 614         ##
 615         my $self = shift;
 616         my ($tag, $md5) = @_;
 617         my $keys = $tag->{content};
 618
 619     my $fh = $self->fh;
 620
 621         ##
 622         # Iterate through buckets, looking for a key match
 623         ##
 624     BUCKET:
 625         for (my $i=0; $i<$MAX_BUCKETS; $i++) {
 626                 my $key = substr($keys, $i * $BUCKET_SIZE, $HASH_SIZE);
 627                 my $subloc = unpack($LONG_PACK, substr($keys, ($i * $BUCKET_SIZE) + $HASH_SIZE, $LONG_SIZE));
 628
 629                 if (!$subloc) {
 630                         ##
 631                         # Hit end of list, no match
 632                         ##
 633                         return;
 634                 }
 635
 636         if ( $md5 ne $key ) {
 637             next BUCKET;
 638         }
 639
 640         ##
 641         # Found match -- seek to offset and read signature
 642         ##
 643         my $signature;
 644         seek($fh, $subloc, SEEK_SET);
 645         read( $fh, $signature, SIG_SIZE);
 646
 647         ##
 648         # If value is a hash or array, return new DeepDB object with correct offset
 649         ##
 650         if (($signature eq TYPE_HASH) || ($signature eq TYPE_ARRAY)) {
 651             my $obj = DBM::Deep->new(
 652                 type => $signature,
 653                 base_offset => $subloc,
 654                 root => $self->root
 655             );
 656
 657             if ($self->root->{autobless}) {
 658                 ##
 659                 # Skip over value and plain key to see if object needs
 660                 # to be re-blessed
 661                 ##
 662                 seek($fh, $DATA_LENGTH_SIZE + $INDEX_SIZE, SEEK_CUR);
 663
 664                 my $size;
 665                 read( $fh, $size, $DATA_LENGTH_SIZE); $size = unpack($DATA_LENGTH_PACK, $size);
 666                 if ($size) { seek($fh, $size, SEEK_CUR); }
 667
 668                 my $bless_bit;
 669                 read( $fh, $bless_bit, 1);
 670                 if (ord($bless_bit)) {
 671                     ##
 672                     # Yes, object needs to be re-blessed
 673                     ##
 674                     my $class_name;
 675                     read( $fh, $size, $DATA_LENGTH_SIZE); $size = unpack($DATA_LENGTH_PACK, $size);
 676                     if ($size) { read( $fh, $class_name, $size); }
 677                     if ($class_name) { $obj = bless( $obj, $class_name ); }
 678                 }
 679             }
 680
 681             return $obj;
 682         }
 683
 684         ##
 685         # Otherwise return actual value
 686         ##
 687         elsif ($signature eq SIG_DATA) {
 688             my $size;
 689             my $value = '';
 690             read( $fh, $size, $DATA_LENGTH_SIZE); $size = unpack($DATA_LENGTH_PACK, $size);
 691             if ($size) { read( $fh, $value, $size); }
 692             return $value;
 693         }
 694
 695         ##
 696         # Key exists, but content is null
 697         ##
 698         else { return; }
 699         } # i loop
 700
 701         return;
 702 }
 703
 704 sub _delete_bucket {
 705         ##
 706         # Delete single key/value pair given tag and MD5 digested key.
 707         ##
 708         my $self = shift;
 709         my ($tag, $md5) = @_;
 710         my $keys = $tag->{content};
 711
 712     my $fh = $self->fh;
 713
 714         ##
 715         # Iterate through buckets, looking for a key match
 716         ##
 717     BUCKET:
 718         for (my $i=0; $i<$MAX_BUCKETS; $i++) {
 719                 my $key = substr($keys, $i * $BUCKET_SIZE, $HASH_SIZE);
 720                 my $subloc = unpack($LONG_PACK, substr($keys, ($i * $BUCKET_SIZE) + $HASH_SIZE, $LONG_SIZE));
 721
 722                 if (!$subloc) {
 723                         ##
 724                         # Hit end of list, no match
 725                         ##
 726                         return;
 727                 }
 728
 729         if ( $md5 ne $key ) {
 730             next BUCKET;
 731         }
 732
 733         ##
 734         # Matched key -- delete bucket and return
 735         ##
 736         seek($fh, $tag->{offset} + ($i * $BUCKET_SIZE), SEEK_SET);
 737         print($fh substr($keys, ($i+1) * $BUCKET_SIZE ) );
 738         print($fh chr(0) x $BUCKET_SIZE );
 739
 740         return 1;
 741         } # i loop
 742
 743         return;
 744 }
 745
 746 sub _bucket_exists {
 747         ##
 748         # Check existence of single key given tag and MD5 digested key.
 749         ##
 750         my $self = shift;
 751         my ($tag, $md5) = @_;
 752         my $keys = $tag->{content};
 753
 754         ##
 755         # Iterate through buckets, looking for a key match
 756         ##
 757     BUCKET:
 758         for (my $i=0; $i<$MAX_BUCKETS; $i++) {
 759                 my $key = substr($keys, $i * $BUCKET_SIZE, $HASH_SIZE);
 760                 my $subloc = unpack($LONG_PACK, substr($keys, ($i * $BUCKET_SIZE) + $HASH_SIZE, $LONG_SIZE));
 761
 762                 if (!$subloc) {
 763                         ##
 764                         # Hit end of list, no match
 765                         ##
 766                         return;
 767                 }
 768
 769         if ( $md5 ne $key ) {
 770             next BUCKET;
 771         }
 772
 773         ##
 774         # Matched key -- return true
 775         ##
 776         return 1;
 777         } # i loop
 778
 779         return;
 780 }
 781
 782 sub _find_bucket_list {
 783         ##
 784         # Locate offset for bucket list, given digested key
 785         ##
 786         my $self = shift;
 787         my $md5 = shift;
 788
 789         ##
 790         # Locate offset for bucket list using digest index system
 791         ##
 792         my $ch = 0;
 793         my $tag = $self->_load_tag($self->base_offset);
 794         if (!$tag) { return; }
 795
 796         while ($tag->{signature} ne SIG_BLIST) {
 797                 $tag = $self->_index_lookup($tag, ord(substr($md5, $ch, 1)));
 798                 if (!$tag) { return; }
 799                 $ch++;
 800         }
 801
 802         return $tag;
 803 }
 804
 805 sub _traverse_index {
 806         ##
 807         # Scan index and recursively step into deeper levels, looking for next key.
 808         ##
 809     my ($self, $offset, $ch, $force_return_next) = @_;
 810     $force_return_next = undef unless $force_return_next;
 811
 812         my $tag = $self->_load_tag( $offset );
 813
 814     my $fh = $self->fh;
 815
 816         if ($tag->{signature} ne SIG_BLIST) {
 817                 my $content = $tag->{content};
 818                 my $start;
 819                 if ($self->{return_next}) { $start = 0; }
 820                 else { $start = ord(substr($self->{prev_md5}, $ch, 1)); }
 821
 822                 for (my $index = $start; $index < 256; $index++) {
 823                         my $subloc = unpack($LONG_PACK, substr($content, $index * $LONG_SIZE, $LONG_SIZE) );
 824                         if ($subloc) {
 825                                 my $result = $self->_traverse_index( $subloc, $ch + 1, $force_return_next );
 826                                 if (defined($result)) { return $result; }
 827                         }
 828                 } # index loop
 829
 830                 $self->{return_next} = 1;
 831         } # tag is an index
 832
 833         elsif ($tag->{signature} eq SIG_BLIST) {
 834                 my $keys = $tag->{content};
 835                 if ($force_return_next) { $self->{return_next} = 1; }
 836
 837                 ##
 838                 # Iterate through buckets, looking for a key match
 839                 ##
 840                 for (my $i=0; $i<$MAX_BUCKETS; $i++) {
 841                         my $key = substr($keys, $i * $BUCKET_SIZE, $HASH_SIZE);
 842                         my $subloc = unpack($LONG_PACK, substr($keys, ($i * $BUCKET_SIZE) + $HASH_SIZE, $LONG_SIZE));
 843
 844                         if (!$subloc) {
 845                                 ##
 846                                 # End of bucket list -- return to outer loop
 847                                 ##
 848                                 $self->{return_next} = 1;
 849                                 last;
 850                         }
 851                         elsif ($key eq $self->{prev_md5}) {
 852                                 ##
 853                                 # Located previous key -- return next one found
 854                                 ##
 855                                 $self->{return_next} = 1;
 856                                 next;
 857                         }
 858                         elsif ($self->{return_next}) {
 859                                 ##
 860                                 # Seek to bucket location and skip over signature
 861                                 ##
 862                                 seek($fh, $subloc + SIG_SIZE, SEEK_SET);
 863
 864                                 ##
 865                                 # Skip over value to get to plain key
 866                                 ##
 867                                 my $size;
 868                                 read( $fh, $size, $DATA_LENGTH_SIZE); $size = unpack($DATA_LENGTH_PACK, $size);
 869                                 if ($size) { seek($fh, $size, SEEK_CUR); }
 870
 871                                 ##
 872                                 # Read in plain key and return as scalar
 873                                 ##
 874                                 my $plain_key;
 875                                 read( $fh, $size, $DATA_LENGTH_SIZE); $size = unpack($DATA_LENGTH_PACK, $size);
 876                                 if ($size) { read( $fh, $plain_key, $size); }
 877
 878                                 return $plain_key;
 879                         }
 880                 } # bucket loop
 881
 882                 $self->{return_next} = 1;
 883         } # tag is a bucket list
 884
 885         return;
 886 }
 887
 888 sub _get_next_key {
 889         ##
 890         # Locate next key, given digested previous one
 891         ##
 892     my $self = $_[0]->_get_self;
 893
 894         $self->{prev_md5} = $_[1] ? $_[1] : undef;
 895         $self->{return_next} = 0;
 896
 897         ##
 898         # If the previous key was not specifed, start at the top and
 899         # return the first one found.
 900         ##
 901         if (!$self->{prev_md5}) {
 902                 $self->{prev_md5} = chr(0) x $HASH_SIZE;
 903                 $self->{return_next} = 1;
 904         }
 905
 906         return $self->_traverse_index( $self->base_offset, 0 );
 907 }
 908
 909 sub lock {
 910         ##
 911         # If db locking is set, flock() the db file.  If called multiple
 912         # times before unlock(), then the same number of unlocks() must
 913         # be called before the lock is released.
 914         ##
 915     my $self = $_[0]->_get_self;
 916         my $type = $_[1];
 917     $type = LOCK_EX unless defined $type;
 918
 919         if (!defined($self->fh)) { return; }
 920
 921         if ($self->root->{locking}) {
 922                 if (!$self->root->{locked}) { flock($self->fh, $type); }
 923                 $self->root->{locked}++;
 924
 925         return 1;
 926         }
 927
 928     return;
 929 }
 930
 931 sub unlock {
 932         ##
 933         # If db locking is set, unlock the db file.  See note in lock()
 934         # regarding calling lock() multiple times.
 935         ##
 936     my $self = $_[0]->_get_self;
 937
 938         if (!defined($self->fh)) { return; }
 939
 940         if ($self->root->{locking} && $self->root->{locked} > 0) {
 941                 $self->root->{locked}--;
 942                 if (!$self->root->{locked}) { flock($self->fh, LOCK_UN); }
 943
 944         return 1;
 945         }
 946
 947     return;
 948 }
 949
 950 #XXX These uses of ref() need verified
 951 sub _copy_node {
 952         ##
 953         # Copy single level of keys or elements to new DB handle.
 954         # Recurse for nested structures
 955         ##
 956     my $self = $_[0]->_get_self;
 957         my $db_temp = $_[1];
 958
 959         if ($self->type eq TYPE_HASH) {
 960                 my $key = $self->first_key();
 961                 while ($key) {
 962                         my $value = $self->get($key);
 963 #XXX This doesn't work with autobless
 964                         if (!ref($value)) { $db_temp->{$key} = $value; }
 965                         else {
 966                                 my $type = $value->type;
 967                                 if ($type eq TYPE_HASH) { $db_temp->{$key} = {}; }
 968                                 else { $db_temp->{$key} = []; }
 969                                 $value->_copy_node( $db_temp->{$key} );
 970                         }
 971                         $key = $self->next_key($key);
 972                 }
 973         }
 974         else {
 975                 my $length = $self->length();
 976                 for (my $index = 0; $index < $length; $index++) {
 977                         my $value = $self->get($index);
 978                         if (!ref($value)) { $db_temp->[$index] = $value; }
 979             #XXX NO tests for this code
 980                         else {
 981                                 my $type = $value->type;
 982                                 if ($type eq TYPE_HASH) { $db_temp->[$index] = {}; }
 983                                 else { $db_temp->[$index] = []; }
 984                                 $value->_copy_node( $db_temp->[$index] );
 985                         }
 986                 }
 987         }
 988 }
 989
 990 sub export {
 991         ##
 992         # Recursively export into standard Perl hashes and arrays.
 993         ##
 994     my $self = $_[0]->_get_self;
 995
 996         my $temp;
 997         if ($self->type eq TYPE_HASH) { $temp = {}; }
 998         elsif ($self->type eq TYPE_ARRAY) { $temp = []; }
 999
1000         $self->lock();
1001         $self->_copy_node( $temp );
1002         $self->unlock();
1003
1004         return $temp;
1005 }
1006
1007 sub import {
1008         ##
1009         # Recursively import Perl hash/array structure
1010         ##
1011     #XXX This use of ref() seems to be ok
1012         if (!ref($_[0])) { return; } # Perl calls import() on use -- ignore
1013
1014     my $self = $_[0]->_get_self;
1015         my $struct = $_[1];
1016
1017     #XXX This use of ref() seems to be ok
1018         if (!ref($struct)) {
1019                 ##
1020                 # struct is not a reference, so just import based on our type
1021                 ##
1022                 shift @_;
1023
1024                 if ($self->type eq TYPE_HASH) { $struct = {@_}; }
1025                 elsif ($self->type eq TYPE_ARRAY) { $struct = [@_]; }
1026         }
1027
1028     my $r = Scalar::Util::reftype($struct) || '';
1029         if ($r eq "HASH" && $self->type eq TYPE_HASH) {
1030                 foreach my $key (keys %$struct) { $self->put($key, $struct->{$key}); }
1031         }
1032         elsif ($r eq "ARRAY" && $self->type eq TYPE_ARRAY) {
1033                 $self->push( @$struct );
1034         }
1035         else {
1036                 return $self->_throw_error("Cannot import: type mismatch");
1037         }
1038
1039         return 1;
1040 }
1041
1042 sub optimize {
1043         ##
1044         # Rebuild entire database into new file, then move
1045         # it back on top of original.
1046         ##
1047     my $self = $_[0]->_get_self;
1048
1049 #XXX Need to create a new test for this
1050 #       if ($self->root->{links} > 1) {
1051 #               return $self->_throw_error("Cannot optimize: reference count is greater than 1");
1052 #       }
1053
1054         my $db_temp = DBM::Deep->new(
1055                 file => $self->root->{file} . '.tmp',
1056                 type => $self->type
1057         );
1058         if (!$db_temp) {
1059                 return $self->_throw_error("Cannot optimize: failed to open temp file: $!");
1060         }
1061
1062         $self->lock();
1063         $self->_copy_node( $db_temp );
1064         undef $db_temp;
1065
1066         ##
1067         # Attempt to copy user, group and permissions over to new file
1068         ##
1069         my @stats = stat($self->fh);
1070         my $perms = $stats[2] & 07777;
1071         my $uid = $stats[4];
1072         my $gid = $stats[5];
1073         chown( $uid, $gid, $self->root->{file} . '.tmp' );
1074         chmod( $perms, $self->root->{file} . '.tmp' );
1075
1076     # q.v. perlport for more information on this variable
1077     if ( $^O eq 'MSWin32' ) {
1078                 ##
1079                 # Potential race condition when optmizing on Win32 with locking.
1080                 # The Windows filesystem requires that the filehandle be closed
1081                 # before it is overwritten with rename().  This could be redone
1082                 # with a soft copy.
1083                 ##
1084                 $self->unlock();
1085                 $self->_close();
1086         }
1087
1088         if (!rename $self->root->{file} . '.tmp', $self->root->{file}) {
1089                 unlink $self->root->{file} . '.tmp';
1090                 $self->unlock();
1091                 return $self->_throw_error("Optimize failed: Cannot copy temp file over original: $!");
1092         }
1093
1094         $self->unlock();
1095         $self->_close();
1096         $self->_open();
1097
1098         return 1;
1099 }
1100
1101 sub clone {
1102         ##
1103         # Make copy of object and return
1104         ##
1105     my $self = $_[0]->_get_self;
1106
1107         return DBM::Deep->new(
1108                 type => $self->type,
1109                 base_offset => $self->base_offset,
1110                 root => $self->root
1111         );
1112 }
1113
1114 {
1115     my %is_legal_filter = map {
1116         $_ => ~~1,
1117     } qw(
1118         store_key store_value
1119         fetch_key fetch_value
1120     );
1121
1122     sub set_filter {
1123         ##
1124         # Setup filter function for storing or fetching the key or value
1125         ##
1126         my $self = $_[0]->_get_self;
1127         my $type = lc $_[1];
1128         my $func = $_[2] ? $_[2] : undef;
1129
1130         if ( $is_legal_filter{$type} ) {
1131             $self->root->{"filter_$type"} = $func;
1132             return 1;
1133         }
1134
1135         return;
1136     }
1137 }
1138
1139 ##
1140 # Accessor methods
1141 ##
1142
1143 sub root {
1144         ##
1145         # Get access to the root structure
1146         ##
1147     my $self = $_[0]->_get_self;
1148         return $self->{root};
1149 }
1150
1151 sub fh {
1152         ##
1153         # Get access to the raw FileHandle
1154         ##
1155     #XXX It will be useful, though, when we split out HASH and ARRAY
1156     my $self = $_[0]->_get_self;
1157         return $self->root->{fh};
1158 }
1159
1160 sub type {
1161         ##
1162         # Get type of current node (TYPE_HASH or TYPE_ARRAY)
1163         ##
1164     my $self = $_[0]->_get_self;
1165         return $self->{type};
1166 }
1167
1168 sub base_offset {
1169         ##
1170         # Get base_offset of current node (TYPE_HASH or TYPE_ARRAY)
1171         ##
1172     my $self = $_[0]->_get_self;
1173         return $self->{base_offset};
1174 }
1175
1176 sub error {
1177         ##
1178         # Get last error string, or undef if no error
1179         ##
1180         return $_[0]
1181         #? ( _get_self($_[0])->{root}->{error} or undef )
1182         ? ( $_[0]->_get_self->{root}->{error} or undef )
1183         : $@;
1184 }
1185
1186 ##
1187 # Utility methods
1188 ##
1189
1190 sub _throw_error {
1191         ##
1192         # Store error string in self
1193         ##
1194     my $self = $_[0]->_get_self;
1195         my $error_text = $_[1];
1196
1197     if ( Scalar::Util::blessed $self ) {
1198         $self->root->{error} = $error_text;
1199
1200         unless ($self->root->{debug}) {
1201             die "DBM::Deep: $error_text\n";
1202         }
1203
1204         warn "DBM::Deep: $error_text\n";
1205         return;
1206     }
1207     else {
1208         die "DBM::Deep: $error_text\n";
1209     }
1210 }
1211
1212 sub clear_error {
1213         ##
1214         # Clear error state
1215         ##
1216     my $self = $_[0]->_get_self;
1217
1218         undef $self->root->{error};
1219 }
1220
1221 sub precalc_sizes {
1222         ##
1223         # Precalculate index, bucket and bucket list sizes
1224         ##
1225
1226     #XXX I don't like this ...
1227     set_pack() unless defined $LONG_SIZE;
1228
1229         $INDEX_SIZE = 256 * $LONG_SIZE;
1230         $BUCKET_SIZE = $HASH_SIZE + $LONG_SIZE;
1231         $BUCKET_LIST_SIZE = $MAX_BUCKETS * $BUCKET_SIZE;
1232 }
1233
1234 sub set_pack {
1235         ##
1236         # Set pack/unpack modes (see file header for more)
1237         ##
1238     my ($long_s, $long_p, $data_s, $data_p) = @_;
1239
1240     $LONG_SIZE = $long_s ? $long_s : 4;
1241     $LONG_PACK = $long_p ? $long_p : 'N';
1242
1243     $DATA_LENGTH_SIZE = $data_s ? $data_s : 4;
1244     $DATA_LENGTH_PACK = $data_p ? $data_p : 'N';
1245
1246         precalc_sizes();
1247 }
1248
1249 sub set_digest {
1250         ##
1251         # Set key digest function (default is MD5)
1252         ##
1253     my ($digest_func, $hash_size) = @_;
1254
1255     $DIGEST_FUNC = $digest_func ? $digest_func : \&Digest::MD5::md5;
1256     $HASH_SIZE = $hash_size ? $hash_size : 16;
1257
1258         precalc_sizes();
1259 }
1260
1261 ##
1262 # tie() methods (hashes and arrays)
1263 ##
1264
1265 sub STORE {
1266         ##
1267         # Store single hash key/value or array element in database.
1268         ##
1269     my $self = $_[0]->_get_self;
1270         my $key = $_[1];
1271
1272     # User may be storing a hash, in which case we do not want it run
1273     # through the filtering system
1274         my $value = ($self->root->{filter_store_value} && !ref($_[2]))
1275         ? $self->root->{filter_store_value}->($_[2])
1276         : $_[2];
1277
1278         my $md5 = $DIGEST_FUNC->($key);
1279
1280         ##
1281         # Make sure file is open
1282         ##
1283         if (!defined($self->fh) && !$self->_open()) {
1284                 return;
1285         }
1286         ##
1287
1288     my $fh = $self->fh;
1289
1290         ##
1291         # Request exclusive lock for writing
1292         ##
1293         $self->lock( LOCK_EX );
1294
1295         ##
1296         # If locking is enabled, set 'end' parameter again, in case another
1297         # DB instance appended to our file while we were unlocked.
1298         ##
1299         if ($self->root->{locking} || $self->root->{volatile}) {
1300                 $self->root->{end} = (stat($fh))[7];
1301         }
1302
1303         ##
1304         # Locate offset for bucket list using digest index system
1305         ##
1306         my $tag = $self->_load_tag($self->base_offset);
1307         if (!$tag) {
1308                 $tag = $self->_create_tag($self->base_offset, SIG_INDEX, chr(0) x $INDEX_SIZE);
1309         }
1310
1311         my $ch = 0;
1312         while ($tag->{signature} ne SIG_BLIST) {
1313                 my $num = ord(substr($md5, $ch, 1));
1314                 my $new_tag = $self->_index_lookup($tag, $num);
1315                 if (!$new_tag) {
1316                         my $ref_loc = $tag->{offset} + ($num * $LONG_SIZE);
1317                         seek($fh, $ref_loc, SEEK_SET);
1318                         print($fh pack($LONG_PACK, $self->root->{end}) );
1319
1320                         $tag = $self->_create_tag($self->root->{end}, SIG_BLIST, chr(0) x $BUCKET_LIST_SIZE);
1321                         $tag->{ref_loc} = $ref_loc;
1322                         $tag->{ch} = $ch;
1323                         last;
1324                 }
1325                 else {
1326                         my $ref_loc = $tag->{offset} + ($num * $LONG_SIZE);
1327                         $tag = $new_tag;
1328                         $tag->{ref_loc} = $ref_loc;
1329                         $tag->{ch} = $ch;
1330                 }
1331                 $ch++;
1332         }
1333
1334         ##
1335         # Add key/value to bucket list
1336         ##
1337         my $result = $self->_add_bucket( $tag, $md5, $key, $value );
1338
1339         $self->unlock();
1340
1341         return $result;
1342 }
1343
1344 sub FETCH {
1345         ##
1346         # Fetch single value or element given plain key or array index
1347         ##
1348     my $self = shift->_get_self;
1349     my $key = shift;
1350
1351         ##
1352         # Make sure file is open
1353         ##
1354         if (!defined($self->fh)) { $self->_open(); }
1355
1356         my $md5 = $DIGEST_FUNC->($key);
1357
1358         ##
1359         # Request shared lock for reading
1360         ##
1361         $self->lock( LOCK_SH );
1362
1363         my $tag = $self->_find_bucket_list( $md5 );
1364         if (!$tag) {
1365                 $self->unlock();
1366                 return;
1367         }
1368
1369         ##
1370         # Get value from bucket list
1371         ##
1372         my $result = $self->_get_bucket_value( $tag, $md5 );
1373
1374         $self->unlock();
1375
1376     #XXX What is ref() checking here?
1377         return ($result && !ref($result) && $self->root->{filter_fetch_value})
1378         ? $self->root->{filter_fetch_value}->($result)
1379         : $result;
1380 }
1381
1382 sub DELETE {
1383         ##
1384         # Delete single key/value pair or element given plain key or array index
1385         ##
1386     my $self = $_[0]->_get_self;
1387         my $key = $_[1];
1388
1389         my $md5 = $DIGEST_FUNC->($key);
1390
1391         ##
1392         # Make sure file is open
1393         ##
1394         if (!defined($self->fh)) { $self->_open(); }
1395
1396         ##
1397         # Request exclusive lock for writing
1398         ##
1399         $self->lock( LOCK_EX );
1400
1401         my $tag = $self->_find_bucket_list( $md5 );
1402         if (!$tag) {
1403                 $self->unlock();
1404                 return;
1405         }
1406
1407         ##
1408         # Delete bucket
1409         ##
1410     my $value = $self->_get_bucket_value( $tag, $md5 );
1411         if ($value && !ref($value) && $self->root->{filter_fetch_value}) {
1412         $value = $self->root->{filter_fetch_value}->($value);
1413     }
1414
1415         my $result = $self->_delete_bucket( $tag, $md5 );
1416
1417         ##
1418         # If this object is an array and the key deleted was on the end of the stack,
1419         # decrement the length variable.
1420         ##
1421
1422         $self->unlock();
1423
1424         return $value;
1425 }
1426
1427 sub EXISTS {
1428         ##
1429         # Check if a single key or element exists given plain key or array index
1430         ##
1431     my $self = $_[0]->_get_self;
1432         my $key = $_[1];
1433
1434         my $md5 = $DIGEST_FUNC->($key);
1435
1436         ##
1437         # Make sure file is open
1438         ##
1439         if (!defined($self->fh)) { $self->_open(); }
1440
1441         ##
1442         # Request shared lock for reading
1443         ##
1444         $self->lock( LOCK_SH );
1445
1446         my $tag = $self->_find_bucket_list( $md5 );
1447
1448         ##
1449         # For some reason, the built-in exists() function returns '' for false
1450         ##
1451         if (!$tag) {
1452                 $self->unlock();
1453                 return '';
1454         }
1455
1456         ##
1457         # Check if bucket exists and return 1 or ''
1458         ##
1459         my $result = $self->_bucket_exists( $tag, $md5 ) || '';
1460
1461         $self->unlock();
1462
1463         return $result;
1464 }
1465
1466 sub CLEAR {
1467         ##
1468         # Clear all keys from hash, or all elements from array.
1469         ##
1470     my $self = $_[0]->_get_self;
1471
1472         ##
1473         # Make sure file is open
1474         ##
1475         if (!defined($self->fh)) { $self->_open(); }
1476
1477         ##
1478         # Request exclusive lock for writing
1479         ##
1480         $self->lock( LOCK_EX );
1481
1482     my $fh = $self->fh;
1483
1484         seek($fh, $self->base_offset, SEEK_SET);
1485         if (eof $fh) {
1486                 $self->unlock();
1487                 return;
1488         }
1489
1490         $self->_create_tag($self->base_offset, $self->type, chr(0) x $INDEX_SIZE);
1491
1492         $self->unlock();
1493
1494         return 1;
1495 }
1496
1497 ##
1498 # Public method aliases
1499 ##
1500 sub put { (shift)->STORE( @_ ) }
1501 sub store { (shift)->STORE( @_ ) }
1502 sub get { (shift)->FETCH( @_ ) }
1503 sub fetch { (shift)->FETCH( @_ ) }
1504 sub delete { (shift)->DELETE( @_ ) }
1505 sub exists { (shift)->EXISTS( @_ ) }
1506 sub clear { (shift)->CLEAR( @_ ) }
1507
1508 package DBM::Deep::_::Root;
1509
1510 sub new {
1511     my $class = shift;
1512     my ($args) = @_;
1513
1514     my $self = bless {
1515         file => undef,
1516         fh => undef,
1517         end => 0,
1518         autoflush => undef,
1519         locking => undef,
1520         volatile => undef,
1521         debug => undef,
1522         mode => 'r+',
1523         filter_store_key => undef,
1524         filter_store_value => undef,
1525         filter_fetch_key => undef,
1526         filter_fetch_value => undef,
1527         autobless => undef,
1528         locked => 0,
1529         %$args,
1530     }, $class;
1531
1532     return $self;
1533 }
1534
1535 sub DESTROY {
1536     my $self = shift;
1537     return unless $self;
1538
1539     close $self->{fh} if $self->{fh};
1540
1541     return;
1542 }
1543
1544 1;
1545
1546 __END__
1547
1548 =head1 NAME
1549
1550 DBM::Deep - A pure perl multi-level hash/array DBM
1551
1552 =head1 SYNOPSIS
1553
1554   use DBM::Deep;
1555   my $db = DBM::Deep->new( "foo.db" );
1556
1557   $db->{key} = 'value'; # tie() style
1558   print $db->{key};
1559
1560   $db->put('key', 'value'); # OO style
1561   print $db->get('key');
1562
1563   # true multi-level support
1564   $db->{my_complex} = [
1565         'hello', { perl => 'rules' },
1566         42, 99 ];
1567
1568 =head1 DESCRIPTION
1569
1570 A unique flat-file database module, written in pure perl.  True
1571 multi-level hash/array support (unlike MLDBM, which is faked), hybrid
1572 OO / tie() interface, cross-platform FTPable files, and quite fast.  Can
1573 handle millions of keys and unlimited hash levels without significant
1574 slow-down.  Written from the ground-up in pure perl -- this is NOT a
1575 wrapper around a C-based DBM.  Out-of-the-box compatibility with Unix,
1576 Mac OS X and Windows.
1577
1578 =head1 INSTALLATION
1579
1580 Hopefully you are using CPAN's excellent Perl module, which will download
1581 and install the module for you.  If not, get the tarball, and run these
1582 commands:
1583
1584         tar zxf DBM-Deep-*
1585         cd DBM-Deep-*
1586         perl Makefile.PL
1587         make
1588         make test
1589         make install
1590
1591 =head1 SETUP
1592
1593 Construction can be done OO-style (which is the recommended way), or using
1594 Perl's tie() function.  Both are examined here.
1595
1596 =head2 OO CONSTRUCTION
1597
1598 The recommended way to construct a DBM::Deep object is to use the new()
1599 method, which gets you a blessed, tied hash or array reference.
1600
1601         my $db = DBM::Deep->new( "foo.db" );
1602
1603 This opens a new database handle, mapped to the file "foo.db".  If this
1604 file does not exist, it will automatically be created.  DB files are
1605 opened in "r+" (read/write) mode, and the type of object returned is a
1606 hash, unless otherwise specified (see L<OPTIONS> below).
1607
1608
1609
1610 You can pass a number of options to the constructor to specify things like
1611 locking, autoflush, etc.  This is done by passing an inline hash:
1612
1613         my $db = DBM::Deep->new(
1614                 file => "foo.db",
1615                 locking => 1,
1616                 autoflush => 1
1617         );
1618
1619 Notice that the filename is now specified I<inside> the hash with
1620 the "file" parameter, as opposed to being the sole argument to the
1621 constructor.  This is required if any options are specified.
1622 See L<OPTIONS> below for the complete list.
1623
1624
1625
1626 You can also start with an array instead of a hash.  For this, you must
1627 specify the C<type> parameter:
1628
1629         my $db = DBM::Deep->new(
1630                 file => "foo.db",
1631                 type => DBM::Deep->TYPE_ARRAY
1632         );
1633
1634 B<Note:> Specifing the C<type> parameter only takes effect when beginning
1635 a new DB file.  If you create a DBM::Deep object with an existing file, the
1636 C<type> will be loaded from the file header, and ignored if it is passed
1637 to the constructor.
1638
1639 =head2 TIE CONSTRUCTION
1640
1641 Alternatively, you can create a DBM::Deep handle by using Perl's built-in
1642 tie() function.  This is not ideal, because you get only a basic, tied hash
1643 (or array) which is not blessed, so you can't call any functions on it.
1644
1645         my %hash;
1646         tie %hash, "DBM::Deep", "foo.db";
1647
1648         my @array;
1649         tie @array, "DBM::Deep", "bar.db";
1650
1651 As with the OO constructor, you can replace the DB filename parameter with
1652 a hash containing one or more options (see L<OPTIONS> just below for the
1653 complete list).
1654
1655         tie %hash, "DBM::Deep", {
1656                 file => "foo.db",
1657                 locking => 1,
1658                 autoflush => 1
1659         };
1660
1661 =head2 OPTIONS
1662
1663 There are a number of options that can be passed in when constructing your
1664 DBM::Deep objects.  These apply to both the OO- and tie- based approaches.
1665
1666 =over
1667
1668 =item * file
1669
1670 Filename of the DB file to link the handle to.  You can pass a full absolute
1671 filesystem path, partial path, or a plain filename if the file is in the
1672 current working directory.  This is a required parameter.
1673
1674 =item * mode
1675
1676 File open mode (read-only, read-write, etc.) string passed to Perl's FileHandle
1677 module.  This is an optional parameter, and defaults to "r+" (read/write).
1678 B<Note:> If the default (r+) mode is selected, the file will also be auto-
1679 created if it doesn't exist.
1680
1681 =item * type
1682
1683 This parameter specifies what type of object to create, a hash or array.  Use
1684 one of these two constants: C<DBM::Deep-E<gt>TYPE_HASH> or C<DBM::Deep-E<gt>TYPE_ARRAY>.
1685 This only takes effect when beginning a new file.  This is an optional
1686 parameter, and defaults to C<DBM::Deep-E<gt>TYPE_HASH>.
1687
1688 =item * locking
1689
1690 Specifies whether locking is to be enabled.  DBM::Deep uses Perl's Fnctl flock()
1691 function to lock the database in exclusive mode for writes, and shared mode for
1692 reads.  Pass any true value to enable.  This affects the base DB handle I<and
1693 any child hashes or arrays> that use the same DB file.  This is an optional
1694 parameter, and defaults to 0 (disabled).  See L<LOCKING> below for more.
1695
1696 =item * autoflush
1697
1698 Specifies whether autoflush is to be enabled on the underlying FileHandle.
1699 This obviously slows down write operations, but is required if you may have
1700 multiple processes accessing the same DB file (also consider enable I<locking>
1701 or at least I<volatile>).  Pass any true value to enable.  This is an optional
1702 parameter, and defaults to 0 (disabled).
1703
1704 =item * volatile
1705
1706 If I<volatile> mode is enabled, DBM::Deep will stat() the DB file before each
1707 STORE() operation.  This is required if an outside force may change the size of
1708 the file between transactions.  Locking also implicitly enables volatile.  This
1709 is useful if you want to use a different locking system or write your own.  Pass
1710 any true value to enable.  This is an optional parameter, and defaults to 0
1711 (disabled).
1712
1713 =item * autobless
1714
1715 If I<autobless> mode is enabled, DBM::Deep will preserve blessed hashes, and
1716 restore them when fetched.  This is an B<experimental> feature, and does have
1717 side-effects.  Basically, when hashes are re-blessed into their original
1718 classes, they are no longer blessed into the DBM::Deep class!  So you won't be
1719 able to call any DBM::Deep methods on them.  You have been warned.
1720 This is an optional parameter, and defaults to 0 (disabled).
1721
1722 =item * filter_*
1723
1724 See L<FILTERS> below.
1725
1726 =item * debug
1727
1728 Setting I<debug> mode will make all errors non-fatal, dump them out to
1729 STDERR, and continue on.  This is for debugging purposes only, and probably
1730 not what you want.  This is an optional parameter, and defaults to 0 (disabled).
1731
1732 =item * fh
1733
1734 Instead of passing a file path, you can instead pass a handle to an pre-opened
1735 filehandle.  Note: Beware of using the magick *DATA handle, as this actually
1736 contains your entire Perl script, as well as the data following the __DATA__
1737 marker.  This will not work, because DBM::Deep uses absolute seek()s into the
1738 file.  Instead, consider reading *DATA into an IO::Scalar handle, then passing
1739 in that.
1740
1741 =back
1742
1743 =head1 TIE INTERFACE
1744
1745 With DBM::Deep you can access your databases using Perl's standard hash/array
1746 syntax.  Because all DBM::Deep objects are I<tied> to hashes or arrays, you can treat
1747 them as such.  DBM::Deep will intercept all reads/writes and direct them to the right
1748 place -- the DB file.  This has nothing to do with the L<TIE CONSTRUCTION>
1749 section above.  This simply tells you how to use DBM::Deep using regular hashes
1750 and arrays, rather than calling functions like C<get()> and C<put()> (although those
1751 work too).  It is entirely up to you how to want to access your databases.
1752
1753 =head2 HASHES
1754
1755 You can treat any DBM::Deep object like a normal Perl hash reference.  Add keys,
1756 or even nested hashes (or arrays) using standard Perl syntax:
1757
1758         my $db = DBM::Deep->new( "foo.db" );
1759
1760         $db->{mykey} = "myvalue";
1761         $db->{myhash} = {};
1762         $db->{myhash}->{subkey} = "subvalue";
1763
1764         print $db->{myhash}->{subkey} . "\n";
1765
1766 You can even step through hash keys using the normal Perl C<keys()> function:
1767
1768         foreach my $key (keys %$db) {
1769                 print "$key: " . $db->{$key} . "\n";
1770         }
1771
1772 Remember that Perl's C<keys()> function extracts I<every> key from the hash and
1773 pushes them onto an array, all before the loop even begins.  If you have an
1774 extra large hash, this may exhaust Perl's memory.  Instead, consider using
1775 Perl's C<each()> function, which pulls keys/values one at a time, using very
1776 little memory:
1777
1778         while (my ($key, $value) = each %$db) {
1779                 print "$key: $value\n";
1780         }
1781
1782 Please note that when using C<each()>, you should always pass a direct
1783 hash reference, not a lookup.  Meaning, you should B<never> do this:
1784
1785         # NEVER DO THIS
1786         while (my ($key, $value) = each %{$db->{foo}}) { # BAD
1787
1788 This causes an infinite loop, because for each iteration, Perl is calling
1789 FETCH() on the $db handle, resulting in a "new" hash for foo every time, so
1790 it effectively keeps returning the first key over and over again. Instead,
1791 assign a temporary variable to C<$db->{foo}>, then pass that to each().
1792
1793 =head2 ARRAYS
1794
1795 As with hashes, you can treat any DBM::Deep object like a normal Perl array
1796 reference.  This includes inserting, removing and manipulating elements,
1797 and the C<push()>, C<pop()>, C<shift()>, C<unshift()> and C<splice()> functions.
1798 The object must have first been created using type C<DBM::Deep-E<gt>TYPE_ARRAY>,
1799 or simply be a nested array reference inside a hash.  Example:
1800
1801         my $db = DBM::Deep->new(
1802                 file => "foo-array.db",
1803                 type => DBM::Deep->TYPE_ARRAY
1804         );
1805
1806         $db->[0] = "foo";
1807         push @$db, "bar", "baz";
1808         unshift @$db, "bah";
1809
1810         my $last_elem = pop @$db; # baz
1811         my $first_elem = shift @$db; # bah
1812         my $second_elem = $db->[1]; # bar
1813
1814         my $num_elements = scalar @$db;
1815
1816 =head1 OO INTERFACE
1817
1818 In addition to the I<tie()> interface, you can also use a standard OO interface
1819 to manipulate all aspects of DBM::Deep databases.  Each type of object (hash or
1820 array) has its own methods, but both types share the following common methods:
1821 C<put()>, C<get()>, C<exists()>, C<delete()> and C<clear()>.
1822
1823 =over
1824
1825 =item * put()
1826
1827 Stores a new hash key/value pair, or sets an array element value.  Takes two
1828 arguments, the hash key or array index, and the new value.  The value can be
1829 a scalar, hash ref or array ref.  Returns true on success, false on failure.
1830
1831         $db->put("foo", "bar"); # for hashes
1832         $db->put(1, "bar"); # for arrays
1833
1834 =item * get()
1835
1836 Fetches the value of a hash key or array element.  Takes one argument: the hash
1837 key or array index.  Returns a scalar, hash ref or array ref, depending on the
1838 data type stored.
1839
1840         my $value = $db->get("foo"); # for hashes
1841         my $value = $db->get(1); # for arrays
1842
1843 =item * exists()
1844
1845 Checks if a hash key or array index exists.  Takes one argument: the hash key
1846 or array index.  Returns true if it exists, false if not.
1847
1848         if ($db->exists("foo")) { print "yay!\n"; } # for hashes
1849         if ($db->exists(1)) { print "yay!\n"; } # for arrays
1850
1851 =item * delete()
1852
1853 Deletes one hash key/value pair or array element.  Takes one argument: the hash
1854 key or array index.  Returns true on success, false if not found.  For arrays,
1855 the remaining elements located after the deleted element are NOT moved over.
1856 The deleted element is essentially just undefined, which is exactly how Perl's
1857 internal arrays work.  Please note that the space occupied by the deleted
1858 key/value or element is B<not> reused again -- see L<UNUSED SPACE RECOVERY>
1859 below for details and workarounds.
1860
1861         $db->delete("foo"); # for hashes
1862         $db->delete(1); # for arrays
1863
1864 =item * clear()
1865
1866 Deletes B<all> hash keys or array elements.  Takes no arguments.  No return
1867 value.  Please note that the space occupied by the deleted keys/values or
1868 elements is B<not> reused again -- see L<UNUSED SPACE RECOVERY> below for
1869 details and workarounds.
1870
1871         $db->clear(); # hashes or arrays
1872
1873 =back
1874
1875 =head2 HASHES
1876
1877 For hashes, DBM::Deep supports all the common methods described above, and the
1878 following additional methods: C<first_key()> and C<next_key()>.
1879
1880 =over
1881
1882 =item * first_key()
1883
1884 Returns the "first" key in the hash.  As with built-in Perl hashes, keys are
1885 fetched in an undefined order (which appears random).  Takes no arguments,
1886 returns the key as a scalar value.
1887
1888         my $key = $db->first_key();
1889
1890 =item * next_key()
1891
1892 Returns the "next" key in the hash, given the previous one as the sole argument.
1893 Returns undef if there are no more keys to be fetched.
1894
1895         $key = $db->next_key($key);
1896
1897 =back
1898
1899 Here are some examples of using hashes:
1900
1901         my $db = DBM::Deep->new( "foo.db" );
1902
1903         $db->put("foo", "bar");
1904         print "foo: " . $db->get("foo") . "\n";
1905
1906         $db->put("baz", {}); # new child hash ref
1907         $db->get("baz")->put("buz", "biz");
1908         print "buz: " . $db->get("baz")->get("buz") . "\n";
1909
1910         my $key = $db->first_key();
1911         while ($key) {
1912                 print "$key: " . $db->get($key) . "\n";
1913                 $key = $db->next_key($key);
1914         }
1915
1916         if ($db->exists("foo")) { $db->delete("foo"); }
1917
1918 =head2 ARRAYS
1919
1920 For arrays, DBM::Deep supports all the common methods described above, and the
1921 following additional methods: C<length()>, C<push()>, C<pop()>, C<shift()>,
1922 C<unshift()> and C<splice()>.
1923
1924 =over
1925
1926 =item * length()
1927
1928 Returns the number of elements in the array.  Takes no arguments.
1929
1930         my $len = $db->length();
1931
1932 =item * push()
1933
1934 Adds one or more elements onto the end of the array.  Accepts scalars, hash
1935 refs or array refs.  No return value.
1936
1937         $db->push("foo", "bar", {});
1938
1939 =item * pop()
1940
1941 Fetches the last element in the array, and deletes it.  Takes no arguments.
1942 Returns undef if array is empty.  Returns the element value.
1943
1944         my $elem = $db->pop();
1945
1946 =item * shift()
1947
1948 Fetches the first element in the array, deletes it, then shifts all the
1949 remaining elements over to take up the space.  Returns the element value.  This
1950 method is not recommended with large arrays -- see L<LARGE ARRAYS> below for
1951 details.
1952
1953         my $elem = $db->shift();
1954
1955 =item * unshift()
1956
1957 Inserts one or more elements onto the beginning of the array, shifting all
1958 existing elements over to make room.  Accepts scalars, hash refs or array refs.
1959 No return value.  This method is not recommended with large arrays -- see
1960 <LARGE ARRAYS> below for details.
1961
1962         $db->unshift("foo", "bar", {});
1963
1964 =item * splice()
1965
1966 Performs exactly like Perl's built-in function of the same name.  See L<perldoc
1967 -f splice> for usage -- it is too complicated to document here.  This method is
1968 not recommended with large arrays -- see L<LARGE ARRAYS> below for details.
1969
1970 =back
1971
1972 Here are some examples of using arrays:
1973
1974         my $db = DBM::Deep->new(
1975                 file => "foo.db",
1976                 type => DBM::Deep->TYPE_ARRAY
1977         );
1978
1979         $db->push("bar", "baz");
1980         $db->unshift("foo");
1981         $db->put(3, "buz");
1982
1983         my $len = $db->length();
1984         print "length: $len\n"; # 4
1985
1986         for (my $k=0; $k<$len; $k++) {
1987                 print "$k: " . $db->get($k) . "\n";
1988         }
1989
1990         $db->splice(1, 2, "biz", "baf");
1991
1992         while (my $elem = shift @$db) {
1993                 print "shifted: $elem\n";
1994         }
1995
1996 =head1 LOCKING
1997
1998 Enable automatic file locking by passing a true value to the C<locking>
1999 parameter when constructing your DBM::Deep object (see L<SETUP> above).
2000
2001         my $db = DBM::Deep->new(
2002                 file => "foo.db",
2003                 locking => 1
2004         );
2005
2006 This causes DBM::Deep to C<flock()> the underlying FileHandle object with exclusive
2007 mode for writes, and shared mode for reads.  This is required if you have
2008 multiple processes accessing the same database file, to avoid file corruption.
2009 Please note that C<flock()> does NOT work for files over NFS.  See L<DB OVER
2010 NFS> below for more.
2011
2012 =head2 EXPLICIT LOCKING
2013
2014 You can explicitly lock a database, so it remains locked for multiple
2015 transactions.  This is done by calling the C<lock()> method, and passing an
2016 optional lock mode argument (defaults to exclusive mode).  This is particularly
2017 useful for things like counters, where the current value needs to be fetched,
2018 then incremented, then stored again.
2019
2020         $db->lock();
2021         my $counter = $db->get("counter");
2022         $counter++;
2023         $db->put("counter", $counter);
2024         $db->unlock();
2025
2026         # or...
2027
2028         $db->lock();
2029         $db->{counter}++;
2030         $db->unlock();
2031
2032 You can pass C<lock()> an optional argument, which specifies which mode to use
2033 (exclusive or shared).  Use one of these two constants: C<DBM::Deep-E<gt>LOCK_EX>
2034 or C<DBM::Deep-E<gt>LOCK_SH>.  These are passed directly to C<flock()>, and are the
2035 same as the constants defined in Perl's C<Fcntl> module.
2036
2037         $db->lock( DBM::Deep->LOCK_SH );
2038         # something here
2039         $db->unlock();
2040
2041 If you want to implement your own file locking scheme, be sure to create your
2042 DBM::Deep objects setting the C<volatile> option to true.  This hints to DBM::Deep
2043 that the DB file may change between transactions.  See L<LOW-LEVEL ACCESS>
2044 below for more.
2045
2046 =head1 IMPORTING/EXPORTING
2047
2048 You can import existing complex structures by calling the C<import()> method,
2049 and export an entire database into an in-memory structure using the C<export()>
2050 method.  Both are examined here.
2051
2052 =head2 IMPORTING
2053
2054 Say you have an existing hash with nested hashes/arrays inside it.  Instead of
2055 walking the structure and adding keys/elements to the database as you go,
2056 simply pass a reference to the C<import()> method.  This recursively adds
2057 everything to an existing DBM::Deep object for you.  Here is an example:
2058
2059         my $struct = {
2060                 key1 => "value1",
2061                 key2 => "value2",
2062                 array1 => [ "elem0", "elem1", "elem2" ],
2063                 hash1 => {
2064                         subkey1 => "subvalue1",
2065                         subkey2 => "subvalue2"
2066                 }
2067         };
2068
2069         my $db = DBM::Deep->new( "foo.db" );
2070         $db->import( $struct );
2071
2072         print $db->{key1} . "\n"; # prints "value1"
2073
2074 This recursively imports the entire C<$struct> object into C<$db>, including
2075 all nested hashes and arrays.  If the DBM::Deep object contains exsiting data,
2076 keys are merged with the existing ones, replacing if they already exist.
2077 The C<import()> method can be called on any database level (not just the base
2078 level), and works with both hash and array DB types.
2079
2080
2081
2082 B<Note:> Make sure your existing structure has no circular references in it.
2083 These will cause an infinite loop when importing.
2084
2085 =head2 EXPORTING
2086
2087 Calling the C<export()> method on an existing DBM::Deep object will return
2088 a reference to a new in-memory copy of the database.  The export is done
2089 recursively, so all nested hashes/arrays are all exported to standard Perl
2090 objects.  Here is an example:
2091
2092         my $db = DBM::Deep->new( "foo.db" );
2093
2094         $db->{key1} = "value1";
2095         $db->{key2} = "value2";
2096         $db->{hash1} = {};
2097         $db->{hash1}->{subkey1} = "subvalue1";
2098         $db->{hash1}->{subkey2} = "subvalue2";
2099
2100         my $struct = $db->export();
2101
2102         print $struct->{key1} . "\n"; # prints "value1"
2103
2104 This makes a complete copy of the database in memory, and returns a reference
2105 to it.  The C<export()> method can be called on any database level (not just
2106 the base level), and works with both hash and array DB types.  Be careful of
2107 large databases -- you can store a lot more data in a DBM::Deep object than an
2108 in-memory Perl structure.
2109
2110
2111
2112 B<Note:> Make sure your database has no circular references in it.
2113 These will cause an infinite loop when exporting.
2114
2115 =head1 FILTERS
2116
2117 DBM::Deep has a number of hooks where you can specify your own Perl function
2118 to perform filtering on incoming or outgoing data.  This is a perfect
2119 way to extend the engine, and implement things like real-time compression or
2120 encryption.  Filtering applies to the base DB level, and all child hashes /
2121 arrays.  Filter hooks can be specified when your DBM::Deep object is first
2122 constructed, or by calling the C<set_filter()> method at any time.  There are
2123 four available filter hooks, described below:
2124
2125 =over
2126
2127 =item * filter_store_key
2128
2129 This filter is called whenever a hash key is stored.  It
2130 is passed the incoming key, and expected to return a transformed key.
2131
2132 =item * filter_store_value
2133
2134 This filter is called whenever a hash key or array element is stored.  It
2135 is passed the incoming value, and expected to return a transformed value.
2136
2137 =item * filter_fetch_key
2138
2139 This filter is called whenever a hash key is fetched (i.e. via
2140 C<first_key()> or C<next_key()>).  It is passed the transformed key,
2141 and expected to return the plain key.
2142
2143 =item * filter_fetch_value
2144
2145 This filter is called whenever a hash key or array element is fetched.
2146 It is passed the transformed value, and expected to return the plain value.
2147
2148 =back
2149
2150 Here are the two ways to setup a filter hook:
2151
2152         my $db = DBM::Deep->new(
2153                 file => "foo.db",
2154                 filter_store_value => \&my_filter_store,
2155                 filter_fetch_value => \&my_filter_fetch
2156         );
2157
2158         # or...
2159
2160         $db->set_filter( "filter_store_value", \&my_filter_store );
2161         $db->set_filter( "filter_fetch_value", \&my_filter_fetch );
2162
2163 Your filter function will be called only when dealing with SCALAR keys or
2164 values.  When nested hashes and arrays are being stored/fetched, filtering
2165 is bypassed.  Filters are called as static functions, passed a single SCALAR
2166 argument, and expected to return a single SCALAR value.  If you want to
2167 remove a filter, set the function reference to C<undef>:
2168
2169         $db->set_filter( "filter_store_value", undef );
2170
2171 =head2 REAL-TIME ENCRYPTION EXAMPLE
2172
2173 Here is a working example that uses the I<Crypt::Blowfish> module to
2174 do real-time encryption / decryption of keys & values with DBM::Deep Filters.
2175 Please visit L<http://search.cpan.org/search?module=Crypt::Blowfish> for more
2176 on I<Crypt::Blowfish>.  You'll also need the I<Crypt::CBC> module.
2177
2178         use DBM::Deep;
2179         use Crypt::Blowfish;
2180         use Crypt::CBC;
2181
2182         my $cipher = Crypt::CBC->new({
2183                 'key'             => 'my secret key',
2184                 'cipher'          => 'Blowfish',
2185                 'iv'              => '$KJh#(}q',
2186                 'regenerate_key'  => 0,
2187                 'padding'         => 'space',
2188                 'prepend_iv'      => 0
2189         });
2190
2191         my $db = DBM::Deep->new(
2192                 file => "foo-encrypt.db",
2193                 filter_store_key => \&my_encrypt,
2194                 filter_store_value => \&my_encrypt,
2195                 filter_fetch_key => \&my_decrypt,
2196                 filter_fetch_value => \&my_decrypt,
2197         );
2198
2199         $db->{key1} = "value1";
2200         $db->{key2} = "value2";
2201         print "key1: " . $db->{key1} . "\n";
2202         print "key2: " . $db->{key2} . "\n";
2203
2204         undef $db;
2205         exit;
2206
2207         sub my_encrypt {
2208                 return $cipher->encrypt( $_[0] );
2209         }
2210         sub my_decrypt {
2211                 return $cipher->decrypt( $_[0] );
2212         }
2213
2214 =head2 REAL-TIME COMPRESSION EXAMPLE
2215
2216 Here is a working example that uses the I<Compress::Zlib> module to do real-time
2217 compression / decompression of keys & values with DBM::Deep Filters.
2218 Please visit L<http://search.cpan.org/search?module=Compress::Zlib> for
2219 more on I<Compress::Zlib>.
2220
2221         use DBM::Deep;
2222         use Compress::Zlib;
2223
2224         my $db = DBM::Deep->new(
2225                 file => "foo-compress.db",
2226                 filter_store_key => \&my_compress,
2227                 filter_store_value => \&my_compress,
2228                 filter_fetch_key => \&my_decompress,
2229                 filter_fetch_value => \&my_decompress,
2230         );
2231
2232         $db->{key1} = "value1";
2233         $db->{key2} = "value2";
2234         print "key1: " . $db->{key1} . "\n";
2235         print "key2: " . $db->{key2} . "\n";
2236
2237         undef $db;
2238         exit;
2239
2240         sub my_compress {
2241                 return Compress::Zlib::memGzip( $_[0] ) ;
2242         }
2243         sub my_decompress {
2244                 return Compress::Zlib::memGunzip( $_[0] ) ;
2245         }
2246
2247 B<Note:> Filtering of keys only applies to hashes.  Array "keys" are
2248 actually numerical index numbers, and are not filtered.
2249
2250 =head1 ERROR HANDLING
2251
2252 Most DBM::Deep methods return a true value for success, and call die() on
2253 failure.  You can wrap calls in an eval block to catch the die.  Also, the
2254 actual error message is stored in an internal scalar, which can be fetched by
2255 calling the C<error()> method.
2256
2257         my $db = DBM::Deep->new( "foo.db" ); # create hash
2258         eval { $db->push("foo"); }; # ILLEGAL -- push is array-only call
2259
2260         print $db->error(); # prints error message
2261
2262 You can then call C<clear_error()> to clear the current error state.
2263
2264         $db->clear_error();
2265
2266 If you set the C<debug> option to true when creating your DBM::Deep object,
2267 all errors are considered NON-FATAL, and dumped to STDERR.  This is only
2268 for debugging purposes.
2269
2270 =head1 LARGEFILE SUPPORT
2271
2272 If you have a 64-bit system, and your Perl is compiled with both LARGEFILE
2273 and 64-bit support, you I<may> be able to create databases larger than 2 GB.
2274 DBM::Deep by default uses 32-bit file offset tags, but these can be changed
2275 by calling the static C<set_pack()> method before you do anything else.
2276
2277         DBM::Deep::set_pack(8, 'Q');
2278
2279 This tells DBM::Deep to pack all file offsets with 8-byte (64-bit) quad words
2280 instead of 32-bit longs.  After setting these values your DB files have a
2281 theoretical maximum size of 16 XB (exabytes).
2282
2283
2284
2285 B<Note:> Changing these values will B<NOT> work for existing database files.
2286 Only change this for new files, and make sure it stays set consistently
2287 throughout the file's life.  If you do set these values, you can no longer
2288 access 32-bit DB files.  You can, however, call C<set_pack(4, 'N')> to change
2289 back to 32-bit mode.
2290
2291
2292
2293 B<Note:> I have not personally tested files > 2 GB -- all my systems have
2294 only a 32-bit Perl.  However, I have received user reports that this does
2295 indeed work!
2296
2297 =head1 LOW-LEVEL ACCESS
2298
2299 If you require low-level access to the underlying FileHandle that DBM::Deep uses,
2300 you can call the C<fh()> method, which returns the handle:
2301
2302         my $fh = $db->fh();
2303
2304 This method can be called on the root level of the datbase, or any child
2305 hashes or arrays.  All levels share a I<root> structure, which contains things
2306 like the FileHandle, a reference counter, and all your options you specified
2307 when you created the object.  You can get access to this root structure by
2308 calling the C<root()> method.
2309
2310         my $root = $db->root();
2311
2312 This is useful for changing options after the object has already been created,
2313 such as enabling/disabling locking, volatile or debug modes.  You can also
2314 store your own temporary user data in this structure (be wary of name
2315 collision), which is then accessible from any child hash or array.
2316
2317 =head1 CUSTOM DIGEST ALGORITHM
2318
2319 DBM::Deep by default uses the I<Message Digest 5> (MD5) algorithm for hashing
2320 keys.  However you can override this, and use another algorithm (such as SHA-256)
2321 or even write your own.  But please note that DBM::Deep currently expects zero
2322 collisions, so your algorithm has to be I<perfect>, so to speak.
2323 Collision detection may be introduced in a later version.
2324
2325
2326
2327 You can specify a custom digest algorithm by calling the static C<set_digest()>
2328 function, passing a reference to a subroutine, and the length of the algorithm's
2329 hashes (in bytes).  This is a global static function, which affects ALL DBM::Deep
2330 objects.  Here is a working example that uses a 256-bit hash from the
2331 I<Digest::SHA256> module.  Please see
2332 L<http://search.cpan.org/search?module=Digest::SHA256> for more.
2333
2334         use DBM::Deep;
2335         use Digest::SHA256;
2336
2337         my $context = Digest::SHA256::new(256);
2338
2339         DBM::Deep::set_digest( \&my_digest, 32 );
2340
2341         my $db = DBM::Deep->new( "foo-sha.db" );
2342
2343         $db->{key1} = "value1";
2344         $db->{key2} = "value2";
2345         print "key1: " . $db->{key1} . "\n";
2346         print "key2: " . $db->{key2} . "\n";
2347
2348         undef $db;
2349         exit;
2350
2351         sub my_digest {
2352                 return substr( $context->hash($_[0]), 0, 32 );
2353         }
2354
2355 B<Note:> Your returned digest strings must be B<EXACTLY> the number
2356 of bytes you specify in the C<set_digest()> function (in this case 32).
2357
2358 =head1 CIRCULAR REFERENCES
2359
2360 DBM::Deep has B<experimental> support for circular references.  Meaning you
2361 can have a nested hash key or array element that points to a parent object.
2362 This relationship is stored in the DB file, and is preserved between sessions.
2363 Here is an example:
2364
2365         my $db = DBM::Deep->new( "foo.db" );
2366
2367         $db->{foo} = "bar";
2368         $db->{circle} = $db; # ref to self
2369
2370         print $db->{foo} . "\n"; # prints "foo"
2371         print $db->{circle}->{foo} . "\n"; # prints "foo" again
2372
2373 One catch is, passing the object to a function that recursively walks the
2374 object tree (such as I<Data::Dumper> or even the built-in C<optimize()> or
2375 C<export()> methods) will result in an infinite loop.  The other catch is,
2376 if you fetch the I<key> of a circular reference (i.e. using the C<first_key()>
2377 or C<next_key()> methods), you will get the I<target object's key>, not the
2378 ref's key.  This gets even more interesting with the above example, where
2379 the I<circle> key points to the base DB object, which technically doesn't
2380 have a key.  So I made DBM::Deep return "[base]" as the key name in that
2381 special case.
2382
2383 =head1 CAVEATS / ISSUES / BUGS
2384
2385 This section describes all the known issues with DBM::Deep.  It you have found
2386 something that is not listed here, please send e-mail to L<jhuckaby@cpan.org>.
2387
2388 =head2 UNUSED SPACE RECOVERY
2389
2390 One major caveat with DBM::Deep is that space occupied by existing keys and
2391 values is not recovered when they are deleted.  Meaning if you keep deleting
2392 and adding new keys, your file will continuously grow.  I am working on this,
2393 but in the meantime you can call the built-in C<optimize()> method from time to
2394 time (perhaps in a crontab or something) to recover all your unused space.
2395
2396         $db->optimize(); # returns true on success
2397
2398 This rebuilds the ENTIRE database into a new file, then moves it on top of
2399 the original.  The new file will have no unused space, thus it will take up as
2400 little disk space as possible.  Please note that this operation can take
2401 a long time for large files, and you need enough disk space to temporarily hold
2402 2 copies of your DB file.  The temporary file is created in the same directory
2403 as the original, named with a ".tmp" extension, and is deleted when the
2404 operation completes.  Oh, and if locking is enabled, the DB is automatically
2405 locked for the entire duration of the copy.
2406
2407
2408
2409 B<WARNING:> Only call optimize() on the top-level node of the database, and
2410 make sure there are no child references lying around.  DBM::Deep keeps a reference
2411 counter, and if it is greater than 1, optimize() will abort and return undef.
2412
2413 =head2 AUTOVIVIFICATION
2414
2415 Unfortunately, autovivification doesn't work with tied hashes.  This appears to
2416 be a bug in Perl's tie() system, as I<Jakob Schmidt> encountered the very same
2417 issue with his I<DWH_FIle> module (see L<http://search.cpan.org/search?module=DWH_File>),
2418 and it is also mentioned in the BUGS section for the I<MLDBM> module <see
2419 L<http://search.cpan.org/search?module=MLDBM>).  Basically, on a new db file,
2420 this does not work:
2421
2422         $db->{foo}->{bar} = "hello";
2423
2424 Since "foo" doesn't exist, you cannot add "bar" to it.  You end up with "foo"
2425 being an empty hash.  Try this instead, which works fine:
2426
2427         $db->{foo} = { bar => "hello" };
2428
2429 As of Perl 5.8.7, this bug still exists.  I have walked very carefully through
2430 the execution path, and Perl indeed passes an empty hash to the STORE() method.
2431 Probably a bug in Perl.
2432
2433 =head2 FILE CORRUPTION
2434
2435 The current level of error handling in DBM::Deep is minimal.  Files I<are> checked
2436 for a 32-bit signature when opened, but other corruption in files can cause
2437 segmentation faults.  DBM::Deep may try to seek() past the end of a file, or get
2438 stuck in an infinite loop depending on the level of corruption.  File write
2439 operations are not checked for failure (for speed), so if you happen to run
2440 out of disk space, DBM::Deep will probably fail in a bad way.  These things will
2441 be addressed in a later version of DBM::Deep.
2442
2443 =head2 DB OVER NFS
2444
2445 Beware of using DB files over NFS.  DBM::Deep uses flock(), which works well on local
2446 filesystems, but will NOT protect you from file corruption over NFS.  I've heard
2447 about setting up your NFS server with a locking daemon, then using lockf() to
2448 lock your files, but your milage may vary there as well.  From what I
2449 understand, there is no real way to do it.  However, if you need access to the
2450 underlying FileHandle in DBM::Deep for using some other kind of locking scheme like
2451 lockf(), see the L<LOW-LEVEL ACCESS> section above.
2452
2453 =head2 COPYING OBJECTS
2454
2455 Beware of copying tied objects in Perl.  Very strange things can happen.
2456 Instead, use DBM::Deep's C<clone()> method which safely copies the object and
2457 returns a new, blessed, tied hash or array to the same level in the DB.
2458
2459         my $copy = $db->clone();
2460
2461 =head2 LARGE ARRAYS
2462
2463 Beware of using C<shift()>, C<unshift()> or C<splice()> with large arrays.
2464 These functions cause every element in the array to move, which can be murder
2465 on DBM::Deep, as every element has to be fetched from disk, then stored again in
2466 a different location.  This may be addressed in a later version.
2467
2468 =head1 PERFORMANCE
2469
2470 This section discusses DBM::Deep's speed and memory usage.
2471
2472 =head2 SPEED
2473
2474 Obviously, DBM::Deep isn't going to be as fast as some C-based DBMs, such as
2475 the almighty I<BerkeleyDB>.  But it makes up for it in features like true
2476 multi-level hash/array support, and cross-platform FTPable files.  Even so,
2477 DBM::Deep is still pretty fast, and the speed stays fairly consistent, even
2478 with huge databases.  Here is some test data:
2479
2480         Adding 1,000,000 keys to new DB file...
2481
2482         At 100 keys, avg. speed is 2,703 keys/sec
2483         At 200 keys, avg. speed is 2,642 keys/sec
2484         At 300 keys, avg. speed is 2,598 keys/sec
2485         At 400 keys, avg. speed is 2,578 keys/sec
2486         At 500 keys, avg. speed is 2,722 keys/sec
2487         At 600 keys, avg. speed is 2,628 keys/sec
2488         At 700 keys, avg. speed is 2,700 keys/sec
2489         At 800 keys, avg. speed is 2,607 keys/sec
2490         At 900 keys, avg. speed is 2,190 keys/sec
2491         At 1,000 keys, avg. speed is 2,570 keys/sec
2492         At 2,000 keys, avg. speed is 2,417 keys/sec
2493         At 3,000 keys, avg. speed is 1,982 keys/sec
2494         At 4,000 keys, avg. speed is 1,568 keys/sec
2495         At 5,000 keys, avg. speed is 1,533 keys/sec
2496         At 6,000 keys, avg. speed is 1,787 keys/sec
2497         At 7,000 keys, avg. speed is 1,977 keys/sec
2498         At 8,000 keys, avg. speed is 2,028 keys/sec
2499         At 9,000 keys, avg. speed is 2,077 keys/sec
2500         At 10,000 keys, avg. speed is 2,031 keys/sec
2501         At 20,000 keys, avg. speed is 1,970 keys/sec
2502         At 30,000 keys, avg. speed is 2,050 keys/sec
2503         At 40,000 keys, avg. speed is 2,073 keys/sec
2504         At 50,000 keys, avg. speed is 1,973 keys/sec
2505         At 60,000 keys, avg. speed is 1,914 keys/sec
2506         At 70,000 keys, avg. speed is 2,091 keys/sec
2507         At 80,000 keys, avg. speed is 2,103 keys/sec
2508         At 90,000 keys, avg. speed is 1,886 keys/sec
2509         At 100,000 keys, avg. speed is 1,970 keys/sec
2510         At 200,000 keys, avg. speed is 2,053 keys/sec
2511         At 300,000 keys, avg. speed is 1,697 keys/sec
2512         At 400,000 keys, avg. speed is 1,838 keys/sec
2513         At 500,000 keys, avg. speed is 1,941 keys/sec
2514         At 600,000 keys, avg. speed is 1,930 keys/sec
2515         At 700,000 keys, avg. speed is 1,735 keys/sec
2516         At 800,000 keys, avg. speed is 1,795 keys/sec
2517         At 900,000 keys, avg. speed is 1,221 keys/sec
2518         At 1,000,000 keys, avg. speed is 1,077 keys/sec
2519
2520 This test was performed on a PowerMac G4 1gHz running Mac OS X 10.3.2 & Perl
2521 5.8.1, with an 80GB Ultra ATA/100 HD spinning at 7200RPM.  The hash keys and
2522 values were between 6 - 12 chars in length.  The DB file ended up at 210MB.
2523 Run time was 12 min 3 sec.
2524
2525 =head2 MEMORY USAGE
2526
2527 One of the great things about DBM::Deep is that it uses very little memory.
2528 Even with huge databases (1,000,000+ keys) you will not see much increased
2529 memory on your process.  DBM::Deep relies solely on the filesystem for storing
2530 and fetching data.  Here is output from I</usr/bin/top> before even opening a
2531 database handle:
2532
2533           PID USER     PRI  NI  SIZE  RSS SHARE STAT %CPU %MEM   TIME COMMAND
2534         22831 root      11   0  2716 2716  1296 R     0.0  0.2   0:07 perl
2535
2536 Basically the process is taking 2,716K of memory.  And here is the same
2537 process after storing and fetching 1,000,000 keys:
2538
2539           PID USER     PRI  NI  SIZE  RSS SHARE STAT %CPU %MEM   TIME COMMAND
2540         22831 root      14   0  2772 2772  1328 R     0.0  0.2  13:32 perl
2541
2542 Notice the memory usage increased by only 56K.  Test was performed on a 700mHz
2543 x86 box running Linux RedHat 7.2 & Perl 5.6.1.
2544
2545 =head1 DB FILE FORMAT
2546
2547 In case you were interested in the underlying DB file format, it is documented
2548 here in this section.  You don't need to know this to use the module, it's just
2549 included for reference.
2550
2551 =head2 SIGNATURE
2552
2553 DBM::Deep files always start with a 32-bit signature to identify the file type.
2554 This is at offset 0.  The signature is "DPDB" in network byte order.  This is
2555 checked when the file is opened.
2556
2557 =head2 TAG
2558
2559 The DBM::Deep file is in a I<tagged format>, meaning each section of the file
2560 has a standard header containing the type of data, the length of data, and then
2561 the data itself.  The type is a single character (1 byte), the length is a
2562 32-bit unsigned long in network byte order, and the data is, well, the data.
2563 Here is how it unfolds:
2564
2565 =head2 MASTER INDEX
2566
2567 Immediately after the 32-bit file signature is the I<Master Index> record.
2568 This is a standard tag header followed by 1024 bytes (in 32-bit mode) or 2048
2569 bytes (in 64-bit mode) of data.  The type is I<H> for hash or I<A> for array,
2570 depending on how the DBM::Deep object was constructed.
2571
2572
2573
2574 The index works by looking at a I<MD5 Hash> of the hash key (or array index
2575 number).  The first 8-bit char of the MD5 signature is the offset into the
2576 index, multipled by 4 in 32-bit mode, or 8 in 64-bit mode.  The value of the
2577 index element is a file offset of the next tag for the key/element in question,
2578 which is usually a I<Bucket List> tag (see below).
2579
2580
2581
2582 The next tag I<could> be another index, depending on how many keys/elements
2583 exist.  See L<RE-INDEXING> below for details.
2584
2585 =head2 BUCKET LIST
2586
2587 A I<Bucket List> is a collection of 16 MD5 hashes for keys/elements, plus
2588 file offsets to where the actual data is stored.  It starts with a standard
2589 tag header, with type I<B>, and a data size of 320 bytes in 32-bit mode, or
2590 384 bytes in 64-bit mode.  Each MD5 hash is stored in full (16 bytes), plus
2591 the 32-bit or 64-bit file offset for the I<Bucket> containing the actual data.
2592 When the list fills up, a I<Re-Index> operation is performed (See
2593 L<RE-INDEXING> below).
2594
2595 =head2 BUCKET
2596
2597 A I<Bucket> is a tag containing a key/value pair (in hash mode), or a
2598 index/value pair (in array mode).  It starts with a standard tag header with
2599 type I<D> for scalar data (string, binary, etc.), or it could be a nested
2600 hash (type I<H>) or array (type I<A>).  The value comes just after the tag
2601 header.  The size reported in the tag header is only for the value, but then,
2602 just after the value is another size (32-bit unsigned long) and then the plain
2603 key itself.  Since the value is likely to be fetched more often than the plain
2604 key, I figured it would be I<slightly> faster to store the value first.
2605
2606
2607
2608 If the type is I<H> (hash) or I<A> (array), the value is another I<Master Index>
2609 record for the nested structure, where the process begins all over again.
2610
2611 =head2 RE-INDEXING
2612
2613 After a I<Bucket List> grows to 16 records, its allocated space in the file is
2614 exhausted.  Then, when another key/element comes in, the list is converted to a
2615 new index record.  However, this index will look at the next char in the MD5
2616 hash, and arrange new Bucket List pointers accordingly.  This process is called
2617 I<Re-Indexing>.  Basically, a new index tag is created at the file EOF, and all
2618 17 (16 + new one) keys/elements are removed from the old Bucket List and
2619 inserted into the new index.  Several new Bucket Lists are created in the
2620 process, as a new MD5 char from the key is being examined (it is unlikely that
2621 the keys will all share the same next char of their MD5s).
2622
2623
2624
2625 Because of the way the I<MD5> algorithm works, it is impossible to tell exactly
2626 when the Bucket Lists will turn into indexes, but the first round tends to
2627 happen right around 4,000 keys.  You will see a I<slight> decrease in
2628 performance here, but it picks back up pretty quick (see L<SPEED> above).  Then
2629 it takes B<a lot> more keys to exhaust the next level of Bucket Lists.  It's
2630 right around 900,000 keys.  This process can continue nearly indefinitely --
2631 right up until the point the I<MD5> signatures start colliding with each other,
2632 and this is B<EXTREMELY> rare -- like winning the lottery 5 times in a row AND
2633 getting struck by lightning while you are walking to cash in your tickets.
2634 Theoretically, since I<MD5> hashes are 128-bit values, you I<could> have up to
2635 340,282,366,921,000,000,000,000,000,000,000,000,000 keys/elements (I believe
2636 this is 340 unodecillion, but don't quote me).
2637
2638 =head2 STORING
2639
2640 When a new key/element is stored, the key (or index number) is first ran through
2641 I<Digest::MD5> to get a 128-bit signature (example, in hex:
2642 b05783b0773d894396d475ced9d2f4f6).  Then, the I<Master Index> record is checked
2643 for the first char of the signature (in this case I<b>).  If it does not exist,
2644 a new I<Bucket List> is created for our key (and the next 15 future keys that
2645 happen to also have I<b> as their first MD5 char).  The entire MD5 is written
2646 to the I<Bucket List> along with the offset of the new I<Bucket> record (EOF at
2647 this point, unless we are replacing an existing I<Bucket>), where the actual
2648 data will be stored.
2649
2650 =head2 FETCHING
2651
2652 Fetching an existing key/element involves getting a I<Digest::MD5> of the key
2653 (or index number), then walking along the indexes.  If there are enough
2654 keys/elements in this DB level, there might be nested indexes, each linked to
2655 a particular char of the MD5.  Finally, a I<Bucket List> is pointed to, which
2656 contains up to 16 full MD5 hashes.  Each is checked for equality to the key in
2657 question.  If we found a match, the I<Bucket> tag is loaded, where the value and
2658 plain key are stored.
2659
2660
2661
2662 Fetching the plain key occurs when calling the I<first_key()> and I<next_key()>
2663 methods.  In this process the indexes are walked systematically, and each key
2664 fetched in increasing MD5 order (which is why it appears random).   Once the
2665 I<Bucket> is found, the value is skipped the plain key returned instead.
2666 B<Note:> Do not count on keys being fetched as if the MD5 hashes were
2667 alphabetically sorted.  This only happens on an index-level -- as soon as the
2668 I<Bucket Lists> are hit, the keys will come out in the order they went in --
2669 so it's pretty much undefined how the keys will come out -- just like Perl's
2670 built-in hashes.
2671
2672 =head1 CODE COVERAGE
2673
2674 I use B<Devel::Cover> to test the code coverage of my tests, below is the B<Devel::Cover>
2675 report on this module's test suite.
2676
2677 ---------------------------- ------ ------ ------ ------ ------ ------ ------
2678 File                           stmt   bran   cond    sub    pod   time  total
2679 ---------------------------- ------ ------ ------ ------ ------ ------ ------
2680 blib/lib/DBM/Deep.pm           93.7   82.5   71.9   96.5   25.9   82.8   87.9
2681 blib/lib/DBM/Deep/Array.pm     98.8   88.0   90.9  100.0    n/a   12.8   96.3
2682 blib/lib/DBM/Deep/Hash.pm      95.2   80.0  100.0  100.0    n/a    4.4   92.3
2683 Total                          94.8   83.2   76.5   97.6   25.9  100.0   89.7
2684 ---------------------------- ------ ------ ------ ------ ------ ------ ------
2685
2686 =head1 AUTHOR
2687
2688 Joseph Huckaby, L<jhuckaby@cpan.org>
2689
2690 Special thanks to Adam Sah and Rich Gaushell!  You know why :-)
2691
2692 =head1 SEE ALSO
2693
2694 perltie(1), Tie::Hash(3), Digest::MD5(3), Fcntl(3), flock(2), lockf(3), nfs(5),
2695 Digest::SHA256(3), Crypt::Blowfish(3), Compress::Zlib(3)
2696
2697 =head1 LICENSE
2698
2699 Copyright (c) 2002-2005 Joseph Huckaby.  All Rights Reserved.
2700 This is free software, you may use it and distribute it under the
2701 same terms as Perl itself.
2702
2703 =cut