--- nfo/perl/libs/Data/Storage.pm 2002/11/29 04:48:23 1.8 +++ nfo/perl/libs/Data/Storage.pm 2002/12/19 16:27:59 1.14 @@ -1,4 +1,4 @@ -# $Id: Storage.pm,v 1.8 2002/11/29 04:48:23 joko Exp $ +# $Id: Storage.pm,v 1.14 2002/12/19 16:27:59 joko Exp $ # # Copyright (c) 2002 Andreas Motl # @@ -7,6 +7,33 @@ ############################################ # # $Log: Storage.pm,v $ +# Revision 1.14 2002/12/19 16:27:59 joko +# - moved 'sub dropDb' to Data::Storage::Handler::DBI +# +# Revision 1.13 2002/12/17 21:54:12 joko +# + feature when using Tangram: +# + what? each object created should delivered with a globally(!?) unique identifier (GUID) besides the native tangram object id (OID) +# + patched Tangram::Storage (jonen) +# + enhanced Data::Storage::Schema::Tangram (joko) +# + enhanced Data::Storage::Handler::Tangram 'sub getObjectByGuid' (jonen) +# + how? +# + each concrete (non-abstract) class gets injected with an additional field/property called 'guid' - this is done (dynamically) on schema level +# + this property ('guid') gets filled on object creation/insertion from 'sub Tangram::Storage::_insert' using Data::UUID from CPAN +# + (as for now) this property can get accessed by calling 'getObjectByGuid' on the already known storage-handle used throughout the application +# +# Revision 1.12 2002/12/12 02:50:15 joko +# + this now (unfortunately) needs DBI for some helper functions +# + TODO: these have to be refactored to another scope! (soon!) +# +# Revision 1.11 2002/12/11 06:53:19 joko +# + updated pod +# +# Revision 1.10 2002/12/07 03:37:23 joko +# + updated pod +# +# Revision 1.9 2002/12/01 22:15:45 joko +# - sub createDb: moved to handler +# # Revision 1.8 2002/11/29 04:48:23 joko # + updated pod # @@ -47,7 +74,7 @@ =head1 NAME -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 =head1 AIMS @@ -161,8 +188,8 @@ =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. + 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 @@ -190,6 +217,9 @@ use Data::Storage::Locator; use Data::Dumper; +# TODO: wipe out! +use DBI; + # TODO: actually implement level (integrate with Log::Dispatch) my $TRACELEVEL = 0; @@ -355,20 +385,6 @@ return $database_name; } -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 ); - } -} - sub testAvailability { my $self = shift; my $status = $self->testDsn(); @@ -376,60 +392,27 @@ return $status; } -sub createDb { +sub isConnected { 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; - + # TODO: REVIEW! + return 1 if $self->{STORAGEHANDLE}; } -sub dropDb { +sub testDsn { my $self = shift; my $dsn = $self->{locator}->{dbi}->{dsn}; - - $logger->debug( __PACKAGE__ . "->dropDb( dsn $dsn )" ); - - $dsn =~ s/database=(.+?);//; - my $database_name = $1; - - my $ok; - + my $result; if ( my $dbh = DBI->connect($dsn, '', '', { PrintError => 0, } ) ) { - if ($database_name) { - if ($dbh->do("DROP DATABASE $database_name;")) { - $ok = 1; - } - } + + # TODO: REVIEW $dbh->disconnect(); + + return 1; + } else { + $logger->warning( __PACKAGE__ . "[$self->{locator}->{type}]" . "->testDsn(): " . "DBI-error: " . $DBI::errstr ); } - - return $ok; -} - -sub isConnected { - my $self = shift; - return 1 if $self->{STORAGEHANDLE}; } 1; @@ -438,29 +421,47 @@ =head1 DESCRIPTION -Data::Storage is a module for accessing various "data structures" stored inside -various "data containers". It sits on top of DBI and/or Tangram. +=head2 Data::Storage + Data::Storage is a module for accessing various "data structures / kinds of structured data" stored inside + various "data containers". + We tried to use the AdapterPattern (http://c2.com/cgi/wiki?AdapterPattern) to implement a wrapper-layer + around core CPAN modules (Tangram, DBI). + +=head2 Why? + + You will get a better code-structure (not bad for later maintenance) in growing Perl code projects, + especially when using multiple database connections at the same time. + You will be able to switch between different _kinds_ of implementations used for storing data. + Your code will use the very same API to access these storage layers. + ... implementation has to be changed for now + Maybe you will be able to switch "on-the-fly" without changing any bits in code in the future.... + ... but that's not the focus -=head1 AUTHORS / COPYRIGHT +=head2 What else? -The Data::Storage module is Copyright (c) 2002 Andreas Motl. -All rights reserved. + Having this, we were able to do implement a generic data synchronization module more easy, + please look at Data::Transfer. + + +=head1 AUTHORS / COPYRIGHT -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. + 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, Jochen Wiedmann and Jeff Zucker for DBD::CSV and related, -Adam Spiers for MySQL::Diff and all contributors. + Larry Wall for Perl, Tim Bunce for DBI, Jean-Louis Leroy for Tangram and Set::Object, + Sam Vilain for Class::Tangram, Jochen Wiedmann and Jeff Zucker for DBD::CSV & Co., + Adam Spiers for MySQL::Diff and all contributors. =head1 SUPPORT / WARRANTY -Data::Storage is free software. IT COMES WITHOUT WARRANTY OF ANY KIND. + Data::Storage is free software. IT COMES WITHOUT WARRANTY OF ANY KIND. =head1 TODO @@ -531,6 +532,17 @@ - .pst - files (Outlook Post Storage?) - XML (e.g. via XML::Simple?) - Move to t3, look at InCASE + - some kind of security layer for methods/objects + - acls (stored via tangram/ldap?) for functions, methods and objects (entity- & data!?) + - where are the hooks needed then? + - is Data::Storage & Co. okay, or do we have to touch the innards of DBI and/or Tangram? + - an attempt to start could be: + - 'sub getACLByObjectId($id, $context)' + - 'sub getACLByMethodname($id, $context)' + - 'sub getACLByName($id, $context)' + ( would require a kinda registry to look up these very names pointing to arbitrary locations (code, data, ...) ) + - add more hooks and various levels + - better integrate introduced 'getObjectByGuid'-mechanism from Data::Storage::Handler::Tangram =head3 LINKS / REFERENCES