1 |
################################# |
## ------------------------------------------------------------------------ |
2 |
# |
## $Id$ |
3 |
# $Id$ |
## ------------------------------------------------------------------------ |
4 |
# |
## $Log$ |
5 |
# $Log$ |
## Revision 1.13 2003/01/30 22:27:05 joko |
6 |
# Revision 1.4 2002/12/01 04:45:38 joko |
## + added new abstract methods |
7 |
# + sub eraseAll |
## |
8 |
# + sub createDb |
## Revision 1.12 2003/01/30 21:46:32 joko |
9 |
# |
## + fixed behaviour of AUTOLOAD-method |
10 |
# Revision 1.3 2002/11/29 04:58:20 joko |
## |
11 |
# + Storage::Result now uses the same dispatching mechanism like Storage::Handler |
## Revision 1.11 2003/01/20 16:43:18 joko |
12 |
# |
## + better argument-property merging |
13 |
# Revision 1.2 2002/10/17 00:08:07 joko |
## + debugging-output !!! |
14 |
# + bugfixes regarding "deep recursion" stuff |
## + abstract-dummy 'sub createChildNode' |
15 |
# |
## |
16 |
# Revision 1.1 2002/10/10 03:44:07 cvsjoko |
## Revision 1.10 2003/01/19 02:31:51 joko |
17 |
# + new |
## + fix to 'sub AUTOLOAD' |
18 |
# |
## |
19 |
# |
## Revision 1.9 2002/12/19 16:30:23 joko |
20 |
################################# |
## + added 'sub dropDb' and 'sub rebuildDb' as croakers for concrete implementations of methods in proper handlers |
21 |
|
## |
22 |
|
## Revision 1.8 2002/12/13 21:48:35 joko |
23 |
|
## + sub _abstract_function |
24 |
|
## |
25 |
|
## Revision 1.7 2002/12/05 07:57:48 joko |
26 |
|
## + now using Tie::SecureHash as a base for the COREHANDLE |
27 |
|
## + former public COREHANDLE becomes private _COREHANDLE now |
28 |
|
## |
29 |
|
## Revision 1.6 2002/12/03 15:52:24 joko |
30 |
|
## + fix/feature: if dispatching to deep core method fails (is not declared), try method at Data::Storage - level |
31 |
|
## |
32 |
|
## Revision 1.5 2002/12/01 22:19:33 joko |
33 |
|
## + just disconnect if COREHANDLE exists |
34 |
|
## |
35 |
|
## Revision 1.4 2002/12/01 04:45:38 joko |
36 |
|
## + sub eraseAll |
37 |
|
## + sub createDb |
38 |
|
## |
39 |
|
## Revision 1.3 2002/11/29 04:58:20 joko |
40 |
|
## + Storage::Result now uses the same dispatching mechanism like Storage::Handler |
41 |
|
## |
42 |
|
## Revision 1.2 2002/10/17 00:08:07 joko |
43 |
|
## + bugfixes regarding "deep recursion" stuff |
44 |
|
## |
45 |
|
## Revision 1.1 2002/10/10 03:44:07 cvsjoko |
46 |
|
## + new |
47 |
|
## ------------------------------------------------------------------------ |
48 |
|
|
49 |
|
|
50 |
package Data::Storage::Handler::Abstract; |
package Data::Storage::Handler::Abstract; |
51 |
|
|
52 |
use strict; |
use strict; |
53 |
use warnings; |
use warnings; |
54 |
|
|
55 |
|
use base qw( DesignPattern::Object ); |
56 |
|
|
57 |
|
|
58 |
use Data::Dumper; |
use Data::Dumper; |
59 |
|
use Tie::SecureHash; |
60 |
|
#use Data::Storage::Handler; |
61 |
|
use Data::Transform::Deep qw( merge ); |
62 |
|
|
63 |
|
|
64 |
# get logger instance |
# get logger instance |
65 |
my $logger = Log::Dispatch::Config->instance; |
my $logger = Log::Dispatch::Config->instance; |
74 |
$logger->debug( "$invocant->new( @_ )" ); |
$logger->debug( "$invocant->new( @_ )" ); |
75 |
#$logger->debug( __PACKAGE__ . "->" . "new()" ); |
#$logger->debug( __PACKAGE__ . "->" . "new()" ); |
76 |
|
|
77 |
# arguments become properties |
# V1 - arguments become properties automagically / normal perl mode blessing |
78 |
|
=pod |
79 |
|
# autovivify passed-in arguments as future object attributes into to-be-blessed hash |
80 |
my $self = { @_ }; |
my $self = { @_ }; |
81 |
# create object from blessed hash-reference |
# create object from blessed hash-reference |
82 |
bless $self, $class; |
bless $self, $class; |
83 |
|
=cut |
84 |
|
|
85 |
|
#=pod |
86 |
|
# V2 - maybe more convenient/secure? utilizing Damian Conway's Tie::SecureHash... |
87 |
|
my $self = Tie::SecureHash->new( |
88 |
|
$class, |
89 |
|
# that's it: |
90 |
|
'metainfo' => undef, |
91 |
|
'lock_info' => undef, |
92 |
|
'_COREHANDLE' => undef, |
93 |
|
'meta' => undef, |
94 |
|
'locator' => undef, |
95 |
|
'dataStorageLayer' => undef, |
96 |
|
'dbi' => undef, |
97 |
|
# tries: |
98 |
|
#'Data::Storage::Handler::Abstract::metainfo' => undef, |
99 |
|
#'dataStorageLayer' |
100 |
|
#'Data::Storage::Handler::Abstract::dataStorageLayer' => undef, |
101 |
|
#'Data::Storage::Handler::Tangram::dataStorageLayer' => undef, |
102 |
|
#'Data::Dumper::locator' => undef, |
103 |
|
#$class . '::locator' => undef, |
104 |
|
#'Data::Storage::Handler::Tangram::locator' => undef, |
105 |
|
#'Data::Storage::Handler::DBI::locator' => undef, |
106 |
|
#_protected => , |
107 |
|
#__private => , |
108 |
|
); |
109 |
|
#=cut |
110 |
|
|
111 |
|
# merge passed-in arguments to constructor as properties into already blessed secure object |
112 |
|
|
113 |
|
# mungle arguments from array into hash - perl does the job ;) |
114 |
|
#my %args = @_; |
115 |
|
#my %args = (); |
116 |
|
|
117 |
|
#print Dumper(@_); |
118 |
|
|
119 |
|
# merge attributes one-by-one |
120 |
|
# TODO: deep_copy? / merge_deep? |
121 |
|
while (my $elemName = shift @_) { |
122 |
|
#print "elemName: $elemName", "\n"; |
123 |
|
if (my $elemValue = shift @_) { |
124 |
|
#print Dumper($elemValue); |
125 |
|
#print "elemName=$elemName, elemValue=$elemValue", "\n"; |
126 |
|
$self->{$elemName} = $elemValue; |
127 |
|
} |
128 |
|
#$self->{$_} = $args{$_}; |
129 |
|
#$self->{$_} = $args{$_}; |
130 |
|
} |
131 |
|
|
132 |
|
# V3 - rolling our own security (just for {COREHANDLE} - nothing else) - nope, Tie::SecureHash works wonderful |
133 |
|
#my $self = { @_ }; |
134 |
|
#bless $self, $class; |
135 |
|
|
136 |
|
|
137 |
|
|
138 |
# handle meta data |
# handle meta data |
139 |
#my $metainfo = $self->getMetaInfo($class); |
#my $metainfo = $self->getMetaInfo($class); |
150 |
} |
} |
151 |
|
|
152 |
|
|
153 |
|
# TODO: use NEXT.pm inside this mechanism (to avoid repetitions...) |
154 |
sub AUTOLOAD { |
sub AUTOLOAD { |
155 |
|
|
156 |
# recursion problem to be avoided here!!! |
# recursion problem to be avoided here!!! |
172 |
# find out methodname |
# find out methodname |
173 |
my $methodname = $AUTOLOAD; |
my $methodname = $AUTOLOAD; |
174 |
$methodname =~ s/^.*:://; |
$methodname =~ s/^.*:://; |
175 |
|
|
176 |
|
#print "method: $methodname", "\n"; |
177 |
|
|
178 |
|
# TODO: document this! handler-private methods listed here will not be triggered (internal use) |
179 |
|
# in this case, "exists" is a method reserved for Tie::SecureHash, |
180 |
|
# which encapsulates the perl data structure (HASH) under this object |
181 |
|
# this is to prevent deep recursion's |
182 |
|
return if lc $methodname eq 'exists'; |
183 |
|
|
184 |
|
#print "$methodname - 1", "\n"; |
185 |
|
|
186 |
|
# TODO: enhance logging/debugging |
187 |
|
#if (!$self->exists('COREHANDLE')) { return; } |
188 |
|
|
189 |
# handle locking (hack) |
# handle locking (hack) |
190 |
if ($self->{lock_info}->{last_method} && $methodname eq $self->{lock_info}->{last_method}) { |
if ($self->can('exists') && $self->exists('lock_info') && $self->{lock_info}->{last_method} && $methodname eq $self->{lock_info}->{last_method}) { |
191 |
$self->{lock_info}->{log_lock} = 1; |
$self->{lock_info}->{log_lock} = 1; |
192 |
} else { |
} else { |
193 |
$self->{lock_info}->{log_lock} = 0; |
$self->{lock_info}->{log_lock} = 0; |
194 |
} |
} |
195 |
$self->{lock_info}->{last_method} = $methodname; |
$self->{lock_info}->{last_method} = $methodname; |
196 |
|
|
197 |
|
#print "$methodname - 2", "\n"; |
198 |
|
|
199 |
|
#print Dumper($self); |
200 |
|
#exit; |
201 |
|
|
202 |
|
# get corehandle instance from underlying handler |
203 |
|
my $core = $self->getCOREHANDLE(); |
204 |
|
|
205 |
# test for COREHANDLE |
# test for COREHANDLE |
206 |
if (!$self->{COREHANDLE}) { |
#if (!$self->{_COREHANDLE}) { |
207 |
#print "no COREHANDLE", "\n"; |
#=pod |
208 |
if (!$self->{lock_info}->{log_lock}) { |
#if (!$self->exists('_COREHANDLE')) { |
209 |
$logger->error( __PACKAGE__ . "[$self->{metainfo}->{type}]" . ": " . "COREHANDLE is undefined while trying to execute method \"$methodname\"" ); |
#if (!$self->{_COREHANDLE}) { |
210 |
} |
if (!$core) { |
211 |
|
|
212 |
|
#print Dumper($self); |
213 |
|
#exit; |
214 |
|
|
215 |
|
my $handlertype = $self->{metainfo}->{type}; |
216 |
|
$handlertype ||= ''; |
217 |
|
|
218 |
|
my $err_msg_core = __PACKAGE__ . "[$handlertype]" . ": " . "COREHANDLE is undefined while trying to execute method \"$methodname\""; |
219 |
|
|
220 |
|
#print $err_msg_core, "\n"; |
221 |
|
|
222 |
|
#if ($self->exists('lock_info') && !$self->{lock_info}->{log_lock}) { |
223 |
|
$logger->error( $err_msg_core ); |
224 |
|
#} |
225 |
|
|
226 |
return; |
return; |
227 |
|
|
228 |
} |
} |
229 |
|
#=cut |
230 |
|
|
231 |
|
#print "$methodname - 3", "\n"; |
232 |
|
|
233 |
# try to dispatch method-call to Storage::Handler::* |
# try to dispatch method-call to Storage::Handler::* |
234 |
#if ($self->can($methodname)) { |
#if ($self->can($methodname)) { |
237 |
#if ($res) { return $res; } |
#if ($res) { return $res; } |
238 |
#} |
#} |
239 |
|
|
240 |
|
#print "$methodname - 4", "\n"; |
241 |
|
|
242 |
# try to dispatch method-call to COREHANDLE |
# try to dispatch method-call to COREHANDLE |
243 |
if ($self->{COREHANDLE}->can($methodname) || $self->{COREHANDLE}->can("AUTOLOAD")) { |
# was: |
244 |
|
#my $core = $self->{_COREHANDLE}; |
245 |
|
# is: |
246 |
|
#my $core = $self->getCOREHANDLE(); |
247 |
|
|
248 |
|
#print Dumper($core); |
249 |
|
#exit; |
250 |
|
|
251 |
|
# was: |
252 |
|
#if ($self->{_COREHANDLE}->can($methodname) || $self->{_COREHANDLE}->can("AUTOLOAD")) { |
253 |
|
# is: |
254 |
|
if ($core->can($methodname) || $core->can("AUTOLOAD")) { |
255 |
#$logger->debug( __PACKAGE__ . "->" . $methodname . " (AUTOLOAD)" ); |
#$logger->debug( __PACKAGE__ . "->" . $methodname . " (AUTOLOAD)" ); |
256 |
#$lock_AUTOLOAD = 1 if ($methodname eq 'insert'); |
#$lock_AUTOLOAD = 1 if ($methodname eq 'insert'); |
257 |
if (!$self->{lock_info}->{log_lock}) { |
if (!$self->{lock_info}->{log_lock}) { |
263 |
#$lock_AUTOLOAD = 0; |
#$lock_AUTOLOAD = 0; |
264 |
#$logger->log( level => 'debug', message => __PACKAGE__ . "->" . $methodname . " (AUTOLOAD)" ); |
#$logger->log( level => 'debug', message => __PACKAGE__ . "->" . $methodname . " (AUTOLOAD)" ); |
265 |
|
|
266 |
# method calls doing it until here will get dispatched to the proper handler |
#print "calling: $methodname", "\n"; |
267 |
return $self->{COREHANDLE}->$methodname(@_); |
|
268 |
|
# method calls making it until here will get dispatched to the proper handler |
269 |
|
return $core->$methodname(@_); |
270 |
|
|
271 |
|
} elsif ($self->can($methodname)) { |
272 |
|
# try to call specified method inside our or inherited module(s) scope(s) |
273 |
|
return $self->$methodname(@_); |
274 |
} |
} |
275 |
|
|
276 |
} |
} |
277 |
|
|
278 |
sub DESTROY { |
sub DESTROY { |
279 |
my $self = shift; |
my $self = shift; |
280 |
if ($self->{COREHANDLE}) { |
#if ($self->{COREHANDLE}) { |
281 |
|
if ($self->exists('_COREHANDLE')) { |
282 |
$logger->debug( __PACKAGE__ . "[$self->{metainfo}->{type}]" . "->DESTROY" ); |
$logger->debug( __PACKAGE__ . "[$self->{metainfo}->{type}]" . "->DESTROY" ); |
283 |
|
|
284 |
my $disconnectMethod = $self->{metainfo}->{disconnectMethod}; |
my $disconnectMethod = $self->{metainfo}->{disconnectMethod}; |
285 |
|
|
286 |
# call "disconnect" or alike on COREHANDLE |
# call "disconnect" or alike on COREHANDLE |
287 |
# was: $self->{COREHANDLE}->disconnect(); |
# was: $self->{COREHANDLE}->disconnect(); |
288 |
$disconnectMethod && ( $self->{COREHANDLE}->$disconnectMethod() ); |
$disconnectMethod && $self->{_COREHANDLE} && ( $self->{_COREHANDLE}->$disconnectMethod() ); |
289 |
|
|
290 |
undef $self->{COREHANDLE}; |
undef $self->{_COREHANDLE}; |
291 |
} |
} |
292 |
} |
} |
293 |
|
|
294 |
|
sub _typeCheck2 { |
|
sub _abstract_function { |
|
|
my $self = shift; |
|
|
my $fName = shift; |
|
|
my $class = ref($self); |
|
|
$logger->error( __PACKAGE__ . ": function \"$fName\" is an abstract method, please implement it in \"$class\""); |
|
|
#exit; |
|
|
} |
|
|
|
|
|
sub _typeCheck { |
|
295 |
my $type = shift; |
my $type = shift; |
296 |
print "type: $type"; |
print "type: $type"; |
297 |
eval("use Data::Storage::$type;"); |
eval("use Data::Storage::$type;"); |
306 |
my $self = shift; |
my $self = shift; |
307 |
my $nodename = shift; |
my $nodename = shift; |
308 |
#$nodename = 'TransactionRoutingTable'; |
#$nodename = 'TransactionRoutingTable'; |
309 |
$logger->debug( __PACKAGE__ . "->getChildNode( nodename $nodename )" ); |
$logger->debug( __PACKAGE__ . "->existsChildNode( nodename $nodename )" ); |
310 |
$self->getChildNodes() unless $self->{meta}->{childnodes}; |
$self->getChildNodes() unless $self->{meta}->{childnodes}; |
311 |
my $result = grep(m/$nodename/i, @{$self->{meta}->{childnodes}}); # TODO: use "/i" only on win32-systems! |
my $result = grep(m/$nodename/i, @{$self->{meta}->{childnodes}}); # TODO: use "/i" only on win32-systems! |
312 |
return $result; |
return $result; |
333 |
# - build them via anonymous subs |
# - build them via anonymous subs |
334 |
# - introduce them via symbols |
# - introduce them via symbols |
335 |
|
|
336 |
|
sub getCOREHANDLE { |
337 |
|
my $self = shift; |
338 |
|
$self->_abstract_function('getCOREHANDLE'); |
339 |
|
} |
340 |
|
|
341 |
sub sendCommand { |
sub sendCommand { |
342 |
my $self = shift; |
my $self = shift; |
343 |
$self->_abstract_function('sendCommand'); |
$self->_abstract_function('sendCommand'); |
344 |
} |
} |
345 |
|
|
346 |
|
sub createChildNode { |
347 |
|
my $self = shift; |
348 |
|
$self->_abstract_function('createChildNode'); |
349 |
|
} |
350 |
|
|
351 |
|
sub existsChildNode_tmp { |
352 |
|
my $self = shift; |
353 |
|
$self->_abstract_function('existsChildNode'); |
354 |
|
} |
355 |
|
|
356 |
sub getChildNodes { |
sub getChildNodes { |
357 |
my $self = shift; |
my $self = shift; |
358 |
$self->_abstract_function('getChildNodes'); |
$self->_abstract_function('getChildNodes'); |
417 |
return; |
return; |
418 |
} |
} |
419 |
|
|
420 |
|
sub dropDb { |
421 |
|
my $self = shift; |
422 |
|
$self->_abstract_function('dropDb'); |
423 |
|
return; |
424 |
|
} |
425 |
|
|
426 |
|
sub rebuildDb { |
427 |
|
my $self = shift; |
428 |
|
$self->_abstract_function('rebuildDb'); |
429 |
|
return; |
430 |
|
} |
431 |
|
|
432 |
|
sub getDbName { |
433 |
|
my $self = shift; |
434 |
|
$self->_abstract_function('getDbName'); |
435 |
|
return; |
436 |
|
} |
437 |
|
|
438 |
|
sub testAvailability { |
439 |
|
my $self = shift; |
440 |
|
$self->_abstract_function('testAvailability'); |
441 |
|
return; |
442 |
|
} |
443 |
|
|
444 |
|
sub isConnected { |
445 |
|
my $self = shift; |
446 |
|
$self->_abstract_function('isConnected'); |
447 |
|
return; |
448 |
|
} |
449 |
|
|
450 |
|
sub testDsn { |
451 |
|
my $self = shift; |
452 |
|
$self->_abstract_function('testDsn'); |
453 |
|
return; |
454 |
|
} |
455 |
|
|
456 |
1; |
1; |