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