/[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.7 by joko, Sun Nov 17 06:07:18 2002 UTC revision 1.17 by joko, Thu Jan 30 21:42:22 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.7  2002/11/17 06:07:18  joko  ##
11  #  + creating the handler is easier than proposed first - for now :-)  ##  $Log$
12  #  + sub testAvailability  ##  Revision 1.17  2003/01/30 21:42:22  joko
13  #  ##  + minor update: renamed method
14  #  Revision 1.6  2002/11/09 01:04:58  joko  ##
15  #  + updated pod  ##  Revision 1.16  2003/01/20 16:52:13  joko
16  #  ##  + now using 'DesignPattern::Object' to create a new 'Data::Storage::Handler::Xyz' on demand - before we did this in a hand-rolled fashion
17  #  Revision 1.5  2002/10/29 19:24:18  joko  ##
18  #  - reduced logging  ##  Revision 1.15  2003/01/19 03:12:59  joko
19  #  + added some pod  ##  + modified header
20  #  ##  - removed pod-documentation - now in 'Storage.pod'
21  #  Revision 1.4  2002/10/27 18:35:07  joko  ##
22  #  + added pod  ##  Revision 1.14  2002/12/19 16:27:59  joko
23  #  ##  - moved 'sub dropDb' to Data::Storage::Handler::DBI
24  #  Revision 1.3  2002/10/25 11:40:37  joko  ##
25  #  + enhanced robustness  ##  Revision 1.13  2002/12/17 21:54:12  joko
26  #  + more logging for debug-levels  ##  + feature when using Tangram:
27  #  + sub dropDb  ##    + what? each object created should delivered with a globally(!?) unique identifier (GUID) besides the native tangram object id (OID)
28  #  ##        + patched Tangram::Storage (jonen)
29  #  Revision 1.2  2002/10/17 00:04:29  joko  ##        + enhanced Data::Storage::Schema::Tangram (joko)
30  #  + sub createDb  ##        + enhanced Data::Storage::Handler::Tangram 'sub getObjectByGuid' (jonen)
31  #  + sub isConnected  ##    + how?
32  #  + bugfixes regarding "deep recursion" stuff  ##        + each concrete (non-abstract) class gets injected with an additional field/property called 'guid' - this is done (dynamically) on schema level
33  #  ##        + this property ('guid') gets filled on object creation/insertion from 'sub Tangram::Storage::_insert' using Data::UUID from CPAN
34  #  Revision 1.1  2002/10/10 03:43:12  cvsjoko  ##        + (as for now) this property can get accessed by calling 'getObjectByGuid' on the already known storage-handle used throughout the application
35  #  + new  ##
36  #  ##  Revision 1.12  2002/12/12 02:50:15  joko
37  #################################  ##  + this now (unfortunately) needs DBI for some helper functions
38    ##  + TODO: these have to be refactored to another scope! (soon!)
39  # aim_V1: should encapsulate Tangram, DBI, DBD::CSV and LWP:: to access them in an unordinary way ;)  ##
40  # aim_V2: introduce a generic layered structure, refactor *SUBLAYER*-stuff, make (e.g.) this possible:  ##  Revision 1.11  2002/12/11 06:53:19  joko
41  #               - Perl Data::Storage[DBD::CSV]  ->  Perl LWP::  ->  Internet HTTP/FTP/*  ->  Host Daemon  ->  csv-file  ##  + updated pod
42    ##
43    ##  Revision 1.10  2002/12/07 03:37:23  joko
44    ##  + updated pod
45    ##
46    ##  Revision 1.9  2002/12/01 22:15:45  joko
47    ##  - sub createDb: moved to handler
48    ##
49    ##  Revision 1.8  2002/11/29 04:48:23  joko
50    ##  + updated pod
51    ##
52    ##  Revision 1.7  2002/11/17 06:07:18  joko
53    ##  + creating the handler is easier than proposed first - for now :-)
54    ##  + sub testAvailability
55    ##
56    ##  Revision 1.6  2002/11/09 01:04:58  joko
57    ##  + updated pod
58    ##
59    ##  Revision 1.5  2002/10/29 19:24:18  joko
60    ##  - reduced logging
61    ##  + added some pod
62    ##
63    ##  Revision 1.4  2002/10/27 18:35:07  joko
64    ##  + added pod
65    ##
66    ##  Revision 1.3  2002/10/25 11:40:37  joko
67    ##  + enhanced robustness
68    ##  + more logging for debug-levels
69    ##  + sub dropDb
70    ##
71    ##  Revision 1.2  2002/10/17 00:04:29  joko
72    ##  + sub createDb
73    ##  + sub isConnected
74    ##  + bugfixes regarding "deep recursion" stuff
75    ##
76    ##  Revision 1.1  2002/10/10 03:43:12  cvsjoko
77    ##  + new
78    ## ------------------------------------------------------------------------
79    
80    
81  BEGIN {  BEGIN {
82  $Data::Storage::VERSION = 0.01;    $Data::Storage::VERSION = 0.03;
83  }  }
84    
   
 =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/or this code for additional information.  
   
   
 =head1 REQUIREMENTS  
   
 For full functionality:  
   DBI              from CPAN  
   Tangram          from CPAN  
   Class::Tangram   from CPAN  
   MySQL::Diff      from http://adamspiers.org/computing/mysqldiff/  
   ... and all their dependencies  
   
 =cut  
   
 # The POD text continues at the end of the file.  
   
   
85  package Data::Storage;  package Data::Storage;
86    
87  use strict;  use strict;
88  use warnings;  use warnings;
89    
 use Data::Storage::Locator;  
90  use Data::Dumper;  use Data::Dumper;
91    # FIXME: wipe out!
92    use DBI;
93    
94    use Data::Storage::Locator;
95    use DesignPattern::Object;
96    
97    
98  # TODO: actually implement level (integrate with Log::Dispatch)  # TODO: actually implement level (integrate with Log::Dispatch)
99  my $TRACELEVEL = 0;  my $TRACELEVEL = 0;
# Line 112  sub new { Line 109  sub new {
109    my $arg_locator = shift;    my $arg_locator = shift;
110    my $arg_options = shift;    my $arg_options = shift;
111    
112      if (!$arg_locator) {
113        $logger->critical( __PACKAGE__ . "->new: No locator passed in!" );
114        return;
115      }
116    
117    #my $self = { STORAGEHANDLE => undef, @_ };    #my $self = { STORAGEHANDLE => undef, @_ };
118    my $self = { STORAGEHANDLE => undef, locator => $arg_locator, options => $arg_options };    my $self = { STORAGEHANDLE => undef, locator => $arg_locator, options => $arg_options };
119    #$logger->debug( __PACKAGE__ . "[$self->{locator}->{type}]" . "->new(@_)" );    #$logger->debug( __PACKAGE__ . "[$self->{locator}->{type}]" . "->new(@_)" );
# Line 126  sub AUTOLOAD { Line 128  sub AUTOLOAD {
128    #     - Deep recursion on subroutine "Data::Storage::AUTOLOAD"    #     - Deep recursion on subroutine "Data::Storage::AUTOLOAD"
129    #     - Deep recursion on subroutine "Data::Storage::Handler::Abstract::AUTOLOAD"    #     - Deep recursion on subroutine "Data::Storage::Handler::Abstract::AUTOLOAD"
130    #     - Deep recursion on anonymous subroutine at [...]    #     - Deep recursion on anonymous subroutine at [...]
131    # 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"
132        
133    my $self = shift;    my $self = shift;
134    our $AUTOLOAD;    our $AUTOLOAD;
# Line 139  sub AUTOLOAD { Line 141  sub AUTOLOAD {
141    
142    # advanced logging of AUTOLOAD calls ...    # advanced logging of AUTOLOAD calls ...
143    # ... nice but do it only when TRACING (TODO) is enabled    # ... nice but do it only when TRACING (TODO) is enabled
     if ($TRACELEVEL) {  
144        my $logstring = "";        my $logstring = "";
145        $logstring .= __PACKAGE__ . "[$self->{locator}->{type}]" . "->" . $method;        $logstring .= __PACKAGE__ . "[$self->{locator}->{type}]" . "->" . $method;
146        #print "count: ", $#_, "\n";        #print "count: ", $#_, "\n";
# Line 148  sub AUTOLOAD { Line 149  sub AUTOLOAD {
149        $logstring .= "\t" x $tabcount . "(AUTOLOAD)";        $logstring .= "\t" x $tabcount . "(AUTOLOAD)";
150        # TODO: only ok if logstring doesn't contain        # TODO: only ok if logstring doesn't contain
151        #            e.g. "Data::Storage[Tangram]->insert(SystemEvent=HASH(0x5c0034c))          (AUTOLOAD)"        #            e.g. "Data::Storage[Tangram]->insert(SystemEvent=HASH(0x5c0034c))          (AUTOLOAD)"
152        # but that would be way too specific as long as we don't have an abstract handler for this  ;)        # but that would be _way_ too specific as long as we don't have an abstract handler for this  ;)
153        if ($TRACELEVEL) {
154        $logger->debug( $logstring );        $logger->debug( $logstring );
155        #print join('; ', @_);        #print join('; ', @_);
156      }      }
157            
158    # filtering AUTOLOAD calls    # filtering AUTOLOAD calls and first-time-touch of the actual storage impl
159    if ($self->_filter_AUTOLOAD($method)) {    if ($self->_filter_AUTOLOAD($method)) {
160      #print "_accessStorage\n";      #print "=== FILTER!", "\n";
161      $self->_accessStorage();      $self->_accessStorageHandle();
162      $self->{STORAGEHANDLE}->$method(@_);      if ($self->{STORAGEHANDLE}) {
163          return $self->{STORAGEHANDLE}->$method(@_);
164        } else {
165          $logger->critical( __PACKAGE__ . "->AUTOLOAD: ERROR: " . $logstring );
166          return;
167        }
168    }    }
169        
170  }  }
# Line 183  sub normalizeArgs { Line 190  sub normalizeArgs {
190    return @result;    return @result;
191  }  }
192    
193  sub _accessStorage {  sub _accessStorageHandle {
194    my $self = shift;    my $self = shift;
195    # TODO: to some tracelevel!    # TODO: to some tracelevel!
196      #print "=========== _accessStorage", "\n";
197    if ($TRACELEVEL) {    if ($TRACELEVEL) {
198      $logger->debug( __PACKAGE__ .  "[$self->{locator}->{type}]" . "->_accessStorage()" );      $logger->debug( __PACKAGE__ .  "[$self->{locator}->{type}]" . "->_accessStorageHandle()" );
199    }    }
200    if (!$self->{STORAGEHANDLE}) {    if (!$self->{STORAGEHANDLE}) {
201      $self->_createStorageHandle();      return $self->_createStorageHandle();
202    }    }
203  }  }
204    
205    sub _createStorageHandle1 {
206      my $self = shift;
207      my $type = $self->{locator}->{type};
208      $logger->debug( __PACKAGE__ .  "[$type]" . "->_createStorageHandle()" );
209    
210      my $pkg = "Data::Storage::Handler::" . $type . "";
211      
212      # try to load perl module at runtime
213      my $evalstr = "use $pkg;";
214      eval($evalstr);
215      if ($@) {
216        $logger->error( __PACKAGE__ .  "[$type]" . "->_createStorageHandle(): $@" );
217        return;
218      }
219      
220      # build up some additional arguments to pass on
221      #my @args = %{$self->{locator}};
222      my @args = ();
223    
224      # - create new storage handle object
225      # - propagate arguments to handler
226      # - pass locator by reference to be able to store status- or meta-information in it
227      $self->{STORAGEHANDLE} = $pkg->new( locator => $self->{locator}, @args );
228    
229    }
230    
231  sub _createStorageHandle {  sub _createStorageHandle {
232    my $self = shift;    my $self = shift;
233    my $type = $self->{locator}->{type};    my $type = $self->{locator}->{type};
234    $logger->debug( __PACKAGE__ .  "[$type]" . "->_createStorageHandle()" );    $logger->debug( __PACKAGE__ .  "[$type]" . "->_createStorageHandle()" );
235    
236    #print Dumper($self);
237    #exit;
238    
239    my $pkg = "Data::Storage::Handler::" . $type . "";    my $pkg = "Data::Storage::Handler::" . $type . "";
240        
241    # try to load perl module at runtime    # try to load perl module at runtime
242    =pod
243    my $evalstr = "use $pkg;";    my $evalstr = "use $pkg;";
244    eval($evalstr);    eval($evalstr);
245    if ($@) {    if ($@) {
# Line 213  sub _createStorageHandle { Line 251  sub _createStorageHandle {
251    #my @args = %{$self->{locator}};    #my @args = %{$self->{locator}};
252    my @args = ();    my @args = ();
253    
254    # create new storage handle object, propagate arguments to handler    # - create new storage handle object
255    # pass locator by reference to be able to store status information in it    # - propagate arguments to handler
256      # - pass locator by reference to be able to store status- or meta-information in it
257    $self->{STORAGEHANDLE} = $pkg->new( locator => $self->{locator}, @args );    $self->{STORAGEHANDLE} = $pkg->new( locator => $self->{locator}, @args );
258    =cut
259    
260      $self->{STORAGEHANDLE} = DesignPattern::Object->fromPackage( $pkg, locator => $self->{locator} );
261      return 1;
262    
263  }  }
264    
# Line 248  sub addLogDispatchHandler { Line 291  sub addLogDispatchHandler {
291  }  }
292    
293  sub removeLogDispatchHandler {  sub removeLogDispatchHandler {
294      my $self = shift;
295        my $self = shift;    my $name = shift;
296        my $name = shift;    #my $logger = shift;
297        #my $logger = shift;    $logger->remove($name);
   
       $logger->remove($name);  
   
298  }  }
299    
300    =pod
301  sub getDbName {  sub getDbName {
302    my $self = shift;    my $self = shift;
303    my $dsn = $self->{locator}->{dbi}->{dsn};    my $dsn = $self->{locator}->{dbi}->{dsn};
# Line 265  sub getDbName { Line 306  sub getDbName {
306    return $database_name;    return $database_name;
307  }  }
308    
 sub testDsn {  
   my $self = shift;  
   my $dsn = $self->{locator}->{dbi}->{dsn};  
   my $result;  
   if ( my $dbh = DBI->connect($dsn, '', '', {  
                                                       PrintError => 0,  
                                                       } ) ) {  
     $dbh->disconnect();  
     return 1;  
   } else {  
     $logger->warning( __PACKAGE__ .  "[$self->{locator}->{type}]" . "->testDsn(): " . "DBI-error: " . $DBI::errstr );  
   }  
 }  
   
309  sub testAvailability {  sub testAvailability {
310    my $self = shift;    my $self = shift;
311    my $status = $self->testDsn();    my $status = $self->testDsn();
# Line 286  sub testAvailability { Line 313  sub testAvailability {
313    return $status;    return $status;
314  }  }
315    
316  sub createDb {  sub isConnected {
317    my $self = shift;    my $self = shift;
318    my $dsn = $self->{locator}->{dbi}->{dsn};    # TODO: REVIEW!
319      return 1 if $self->{STORAGEHANDLE};
   $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;  
     
320  }  }
321    
322  sub dropDb {  sub testDsn {
323    my $self = shift;    my $self = shift;
324    my $dsn = $self->{locator}->{dbi}->{dsn};    my $dsn = $self->{locator}->{dbi}->{dsn};
325      my $result;
   $logger->debug( __PACKAGE__ .  "->dropDb( dsn $dsn )" );  
   
   $dsn =~ s/database=(.+?);//;  
   my $database_name = $1;  
   
   my $ok;  
     
326    if ( my $dbh = DBI->connect($dsn, '', '', {    if ( my $dbh = DBI->connect($dsn, '', '', {
327                                                        PrintError => 0,                                                        PrintError => 0,
328                                                        } ) ) {                                                        } ) ) {
329      if ($database_name) {      
330        if ($dbh->do("DROP DATABASE $database_name;")) {      # TODO: REVIEW
         $ok = 1;  
       }  
     }  
331      $dbh->disconnect();      $dbh->disconnect();
332        
333        return 1;
334      } else {
335        $logger->warning( __PACKAGE__ .  "[$self->{locator}->{type}]" . "->testDsn(): " . "DBI-error: " . $DBI::errstr );
336    }    }
     
   return $ok;  
 }  
   
 sub isConnected {  
   my $self = shift;  
   return 1 if $self->{STORAGEHANDLE};  
337  }  }
338    =cut
339    
340  1;  1;
341  __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 for Perl, Tim Bunce for DBI, Jean-Louis Leroy for Tangram and Set::Object,  
 Sam Vilain for Class::Tangram, Adam Spiers for MySQL::Diff and all contributors.  
   
   
 =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 pre-alpha stage.  
   And loosing data by being able to modify and redeploy schemas easily is definitely quite easy.  
     
   As we can see, creations of Classes and new Class variables is handled  
   automatically and this is believed to be the most common case under normal circumstances.  
   
   
 =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 programmers.  
   - Add some more handlers:  
     - look at DBD::CSV, Text::CSV, XML::CSV, XML::Excel  
   - Add some more locations/locators:  
     - PerlDAV: http://www.webdav.org/perldav/  
   - Move to t3, use InCASE  
   
   
 =head3 Links:  
   
   Specs:  
     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  
   
   CASE Tools:  
     Rational Rose (commercial): http://www.rational.com/products/rose/  
     Together (commercial): http://www.oi.com/products/controlcenter/index.jsp  
     InCASE - Tangram-based Universal Object Editor  
     Sybase PowerDesigner: http://www.sybase.com/powerdesigner  
     
   UML Editors:  
     Fujaba (free, university): http://www.fujaba.de/  
     ArgoUML (free): http://argouml.tigris.org/  
     Poseidon (commercial): http://www.gentleware.com/products/poseidonDE.php3  
     Co-operative UML Editor (research): http://www.darmstadt.gmd.de/concert/activities/internal/umledit.html  
     Metamill (commercial): http://www.metamill.com/  
     Violet (university, research, education): http://www.horstmann.com/violet/  
     PyUt (free): http://pyut.sourceforge.net/  
     (Dia (free): http://www.lysator.liu.se/~alla/dia/)  
     UMLet (free, university): http://www.swt.tuwien.ac.at/umlet/index.html  
     Voodoo (free): http://voodoo.sourceforge.net/  
     Umbrello UML Modeller: http://uml.sourceforge.net/  
   
   UML Tools:  
     http://www.objectsbydesign.com/tools/umltools_byPrice.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  
   
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.17
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed