/[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.14 by joko, Thu Dec 19 16:27:59 2002 UTC
# Line 4  Line 4 
4  #  #
5  # See COPYRIGHT section in pod text below for usage and distribution rights.  # See COPYRIGHT section in pod text below for usage and distribution rights.
6  #  #
7  #################################  ############################################
8  #  #
9  #  $Log$  #  $Log$
10    #  Revision 1.14  2002/12/19 16:27:59  joko
11    #  - moved 'sub dropDb' to Data::Storage::Handler::DBI
12    #
13    #  Revision 1.13  2002/12/17 21:54:12  joko
14    #  + feature when using Tangram:
15    #    + what? each object created should delivered with a globally(!?) unique identifier (GUID) besides the native tangram object id (OID)
16    #        + patched Tangram::Storage (jonen)
17    #        + enhanced Data::Storage::Schema::Tangram (joko)
18    #        + enhanced Data::Storage::Handler::Tangram 'sub getObjectByGuid' (jonen)
19    #    + how?
20    #        + each concrete (non-abstract) class gets injected with an additional field/property called 'guid' - this is done (dynamically) on schema level
21    #        + this property ('guid') gets filled on object creation/insertion from 'sub Tangram::Storage::_insert' using Data::UUID from CPAN
22    #        + (as for now) this property can get accessed by calling 'getObjectByGuid' on the already known storage-handle used throughout the application
23    #
24    #  Revision 1.12  2002/12/12 02:50:15  joko
25    #  + this now (unfortunately) needs DBI for some helper functions
26    #  + TODO: these have to be refactored to another scope! (soon!)
27    #
28    #  Revision 1.11  2002/12/11 06:53:19  joko
29    #  + updated pod
30    #
31    #  Revision 1.10  2002/12/07 03:37:23  joko
32    #  + updated pod
33    #
34    #  Revision 1.9  2002/12/01 22:15:45  joko
35    #  - sub createDb: moved to handler
36    #
37    #  Revision 1.8  2002/11/29 04:48:23  joko
38    #  + updated pod
39    #
40  #  Revision 1.7  2002/11/17 06:07:18  joko  #  Revision 1.7  2002/11/17 06:07:18  joko
41  #  + creating the handler is easier than proposed first - for now :-)  #  + creating the handler is easier than proposed first - for now :-)
42  #  + sub testAvailability  #  + sub testAvailability
# Line 34  Line 64 
64  #  Revision 1.1  2002/10/10 03:43:12  cvsjoko  #  Revision 1.1  2002/10/10 03:43:12  cvsjoko
65  #  + new  #  + new
66  #  #
67  #################################  ############################################
68    
 # aim_V1: should encapsulate Tangram, DBI, DBD::CSV and LWP:: to access them in an unordinary way ;)  
 # aim_V2: introduce a generic layered structure, refactor *SUBLAYER*-stuff, make (e.g.) this possible:  
 #               - Perl Data::Storage[DBD::CSV]  ->  Perl LWP::  ->  Internet HTTP/FTP/*  ->  Host Daemon  ->  csv-file  
69    
70  BEGIN {  BEGIN {
71  $Data::Storage::VERSION = 0.01;    $Data::Storage::VERSION = 0.02;
72  }  }
73    
74    
75  =head1 NAME  =head1 NAME
76    
77  Data::Storage - Interface for accessing various Storage implementations for Perl in an independent way    Data::Storage - Interface for accessing various Storage implementations for Perl in an independent way
78    
79    
80    =head1 AIMS
81    
82      - should encapsulate Tangram, DBI, DBD::CSV and LWP:: to access them in an unordinary (more convenient) way ;)
83      - introduce a generic layered structure, refactor *SUBLAYER*-stuff, make (e.g.) this possible:
84        Perl Data::Storage[DBD::CSV]  ->  Perl LWP::  ->  Internet HTTP/FTP/*  ->  Host Daemon  ->  csv-file
85      - provide generic synchronization mechanisms across arbitrary/multiple storages based on ident/checksum
86        maybe it's possible to have schema-, structural- and semantical modifications synchronized???
87    
88    
89  =head1 SYNOPSIS  =head1 SYNOPSIS
90    
91    ... the basic way:  =head2 BASIC ACCESS
92    
93    =head2 ADVANCED ACCESS
94    
95    ... via inheritance:    ... via inheritance:
96        
# Line 70  Data::Storage - Interface for accessing Line 108  Data::Storage - Interface for accessing
108      $self->{storage}->insert($proxyObj);      $self->{storage}->insert($proxyObj);
109    
110    
111    =head2 SYNCHRONIZATION
112    
113      my $nodemapping = {
114        'LangText' => 'langtexts.csv',
115        'Currency' => 'currencies.csv',
116        'Country'  => 'countries.csv',
117      };
118    
119      my $propmapping = {
120        'LangText' => [
121          [ 'source:lcountrykey'  =>  'target:country' ],
122          [ 'source:lkey'         =>  'target:key' ],
123          [ 'source:lvalue'       =>  'target:text' ],
124        ],
125        'Currency' => [
126          [ 'source:ckey'         =>  'target:key' ],
127          [ 'source:cname'        =>  'target:text' ],
128        ],
129        'Country' => [
130          [ 'source:ckey'         =>  'target:key' ],
131          [ 'source:cname'        =>  'target:text' ],
132        ],
133      };
134    
135      sub syncResource {
136    
137        my $self = shift;
138        my $node_source = shift;
139        my $mode = shift;
140        my $opts = shift;
141        
142        $mode ||= '';
143        $opts->{erase} ||= 0;
144        
145        $logger->info( __PACKAGE__ . "->syncResource( node_source $node_source mode $mode erase $opts->{erase} )");
146      
147        # resolve metadata for syncing requested resource
148        my $node_target = $nodemapping->{$node_source};
149        my $mapping = $propmapping->{$node_source};
150        
151        if (!$node_target || !$mapping) {
152          # loggger.... "no target, sorry!"
153          print "error while resolving resource metadata", "\n";
154          return;
155        }
156        
157        if ($opts->{erase}) {
158          $self->_erase_all($node_source);
159        }
160      
161        # create new sync object
162        my $sync = Data::Transfer::Sync->new(
163          storages => {
164            L => $self->{bizWorks}->{backend},
165            R => $self->{bizWorks}->{resources},
166          },
167          id_authorities        =>  [qw( L ) ],
168          checksum_authorities  =>  [qw( L ) ],
169          write_protected       =>  [qw( R ) ],
170          verbose               =>  1,
171        );
172        
173        # sync
174        # todo: filter!?
175        $sync->syncNodes( {
176          direction       =>  $mode,                 # | +PUSH | +PULL | -FULL | +IMPORT | -EXPORT
177          method          =>  'checksum',            # | -timestamp | -manual
178          source          =>  "L:$node_source",
179          source_ident    =>  'storage_method:id',
180          source_exclude  =>  [qw( id cs )],
181          target          =>  "R:$node_target",
182          target_ident    =>  'property:oid',
183          mapping         =>  $mapping,
184        } );
185    
186      }
187    
188    
189  =head2 NOTE  =head2 NOTE
190    
191  This module heavily relies on DBI and Tangram, but adds a lot of additional bugs and quirks.    This module heavily relies on DBI and Tangram, but adds a lot of additional bugs and quirks.
192  Please look at their documentation and/or this code for additional information.    Please look at their documentation and/or this code for additional information.
193    
194    
195  =head1 REQUIREMENTS  =head1 REQUIREMENTS
196    
197  For full functionality:    For full functionality:
198    DBI              from CPAN      DBI              from CPAN
199    Tangram          from CPAN      DBD::mysql       from CPAN
200    Class::Tangram   from CPAN      Tangram 2.04     from CPAN         (hmmm, 2.04 won't do in some cases)
201    MySQL::Diff      from http://adamspiers.org/computing/mysqldiff/      Tangram 2.05     from http://...   (2.05 seems okay but there are also additional patches from our side)
202    ... and all their dependencies      Class::Tangram   from CPAN
203        DBD::CSV         from CPAN
204        MySQL::Diff      from http://adamspiers.org/computing/mysqldiff/
205        ... and all their dependencies
206    
207  =cut  =cut
208    
# Line 98  use warnings; Line 217  use warnings;
217  use Data::Storage::Locator;  use Data::Storage::Locator;
218  use Data::Dumper;  use Data::Dumper;
219    
220    # TODO: wipe out!
221    use DBI;
222    
223  # TODO: actually implement level (integrate with Log::Dispatch)  # TODO: actually implement level (integrate with Log::Dispatch)
224  my $TRACELEVEL = 0;  my $TRACELEVEL = 0;
225    
# Line 126  sub AUTOLOAD { Line 248  sub AUTOLOAD {
248    #     - Deep recursion on subroutine "Data::Storage::AUTOLOAD"    #     - Deep recursion on subroutine "Data::Storage::AUTOLOAD"
249    #     - Deep recursion on subroutine "Data::Storage::Handler::Abstract::AUTOLOAD"    #     - Deep recursion on subroutine "Data::Storage::Handler::Abstract::AUTOLOAD"
250    #     - Deep recursion on anonymous subroutine at [...]    #     - Deep recursion on anonymous subroutine at [...]
251    # 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"
252        
253    my $self = shift;    my $self = shift;
254    our $AUTOLOAD;    our $AUTOLOAD;
# Line 148  sub AUTOLOAD { Line 270  sub AUTOLOAD {
270        $logstring .= "\t" x $tabcount . "(AUTOLOAD)";        $logstring .= "\t" x $tabcount . "(AUTOLOAD)";
271        # TODO: only ok if logstring doesn't contain        # TODO: only ok if logstring doesn't contain
272        #            e.g. "Data::Storage[Tangram]->insert(SystemEvent=HASH(0x5c0034c))          (AUTOLOAD)"        #            e.g. "Data::Storage[Tangram]->insert(SystemEvent=HASH(0x5c0034c))          (AUTOLOAD)"
273        # 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  ;)
274        $logger->debug( $logstring );        $logger->debug( $logstring );
275        #print join('; ', @_);        #print join('; ', @_);
276      }      }
277            
278    # filtering AUTOLOAD calls    # filtering AUTOLOAD calls and first-time-touch of the actual storage impl
279    if ($self->_filter_AUTOLOAD($method)) {    if ($self->_filter_AUTOLOAD($method)) {
280      #print "_accessStorage\n";      #print "_accessStorage\n";
281      $self->_accessStorage();      $self->_accessStorage();
# Line 213  sub _createStorageHandle { Line 335  sub _createStorageHandle {
335    #my @args = %{$self->{locator}};    #my @args = %{$self->{locator}};
336    my @args = ();    my @args = ();
337    
338    # create new storage handle object, propagate arguments to handler    # - create new storage handle object
339    # pass locator by reference to be able to store status information in it    # - propagate arguments to handler
340      # - pass locator by reference to be able to store status- or meta-information in it
341    $self->{STORAGEHANDLE} = $pkg->new( locator => $self->{locator}, @args );    $self->{STORAGEHANDLE} = $pkg->new( locator => $self->{locator}, @args );
342    
343  }  }
# Line 248  sub addLogDispatchHandler { Line 371  sub addLogDispatchHandler {
371  }  }
372    
373  sub removeLogDispatchHandler {  sub removeLogDispatchHandler {
374      my $self = shift;
375        my $self = shift;    my $name = shift;
376        my $name = shift;    #my $logger = shift;
377        #my $logger = shift;    $logger->remove($name);
   
       $logger->remove($name);  
   
378  }  }
379    
380  sub getDbName {  sub getDbName {
# Line 265  sub getDbName { Line 385  sub getDbName {
385    return $database_name;    return $database_name;
386  }  }
387    
 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 );  
   }  
 }  
   
388  sub testAvailability {  sub testAvailability {
389    my $self = shift;    my $self = shift;
390    my $status = $self->testDsn();    my $status = $self->testDsn();
# Line 286  sub testAvailability { Line 392  sub testAvailability {
392    return $status;    return $status;
393  }  }
394    
395  sub createDb {  sub isConnected {
396    my $self = shift;    my $self = shift;
397    my $dsn = $self->{locator}->{dbi}->{dsn};    # TODO: REVIEW!
398      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;  
     
399  }  }
400    
401  sub dropDb {  sub testDsn {
402    my $self = shift;    my $self = shift;
403    my $dsn = $self->{locator}->{dbi}->{dsn};    my $dsn = $self->{locator}->{dbi}->{dsn};
404      my $result;
   $logger->debug( __PACKAGE__ .  "->dropDb( dsn $dsn )" );  
   
   $dsn =~ s/database=(.+?);//;  
   my $database_name = $1;  
   
   my $ok;  
     
405    if ( my $dbh = DBI->connect($dsn, '', '', {    if ( my $dbh = DBI->connect($dsn, '', '', {
406                                                        PrintError => 0,                                                        PrintError => 0,
407                                                        } ) ) {                                                        } ) ) {
408      if ($database_name) {      
409        if ($dbh->do("DROP DATABASE $database_name;")) {      # TODO: REVIEW
         $ok = 1;  
       }  
     }  
410      $dbh->disconnect();      $dbh->disconnect();
411        
412        return 1;
413      } else {
414        $logger->warning( __PACKAGE__ .  "[$self->{locator}->{type}]" . "->testDsn(): " . "DBI-error: " . $DBI::errstr );
415    }    }
     
   return $ok;  
 }  
   
 sub isConnected {  
   my $self = shift;  
   return 1 if $self->{STORAGEHANDLE};  
416  }  }
417    
418  1;  1;
# Line 348  __END__ Line 421  __END__
421    
422  =head1 DESCRIPTION  =head1 DESCRIPTION
423    
424  Data::Storage is module for a accessing various "data structures" stored inside  =head2 Data::Storage
 various "data containers". It sits on top of DBI and/or Tangram.  
425    
426      Data::Storage is a module for accessing various "data structures / kinds of structured data" stored inside
427      various "data containers".
428      We tried to use the AdapterPattern (http://c2.com/cgi/wiki?AdapterPattern) to implement a wrapper-layer
429      around core CPAN modules (Tangram, DBI).
430    
431    =head2 Why?
432    
433      You will get a better code-structure (not bad for later maintenance) in growing Perl code projects,
434      especially when using multiple database connections at the same time.
435      You will be able to switch between different _kinds_ of implementations used for storing data.
436      Your code will use the very same API to access these storage layers.
437          ... implementation has to be changed for now
438      Maybe you will be able to switch "on-the-fly" without changing any bits in code in the future....
439          ... but that's not the focus
440    
441  =head1 AUTHORS / COPYRIGHT  =head2 What else?
442    
443      Having this, we were able to do implement a generic data synchronization module more easy,
444      please look at Data::Transfer.
445    
 The Data::Storage module is Copyright (c) 2002 Andreas Motl.  
 All rights reserved.  
446    
447  You may distribute it under the terms of either the GNU General Public  =head1 AUTHORS / COPYRIGHT
448  License or the Artistic License, as specified in the Perl README file.  
449      The Data::Storage module is Copyright (c) 2002 Andreas Motl.
450      All rights reserved.
451      You may distribute it under the terms of either the GNU General Public
452      License or the Artistic License, as specified in the Perl README file.
453    
454    
455  =head1 ACKNOWLEDGEMENTS  =head1 ACKNOWLEDGEMENTS
456    
457  Larry Wall for Perl, Tim Bunce for DBI, Jean-Louis Leroy for Tangram and Set::Object,    Larry Wall for Perl, Tim Bunce for DBI, Jean-Louis Leroy for Tangram and Set::Object,
458  Sam Vilain for Class::Tangram, Adam Spiers for MySQL::Diff and all contributors.    Sam Vilain for Class::Tangram, Jochen Wiedmann and Jeff Zucker for DBD::CSV & Co.,
459      Adam Spiers for MySQL::Diff and all contributors.
460    
461    
462  =head1 SUPPORT / WARRANTY  =head1 SUPPORT / WARRANTY
463    
464  Data::Storage is free software. IT COMES WITHOUT WARRANTY OF ANY KIND.    Data::Storage is free software. IT COMES WITHOUT WARRANTY OF ANY KIND.
465    
466    
467  =head1 TODO  =head1 TODO
468    
469    
470  =head2 Handle the following errors/cases:  =head2 BUGS
471    
472    "DBI-Error [Tangram]: DBD::mysql::st execute failed: Unknown column 't1.requestdump' in 'field list'"
473    
474  =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:
475      this should be detected and appended/replaced through:
476      "Schema-Error detected, maybe (just) an inconsistency.
477      Please check if your declaration in schema-module "a" matches structure in database "b" or try to run"
478      db_setup.pl --dbkey=import --action=deploy
479    
     ... 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  
480    
481  =head3 Compare schema (structure diff) with database ...  Compare schema (structure diff) with database ...
482    
483    ... when issuing "db_setup.pl --dbkey=import --action=deploy"    ... when issuing "db_setup.pl --dbkey=import --action=deploy"
484    on a database with an already deployed schema, use an additional "--update" then    on a database with an already deployed schema, use an additional "--update" then
# Line 414  Data::Storage is free software. IT COMES Line 507  Data::Storage is free software. IT COMES
507    automatically and this is believed to be the most common case under normal circumstances.    automatically and this is believed to be the most common case under normal circumstances.
508    
509    
510  =head2 Introduce some features:  =head2 FEATURES
511    
512    - Get this stuff together with UML (Unified Modeling Language) and/or standards from ODMG.    - Get this stuff together with UML (Unified Modeling Language) and/or standards from ODMG.
513    - Make it possible to load/save schemas in XMI (XML Metadata Interchange),    - Make it possible to load/save schemas in XMI (XML Metadata Interchange),
# Line 422  Data::Storage is free software. IT COMES Line 515  Data::Storage is free software. IT COMES
515      Integrate/bundle this with a web-/html-based UML modeling tool or      Integrate/bundle this with a web-/html-based UML modeling tool or
516      some other interesting stuff like the "Co-operative UML Editor" from Uni Darmstadt. (web-/java-based)      some other interesting stuff like the "Co-operative UML Editor" from Uni Darmstadt. (web-/java-based)
517    - Enable Round Trip Engineering. Keep code and diagrams in sync. Don't annoy/bother the programmers.    - Enable Round Trip Engineering. Keep code and diagrams in sync. Don't annoy/bother the programmers.
518    - Add some more handlers:    - Add support for some more handlers/locators to be able to
519      - look at DBD::CSV, Text::CSV, XML::CSV, XML::Excel       access the following standards/protocols/interfaces/programs/apis transparently:
520    - Add some more locations/locators:      +  DBD::CSV (via Data::Storage::Handler::DBI)
521      - PerlDAV: http://www.webdav.org/perldav/     (-) Text::CSV, XML::CSV, XML::Excel
522    - Move to t3, use InCASE      -  MAPI
523        -  LDAP
524        -  DAV (look at PerlDAV: http://www.webdav.org/perldav/)
525        -  Mbox (use formail for seperating/splitting entries/nodes)
526        -  Cyrus (cyrdeliver - what about cyrretrieve (export)???)
527        -  use File::DiffTree, use File::Compare
528        -  Hibernate
529        -  "Win32::UserAccountDb"
530        -  "*nix::UserAccountDb"
531        -  .wab - files (Windows Address Book)
532        -  .pst - files (Outlook Post Storage?)
533        -  XML (e.g. via XML::Simple?)
534      - Move to t3, look at InCASE
535      - some kind of security layer for methods/objects
536        - acls (stored via tangram/ldap?) for functions, methods and objects (entity- & data!?)
537        - where are the hooks needed then?
538          - is Data::Storage & Co. okay, or do we have to touch the innards of DBI and/or Tangram?
539          - an attempt to start could be:
540             - 'sub getACLByObjectId($id, $context)'
541             - 'sub getACLByMethodname($id, $context)'
542             - 'sub getACLByName($id, $context)'
543                ( would require a kinda registry to look up these very names pointing to arbitrary locations (code, data, ...) )
544      - add more hooks and various levels
545      - better integrate introduced 'getObjectByGuid'-mechanism from Data::Storage::Handler::Tangram
546    
547    
548  =head3 Links:  =head3 LINKS / REFERENCES
549    
550    Specs:    Specs:
551      UML 1.3 Spec: http://cgi.omg.org/cgi-bin/doc?ad/99-06-08.pdf      UML 1.3 Spec: http://cgi.omg.org/cgi-bin/doc?ad/99-06-08.pdf
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.14
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed