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

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

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

revision 1.4 by joko, Sun Oct 27 18:35:07 2002 UTC revision 1.18 by joko, Thu Jan 30 22:12:17 2003 UTC
# Line 1  Line 1 
1  # $Id$  ## ------------------------------------------------------------------------
2  #  ##
3  # Copyright (c) 2002  Andreas Motl <andreas.motl@ilo.de>  ##    $Id$
4  #  ##
5  # See COPYRIGHT section in pod text below for usage and distribution rights.  ##    Copyright (c) 2002  Andreas Motl <andreas.motl@ilo.de>
6  #  ##
7  #################################  ##    See COPYRIGHT section in pod text below for usage and distribution rights.
8  #  ##
9  #  $Log$  ## ------------------------------------------------------------------------
10  #  Revision 1.4  2002/10/27 18:35:07  joko  ##
11  #  + added pod  ##  $Log$
12  #  ##  Revision 1.18  2003/01/30 22:12:17  joko
13  #  Revision 1.3  2002/10/25 11:40:37  joko  ##  - removed/refactored old code: ->Data::Storage::Handler::Tangram|DBI
14  #  + enhanced robustness  ##
15  #  + more logging for debug-levels  ##  Revision 1.17  2003/01/30 21:42:22  joko
16  #  + sub dropDb  ##  + minor update: renamed method
17  #  ##
18  #  Revision 1.2  2002/10/17 00:04:29  joko  ##  Revision 1.16  2003/01/20 16:52:13  joko
19  #  + sub createDb  ##  + now using 'DesignPattern::Object' to create a new 'Data::Storage::Handler::Xyz' on demand - before we did this in a hand-rolled fashion
20  #  + sub isConnected  ##
21  #  + bugfixes regarding "deep recursion" stuff  ##  Revision 1.15  2003/01/19 03:12:59  joko
22  #  ##  + modified header
23  #  Revision 1.1  2002/10/10 03:43:12  cvsjoko  ##  - removed pod-documentation - now in 'Storage.pod'
24  #  + new  ##
25  #  ##  Revision 1.14  2002/12/19 16:27:59  joko
26  #################################  ##  - moved 'sub dropDb' to Data::Storage::Handler::DBI
27    ##
28  # aim_V1: should encapsulate Tangram, DBI, DBD::CSV and LWP:: to access them in an unordinary way ;)  ##  Revision 1.13  2002/12/17 21:54:12  joko
29  # aim_V2: introduce a generic layered structure, refactor *SUBLAYER*-stuff, make (e.g.) this possible:  ##  + feature when using Tangram:
30  #               - Perl Data::Storage[DBD::CSV]  ->  Perl LWP::  ->  Internet HTTP/FTP/*  ->  Host Daemon  ->  csv-file  ##    + what? each object created should delivered with a globally(!?) unique identifier (GUID) besides the native tangram object id (OID)
31    ##        + patched Tangram::Storage (jonen)
32    ##        + enhanced Data::Storage::Schema::Tangram (joko)
33    ##        + enhanced Data::Storage::Handler::Tangram 'sub getObjectByGuid' (jonen)
34    ##    + how?
35    ##        + each concrete (non-abstract) class gets injected with an additional field/property called 'guid' - this is done (dynamically) on schema level
36    ##        + this property ('guid') gets filled on object creation/insertion from 'sub Tangram::Storage::_insert' using Data::UUID from CPAN
37    ##        + (as for now) this property can get accessed by calling 'getObjectByGuid' on the already known storage-handle used throughout the application
38    ##
39    ##  Revision 1.12  2002/12/12 02:50:15  joko
40    ##  + this now (unfortunately) needs DBI for some helper functions
41    ##  + TODO: these have to be refactored to another scope! (soon!)
42    ##
43    ##  Revision 1.11  2002/12/11 06:53:19  joko
44    ##  + updated pod
45    ##
46    ##  Revision 1.10  2002/12/07 03:37:23  joko
47    ##  + updated pod
48    ##
49    ##  Revision 1.9  2002/12/01 22:15:45  joko
50    ##  - sub createDb: moved to handler
51    ##
52    ##  Revision 1.8  2002/11/29 04:48:23  joko
53    ##  + updated pod
54    ##
55    ##  Revision 1.7  2002/11/17 06:07:18  joko
56    ##  + creating the handler is easier than proposed first - for now :-)
57    ##  + sub testAvailability
58    ##
59    ##  Revision 1.6  2002/11/09 01:04:58  joko
60    ##  + updated pod
61    ##
62    ##  Revision 1.5  2002/10/29 19:24:18  joko
63    ##  - reduced logging
64    ##  + added some pod
65    ##
66    ##  Revision 1.4  2002/10/27 18:35:07  joko
67    ##  + added pod
68    ##
69    ##  Revision 1.3  2002/10/25 11:40:37  joko
70    ##  + enhanced robustness
71    ##  + more logging for debug-levels
72    ##  + sub dropDb
73    ##
74    ##  Revision 1.2  2002/10/17 00:04:29  joko
75    ##  + sub createDb
76    ##  + sub isConnected
77    ##  + bugfixes regarding "deep recursion" stuff
78    ##
79    ##  Revision 1.1  2002/10/10 03:43:12  cvsjoko
80    ##  + new
81    ## ------------------------------------------------------------------------
82    
83    
84  BEGIN {  BEGIN {
85  $Data::Storage::VERSION = 0.01;    $Data::Storage::VERSION = 0.03;
86  }  }
87    
 =head1 NAME  
   
 Data::Storage - Interface for accessing various Storage implementations for Perl in an independent way  
   
 =head1 SYNOPSIS  
   
   ... the basic way:  
   
   
   ... via inheritance:  
     
     use Data::Storage;  
     my $proxyObj = new HttpProxy;  
     $proxyObj->{url} = $url;  
     $proxyObj->{payload} = $content;  
     $self->{storage}->insert($proxyObj);  
       
     use Data::Storage;  
     my $proxyObj = HttpProxy->new(  
       url => $url,  
       payload => $content,  
     );  
     $self->{storage}->insert($proxyObj);  
   
   
 =head2 NOTE  
   
 This module heavily relies on DBI and Tangram, but adds a lot of additional bugs and quirks.  
 Please look at their documentation and this code for additional information.  
   
   
 =cut  
   
 # The POD text continues at the end of the file.  
   
   
88  package Data::Storage;  package Data::Storage;
89    
90  use strict;  use strict;
91  use warnings;  use warnings;
92    
93    use Data::Dumper;
94    # FIXME: wipe out!
95    use DBI;
96    
97  use Data::Storage::Locator;  use Data::Storage::Locator;
98    use DesignPattern::Object;
99    
100    
101    # TODO: actually implement level (integrate with Log::Dispatch)
102    my $TRACELEVEL = 0;
103    
104  # get logger instance  # get logger instance
105  my $logger = Log::Dispatch::Config->instance;  my $logger = Log::Dispatch::Config->instance;
# Line 83  sub new { Line 108  sub new {
108    my $invocant = shift;    my $invocant = shift;
109    my $class = ref($invocant) || $invocant;    my $class = ref($invocant) || $invocant;
110    #my @args = normalizeArgs(@_);    #my @args = normalizeArgs(@_);
111      
112    my $arg_locator = shift;    my $arg_locator = shift;
113    my $arg_options = shift;    my $arg_options = shift;
114      
115      if (!$arg_locator) {
116        $logger->critical( __PACKAGE__ . "->new: No locator passed in!" );
117        return;
118      }
119    
120    #my $self = { STORAGEHANDLE => undef, @_ };    #my $self = { STORAGEHANDLE => undef, @_ };
121    my $self = { STORAGEHANDLE => undef, locator => $arg_locator, options => $arg_options };    my $self = { STORAGEHANDLE => undef, locator => $arg_locator, options => $arg_options };
122    $logger->debug( __PACKAGE__ . "[$self->{locator}->{type}]" . "->new(@_)" );    #$logger->debug( __PACKAGE__ . "[$self->{locator}->{type}]" . "->new(@_)" );
123      $logger->debug( __PACKAGE__ . "[$arg_locator->{type}]" . "->new(@_)" );
124    return bless $self, $class;    return bless $self, $class;
125  }  }
126    
# Line 100  sub AUTOLOAD { Line 131  sub AUTOLOAD {
131    #     - Deep recursion on subroutine "Data::Storage::AUTOLOAD"    #     - Deep recursion on subroutine "Data::Storage::AUTOLOAD"
132    #     - Deep recursion on subroutine "Data::Storage::Handler::Abstract::AUTOLOAD"    #     - Deep recursion on subroutine "Data::Storage::Handler::Abstract::AUTOLOAD"
133    #     - Deep recursion on anonymous subroutine at [...]    #     - Deep recursion on anonymous subroutine at [...]
134    # we also might filter log messages caused by logging itself in "advanced logging of AUTOLOAD calls"    # we also might filter log messages caused by logging to itself in "advanced logging of AUTOLOAD calls"
135        
136    my $self = shift;    my $self = shift;
137    our $AUTOLOAD;    our $AUTOLOAD;
# Line 111  sub AUTOLOAD { Line 142  sub AUTOLOAD {
142    my $method = $AUTOLOAD;    my $method = $AUTOLOAD;
143    $method =~ s/^.*:://;    $method =~ s/^.*:://;
144    
145    # advanced logging of AUTOLOAD calls    # advanced logging of AUTOLOAD calls ...
146      my $logstring = "";    # ... nice but do it only when TRACING (TODO) is enabled
147      $logstring .= __PACKAGE__ . "[$self->{locator}->{type}]" . "->" . $method;        my $logstring = "";
148      #print "count: ", $#_, "\n";        $logstring .= __PACKAGE__ . "[$self->{locator}->{type}]" . "->" . $method;
149      #$logstring .= Dumper(@_) if ($#_ != -1);        #print "count: ", $#_, "\n";
150      my $tabcount = int( (80 - length($logstring)) / 10 );        #$logstring .= Dumper(@_) if ($#_ != -1);
151      $logstring .= "\t" x $tabcount . "(AUTOLOAD)";        my $tabcount = int( (80 - length($logstring)) / 10 );
152      # TODO: only ok if logstring doesn't contain        $logstring .= "\t" x $tabcount . "(AUTOLOAD)";
153      #            e.g. "Data::Storage[Tangram]->insert(SystemEvent=HASH(0x5c0034c))          (AUTOLOAD)"        # TODO: only ok if logstring doesn't contain
154      # but that would be way too specific as long as we don't have an abstract handler for this  ;)        #            e.g. "Data::Storage[Tangram]->insert(SystemEvent=HASH(0x5c0034c))          (AUTOLOAD)"
155      $logger->debug( $logstring );        # but that would be _way_ too specific as long as we don't have an abstract handler for this  ;)
156        if ($TRACELEVEL) {
157    # filtering AUTOLOAD calls        $logger->debug( $logstring );
158          #print join('; ', @_);
159        }
160        
161      # filtering AUTOLOAD calls and first-time-touch of the actual storage impl
162    if ($self->_filter_AUTOLOAD($method)) {    if ($self->_filter_AUTOLOAD($method)) {
163      $self->_accessStorage();      #print "=== FILTER!", "\n";
164      $self->{STORAGEHANDLE}->$method(@_);      $self->_accessStorageHandle();
165        if ($self->{STORAGEHANDLE}) {
166          return $self->{STORAGEHANDLE}->$method(@_);
167        } else {
168          $logger->critical( __PACKAGE__ . "->AUTOLOAD: ERROR: " . $logstring );
169          return;
170        }
171    }    }
172        
173  }  }
# Line 143  sub _filter_AUTOLOAD { Line 184  sub _filter_AUTOLOAD {
184  }  }
185    
186    
187  sub normalizeArgs {  sub _accessStorageHandle {
   my %args = @_;  
   if (!$args{dsn} && $args{meta}{dsn}) {  
     $args{dsn} = $args{meta}{dsn};  
   }  
   my @result = %args;  
   return @result;  
 }  
   
 sub _accessStorage {  
188    my $self = shift;    my $self = shift;
189    # TODO: to some tracelevel!    # TODO: to some tracelevel!
190    $logger->debug( __PACKAGE__ .  "[$self->{locator}->{type}]" . "->_accessStorage()" );    #print "=========== _accessStorage", "\n";
191      if ($TRACELEVEL) {
192        $logger->debug( __PACKAGE__ .  "[$self->{locator}->{type}]" . "->_accessStorageHandle()" );
193      }
194    if (!$self->{STORAGEHANDLE}) {    if (!$self->{STORAGEHANDLE}) {
195      $self->_createStorageHandle();      return $self->_createStorageHandle();
196    }    }
197  }  }
198    
199  sub _createStorageHandle {  sub _createStorageHandle1 {
200    my $self = shift;    my $self = shift;
   
201    my $type = $self->{locator}->{type};    my $type = $self->{locator}->{type};
202    $logger->debug( __PACKAGE__ .  "[$type]" . "->_createStorageHandle()" );    $logger->debug( __PACKAGE__ .  "[$type]" . "->_createStorageHandle()" );
203    
204    my $pkg = "Data::Storage::Handler::" . $type . "";    my $pkg = "Data::Storage::Handler::" . $type . "";
205        
206    # propagate args to handler    # try to load perl module at runtime
207    # needs some more thoughts! (not only "dbi" to Tangram, when (in future) db is not more the common case)    my $evalstr = "use $pkg;";
208    if ($type eq 'DBI') {    eval($evalstr);
209      use Data::Storage::Handler::DBI;    if ($@) {
210      #my @args = %{$self->{locator}->{dbi}};      $logger->error( __PACKAGE__ .  "[$type]" . "->_createStorageHandle(): $@" );
211      my @args = %{$self->{locator}};      return;
     # create new storage handle  
     $self->{STORAGEHANDLE} = $pkg->new( @args );  
212    }    }
213    if ($type eq 'Tangram') {    
214      use Data::Storage::Handler::Tangram;    # build up some additional arguments to pass on
215      #$self->{STORAGEHANDLE} = $pkg->new( dsn => $self->{locator}->{dbi}->{dsn} );    #my @args = %{$self->{locator}};
216      #my @args = %{$self->{locator}->{dbi}};    my @args = ();
217      my @args = %{$self->{locator}};  
218      # create new storage handle    # - create new storage handle object
219      $self->{STORAGEHANDLE} = $pkg->new( @args );    # - propagate arguments to handler
220      # - pass locator by reference to be able to store status- or meta-information in it
221      $self->{STORAGEHANDLE} = $pkg->new( locator => $self->{locator}, @args );
222    
223    }
224    
225      #$self->{STORAGEHANDLE_UNDERLYING} = $self->{STORAGEHANDLE}->getUnderlyingStorage();  sub _createStorageHandle {
226      #$self->{STORAGEHANDLE_UNDERLYING}->_configureCOREHANDLE();    my $self = shift;
227      my $type = $self->{locator}->{type};
228      $logger->debug( __PACKAGE__ .  "[$type]" . "->_createStorageHandle()" );
229    
230    #print Dumper($self);
231    #exit;
232    
233      my $pkg = "Data::Storage::Handler::" . $type . "";
234      
235      # try to load perl module at runtime
236    =pod
237      my $evalstr = "use $pkg;";
238      eval($evalstr);
239      if ($@) {
240        $logger->error( __PACKAGE__ .  "[$type]" . "->_createStorageHandle(): $@" );
241        return;
242    }    }
243        
244      # build up some additional arguments to pass on
245      #my @args = %{$self->{locator}};
246      my @args = ();
247    
248      # - create new storage handle object
249      # - propagate arguments to handler
250      # - pass locator by reference to be able to store status- or meta-information in it
251      $self->{STORAGEHANDLE} = $pkg->new( locator => $self->{locator}, @args );
252    =cut
253    
254      $self->{STORAGEHANDLE} = DesignPattern::Object->fromPackage( $pkg, locator => $self->{locator} );
255      return 1;
256    
257  }  }
258    
259  sub addLogDispatchHandler {  sub addLogDispatchHandler {
# Line 221  sub addLogDispatchHandler { Line 285  sub addLogDispatchHandler {
285  }  }
286    
287  sub removeLogDispatchHandler {  sub removeLogDispatchHandler {
   
       my $self = shift;  
       my $name = shift;  
       #my $logger = shift;  
   
       $logger->remove($name);  
   
 }  
   
 sub getDbName {  
   my $self = shift;  
   my $dsn = $self->{locator}->{dbi}->{dsn};  
   $dsn =~ m/database=(.+?);/;  
   my $database_name = $1;  
   return $database_name;  
 }  
   
 sub testDsn {  
288    my $self = shift;    my $self = shift;
289    my $dsn = $self->{locator}->{dbi}->{dsn};    my $name = shift;
290    my $result;    #my $logger = shift;
291    if ( my $dbh = DBI->connect($dsn, '', '', {    $logger->remove($name);
                                                       PrintError => 0,  
                                                       } ) ) {  
     $dbh->disconnect();  
     return 1;  
   } else {  
     $logger->error( __PACKAGE__ .  "[$self->{locator}->{type}]" . "->testDsn(): " . "DBI-error: " . $DBI::errstr );  
   }  
292  }  }
293    
 sub createDb {  
   my $self = shift;  
   my $dsn = $self->{locator}->{dbi}->{dsn};  
   
   $logger->debug( __PACKAGE__ .  "->createDb( dsn $dsn )" );  
   
   $dsn =~ s/database=(.+?);//;  
   my $database_name = $1;  
   
   my $ok;  
     
   if ( my $dbh = DBI->connect($dsn, '', '', {  
                                                       PrintError => 0,  
                                                       } ) ) {  
     if ($database_name) {  
       if ($dbh->do("CREATE DATABASE $database_name;")) {  
         $ok = 1;  
       }  
     }  
     $dbh->disconnect();  
   }  
     
   return $ok;  
     
 }  
   
 sub dropDb {  
   my $self = shift;  
   my $dsn = $self->{locator}->{dbi}->{dsn};  
   
   $logger->debug( __PACKAGE__ .  "->dropDb( dsn $dsn )" );  
   
   $dsn =~ s/database=(.+?);//;  
   my $database_name = $1;  
   
   my $ok;  
     
   if ( my $dbh = DBI->connect($dsn, '', '', {  
                                                       PrintError => 0,  
                                                       } ) ) {  
     if ($database_name) {  
       if ($dbh->do("DROP DATABASE $database_name;")) {  
         $ok = 1;  
       }  
     }  
     $dbh->disconnect();  
   }  
     
   return $ok;  
 }  
   
 sub isConnected {  
   my $self = shift;  
   return 1 if $self->{STORAGEHANDLE};  
 }  
294    
295  1;  1;
296  __END__  __END__
   
   
 =head1 DESCRIPTION  
   
 Data::Storage is module for a accessing various "data structures" stored inside  
 various "data containers". It sits on top of DBI and/or Tangram.  
   
   
 =head1 AUTHORS / COPYRIGHT  
   
 The Data::Storage module is Copyright (c) 2002 Andreas Motl.  
 All rights reserved.  
   
 You may distribute it under the terms of either the GNU General Public  
 License or the Artistic License, as specified in the Perl README file.  
   
   
 =head1 ACKNOWLEDGEMENTS  
   
 Larry Wall and the C<perl5-porters> for Perl,  
 Tim Bunce for DBI, Jean-Louis Leroy for Tangram and Set::Object,  
 Sam Vilain for Class::Tangram.  
   
   
 =head1 SUPPORT / WARRANTY  
   
 Data::Storage is free software. IT COMES WITHOUT WARRANTY OF ANY KIND.  
   
   
 =head1 TODO  
   
   
 =head2 Handle the following errors/cases:  
   
 =head3 "DBI-Error [Tangram]: DBD::mysql::st execute failed: Unknown column 't1.requestdump' in 'field list'"  
   
     ... occours when operating on object-attributes not introduced yet:  
     this should be detected and appended/replaced through:  
     "Schema-Error detected, maybe (just) an inconsistency.  
     Please check if your declaration in schema-module "a" matches structure in database "b" or try to run"  
     db_setup.pl --dbkey=import --action=deploy  
   
 =head3 Compare schema (structure diff) with database ...  
   
   ... when issuing "db_setup.pl --dbkey=import --action=deploy"  
   on a database with an already deployed schema, use an additional "--update" then  
   to lift the schema inside the database to the current declared schema.  
   You will have to approve removals and changes on field-level while  
   new objects and new fields are introduced silently without any interaction needed.  
   In future versions there may be additional options to control silent processing of  
   removals and changes.  
   See this CRUD-table applying to the actions occouring on Classes and Class variables when deploying schemas,  
   don't mix this up with CRUD-actions on Objects, these are already handled by (e.g.) Tangram itself.  
   Classes:  
     C create    ->  yes, handled automatically  
     R retrieve  ->  no, not subject of this aspect since it is about deployment only  
     U update    ->  yes, automatically for Class meta-attributes, yes/no for Class variables (look at the rules down here)  
     D delete    ->  yes, just by user-interaction  
   Class variables:  
     C create    ->  yes, handled automatically  
     R retrieve  ->  no, not subject of this aspect since it is about deployment only  
     U update    ->  yes, just by user-interaction; maybe automatically if it can be determined that data wouldn't be lost  
     D delete    ->  yes, just by user-interaction  
   It's all about not to be able to loose data simply while this is in alpha stage.  
   
   
 =head2 Introduce some features:  
   
   Get this stuff together with UML (Unified Modeling Language) and/or standards from ODMG.  
   Make it possible to load/save schemas in XMI (XML Metadata Interchange),  
   which seems to be most commonly used today, perhaps handle objects with OIFML.  
   Integrate/bundle this with a web-/html-based UML modeling tool or  
   some other interesting stuff like the "Co-operative UML Editor" from Uni Darmstadt. (web-/java-based)  
   Enable Round Trip Engineering. Keep code and diagrams in sync. Don't annoy/bother the programmer.  
   
   
 =head3 Links:  
   
     UML 1.3 Spec: http://cgi.omg.org/cgi-bin/doc?ad/99-06-08.pdf  
     XMI 1.1 Spec: http://cgi.omg.org/cgi-bin/doc?ad/99-10-02.pdf  
     XMI 2.0 Spec: http://cgi.omg.org/docs/ad/01-06-12.pdf  
     ODMG: http://odmg.org/  
     OIFML: http://odmg.org/library/readingroom/oifml.pdf  
     Co-operative UML Editor: http://www.darmstadt.gmd.de/concert/activities/internal/umledit.html  
   
   further readings:  
     http://www.google.com/search?q=web+based+uml+editor&hl=en&lr=&ie=UTF-8&oe=UTF-8&start=10&sa=N  
     http://www.fernuni-hagen.de/DVT/Aktuelles/01FHHeidelberg.pdf  
     http://www.enhyper.com/src/documentation/  
     http://cis.cs.tu-berlin.de/Dokumente/Diplomarbeiten/2001/skinner.pdf  
     http://citeseer.nj.nec.com/vilain00diagrammatic.html  
     http://archive.devx.com/uml/articles/Smith01/Smith01-3.asp  
   
   maybe useful for / to be integrated with:  
     ArapXML: http://xml.coverpages.org/ni2001-09-24-b.html  
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