6 use warnings FATAL => 'all';
8 our $VERSION = q(1.0015);
12 use DBM::Deep::Engine::File ();
14 use DBM::Deep::SQL::Util;
15 use DBM::Deep::SQL::Array;
16 use DBM::Deep::SQL::Hash;
19 '""' => sub { overload::StrVal( $_[0] ) },
22 use constant DEBUG => 0;
24 sub TYPE_HASH () { DBM::Deep::Engine->SIG_HASH }
25 sub TYPE_ARRAY () { DBM::Deep::Engine->SIG_ARRAY }
27 # This is used in all the children of this class in their TIE<type> methods.
34 $proto->_throw_error( "Odd number of parameters to " . (caller(1))[2] );
39 unless ( eval { local $SIG{'__DIE__'}; %{$_[0]} || 1 } ) {
40 $proto->_throw_error( "Not a hashref in args to " . (caller(1))[2] );
45 $args = { file => shift };
51 # Class constructor method for Perl OO interface.
52 # Calls tie() and returns blessed reference to tied hash or array,
53 # providing a hybrid OO/tie interface.
56 my $args = $class->_get_args( @_ );
60 # Check for SQL storage
62 if (exists $args->{dbi}) {
64 require DBIx::Abstract;
66 DBM::Deep->_throw_error('DBIx::Abstract not installed. You cannot use the SQL mode.');
68 unless (UNIVERSAL::isa($args->{dbi}, 'DBIx::Abstract')) {
69 $args->{dbi} = DBIx::Abstract->connect($args->{dbi});
72 if (defined $args->{id}) {
73 unless ($args->{id} =~ /^\d+$/ && $args->{id} > 0) {
74 DBM::Deep->_throw_error('Invalid SQL record id');
76 my $util = {dbi => $args->{dbi}};
77 bless $util, 'DBM::Deep::SQL::Util';
78 my $q = $util->_select(
80 fields => 'item_type',
81 where => {id => $args->{id}},
83 if ($q->[0]->[0] eq 'array') {
84 $args->{type} = TYPE_ARRAY;
86 elsif ($q->[0]->[0] eq 'hash') {
87 $args->{type} = TYPE_HASH;
90 DBM::Deep->_throw_error('Unknown SQL record id');
94 my $util = {dbi => $args->{dbi}};
95 bless $util, 'DBM::Deep::SQL::Util';
96 if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
97 $args->{id} = $util->_create('array');
100 $args->{id} = $util->_create('hash');
104 if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
105 $class = 'DBM::Deep::SQL::Array';
106 require DBM::Deep::SQL::Array;
107 tie @$self, $class, %$args;
108 if ($args->{prefetch}) {
109 (tied(@$self))->_prefetch();
111 return bless $self, $class;
114 $class = 'DBM::Deep::SQL::Hash';
115 require DBM::Deep::SQL::Hash;
116 tie %$self, $class, %$args;
117 if ($args->{prefetch}) {
118 (tied(%$self))->_prefetch();
120 return bless $self, $class;
125 # Check if we want a tied hash or array.
127 if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
128 $class = 'DBM::Deep::Array';
129 require DBM::Deep::Array;
130 tie @$self, $class, %$args;
133 $class = 'DBM::Deep::Hash';
134 require DBM::Deep::Hash;
135 tie %$self, $class, %$args;
138 return bless $self, $class;
141 # This initializer is called from the various TIE* methods. new() calls tie(),
142 # which allows for a single point of entry.
147 # locking implicitly enables autoflush
148 if ($args->{locking}) { $args->{autoflush} = 1; }
150 # These are the defaults to be optionally overridden below
153 base_offset => undef,
158 $args->{engine} = DBM::Deep::Engine::File->new( { %{$args}, obj => $self } )
159 unless exists $args->{engine};
161 # Grab the parameters we want to use
162 foreach my $param ( keys %$self ) {
163 next unless exists $args->{$param};
164 $self->{$param} = $args->{$param};
168 local $SIG{'__DIE__'};
170 $self->lock_exclusive;
171 $self->_engine->setup( $self );
175 eval { local $SIG{'__DIE__'}; $self->unlock; };
184 require DBM::Deep::Hash;
185 return DBM::Deep::Hash->TIEHASH( @_ );
190 require DBM::Deep::Array;
191 return DBM::Deep::Array->TIEARRAY( @_ );
195 my $self = shift->_get_self;
196 return $self->_engine->lock_exclusive( $self, @_ );
198 *lock = \&lock_exclusive;
200 my $self = shift->_get_self;
201 return $self->_engine->lock_shared( $self, @_ );
205 my $self = shift->_get_self;
206 return $self->_engine->unlock( $self, @_ );
210 my $self = shift->_get_self;
211 my ($spot, $value) = @_;
217 my $r = Scalar::Util::reftype( $value );
219 if ( $r eq 'ARRAY' ) {
220 $tied = tied(@$value);
222 # This assumes hash or array only. This is a bad assumption moving
223 # forward. -RobK, 2008-05-27
225 $tied = tied(%$value);
228 if ( eval { local $SIG{__DIE__}; $tied->isa( 'DBM::Deep' ) } ) {
229 ${$spot} = $tied->_repr;
230 $tied->_copy_node( ${$spot} );
233 if ( $r eq 'ARRAY' ) {
234 ${$spot} = [ @{$value} ];
237 ${$spot} = { %{$value} };
241 my $c = Scalar::Util::blessed( $value );
242 if ( defined $c && !$c->isa( 'DBM::Deep') ) {
243 ${$spot} = bless ${$spot}, $c
251 # die "Must be implemented in a child class\n";
255 # die "Must be implemented in a child class\n";
259 my $self = shift->_get_self;
261 my $temp = $self->_repr;
263 $self->lock_exclusive;
264 $self->_copy_node( $temp );
267 my $classname = $self->_engine->get_classname( $self );
268 if ( defined $classname ) {
269 bless $temp, $classname;
275 sub _check_legality {
279 my $r = Scalar::Util::reftype( $val );
281 return $r if !defined $r || '' eq $r;
282 return $r if 'HASH' eq $r;
283 return $r if 'ARRAY' eq $r;
285 DBM::Deep->_throw_error(
286 "Storage of references of type '$r' is not supported."
291 return if !ref $_[0]; # Perl calls import() on use -- ignore
293 my $self = shift->_get_self;
296 my $type = $self->_check_legality( $struct );
298 DBM::Deep->_throw_error( "Cannot import a scalar" );
301 if ( substr( $type, 0, 1 ) ne $self->_type ) {
302 DBM::Deep->_throw_error(
303 "Cannot import " . ('HASH' eq $type ? 'a hash' : 'an array')
304 . " into " . ('HASH' eq $type ? 'an array' : 'a hash')
313 my $obj = 'HASH' eq Scalar::Util::reftype( $db ) ? tied(%$db) : tied(@$db);
316 my $r = $self->_check_legality( $val );
317 if ( 'HASH' eq $r ) {
318 while ( my ($k, $v) = each %$val ) {
319 my $r = $self->_check_legality( $v );
321 my $temp = 'HASH' eq $r ? {} : [];
322 if ( my $c = Scalar::Util::blessed( $v ) ) {
325 $obj->put( $k, $temp );
326 $recurse->( $temp, $v );
333 elsif ( 'ARRAY' eq $r ) {
334 foreach my $k ( 0 .. $#$val ) {
336 my $r = $self->_check_legality( $v );
338 my $temp = 'HASH' eq $r ? {} : [];
339 if ( my $c = Scalar::Util::blessed( $v ) ) {
342 $obj->put( $k, $temp );
343 $recurse->( $temp, $v );
351 $recurse->( $self, $struct );
356 #XXX Need to keep track of who has a fh to this file in order to
357 #XXX close them all prior to optimize on Win32/cygwin
358 # Rebuild entire database into new file, then move
359 # it back on top of original.
361 my $self = shift->_get_self;
363 # Optimizing is only something we need to do when we're working with our
364 # own file format. Otherwise, let the other guy do the optimizations.
365 return unless $self->_engine->isa( 'DBM::Deep::Engine::File' );
367 #XXX Need to create a new test for this
368 # if ($self->_engine->storage->{links} > 1) {
369 # $self->_throw_error("Cannot optimize: reference count is greater than 1");
372 #XXX Do we have to lock the tempfile?
374 #XXX Should we use tempfile() here instead of a hard-coded name?
375 my $temp_filename = $self->_engine->storage->{file} . '.tmp';
376 my $db_temp = DBM::Deep->new(
377 file => $temp_filename,
378 type => $self->_type,
380 # Bring over all the parameters that we need to bring over
381 ( map { $_ => $self->_engine->$_ } qw(
382 byte_size max_buckets data_sector_size num_txns
386 $self->lock_exclusive;
387 $self->_engine->clear_cache;
388 $self->_copy_node( $db_temp );
389 $db_temp->_engine->storage->close;
393 # Attempt to copy user, group and permissions over to new file
395 $self->_engine->storage->copy_stats( $temp_filename );
397 # q.v. perlport for more information on this variable
398 if ( $^O eq 'MSWin32' || $^O eq 'cygwin' ) {
400 # Potential race condition when optmizing on Win32 with locking.
401 # The Windows filesystem requires that the filehandle be closed
402 # before it is overwritten with rename(). This could be redone
406 $self->_engine->storage->close;
409 if (!rename $temp_filename, $self->_engine->storage->{file}) {
410 unlink $temp_filename;
412 $self->_throw_error("Optimize failed: Cannot copy temp file over original: $!");
416 $self->_engine->storage->close;
418 $self->_engine->storage->open;
419 $self->lock_exclusive;
420 $self->_engine->setup( $self );
428 # Make copy of object and return
430 my $self = shift->_get_self;
432 return DBM::Deep->new(
433 type => $self->_type,
434 base_offset => $self->_base_offset,
435 staleness => $self->_staleness,
436 engine => $self->_engine,
440 #XXX Migrate this to the engine, where it really belongs and go through some
441 # API - stop poking in the innards of someone else..
443 my %is_legal_filter = map {
446 store_key store_value
447 fetch_key fetch_value
451 my $self = shift->_get_self;
455 if ( $is_legal_filter{$type} ) {
456 $self->_engine->storage->{"filter_$type"} = $func;
463 sub filter_store_key { $_[0]->set_filter( store_key => $_[1] ); }
464 sub filter_store_value { $_[0]->set_filter( store_value => $_[1] ); }
465 sub filter_fetch_key { $_[0]->set_filter( fetch_key => $_[1] ); }
466 sub filter_fetch_value { $_[0]->set_filter( fetch_value => $_[1] ); }
470 my $self = shift->_get_self;
471 $self->lock_exclusive;
472 my $rv = eval { $self->_engine->begin_work( $self, @_ ) };
480 my $self = shift->_get_self;
481 $self->lock_exclusive;
482 my $rv = eval { $self->_engine->rollback( $self, @_ ) };
490 my $self = shift->_get_self;
491 $self->lock_exclusive;
492 my $rv = eval { $self->_engine->commit( $self, @_ ) };
501 my $self = $_[0]->_get_self;
502 return $self->{engine};
506 my $self = $_[0]->_get_self;
507 return $self->{type};
511 my $self = $_[0]->_get_self;
512 return $self->{base_offset};
516 my $self = $_[0]->_get_self;
517 return $self->{staleness};
524 my @caller = caller( ++$n );
525 next if $caller[0] =~ m/^DBM::Deep/;
527 die "DBM::Deep: $_[1] at $0 line $caller[2]\n";
531 # Store single hash key/value or array element in database.
533 my $self = shift->_get_self;
534 my ($key, $value) = @_;
535 warn "STORE($self, '$key', '@{[defined$value?$value:'undef']}')\n" if DEBUG;
537 unless ( $self->_engine->storage->is_writable ) {
538 $self->_throw_error( 'Cannot write to a readonly filehandle' );
541 $self->lock_exclusive;
543 # User may be storing a complex value, in which case we do not want it run
544 # through the filtering system.
545 if ( !ref($value) && $self->_engine->storage->{filter_store_value} ) {
546 $value = $self->_engine->storage->{filter_store_value}->( $value );
549 $self->_engine->write_value( $self, $key, $value);
556 # Fetch single value or element given plain key or array index
558 my $self = shift->_get_self;
560 warn "FETCH($self, '$key')\n" if DEBUG;
564 my $result = $self->_engine->read_value( $self, $key);
568 # Filters only apply to scalar values, so the ref check is making
569 # sure the fetched bucket is a scalar, not a child hash or array.
570 return ($result && !ref($result) && $self->_engine->storage->{filter_fetch_value})
571 ? $self->_engine->storage->{filter_fetch_value}->($result)
575 # Delete single key/value pair or element given plain key or array index
577 my $self = shift->_get_self;
579 warn "DELETE($self, '$key')\n" if DEBUG;
581 unless ( $self->_engine->storage->is_writable ) {
582 $self->_throw_error( 'Cannot write to a readonly filehandle' );
585 $self->lock_exclusive;
590 my $value = $self->_engine->delete_key( $self, $key);
592 if (defined $value && !ref($value) && $self->_engine->storage->{filter_fetch_value}) {
593 $value = $self->_engine->storage->{filter_fetch_value}->($value);
601 # Check if a single key or element exists given plain key or array index
603 my $self = shift->_get_self;
605 warn "EXISTS($self, '$key')\n" if DEBUG;
609 my $result = $self->_engine->key_exists( $self, $key );
616 # Clear all keys from hash, or all elements from array.
618 my $self = shift->_get_self;
619 warn "CLEAR($self)\n" if DEBUG;
621 unless ( $self->_engine->storage->is_writable ) {
622 $self->_throw_error( 'Cannot write to a readonly filehandle' );
625 $self->lock_exclusive;
627 #XXX Rewrite this dreck to do it in the engine as a tight loop vs.
628 # iterating over keys - such a WASTE - is this required for transactional
629 # clearning?! Surely that can be detected in the engine ...
630 if ( $self->_type eq TYPE_HASH ) {
631 my $key = $self->first_key;
633 # Retrieve the key before deleting because we depend on next_key
634 my $next_key = $self->next_key( $key );
635 $self->_engine->delete_key( $self, $key, $key );
640 my $size = $self->FETCHSIZE;
641 for my $key ( 0 .. $size - 1 ) {
642 $self->_engine->delete_key( $self, $key, $key );
644 $self->STORESIZE( 0 );
652 # Public method aliases
653 sub put { (shift)->STORE( @_ ) }
654 sub get { (shift)->FETCH( @_ ) }
655 sub store { (shift)->STORE( @_ ) }
656 sub fetch { (shift)->FETCH( @_ ) }
657 sub delete { (shift)->DELETE( @_ ) }
658 sub exists { (shift)->EXISTS( @_ ) }
659 sub clear { (shift)->CLEAR( @_ ) }
661 sub _dump_file {shift->_get_self->_engine->_dump_file;}