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