Added test to verify no writing to a readonly file
[dbsrgits/DBM-Deep.git] / lib / DBM / Deep.pm
index 83c7d65..3129d5c 100644 (file)
@@ -24,7 +24,7 @@ package DBM::Deep;
 #      print "This module " . $db->{my_complex}->[1]->{perl} . "!\n";
 #
 # Copyright:
-#      (c) 2002-2005 Joseph Huckaby.  All Rights Reserved.
+#      (c) 2002-2006 Joseph Huckaby.  All Rights Reserved.
 #      This program is free software; you can redistribute it and/or 
 #      modify it under the same terms as Perl itself.
 ##
@@ -246,17 +246,15 @@ sub _open {
     ##
     if (!$bytes_read) {
         seek($fh, 0 + $self->_root->{file_offset}, SEEK_SET);
-        print($fh SIG_FILE);
+        print( $fh SIG_FILE);
         $self->_create_tag($self->_base_offset, $self->_type, chr(0) x $INDEX_SIZE);
 
         my $plain_key = "[base]";
-        print($fh pack($DATA_LENGTH_PACK, length($plain_key)) . $plain_key );
+        print( $fh pack($DATA_LENGTH_PACK, length($plain_key)) . $plain_key );
 
         # Flush the filehandle
         my $old_fh = select $fh;
-        my $old_af = $|;
-        $| = 1;
-        $| = $old_af;
+        my $old_af = $|; $| = 1; $| = $old_af;
         select $old_fh;
 
         my @stats = stat($fh);
@@ -315,7 +313,7 @@ sub _create_tag {
     my $fh = $self->_fh;
 
        seek($fh, $offset + $self->_root->{file_offset}, SEEK_SET);
-       print($fh $sig . pack($DATA_LENGTH_PACK, $size) . $content );
+       print( $fh $sig . pack($DATA_LENGTH_PACK, $size) . $content );
        
        if ($offset == $self->_root->{end}) {
                $self->_root->{end} += SIG_SIZE + $DATA_LENGTH_SIZE + $size;
@@ -341,12 +339,9 @@ sub _load_tag {
        seek($fh, $offset + $self->_root->{file_offset}, SEEK_SET);
        if (eof $fh) { return undef; }
        
-       my $sig;
-       read( $fh, $sig, SIG_SIZE);
-       
-       my $size;
-       read( $fh, $size, $DATA_LENGTH_SIZE);
-       $size = unpack($DATA_LENGTH_PACK, $size);
+    my $b;
+    read( $fh, $b, SIG_SIZE + $DATA_LENGTH_SIZE );
+    my ($sig, $size) = unpack( "A $DATA_LENGTH_PACK", $b );
        
        my $buffer;
        read( $fh, $buffer, $size);
@@ -383,11 +378,10 @@ sub _add_bucket {
        my $location = 0;
        my $result = 2;
 
-       # added ref() check first to avoid eval and runtime exception for every
-       # scalar value being stored.  performance tweak.
+    my $root = $self->_root;
+
     my $is_dbm_deep = eval { local $SIG{'__DIE__'}; $value->isa( 'DBM::Deep' ) };
-    
-       my $internal_ref = $is_dbm_deep && ($value->_root eq $self->_root);
+       my $internal_ref = $is_dbm_deep && ($value->_root eq $root);
 
     my $fh = $self->_fh;
 
@@ -395,7 +389,6 @@ sub _add_bucket {
        # Iterate through buckets, seeing if this is a new entry or a replace.
        ##
        for (my $i=0; $i<$MAX_BUCKETS; $i++) {
-               my $key = substr($keys, $i * $BUCKET_SIZE, $HASH_SIZE);
                my $subloc = unpack($LONG_PACK, substr($keys, ($i * $BUCKET_SIZE) + $HASH_SIZE, $LONG_SIZE));
                if (!$subloc) {
                        ##
@@ -405,13 +398,15 @@ sub _add_bucket {
                        
             $location = $internal_ref
                 ? $value->_base_offset
-                : $self->_root->{end};
+                : $root->{end};
                        
-                       seek($fh, $tag->{offset} + ($i * $BUCKET_SIZE) + $self->_root->{file_offset}, SEEK_SET);
-                       print($fh $md5 . pack($LONG_PACK, $location) );
+                       seek($fh, $tag->{offset} + ($i * $BUCKET_SIZE) + $root->{file_offset}, SEEK_SET);
+                       print( $fh $md5 . pack($LONG_PACK, $location) );
                        last;
                }
-               elsif ($md5 eq $key) {
+
+               my $key = substr($keys, $i * $BUCKET_SIZE, $HASH_SIZE);
+               if ($md5 eq $key) {
                        ##
                        # Found existing bucket with same key.  Replace with new value.
                        ##
@@ -419,47 +414,48 @@ sub _add_bucket {
                        
                        if ($internal_ref) {
                                $location = $value->_base_offset;
-                               seek($fh, $tag->{offset} + ($i * $BUCKET_SIZE) + $self->_root->{file_offset}, SEEK_SET);
-                               print($fh $md5 . pack($LONG_PACK, $location) );
+                               seek($fh, $tag->{offset} + ($i * $BUCKET_SIZE) + $root->{file_offset}, SEEK_SET);
+                               print( $fh $md5 . pack($LONG_PACK, $location) );
+                return $result;
                        }
-                       else {
-                               seek($fh, $subloc + SIG_SIZE + $self->_root->{file_offset}, SEEK_SET);
-                               my $size;
-                               read( $fh, $size, $DATA_LENGTH_SIZE); $size = unpack($DATA_LENGTH_PACK, $size);
-                               
-                               ##
-                               # If value is a hash, array, or raw value with equal or less size, we can
-                               # reuse the same content area of the database.  Otherwise, we have to create
-                               # a new content area at the EOF.
-                               ##
-                               my $actual_length;
-                my $r = Scalar::Util::reftype( $value ) || '';
-                if ( $r eq 'HASH' || $r eq 'ARRAY' ) {
-                       $actual_length = $INDEX_SIZE;
-                       
-                       # if autobless is enabled, must also take into consideration
-                       # the class name, as it is stored along with key/value.
-                       if ( $self->_root->{autobless} ) {
-                                               my $value_class = Scalar::Util::blessed($value);
-                                               if ( defined $value_class && $value_class ne 'DBM::Deep' ) {
-                                                       $actual_length += length($value_class);
-                                               }
-                                       } # autobless
+
+            seek($fh, $subloc + SIG_SIZE + $root->{file_offset}, SEEK_SET);
+            my $size;
+            read( $fh, $size, $DATA_LENGTH_SIZE); $size = unpack($DATA_LENGTH_PACK, $size);
+            
+            ##
+            # If value is a hash, array, or raw value with equal or less size, we can
+            # reuse the same content area of the database.  Otherwise, we have to create
+            # a new content area at the EOF.
+            ##
+            my $actual_length;
+            my $r = Scalar::Util::reftype( $value ) || '';
+            if ( $r eq 'HASH' || $r eq 'ARRAY' ) {
+                $actual_length = $INDEX_SIZE;
+                
+                # if autobless is enabled, must also take into consideration
+                # the class name, as it is stored along with key/value.
+                if ( $root->{autobless} ) {
+                    my $value_class = Scalar::Util::blessed($value);
+                    if ( defined $value_class && !$value->isa('DBM::Deep') ) {
+                        $actual_length += length($value_class);
+                    }
                 }
-                               else { $actual_length = length($value); }
-                               
-                               if ($actual_length <= $size) {
-                                       $location = $subloc;
-                               }
-                               else {
-                                       $location = $self->_root->{end};
-                                       seek($fh, $tag->{offset} + ($i * $BUCKET_SIZE) + $HASH_SIZE + $self->_root->{file_offset}, SEEK_SET);
-                                       print($fh pack($LONG_PACK, $location) );
-                               }
-                       }
+            }
+            else { $actual_length = length($value); }
+            
+            if ($actual_length <= $size) {
+                $location = $subloc;
+            }
+            else {
+                $location = $root->{end};
+                seek($fh, $tag->{offset} + ($i * $BUCKET_SIZE) + $HASH_SIZE + $root->{file_offset}, SEEK_SET);
+                print( $fh pack($LONG_PACK, $location) );
+            }
+
                        last;
                }
-       } # i loop
+       }
        
        ##
        # If this is an internal reference, return now.
@@ -473,10 +469,10 @@ sub _add_bucket {
        # If bucket didn't fit into list, split into a new index level
        ##
        if (!$location) {
-               seek($fh, $tag->{ref_loc} + $self->_root->{file_offset}, SEEK_SET);
-               print($fh pack($LONG_PACK, $self->_root->{end}) );
+               seek($fh, $tag->{ref_loc} + $root->{file_offset}, SEEK_SET);
+               print( $fh pack($LONG_PACK, $root->{end}) );
                
-               my $index_tag = $self->_create_tag($self->_root->{end}, SIG_INDEX, chr(0) x $INDEX_SIZE);
+               my $index_tag = $self->_create_tag($root->{end}, SIG_INDEX, chr(0) x $INDEX_SIZE);
                my @offsets = ();
                
                $keys .= $md5 . pack($LONG_PACK, 0);
@@ -489,33 +485,33 @@ sub _add_bucket {
                                
                                if ($offsets[$num]) {
                                        my $offset = $offsets[$num] + SIG_SIZE + $DATA_LENGTH_SIZE;
-                                       seek($fh, $offset + $self->_root->{file_offset}, SEEK_SET);
+                                       seek($fh, $offset + $root->{file_offset}, SEEK_SET);
                                        my $subkeys;
                                        read( $fh, $subkeys, $BUCKET_LIST_SIZE);
                                        
                                        for (my $k=0; $k<$MAX_BUCKETS; $k++) {
                                                my $subloc = unpack($LONG_PACK, substr($subkeys, ($k * $BUCKET_SIZE) + $HASH_SIZE, $LONG_SIZE));
                                                if (!$subloc) {
-                                                       seek($fh, $offset + ($k * $BUCKET_SIZE) + $self->_root->{file_offset}, SEEK_SET);
-                                                       print($fh $key . pack($LONG_PACK, $old_subloc || $self->_root->{end}) );
+                                                       seek($fh, $offset + ($k * $BUCKET_SIZE) + $root->{file_offset}, SEEK_SET);
+                                                       print( $fh $key . pack($LONG_PACK, $old_subloc || $root->{end}) );
                                                        last;
                                                }
                                        } # k loop
                                }
                                else {
-                                       $offsets[$num] = $self->_root->{end};
-                                       seek($fh, $index_tag->{offset} + ($num * $LONG_SIZE) + $self->_root->{file_offset}, SEEK_SET);
-                                       print($fh pack($LONG_PACK, $self->_root->{end}) );
+                                       $offsets[$num] = $root->{end};
+                                       seek($fh, $index_tag->{offset} + ($num * $LONG_SIZE) + $root->{file_offset}, SEEK_SET);
+                                       print( $fh pack($LONG_PACK, $root->{end}) );
                                        
-                                       my $blist_tag = $self->_create_tag($self->_root->{end}, SIG_BLIST, chr(0) x $BUCKET_LIST_SIZE);
+                                       my $blist_tag = $self->_create_tag($root->{end}, SIG_BLIST, chr(0) x $BUCKET_LIST_SIZE);
                                        
-                                       seek($fh, $blist_tag->{offset} + $self->_root->{file_offset}, SEEK_SET);
-                                       print($fh $key . pack($LONG_PACK, $old_subloc || $self->_root->{end}) );
+                                       seek($fh, $blist_tag->{offset} + $root->{file_offset}, SEEK_SET);
+                                       print( $fh $key . pack($LONG_PACK, $old_subloc || $root->{end}) );
                                }
                        } # key is real
                } # i loop
                
-               $location ||= $self->_root->{end};
+               $location ||= $root->{end};
        } # re-index bucket list
        
        ##
@@ -523,54 +519,54 @@ sub _add_bucket {
        ##
        if ($location) {
                my $content_length;
-               seek($fh, $location + $self->_root->{file_offset}, SEEK_SET);
+               seek($fh, $location + $root->{file_offset}, SEEK_SET);
                
                ##
                # Write signature based on content type, set content length and write actual value.
                ##
         my $r = Scalar::Util::reftype($value) || '';
                if ($r eq 'HASH') {
-                       print($fh TYPE_HASH );
-                       print($fh pack($DATA_LENGTH_PACK, $INDEX_SIZE) . chr(0) x $INDEX_SIZE );
+                       print( $fh TYPE_HASH );
+                       print( $fh pack($DATA_LENGTH_PACK, $INDEX_SIZE) . chr(0) x $INDEX_SIZE );
                        $content_length = $INDEX_SIZE;
                }
                elsif ($r eq 'ARRAY') {
-                       print($fh TYPE_ARRAY );
-                       print($fh pack($DATA_LENGTH_PACK, $INDEX_SIZE) . chr(0) x $INDEX_SIZE );
+                       print( $fh TYPE_ARRAY );
+                       print( $fh pack($DATA_LENGTH_PACK, $INDEX_SIZE) . chr(0) x $INDEX_SIZE );
                        $content_length = $INDEX_SIZE;
                }
                elsif (!defined($value)) {
-                       print($fh SIG_NULL );
-                       print($fh pack($DATA_LENGTH_PACK, 0) );
+                       print( $fh SIG_NULL );
+                       print( $fh pack($DATA_LENGTH_PACK, 0) );
                        $content_length = 0;
                }
                else {
-                       print($fh SIG_DATA );
-                       print($fh pack($DATA_LENGTH_PACK, length($value)) . $value );
+                       print( $fh SIG_DATA );
+                       print( $fh pack($DATA_LENGTH_PACK, length($value)) . $value );
                        $content_length = length($value);
                }
                
                ##
                # Plain key is stored AFTER value, as keys are typically fetched less often.
                ##
-               print($fh pack($DATA_LENGTH_PACK, length($plain_key)) . $plain_key );
+               print( $fh pack($DATA_LENGTH_PACK, length($plain_key)) . $plain_key );
                
                ##
                # If value is blessed, preserve class name
                ##
-               if ( $self->_root->{autobless} ) {
+               if ( $root->{autobless} ) {
             my $value_class = Scalar::Util::blessed($value);
             if ( defined $value_class && $value_class ne 'DBM::Deep' ) {
                 ##
                 # Blessed ref -- will restore later
                 ##
-                print($fh chr(1) );
-                print($fh pack($DATA_LENGTH_PACK, length($value_class)) . $value_class );
+                print( $fh chr(1) );
+                print( $fh pack($DATA_LENGTH_PACK, length($value_class)) . $value_class );
                 $content_length += 1;
                 $content_length += $DATA_LENGTH_SIZE + length($value_class);
             }
             else {
-                print($fh chr(0) );
+                print( $fh chr(0) );
                 $content_length += 1;
             }
         }
@@ -578,10 +574,10 @@ sub _add_bucket {
                ##
                # If this is a new content area, advance EOF counter
                ##
-               if ($location == $self->_root->{end}) {
-                       $self->_root->{end} += SIG_SIZE;
-                       $self->_root->{end} += $DATA_LENGTH_SIZE + $content_length;
-                       $self->_root->{end} += $DATA_LENGTH_SIZE + length($plain_key);
+               if ($location == $root->{end}) {
+                       $root->{end} += SIG_SIZE;
+                       $root->{end} += $DATA_LENGTH_SIZE + $content_length;
+                       $root->{end} += $DATA_LENGTH_SIZE + length($plain_key);
                }
                
                ##
@@ -592,7 +588,7 @@ sub _add_bucket {
                        my $branch = DBM::Deep->new(
                                type => TYPE_HASH,
                                base_offset => $location,
-                               root => $self->_root,
+                               root => $root,
                        );
                        foreach my $key (keys %{$value}) {
                 $branch->STORE( $key, $value->{$key} );
@@ -602,7 +598,7 @@ sub _add_bucket {
                        my $branch = DBM::Deep->new(
                                type => TYPE_ARRAY,
                                base_offset => $location,
-                               root => $self->_root,
+                               root => $root,
                        );
                        my $index = 0;
                        foreach my $element (@{$value}) {
@@ -743,8 +739,8 @@ sub _delete_bucket {
         # Matched key -- delete bucket and return
         ##
         seek($fh, $tag->{offset} + ($i * $BUCKET_SIZE) + $self->_root->{file_offset}, SEEK_SET);
-        print($fh substr($keys, ($i+1) * $BUCKET_SIZE ) );
-        print($fh chr(0) x $BUCKET_SIZE );
+        print( $fh substr($keys, ($i+1) * $BUCKET_SIZE ) );
+        print( $fh chr(0) x $BUCKET_SIZE );
         
         return 1;
        } # i loop
@@ -1216,7 +1212,6 @@ sub error {
        # Get last error string, or undef if no error
        ##
        return $_[0]
-        #? ( _get_self($_[0])->{root}->{error} or undef )
         ? ( $_[0]->_get_self->{root}->{error} or undef )
         : $@;
 }
@@ -1296,6 +1291,16 @@ sub set_digest {
        _precalc_sizes();
 }
 
+sub _is_writable {
+    my $fh = shift;
+    (O_WRONLY | O_RDWR) & fcntl( $fh, F_GETFL, my $slush = 0);
+}
+
+sub _is_readable {
+    my $fh = shift;
+    (O_RDONLY | O_RDWR) & fcntl( $fh, F_GETFL, my $slush = 0);
+}
+
 ##
 # tie() methods (hashes and arrays)
 ##
@@ -1321,7 +1326,10 @@ sub STORE {
        if (!defined($self->_fh) && !$self->_open()) {
                return;
        }
-       ##
+
+    unless ( _is_writable( $self->_fh ) ) {
+        $self->_throw_error( 'Cannot write to a readonly filehandle' );
+    }
        
        ##
        # Request exclusive lock for writing
@@ -1341,20 +1349,24 @@ sub STORE {
        my $ch = 0;
        while ($tag->{signature} ne SIG_BLIST) {
                my $num = ord(substr($md5, $ch, 1));
+
+        my $ref_loc = $tag->{offset} + ($num * $LONG_SIZE);
                my $new_tag = $self->_index_lookup($tag, $num);
+
                if (!$new_tag) {
-                       my $ref_loc = $tag->{offset} + ($num * $LONG_SIZE);
                        seek($fh, $ref_loc + $self->_root->{file_offset}, SEEK_SET);
-                       print($fh pack($LONG_PACK, $self->_root->{end}) );
+                       print( $fh pack($LONG_PACK, $self->_root->{end}) );
                        
                        $tag = $self->_create_tag($self->_root->{end}, SIG_BLIST, chr(0) x $BUCKET_LIST_SIZE);
+
                        $tag->{ref_loc} = $ref_loc;
                        $tag->{ch} = $ch;
+
                        last;
                }
                else {
-                       my $ref_loc = $tag->{offset} + ($num * $LONG_SIZE);
                        $tag = $new_tag;
+
                        $tag->{ref_loc} = $ref_loc;
                        $tag->{ch} = $ch;
                }
@@ -1767,15 +1779,7 @@ Setting I<debug> mode will make all errors non-fatal, dump them out to
 STDERR, and continue on.  This is for debugging purposes only, and probably
 not what you want.  This is an optional parameter, and defaults to 0 (disabled).
 
-=item * fh
-
-Instead of passing a file path, you can instead pass a handle to an pre-opened
-filehandle.  Note: Beware of using the magick *DATA handle, as this actually 
-contains your entire Perl script, as well as the data following the __DATA__
-marker.  This will not work, because DBM::Deep uses absolute seek()s into the
-file.  Instead, consider reading *DATA into an IO::Scalar handle, then passing
-in that.  Also please note optimize() will NOT work when passing in only a
-handle.  Pass in a real filename in order to use optimize().
+B<NOTE>: This parameter is considered deprecated and should not be used anymore.
 
 =back
 
@@ -1932,7 +1936,7 @@ q.v. adjusting the interal parameters.
 
 =item * error() / clear_error()
 
-Error handling methods (may be deprecated).
+Error handling methods. These are deprecated and will be removed in 1.00.
 .
 =back
 
@@ -2324,6 +2328,9 @@ all errors are considered NON-FATAL, and dumped to STDERR.  This should only
 be used for debugging purposes and not production work. DBM::Deep expects errors
 to be thrown, not propagated back up the stack.
 
+B<NOTE>: error() and clear_error() are considered deprecated and I<will> be removed
+in 1.00. Please don't use them. Instead, wrap all your functions with in eval-blocks.
+
 =head1 LARGEFILE SUPPORT
 
 If you have a 64-bit system, and your Perl is compiled with both LARGEFILE