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

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

Parent Directory | Revision Log | View Patch Patch

-revision 1.7 by joko,
Sun Nov 17 06:07:18 2002 UTC
+revision 1.8 by joko,
Fri Nov 29 04:48:23 2002 UTC
 Line 4
  #
  # See COPYRIGHT section in pod text below for usage and distribution rights.
  #
- #################################
+ ############################################
  #
  #  $Log$
+ #  Revision 1.8  2002/11/29 04:48:23  joko
+ #  + updated pod
+ #
  #  Revision 1.7  2002/11/17 06:07:18  joko
  #  + creating the handler is easier than proposed first - for now :-)
  #  + sub testAvailability
-Line 34
+Line 37
  #  Revision 1.1  2002/10/10 03:43:12  cvsjoko
  #  + new
  #
- #################################
+ ############################################
- # 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
  BEGIN {
- $Data::Storage::VERSION = 0.01;
+   $Data::Storage::VERSION = 0.02;
  }
 Line 49 
 $Data::Storage::VERSION = 0.01;
  Data::Storage - Interface for accessing various Storage implementations for Perl in an independent way
+ =head1 AIMS
+   - should encapsulate Tangram, DBI, DBD::CSV and LWP:: to access them in an unordinary (more convenient) way ;)
+   - 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
+   - provide generic synchronization mechanisms across arbitrary/multiple storages based on ident/checksum
+     maybe it's possible to have schema-, structural- and semantical modifications synchronized???
  =head1 SYNOPSIS
-   ... the basic way:
+ =head2 BASIC ACCESS
+ =head2 ADVANCED ACCESS
    ... via inheritance:
-Line 70 
 Data::Storage - Interface for accessing
+Line 81 
 Data::Storage - Interface for accessing
      $self->{storage}->insert($proxyObj);
+ =head2 SYNCHRONIZATION
+   my $nodemapping = {
+     'LangText' => 'langtexts.csv',
+     'Currency' => 'currencies.csv',
+     'Country'  => 'countries.csv',
+   };
+   my $propmapping = {
+     'LangText' => [
+       [ 'source:lcountrykey'  =>  'target:country' ],
+       [ 'source:lkey'         =>  'target:key' ],
+       [ 'source:lvalue'       =>  'target:text' ],
+     ],
+     'Currency' => [
+       [ 'source:ckey'         =>  'target:key' ],
+       [ 'source:cname'        =>  'target:text' ],
+     ],
+     'Country' => [
+       [ 'source:ckey'         =>  'target:key' ],
+       [ 'source:cname'        =>  'target:text' ],
+     ],
+   };
+   sub syncResource {
+     my $self = shift;
+     my $node_source = shift;
+     my $mode = shift;
+     my $opts = shift;
+     $mode ||= '';
+     $opts->{erase} ||= 0;
+     $logger->info( __PACKAGE__ . "->syncResource( node_source $node_source mode $mode erase $opts->{erase} )");
+     # resolve metadata for syncing requested resource
+     my $node_target = $nodemapping->{$node_source};
+     my $mapping = $propmapping->{$node_source};
+     if (!$node_target || !$mapping) {
+       # loggger.... "no target, sorry!"
+       print "error while resolving resource metadata", "\n";
+       return;
+     }
+     if ($opts->{erase}) {
+       $self->_erase_all($node_source);
+     }
+     # create new sync object
+     my $sync = Data::Transfer::Sync->new(
+       storages => {
+         L => $self->{bizWorks}->{backend},
+         R => $self->{bizWorks}->{resources},
+       },
+       id_authorities        =>  [qw( L ) ],
+       checksum_authorities  =>  [qw( L ) ],
+       write_protected       =>  [qw( R ) ],
+       verbose               =>  1,
+     );
+     # sync
+     # todo: filter!?
+     $sync->syncNodes( {
+       direction       =>  $mode,                 # | +PUSH | +PULL | -FULL | +IMPORT | -EXPORT
+       method          =>  'checksum',            # | -timestamp | -manual
+       source          =>  "L:$node_source",
+       source_ident    =>  'storage_method:id',
+       source_exclude  =>  [qw( id cs )],
+       target          =>  "R:$node_target",
+       target_ident    =>  'property:oid',
+       mapping         =>  $mapping,
+     } );
+   }
  =head2 NOTE
  This module heavily relies on DBI and Tangram, but adds a lot of additional bugs and quirks.
-Line 78 
 Please look at their documentation and/o
+Line 167 
 Please look at their documentation and/o
  =head1 REQUIREMENTS
- For full functionality:
+   For full functionality:
-   DBI              from CPAN
+     DBI              from CPAN
-   Tangram          from CPAN
+     DBD::mysql       from CPAN
-   Class::Tangram   from CPAN
+     Tangram 2.04     from CPAN         (hmmm, 2.04 won't do in some cases)
-   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)
-   ... and all their dependencies
+     Class::Tangram   from CPAN
+     DBD::CSV         from CPAN
+     MySQL::Diff      from http://adamspiers.org/computing/mysqldiff/
+     ... and all their dependencies
  =cut
-Line 126 
 sub AUTOLOAD {
+Line 218 
 sub AUTOLOAD {
    #     - Deep recursion on subroutine "Data::Storage::AUTOLOAD"
    #     - Deep recursion on subroutine "Data::Storage::Handler::Abstract::AUTOLOAD"
    #     - Deep recursion on anonymous subroutine at [...]
-   # 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"
    my $self = shift;
    our $AUTOLOAD;
-Line 148 
 sub AUTOLOAD {
+Line 240 
 sub AUTOLOAD {
        $logstring .= "\t" x $tabcount . "(AUTOLOAD)";
        # TODO: only ok if logstring doesn't contain
        #            e.g. "Data::Storage[Tangram]->insert(SystemEvent=HASH(0x5c0034c))          (AUTOLOAD)"
-       # 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  ;)
        $logger->debug( $logstring );
        #print join('; ', @_);
      }
-   # filtering AUTOLOAD calls
+   # filtering AUTOLOAD calls and first-time-touch of the actual storage impl
    if ($self->_filter_AUTOLOAD($method)) {
      #print "_accessStorage\n";
      $self->_accessStorage();
-Line 213 
 sub _createStorageHandle {
+Line 305 
 sub _createStorageHandle {
    #my @args = %{$self->{locator}};
    my @args = ();
-   # create new storage handle object, propagate arguments to handler
+   # - create new storage handle object
-   # pass locator by reference to be able to store status information in it
+   # - propagate arguments to handler
+   # - pass locator by reference to be able to store status- or meta-information in it
    $self->{STORAGEHANDLE} = $pkg->new( locator => $self->{locator}, @args );
  }
-Line 248 
 sub addLogDispatchHandler {
+Line 341 
 sub addLogDispatchHandler {
  }
  sub removeLogDispatchHandler {
+   my $self = shift;
-       my $self = shift;
+   my $name = shift;
-       my $name = shift;
+   #my $logger = shift;
-       #my $logger = shift;
+   $logger->remove($name);
-       $logger->remove($name);
  }
  sub getDbName {
-Line 348 
 __END__
+Line 438 
 __END__
  =head1 DESCRIPTION
- Data::Storage is module for a accessing various "data structures" stored inside
+ Data::Storage is a module for accessing various "data structures" stored inside
  various "data containers". It sits on top of DBI and/or Tangram.
-Line 364 
 License or the Artistic License, as spec
+Line 454 
 License or the Artistic License, as spec
  =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.
+ Sam Vilain for Class::Tangram, Jochen Wiedmann and Jeff Zucker for DBD::CSV and related,
+ Adam Spiers for MySQL::Diff and all contributors.
  =head1 SUPPORT / WARRANTY
-Line 375 
 Data::Storage is free software. IT COMES
+Line 466 
 Data::Storage is free software. IT COMES
  =head1 TODO
- =head2 Handle the following errors/cases:
+ =head2 BUGS
+ "DBI-Error [Tangram]: DBD::mysql::st execute failed: Unknown column 't1.requestdump' in 'field list'"
- =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
-     ... 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 ...
+ 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
-Line 414 
 Data::Storage is free software. IT COMES
+Line 506 
 Data::Storage is free software. IT COMES
    automatically and this is believed to be the most common case under normal circumstances.
- =head2 Introduce some features:
+ =head2 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),
-Line 422 
 Data::Storage is free software. IT COMES
+Line 514 
 Data::Storage is free software. IT COMES
      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:
+   - Add support for some more handlers/locators to be able to
-     - look at DBD::CSV, Text::CSV, XML::CSV, XML::Excel
+      access the following standards/protocols/interfaces/programs/apis transparently:
-   - Add some more locations/locators:
+     +  DBD::CSV (via Data::Storage::Handler::DBI)
-     - PerlDAV: http://www.webdav.org/perldav/
+    (-) Text::CSV, XML::CSV, XML::Excel
-   - Move to t3, use InCASE
+     -  MAPI
+     -  LDAP
+     -  DAV (look at PerlDAV: http://www.webdav.org/perldav/)
+     -  Mbox (use formail for seperating/splitting entries/nodes)
+     -  Cyrus (cyrdeliver - what about cyrretrieve (export)???)
+     -  use File::DiffTree, use File::Compare
+     -  Hibernate
+     -  "Win32::UserAccountDb"
+     -  "*nix::UserAccountDb"
+     -  .wab - files (Windows Address Book)
+     -  .pst - files (Outlook Post Storage?)
+     -  XML (e.g. via XML::Simple?)
+   - Move to t3, look at InCASE
- =head3 Links:
+ =head3 LINKS / REFERENCES
    Specs:
      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.8
 Legend:



Removed from v.1.7
 


changed lines


 
Added in v.1.8
-Removed from v.1.7
+Added in v.1.8

MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26