/[cvs]/nfo/perl/libs/Data/Storage/Handler/Abstract.pm
ViewVC logotype

Diff of /nfo/perl/libs/Data/Storage/Handler/Abstract.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.4 by joko, Sun Dec 1 04:45:38 2002 UTC revision 1.18 by joko, Fri Jun 6 03:40:57 2003 UTC
# Line 1  Line 1 
1  #################################  ##    ------------------------------------------------------------------------
2  #  ##    $Id$
3  #  $Id$  ##    ------------------------------------------------------------------------
4  #  ##    $Log$
5  #  $Log$  ##    Revision 1.18  2003/06/06 03:40:57  joko
6  #  Revision 1.4  2002/12/01 04:45:38  joko  ##    disabled autovivifying of arguments as attributes
7  #  + sub eraseAll  ##
8  #  + sub createDb  ##    Revision 1.17  2003/05/13 07:58:49  joko
9  #  ##    fix: die if methodname is empty
10  #  Revision 1.3  2002/11/29 04:58:20  joko  ##    fixes to log-string
11  #  + Storage::Result now uses the same dispatching mechanism like Storage::Handler  ##
12  #  ##    Revision 1.16  2003/04/18 16:07:53  joko
13  #  Revision 1.2  2002/10/17 00:08:07  joko  ##    just use logger if instantiation successed
14  #  + bugfixes regarding "deep recursion" stuff  ##
15  #  ##    Revision 1.15  2003/02/20 20:19:13  joko
16  #  Revision 1.1  2002/10/10 03:44:07  cvsjoko  ##    tried to get auto-disconnect working again - failed with that
17  #  + new  ##
18  #  ##    Revision 1.14  2003/02/09 05:12:28  joko
19  #  ##    + quoting of strings used in sql-queries!
20  #################################  ##
21    ##    Revision 1.13  2003/01/30 22:27:05  joko
22    ##    + added new abstract methods
23    ##
24    ##    Revision 1.12  2003/01/30 21:46:32  joko
25    ##    + fixed behaviour of AUTOLOAD-method
26    ##
27    ##    Revision 1.11  2003/01/20 16:43:18  joko
28    ##    + better argument-property merging
29    ##    + debugging-output !!!
30    ##    + abstract-dummy 'sub createChildNode'
31    ##
32    ##    Revision 1.10  2003/01/19 02:31:51  joko
33    ##    + fix to 'sub AUTOLOAD'
34    ##
35    ##    Revision 1.9  2002/12/19 16:30:23  joko
36    ##    + added 'sub dropDb' and 'sub rebuildDb' as croakers for concrete implementations of methods in proper handlers
37    ##
38    ##    Revision 1.8  2002/12/13 21:48:35  joko
39    ##    + sub _abstract_function
40    ##
41    ##    Revision 1.7  2002/12/05 07:57:48  joko
42    ##    + now using Tie::SecureHash as a base for the COREHANDLE
43    ##    + former public COREHANDLE becomes private _COREHANDLE now
44    ##
45    ##    Revision 1.6  2002/12/03 15:52:24  joko
46    ##    + fix/feature: if dispatching to deep core method fails (is not declared), try method at Data::Storage - level
47    ##
48    ##    Revision 1.5  2002/12/01 22:19:33  joko
49    ##    + just disconnect if COREHANDLE exists
50    ##
51    ##    Revision 1.4  2002/12/01 04:45:38  joko
52    ##    + sub eraseAll
53    ##    + sub createDb
54    ##
55    ##    Revision 1.3  2002/11/29 04:58:20  joko
56    ##    + Storage::Result now uses the same dispatching mechanism like Storage::Handler
57    ##
58    ##    Revision 1.2  2002/10/17 00:08:07  joko
59    ##    + bugfixes regarding "deep recursion" stuff
60    ##
61    ##    Revision 1.1  2002/10/10 03:44:07  cvsjoko
62    ##    + new
63    ##    ------------------------------------------------------------------------
64    
65    
66  package Data::Storage::Handler::Abstract;  package Data::Storage::Handler::Abstract;
67    
68  use strict;  use strict;
69  use warnings;  use warnings;
70    
71    use base qw( DesignPattern::Object );
72    
73    
74  use Data::Dumper;  use Data::Dumper;
75    use Tie::SecureHash;
76    #use Data::Storage::Handler;
77    use Hash::Merge qw( merge );
78    
79    #use Log::Dispatch::Config;
80    #Log::Dispatch::Config->configure();
81    
82  # get logger instance  # get logger instance
83  my $logger = Log::Dispatch::Config->instance;  my $logger;
84    eval('$logger = Log::Dispatch::Config->instance;');
85    
86  #our $lock_info;  #our $lock_info;
87    
# Line 36  sub new { Line 90  sub new {
90    my $class = ref($invocant) || $invocant;    my $class = ref($invocant) || $invocant;
91        
92    # logging info about the actual handler called    # logging info about the actual handler called
93      $logger->debug( "$invocant->new( @_ )" );      $logger->debug( "$invocant->new( @_ )" ) if $logger;
94      #$logger->debug( __PACKAGE__ . "->" . "new()" );      #$logger->debug( __PACKAGE__ . "->" . "new()" );
95    
96    # arguments become properties    # V1 - arguments become properties automagically / normal perl mode blessing
97    =pod
98      # autovivify passed-in arguments as future object attributes into to-be-blessed hash
99    my $self = { @_ };    my $self = { @_ };
100    # create object from blessed hash-reference    # create object from blessed hash-reference
101    bless $self, $class;    bless $self, $class;
102    =cut
103    
104    #=pod
105      # V2 - maybe more convenient/secure? utilizing Damian Conway's Tie::SecureHash...
106      my $self = Tie::SecureHash->new(
107        $class,
108        # that's it:
109          'metainfo' => undef,
110          'lock_info' => undef,
111          '_COREHANDLE' => undef,
112          'meta' => undef,
113          'locator' => undef,
114          'dataStorageLayer' => undef,
115          'dbi' => undef,
116        # tries:
117          #'Data::Storage::Handler::Abstract::metainfo' => undef,
118          #'dataStorageLayer'
119          #'Data::Storage::Handler::Abstract::dataStorageLayer' => undef,
120          #'Data::Storage::Handler::Tangram::dataStorageLayer' => undef,
121          #'Data::Dumper::locator' => undef,
122          #$class . '::locator' => undef,
123          #'Data::Storage::Handler::Tangram::locator' => undef,
124          #'Data::Storage::Handler::DBI::locator' => undef,
125          #_protected => ,
126          #__private => ,
127      );
128    #=cut
129    
130      # merge passed-in arguments to constructor as properties into already blessed secure object
131    
132        # mungle arguments from array into hash - perl does the job  ;)
133        #my %args = @_;
134        #my %args = ();
135    
136    #print Dumper(@_);
137    
138        # merge attributes one-by-one
139        # TODO: deep_copy? / merge_deep?
140        while (my $elemName = shift @_) {
141          #print "elemName: $elemName", "\n";
142          if (my $elemValue = shift @_) {
143            #print Dumper($elemValue);
144            #print "elemName=$elemName, elemValue=$elemValue", "\n";
145            $self->{$elemName} = $elemValue;
146          }
147          #$self->{$_} = $args{$_};
148          #$self->{$_} = $args{$_};
149        }
150      
151      # V3 - rolling our own security (just for {COREHANDLE} - nothing else)  -  nope, Tie::SecureHash works wonderful
152      #my $self = { @_ };
153      #bless $self, $class;
154      
155      
156    
157    # handle meta data    # handle meta data
158      #my $metainfo = $self->getMetaInfo($class);      #my $metainfo = $self->getMetaInfo($class);
# Line 59  sub new { Line 169  sub new {
169  }  }
170    
171    
172    # TODO: use NEXT.pm inside this mechanism (to avoid repetitions...)
173  sub AUTOLOAD {  sub AUTOLOAD {
174    
175    # recursion problem to be avoided here!!!    # recursion problem to be avoided here!!!
# Line 80  sub AUTOLOAD { Line 191  sub AUTOLOAD {
191    # find out methodname    # find out methodname
192    my $methodname = $AUTOLOAD;    my $methodname = $AUTOLOAD;
193    $methodname =~ s/^.*:://;    $methodname =~ s/^.*:://;
194      
195    #print "method: $methodname", "\n";
196      
197      # TODO: document this! handler-private methods listed here will not be triggered (internal use)
198      # in this case, "exists" is a method reserved for Tie::SecureHash,
199      # which encapsulates the perl data structure (HASH) under this object
200      # this is to prevent deep recursion's
201      return if lc $methodname eq 'exists';
202    
203    #print "$methodname - 1", "\n";
204    
205      # TODO: enhance logging/debugging
206      #if (!$self->exists('COREHANDLE')) { return; }
207    
208    # handle locking (hack)    # handle locking (hack)
209    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}) {
210      $self->{lock_info}->{log_lock} = 1;      $self->{lock_info}->{log_lock} = 1;
211    } else {    } else {
212      $self->{lock_info}->{log_lock} = 0;      $self->{lock_info}->{log_lock} = 0;
213    }    }
214    $self->{lock_info}->{last_method} = $methodname;    $self->{lock_info}->{last_method} = $methodname;
215        
216    #print "$methodname - 2", "\n";
217    
218    #print Dumper($self);
219    #exit;
220    
221      # get corehandle instance from underlying handler
222      my $core = $self->getCOREHANDLE();
223    
224    # test for COREHANDLE    # test for COREHANDLE
225    if (!$self->{COREHANDLE}) {    #if (!$self->{_COREHANDLE}) {
226      #print "no COREHANDLE", "\n";  #=pod
227      if (!$self->{lock_info}->{log_lock}) {    #if (!$self->exists('_COREHANDLE')) {
228        $logger->error( __PACKAGE__ . "[$self->{metainfo}->{type}]" . ": " . "COREHANDLE is undefined while trying to execute method \"$methodname\"" );    #if (!$self->{_COREHANDLE}) {
229      }    if (!$core) {
230    
231    #print Dumper($self);    
232    #exit;
233    
234        my $handlertype = $self->{metainfo}->{type};
235        $handlertype ||= '';
236    
237        my $err_msg_core = __PACKAGE__ . "[$handlertype]" . ": " . "COREHANDLE is undefined while trying to execute method \"$methodname\"";
238    
239    #print $err_msg_core, "\n";
240    
241        #if ($self->exists('lock_info') && !$self->{lock_info}->{log_lock}) {
242          $logger->error( $err_msg_core );
243        #}
244    
245        return;
246        
247      }
248    #=cut
249    
250    =pod
251      if (!$methodname) {
252        die("Methodname is not defined!");
253      return;      return;
254    }    }
255    =cut
256    
257    #print "$methodname - 3", "\n";
258    
259    # try to dispatch method-call to Storage::Handler::*    # try to dispatch method-call to Storage::Handler::*
260    #if ($self->can($methodname)) {    #if ($self->can($methodname)) {
# Line 105  sub AUTOLOAD { Line 263  sub AUTOLOAD {
263      #if ($res) { return $res; }      #if ($res) { return $res; }
264    #}    #}
265    
266    #print "$methodname - 4", "\n";
267    
268    # try to dispatch method-call to COREHANDLE    # try to dispatch method-call to COREHANDLE
269    if ($self->{COREHANDLE}->can($methodname) || $self->{COREHANDLE}->can("AUTOLOAD")) {    # was:
270      #my $core = $self->{_COREHANDLE};
271      # is:
272      #my $core = $self->getCOREHANDLE();
273    
274    #print Dumper($core);
275    #exit;
276    
277      # was:
278      #if ($self->{_COREHANDLE}->can($methodname) || $self->{_COREHANDLE}->can("AUTOLOAD")) {
279      # is:
280      if ($core->can($methodname) || $core->can("AUTOLOAD")) {
281      #$logger->debug( __PACKAGE__ . "->" . $methodname . " (AUTOLOAD)" );      #$logger->debug( __PACKAGE__ . "->" . $methodname . " (AUTOLOAD)" );
282      #$lock_AUTOLOAD = 1 if ($methodname eq 'insert');      #$lock_AUTOLOAD = 1 if ($methodname eq 'insert');
283      if (!$self->{lock_info}->{log_lock}) {      if (!$self->{lock_info}->{log_lock}) {
284        #print "method: $methodname", "\n";        #print "method: $methodname", "\n";
285        $logger->debug( __PACKAGE__ . "[$self->{metainfo}->{type}]" . "->" . $methodname . "(@_)" );        my $type = $self->{metainfo}->{type};
286          $type ||= '';
287          # FIXME!
288          #$logger->debug( __PACKAGE__ . "[$type]" . "->" . $methodname . "(@_)" );
289          $logger->debug( __PACKAGE__ . "[$type]" . "->" . $methodname );
290      } else {      } else {
291        # AUTOLOAD - sub is locked to prevent deep recursions if (e.g.) db-inserts cause log-actions to same db itself        # AUTOLOAD - sub is locked to prevent deep recursions if (e.g.) db-inserts cause log-actions to same db itself
292      }      }
293      #$lock_AUTOLOAD = 0;      #$lock_AUTOLOAD = 0;
294      #$logger->log( level => 'debug', message => __PACKAGE__ . "->" . $methodname . " (AUTOLOAD)" );      #$logger->log( level => 'debug', message => __PACKAGE__ . "->" . $methodname . " (AUTOLOAD)" );
295            
296      # method calls doing it until here will get dispatched to the proper handler  #print "calling: $methodname", "\n";
297      return $self->{COREHANDLE}->$methodname(@_);      
298        # method calls making it until here will get dispatched to the proper handler
299        return $core->$methodname(@_);
300      
301      } elsif ($self->can($methodname)) {
302        # try to call specified method inside our or inherited module(s) scope(s)
303        return $self->$methodname(@_);
304    }    }
305    
306  }  }
307    
308  sub DESTROY {  sub DESTROY {
309    my $self = shift;    my $self = shift;
310    if ($self->{COREHANDLE}) {  
311    return;
312    
313      $logger->debug( __PACKAGE__ . "[$self->{metainfo}->{type}]" . "->DESTROY" );
314    
315      my $disconnectMethod = $self->{metainfo}->{disconnectMethod};
316      print "meth: ", $disconnectMethod, "\n";
317      
318      #$disconnectMethod && $self->{_COREHANDLE} && ( $self->{_COREHANDLE}->$disconnectMethod() );
319      $self->{_COREHANDLE}->$disconnectMethod();
320      #$self->$disconnectMethod();
321    
322      #my $core1 = $self->getCOREHANDLE() if $self->can('getCOREHANDLE');
323      #$core1->$disconnectMethod();
324    
325    return;
326    
327      print "DESTROY-1", "\n";
328      #if ($self->{__COREHANDLE}) {
329      #if ($self->exists('_COREHANDLE')) {
330    
331      # get corehandle instance from underlying handler
332      my $core;
333      $core = $self->getCOREHANDLE() if $self->can('getCOREHANDLE');
334    
335      #if ($self->{STORAGEHANDLE}) {
336      if ($core) {
337        print "DESTROY-2", "\n";
338      $logger->debug( __PACKAGE__ . "[$self->{metainfo}->{type}]" . "->DESTROY" );      $logger->debug( __PACKAGE__ . "[$self->{metainfo}->{type}]" . "->DESTROY" );
339    
340      my $disconnectMethod = $self->{metainfo}->{disconnectMethod};      my $disconnectMethod = $self->{metainfo}->{disconnectMethod};
341    
342      # call "disconnect" or alike on COREHANDLE      # call "disconnect" or alike on COREHANDLE
343      # was: $self->{COREHANDLE}->disconnect();      # was: $self->{COREHANDLE}->disconnect();
344      $disconnectMethod && ( $self->{COREHANDLE}->$disconnectMethod() );      $disconnectMethod && $self->{_COREHANDLE} && ( $self->{_COREHANDLE}->$disconnectMethod() );
345    
346      undef $self->{COREHANDLE};      undef $self->{_COREHANDLE};
347    }    }
348  }  }
349    
350    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 {  
351    my $type = shift;    my $type = shift;
352    print "type: $type";    print "type: $type";
353    eval("use Data::Storage::$type;");    eval("use Data::Storage::$type;");
# Line 162  sub _typeCheck { Line 361  sub _typeCheck {
361    sub existsChildNode {    sub existsChildNode {
362      my $self = shift;      my $self = shift;
363      my $nodename = shift;      my $nodename = shift;
364      #$nodename = 'TransactionRoutingTable';  
365      $logger->debug( __PACKAGE__ . "->getChildNode( nodename $nodename )" );      # TODO: don't use $self->{meta}->{childnodes} directly in here
366        # get it returned from $self->getChildNodes()!!!
367    
368        $logger->debug( __PACKAGE__ . "->existsChildNode( nodename=$nodename )" );
369      $self->getChildNodes() unless $self->{meta}->{childnodes};      $self->getChildNodes() unless $self->{meta}->{childnodes};
370      my $result = grep(m/$nodename/i, @{$self->{meta}->{childnodes}});     # TODO: use "/i" only on win32-systems!  
371        # quote this, it might contain meta characters which don't work in a regex
372          $nodename = quotemeta($nodename);
373    
374        # trace
375          #print Dumper($self->{meta});
376          #print "nodename: $nodename", "\n";
377        
378        # FIXME: use "/i" only on win32-systems!
379        my $result = grep(m/$nodename/i, @{$self->{meta}->{childnodes}});
380        
381      return $result;      return $result;
382    }    }
383    
# Line 190  sub _typeCheck { Line 402  sub _typeCheck {
402    #   - build them via anonymous subs    #   - build them via anonymous subs
403    #   - introduce them via symbols    #   - introduce them via symbols
404    
405      sub getCOREHANDLE {
406        my $self = shift;
407        $self->_abstract_function('getCOREHANDLE');
408      }
409    
410    sub sendCommand {    sub sendCommand {
411      my $self = shift;      my $self = shift;
412      $self->_abstract_function('sendCommand');      $self->_abstract_function('sendCommand');
413    }    }
414    
415      sub createChildNode {
416        my $self = shift;
417        $self->_abstract_function('createChildNode');
418      }
419    
420      sub existsChildNode_tmp {
421        my $self = shift;
422        $self->_abstract_function('existsChildNode');
423      }
424    
425    sub getChildNodes {    sub getChildNodes {
426      my $self = shift;      my $self = shift;
427      $self->_abstract_function('getChildNodes');      $self->_abstract_function('getChildNodes');
# Line 259  sub _typeCheck { Line 486  sub _typeCheck {
486      return;      return;
487    }    }
488    
489      sub dropDb {
490        my $self = shift;
491        $self->_abstract_function('dropDb');
492        return;
493      }
494    
495      sub rebuildDb {
496        my $self = shift;
497        $self->_abstract_function('rebuildDb');
498        return;
499      }
500    
501      sub getDbName {
502        my $self = shift;
503        $self->_abstract_function('getDbName');
504        return;
505      }
506    
507      sub testAvailability {
508        my $self = shift;
509        $self->_abstract_function('testAvailability');
510        return;
511      }
512    
513      sub isConnected {
514        my $self = shift;
515        $self->_abstract_function('isConnected');
516        return;
517      }
518    
519      sub testDsn {
520        my $self = shift;
521        $self->_abstract_function('testDsn');
522        return;
523      }
524    
525  1;  1;
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.18
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed