Transfer/Sync/StorageInterface.pm

##    $Id: StorageInterface.pm,v 1.3 2003/02/11 07:54:55 joko Exp $
##
##    Copyright (c) 2002  Andreas Motl <andreas.motl@ilo.de>
##
##    See COPYRIGHT section in pod text below for usage and distribution rights.
##
##    ----------------------------------------------------------------------------------------
##    $Log: StorageInterface.pm,v $
##    Revision 1.3  2003/02/11 07:54:55  joko
##    + modified module usage
##    + debugging trials
##
##    Revision 1.2  2003/02/09 05:05:58  joko
##    + major structure changes
##    - refactored code to sister modules
##    + refactored code to this place
##
##    Revision 1.1  2003/01/20 16:58:46  joko
##    + initial check-in: here they are....
##
##    Revision 1.1  2003/01/19 01:23:04  joko
##    + new from Data/Transfer/Sync.pm
##
##    ----------------------------------------------------------------------------------------


package Data::Transfer::Sync::StorageInterface;

use strict;
use warnings;

use mixin::with qw( Data::Transfer::Sync );


# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   main

use Data::Dumper;
use Hash::Merge qw( merge );
use libdb qw( hash2Sql );
use Data::Transform::Deep qw( hash2object );


# get logger instance
my $logger = Log::Dispatch::Config->instance;

# this is a shortcut method
# ... let's try to avoid _any_ redundant code in here (ok... - at the cost of method lookups...)
sub _getNodeList {
  my $self = shift;
  my $descent = shift;
  my $filter = shift;
  $logger->debug( __PACKAGE__ . "->_getNodeList( descent=$descent, accessorName=$self->{meta}->{$descent}->{accessorName} )" );
  #$results ||= $self->{source}->getListUnfiltered($self->{meta}->{source}->{node});
  #$results ||= $self->{meta}->{source}->{storage}->getListUnfiltered($self->{meta}->{source}->{node});
  my $list = $self->{meta}->{$descent}->{storage}->getListFiltered($self->{meta}->{$descent}->{accessorName}, $filter);
#print Dumper($list);
  return $list;
}

sub _resolveNodeIdent {
  my $self = shift;
  my $descent = shift;
  
  # trace
    #print Dumper($self->{node}->{$descent});
    #print Dumper($self);
    #exit;
    
  $logger->debug( __PACKAGE__ . "->_resolveNodeIdent( descent=$descent, accessorName=$self->{meta}->{$descent}->{accessorName} )" );
  
  # get to the payload
    #my $item = $specifier->{item};
    my $payload = $self->{node}->{$descent}->{payload};

  # resolve method to get to the id of the given item
  # we use global metadata and the given descent for this task
    #my $ident = $self->{$descent}->id($item);
    #my $ident = $self->{meta}->{$descent}->{storage}->id($item);

  # trace
    #print Dumper($self->{meta}->{$descent});
    #exit;

    my $ident;
    my $provider_method = $self->{meta}->{$descent}->{IdentProvider}->{method};
    my $provider_arg = $self->{meta}->{$descent}->{IdentProvider}->{arg};

    # trace
      #print "provider_method: $provider_method", "\n";
      #print "provider_arg: $provider_arg", "\n";
      #print Dumper($payload);

    # resolve to ident
    if (lc $provider_method eq 'property') {
      $ident = $payload->{$provider_arg};

    } elsif (lc $provider_method eq 'storage_method') {
      #$ident = $self->{meta}->{$descent}->{storage}->id($item);
      $ident = $self->{meta}->{$descent}->{storage}->$provider_arg($payload);

    } elsif (lc $provider_method eq 'code') {
      $ident = 'ac';
      
    }
    
    $self->{node}->{$descent}->{ident} = $ident;
    
  return 1 if $ident;

}

# TODO:
# this should be split up into...
#   - a "_statNode" (should just touch the node to check for existance)
#   - a "_loadNode" (should load node completely)
#   - maybe additionally a "loadNodeProperty" (may specify properties to load)
#   - introduce $self->{nodecache} for this purpose
# TODO:
#   should we:
#     - not pass ident in here but resolve it via "$descent"?
#     - refactor this and stuff it with additional debug/error message
#       - this = the way the implicit load mechanism works
sub _statloadNode {

  my $self = shift;
  my $descent = shift;
  my $ident = shift;
  my $force = shift;

  #$logger->debug( __PACKAGE__ . "->_statloadNode( descent=$descent ident=$ident )" );

  # fetch entry to retrieve checksum from
  # was:
  if (!$self->{node}->{$descent} || $force) {
  # is:
  #if (!$self->{node}->{$descent}->{item} || $force) {
    
    if (!$ident) {
      #print "\n", "Attempt to fetch entry implicitely by ident failed: no ident given! This may result in an insert if no write-protection is in the way.", "\n";
      return;
    }
    
    # patch for DBD::CSV
    if ($ident && $ident eq 'Null') {
      return;
    }

    #print Dumper($self->{meta});

    my $query = { 
      node => $self->{meta}->{$descent}->{accessorName}, 
      subnodes => [qw( cs )], 
      criterias => [ 
        { key => $self->{meta}->{$descent}->{IdentProvider}->{arg}, 
           op => 'eq', 
           val => $ident },
      ]
    };

    # trace
      #print "query:", "\n";
      #print Dumper($query);

    # send query and fetch first entry from result
      my $result = $self->{meta}->{$descent}->{storage}->sendQuery($query);
      my $entry = $result->getNextEntry();

    # trace
      #print Dumper($entry);
      #print "pers: " . $self->{meta}->{$descent}->{storage}->is_persistent($entry), "\n";
      #my $state = $self->{meta}->{$descent}->{storage}->_fetch_object_state($entry, { name => 'TransactionHop' } );
      #print Dumper($state);

    # be informed about the status of the query
      my $status = $result->getStatus();

#print Dumper($status);
    
    # TODO: enhance error handling (store inside tc)
    #if (!$row) {
    #  print "\n", "row error", "\n";
    #  next;
    #}

    # these checks run before actually loading payload- and meta-data to node-container
    
      # 1st level - hard error
      if ($status && $status->{err}) {
        $logger->debug( __PACKAGE__ . "->_statloadNode (ident=\"$ident\") failed - hard error (that's ok): $status->{err}" );
        return;
      }
  
      # 2nd level - logical (empty/notfound) error
      if (($status && $status->{empty}) || !$entry) {
        $logger->debug( __PACKAGE__ . "->_statloadNode (ident=\"$ident\") failed - logical error (that's ok)" );
        #print "no entry (logical)", "\n";
        return;
      }

#print Dumper($entry);

    # was:
    # $self->{node}->{$descent}->{ident} = $ident;  
    # is:
    # TODO: re-resolve ident from entry via metadata "IdentProvider" here - like elsewhere
    $self->{node}->{$descent}->{ident} = $ident;
    $self->{node}->{$descent}->{payload} = $entry;

  }
  
  return 1;
  
}


sub _touchNodeSet {
  my $self = shift;

  $logger->debug( __PACKAGE__ . "->touchNodeSet" );

  # check descents/nodes: does descent exist / is node available?
  foreach my $descent (keys %{$self->{meta}}) {
    
    # 1. check metadata of descent(s)
      if (!$self->{meta}->{$descent}) {
        $logger->critical( __PACKAGE__ . "->touchNodeSet: Could not find descent '$descent' in configuration metadata." );
        next;
      }

    # 2. check storage handle(s)
      my $dbkey = $self->{meta}->{$descent}->{dbKey};
      if (!$self->{meta}->{$descent}->{storage}) {
        $logger->critical( __PACKAGE__ . "->touchNodeSet: Could not access storage ( descent='$descent', dbKey='$dbkey' ) - configuration-error?" );
        next;
      }
    
    # 3. check if descents (and nodes?) are actually available....
      # TODO:
      # eventually pre-check mode of access-attempt (read/write) here to provide an "early-croak" if possible
    
    # trace
      # print Dumper($self->{meta}->{$descent}->{storage}->{locator});


      my $dbType = $self->{meta}->{$descent}->{storage}->{locator}->{type};
      my $nodeName = $self->{meta}->{$descent}->{nodeName};
      my $accessorType = $self->{meta}->{$descent}->{accessorType};
      my $accessorName = $self->{meta}->{$descent}->{accessorName};


    # 4. check nodeset

    # debug message containing database type and used/determined accessor name
    $logger->debug( __PACKAGE__ . "->touchNodeSet: Accessing dbType=$dbType, accessorName=$accessorName" );
    
    # if target node(s) do(es) not exist, check if we should create it automagically
    if ($dbType ne 'DBI' && !$self->{meta}->{$descent}->{storage}->existsChildNode($accessorName)) {

      if ($descent eq 'target' && $self->{options}->{target}->{autocreateFolders}) {
        if (!$self->{meta}->{$descent}->{storage}->createChildNode($accessorName)) {
          $logger->critical( __PACKAGE__ . "->touchNodeSet: Could not create node '$self->{meta}->{$descent}->{nodeName}\@$self->{meta}->{$descent}->{dbKey}' [$self->{meta}->{$descent}->{nodeType}]." );
          next;
        }
      } else {
        $logger->critical( __PACKAGE__ . "->touchNodeSet: Could not reach node \"$nodeName\" (accessorName=$accessorName, accessorType=$accessorType) at descent \"$descent\"" );
        next;
      }
    }
    
  }

  # trace
    #print Dumper($self->{meta});
    #exit;

  
  return 1;

}


sub _modifyNode {
  my $self = shift;
  my $descent = shift;
  my $action = shift;
  my $map = shift;
  my $crit = shift;

  # map for new style callbacks
  my $map_callbacks = {};

  # checks go first!
  
    # TODO: this should be reviewed first - before extending  ;-)
    # TODO: this should be extended:
    # count this cases inside the caller to this sub and provide a better overall message
    # if this counts still zero in the end:
    #     "No nodes have been touched for modify: Do you have column-headers in your csv file?"
    if (not defined $self->{node}) {
      #$logger->critical( __PACKAGE__ . "->_modifyNode failed: \"$descent\" node is empty." );
      #return;
    }

  # transfer callback nodes from value map to callback map - handle them afterwards! - (new style callbacks)
  if (my $callbacks = $self->{meta}->{$descent}->{Callback}) {
    foreach my $callback (keys %{$callbacks->{write}}) {
      $map_callbacks->{write}->{$callback} = $map->{$callback};
      delete $map->{$callback};
    }
  }
  
  
  # trace
    #print Dumper($self->{meta});


  # --------------------------------------------------------------------------
  # DBI speaks SQL
  if ($self->{meta}->{$descent}->{storage}->{locator}->{type} eq 'DBI') {

    # trace
      #print Dumper($map);
      #delete $map->{cs};

    # transfer data
      # TODO: wrap this around '$storageHandle->sendQuery(...)'!?
      my $sql_main;
      if (lc($action) eq 'insert') {
        $sql_main = hash2Sql($self->{meta}->{$descent}->{accessorName}, $map, 'SQL_INSERT');
      } elsif (lc $action eq 'update') {
        $crit ||= "$self->{meta}->{$descent}->{IdentProvider}->{arg}='$self->{node}->{$descent}->{ident}'";
        $sql_main = hash2Sql($self->{meta}->{$descent}->{accessorName}, $map, 'SQL_UPDATE', $crit);
      }
      my $sqlHandle = $self->{meta}->{$descent}->{storage}->sendCommand($sql_main);

    # handle errors
      if ($sqlHandle->err) {
        #if ($self->{args}->{debug}) { print "sql-error with statement: $sql_main", "\n"; }
        $self->{node}->{status}->{error} = {
          statement => $sql_main,
          state => $sqlHandle->state, 
          err => $sqlHandle->err, 
          errstr => $sqlHandle->errstr, 
        };
      } else {
        $self->{node}->{status}->{ok} = 1;
      }


  # --------------------------------------------------------------------------
  # Tangram does it the oo-way (naturally)
  } elsif ($self->{meta}->{$descent}->{storage}->{locator}->{type} eq 'Tangram') {
    my $sql_main;
    my $object;

    # determine classname
    my $classname = $self->{meta}->{$descent}->{nodeType};
    
    # attributes/properties to exclude
      # push declared ones from metadata
      my @exclude = @{$self->{meta}->{$descent}->{subnodes_exclude}};
      # push the attributes associated with the identifier
      if (my $identProvider = $self->{meta}->{$descent}->{IdentProvider}) {
        push @exclude, $identProvider->{arg};
      }

    # trace
      #print Dumper($self->{meta});
      #exit;

    # new feature:
    #     - check TypeProvider metadata property from other side
    #     - use argument (arg) inside as a classname for object creation on this side
    #my $otherSide = $self->_otherSide($descent);
    if (my $typeProvider = $self->{meta}->{$descent}->{TypeProvider}) {
      #print Dumper($map);
      $classname = $map->{$typeProvider->{arg}};
      # remove nodes from map also (push nodes to "subnodes_exclude" list)
      push @exclude, $typeProvider->{arg};
    }
    
    # exclude banned properties (remove from map)
    #map { delete $self->{node}->{map}->{$_} } @{$self->{args}->{exclude}};
    map { delete $map->{$_} } @exclude;

    # list of properties
    my @props = keys %{$map};

    # transfer data
    if (lc $action eq 'insert') {

      # make the object persistent in four steps:
      #   - raw create (perl / class tangram scope)
      #   - orm insert (tangram scope)   ... this establishes inheritance - don't try to fill in inherited properties before!
      #      is this a Tangram bug?
      #   - raw fill-in from hash (perl scope)
      #   - orm update (tangram scope)  ... this updates all properties just filled in
      
      
      # ==========================
      # TODO: REVIEW HERE!!!
      # can't we achieve this more elegant?
      #   o use DesignPattern::Object???
      #   o use Hash::Merge!!! (take care about the cloning behaviour)
      
        # check if object exists (is classname a valid perl package/module?)

          # we can just check if the classname is valid here
          if (!$classname) {
            $logger->critical( __PACKAGE__ . "->_modifyNode: classname is undefined" );
            # FIXME: stop syncing here?
            return;
          }
        
          # try to match against the classes known by Class::Tangram
          # FIXME: do "/i" on win32 only!
          my $classname_find = quotemeta($classname);
          if (!grep(m/$classname_find/i, Class::Tangram::known_classes())) {
            $logger->critical( __PACKAGE__ . "->_modifyNode: Classname '$classname' is not known by Class::Tangram" );
            # FIXME: stop syncing here?
            return;
          }
      
        # create new object ... 
          # V1
            # build array to initialize object
            #my @initarray = ();
            #map { push @initarray, $_, undef; } @props;
            #my $object = $classname->new( @initarray );
          # V2
            $object = $classname->new();
          # V3
            # $object = DesignPattern::Object->new($data);

        # ... pass to orm first ...
        $self->{meta}->{$descent}->{storage}->insert($object);
  
        # ... and initialize with empty (undef'd) properties afterwards.
        map { $object->{$_} = undef; } @props;
  
        # trace
          #print "\n";
          #print Dumper($map);
          #print Dumper($object);
          #exit;

        # mix in (merge) values ...
          # TODO: use Hash::Merge here? benchmark!
          # no! we'd need a Object::Merge here! it's *...2object*
          hash2object($object, $map);
  
        # trace
          #print Dumper($object);
          #exit;

      # TODO: REVIEW HERE!!!
      # ==========================

      # ... and re-update@orm.
        $self->{meta}->{$descent}->{storage}->update($object);

      # asymmetry: get ident after insert
      # TODO:
      #   - just do this if it is an IdentAuthority
      #   - use IdentProvider metadata here
#print Dumper($self->{meta}->{$descent});
      my $oid = $self->{meta}->{$descent}->{storage}->id($object);
#print "oid: $oid", "\n";
      $self->{node}->{$descent}->{ident} = $oid;


    } elsif (lc $action eq 'update') {
      
      # get fresh object from orm first
      $object = $self->{meta}->{$descent}->{storage}->load($self->{node}->{$descent}->{ident});

#print Dumper($self->{node});
      
      # mix in values
        #print Dumper($object);
        # TODO: use Hash::Merge here???
        hash2object($object, $map);
        #print Dumper($object);
        #exit;

      # update orm
        $self->{meta}->{$descent}->{storage}->update($object);
        
    }

#exit;
    
    my $error = 0;

    # handle new style callbacks - this is a HACK - do this without an eval!
    #print Dumper($map);
    #print "cb: ", Dumper($self->{meta}->{$descent}->{Callback});
    #print Dumper($map_callbacks);
    foreach my $node (keys %{$map_callbacks->{write}}) {
      #print Dumper($node);

      # ------------  half-redundant: make $self->callCallback($object, $value, $opts)
      my $perl_callback = $self->{meta}->{$descent}->{nodeType} . '::' . $node . '_write';
      my $evalstring = $perl_callback . '( { object => $object, value => $map_callbacks->{write}->{$node}, storage => $self->{meta}->{$descent}->{storage} } );';
      #print $evalstring, "\n"; exit;
      eval($evalstring);
      if ($@) {
        $error = 1;
        $logger->error( __PACKAGE__ . "->_modifyNode: $@" );
        next;
      }
      # ------------  half-redundant: make $self->callCallback($object, $value, $opts)
      
      #print "after eval", "\n";
      
      if (!$error) {
        # re-update@orm
        $self->{meta}->{$descent}->{storage}->update($object);
      }
    }
  
    # handle errors
    if ($error) {
      #print "error", "\n";
=pod
      my $sqlHandle;
      #if ($self->{args}->{debug}) { print "sql-error with statement: $sql_main", "\n"; }
      $self->{node}->{status}->{error} = {
        statement => $sql_main,
        state => $sqlHandle->state, 
        err => $sqlHandle->err, 
        errstr => $sqlHandle->errstr, 
      };
=cut
      # rollback....
      #print "rollback", "\n";
      $self->{meta}->{$descent}->{storage}->erase($object);
      #print "after rollback", "\n";
    } else {
      $self->{node}->{status}->{ok} = 1;
    }

  }

}

sub _erase_all {
  my $self = shift;
  my $descent = shift;
  #my $node = shift;
  #print Dumper($self->{meta}->{$descent});
  #my $node = $self->{meta}->{$descent}->{nodeName};
  my $node = $self->{meta}->{$descent}->{accessorName};
  $logger->debug( __PACKAGE__ . "->_erase_all( node $node )" );
  $self->{meta}->{$descent}->{storage}->eraseAll($node);
}

1;
__END__
1	joko	1.4	## $Id: StorageInterface.pm,v 1.3 2003/02/11 07:54:55 joko Exp $
2	joko	1.1	##
3			## Copyright (c) 2002 Andreas Motl <andreas.motl@ilo.de>
4			##
5			## See COPYRIGHT section in pod text below for usage and distribution rights.
6			##
7			## ----------------------------------------------------------------------------------------
8	joko	1.2	## $Log: StorageInterface.pm,v $
9	joko	1.4	## Revision 1.3 2003/02/11 07:54:55 joko
10			## + modified module usage
11			## + debugging trials
12			##
13	joko	1.3	## Revision 1.2 2003/02/09 05:05:58 joko
14			## + major structure changes
15			## - refactored code to sister modules
16			## + refactored code to this place
17			##
18	joko	1.2	## Revision 1.1 2003/01/20 16:58:46 joko
19			## + initial check-in: here they are....
20			##
21	joko	1.1	## Revision 1.1 2003/01/19 01:23:04 joko
22			## + new from Data/Transfer/Sync.pm
23			##
24			## ----------------------------------------------------------------------------------------
25
26
27			package Data::Transfer::Sync::StorageInterface;
28
29			use strict;
30			use warnings;
31
32			use mixin::with qw( Data::Transfer::Sync );
33
34
35			# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - main
36
37	joko	1.2	use Data::Dumper;
38			use Hash::Merge qw( merge );
39	joko	1.3	use libdb qw( hash2Sql );
40			use Data::Transform::Deep qw( hash2object );
41	joko	1.2
42
43	joko	1.1	# get logger instance
44			my $logger = Log::Dispatch::Config->instance;
45
46			# this is a shortcut method
47			# ... let's try to avoid _any_ redundant code in here (ok... - at the cost of method lookups...)
48			sub _getNodeList {
49			my $self = shift;
50			my $descent = shift;
51			my $filter = shift;
52	joko	1.2	$logger->debug( __PACKAGE__ . "->_getNodeList( descent=$descent, accessorName=$self->{meta}->{$descent}->{accessorName} )" );
53	joko	1.1	#$results \|\|= $self->{source}->getListUnfiltered($self->{meta}->{source}->{node});
54			#$results \|\|= $self->{meta}->{source}->{storage}->getListUnfiltered($self->{meta}->{source}->{node});
55	joko	1.2	my $list = $self->{meta}->{$descent}->{storage}->getListFiltered($self->{meta}->{$descent}->{accessorName}, $filter);
56	joko	1.1	#print Dumper($list);
57			return $list;
58			}
59
60			sub _resolveNodeIdent {
61			my $self = shift;
62			my $descent = shift;
63
64	joko	1.3	# trace
65			#print Dumper($self->{node}->{$descent});
66			#print Dumper($self);
67			#exit;
68
69	joko	1.2	$logger->debug( __PACKAGE__ . "->_resolveNodeIdent( descent=$descent, accessorName=$self->{meta}->{$descent}->{accessorName} )" );
70	joko	1.1
71			# get to the payload
72			#my $item = $specifier->{item};
73			my $payload = $self->{node}->{$descent}->{payload};
74
75			# resolve method to get to the id of the given item
76			# we use global metadata and the given descent for this task
77			#my $ident = $self->{$descent}->id($item);
78			#my $ident = $self->{meta}->{$descent}->{storage}->id($item);
79
80	joko	1.3	# trace
81			#print Dumper($self->{meta}->{$descent});
82			#exit;
83
84	joko	1.1	my $ident;
85			my $provider_method = $self->{meta}->{$descent}->{IdentProvider}->{method};
86			my $provider_arg = $self->{meta}->{$descent}->{IdentProvider}->{arg};
87
88	joko	1.2	# trace
89			#print "provider_method: $provider_method", "\n";
90			#print "provider_arg: $provider_arg", "\n";
91			#print Dumper($payload);
92	joko	1.1
93			# resolve to ident
94			if (lc $provider_method eq 'property') {
95			$ident = $payload->{$provider_arg};
96
97			} elsif (lc $provider_method eq 'storage_method') {
98			#$ident = $self->{meta}->{$descent}->{storage}->id($item);
99			$ident = $self->{meta}->{$descent}->{storage}->$provider_arg($payload);
100
101			} elsif (lc $provider_method eq 'code') {
102			$ident = 'ac';
103
104			}
105
106			$self->{node}->{$descent}->{ident} = $ident;
107
108			return 1 if $ident;
109
110			}
111
112			# TODO:
113			# this should be split up into...
114			# - a "_statNode" (should just touch the node to check for existance)
115			# - a "_loadNode" (should load node completely)
116			# - maybe additionally a "loadNodeProperty" (may specify properties to load)
117			# - introduce $self->{nodecache} for this purpose
118			# TODO:
119			# should we:
120			# - not pass ident in here but resolve it via "$descent"?
121			# - refactor this and stuff it with additional debug/error message
122			# - this = the way the implicit load mechanism works
123			sub _statloadNode {
124
125			my $self = shift;
126			my $descent = shift;
127			my $ident = shift;
128			my $force = shift;
129
130	joko	1.3	#$logger->debug( __PACKAGE__ . "->_statloadNode( descent=$descent ident=$ident )" );
131	joko	1.2
132	joko	1.1	# fetch entry to retrieve checksum from
133			# was:
134			if (!$self->{node}->{$descent} \|\| $force) {
135			# is:
136			#if (!$self->{node}->{$descent}->{item} \|\| $force) {
137
138			if (!$ident) {
139			#print "\n", "Attempt to fetch entry implicitely by ident failed: no ident given! This may result in an insert if no write-protection is in the way.", "\n";
140			return;
141			}
142
143			# patch for DBD::CSV
144			if ($ident && $ident eq 'Null') {
145			return;
146			}
147
148	joko	1.2	#print Dumper($self->{meta});
149	joko	1.1
150			my $query = {
151	joko	1.2	node => $self->{meta}->{$descent}->{accessorName},
152	joko	1.1	subnodes => [qw( cs )],
153			criterias => [
154			{ key => $self->{meta}->{$descent}->{IdentProvider}->{arg},
155			op => 'eq',
156			val => $ident },
157			]
158			};
159
160	joko	1.2	# trace
161			#print "query:", "\n";
162			#print Dumper($query);
163
164			# send query and fetch first entry from result
165			my $result = $self->{meta}->{$descent}->{storage}->sendQuery($query);
166			my $entry = $result->getNextEntry();
167
168			# trace
169			#print Dumper($entry);
170			#print "pers: " . $self->{meta}->{$descent}->{storage}->is_persistent($entry), "\n";
171			#my $state = $self->{meta}->{$descent}->{storage}->_fetch_object_state($entry, { name => 'TransactionHop' } );
172			#print Dumper($state);
173	joko	1.1
174	joko	1.2	# be informed about the status of the query
175			my $status = $result->getStatus();
176	joko	1.1
177			#print Dumper($status);
178
179			# TODO: enhance error handling (store inside tc)
180			#if (!$row) {
181			# print "\n", "row error", "\n";
182			# next;
183			#}
184
185			# these checks run before actually loading payload- and meta-data to node-container
186
187			# 1st level - hard error
188			if ($status && $status->{err}) {
189			$logger->debug( __PACKAGE__ . "->_statloadNode (ident=\"$ident\") failed - hard error (that's ok): $status->{err}" );
190			return;
191			}
192
193			# 2nd level - logical (empty/notfound) error
194			if (($status && $status->{empty}) \|\| !$entry) {
195			$logger->debug( __PACKAGE__ . "->_statloadNode (ident=\"$ident\") failed - logical error (that's ok)" );
196			#print "no entry (logical)", "\n";
197			return;
198			}
199
200			#print Dumper($entry);
201
202			# was:
203			# $self->{node}->{$descent}->{ident} = $ident;
204			# is:
205			# TODO: re-resolve ident from entry via metadata "IdentProvider" here - like elsewhere
206			$self->{node}->{$descent}->{ident} = $ident;
207			$self->{node}->{$descent}->{payload} = $entry;
208
209			}
210
211			return 1;
212
213	joko	1.2	}
214
215
216			sub _touchNodeSet {
217			my $self = shift;
218
219			$logger->debug( __PACKAGE__ . "->touchNodeSet" );
220
221			# check descents/nodes: does descent exist / is node available?
222			foreach my $descent (keys %{$self->{meta}}) {
223
224			# 1. check metadata of descent(s)
225			if (!$self->{meta}->{$descent}) {
226			$logger->critical( __PACKAGE__ . "->touchNodeSet: Could not find descent '$descent' in configuration metadata." );
227			next;
228			}
229
230			# 2. check storage handle(s)
231			my $dbkey = $self->{meta}->{$descent}->{dbKey};
232			if (!$self->{meta}->{$descent}->{storage}) {
233			$logger->critical( __PACKAGE__ . "->touchNodeSet: Could not access storage ( descent='$descent', dbKey='$dbkey' ) - configuration-error?" );
234			next;
235			}
236
237			# 3. check if descents (and nodes?) are actually available....
238			# TODO:
239			# eventually pre-check mode of access-attempt (read/write) here to provide an "early-croak" if possible
240
241			# trace
242			# print Dumper($self->{meta}->{$descent}->{storage}->{locator});
243
244
245			my $dbType = $self->{meta}->{$descent}->{storage}->{locator}->{type};
246			my $nodeName = $self->{meta}->{$descent}->{nodeName};
247			my $accessorType = $self->{meta}->{$descent}->{accessorType};
248			my $accessorName = $self->{meta}->{$descent}->{accessorName};
249
250
251			# 4. check nodeset
252
253			# debug message containing database type and used/determined accessor name
254			$logger->debug( __PACKAGE__ . "->touchNodeSet: Accessing dbType=$dbType, accessorName=$accessorName" );
255
256			# if target node(s) do(es) not exist, check if we should create it automagically
257			if ($dbType ne 'DBI' && !$self->{meta}->{$descent}->{storage}->existsChildNode($accessorName)) {
258
259			if ($descent eq 'target' && $self->{options}->{target}->{autocreateFolders}) {
260			if (!$self->{meta}->{$descent}->{storage}->createChildNode($accessorName)) {
261			$logger->critical( __PACKAGE__ . "->touchNodeSet: Could not create node '$self->{meta}->{$descent}->{nodeName}\@$self->{meta}->{$descent}->{dbKey}' [$self->{meta}->{$descent}->{nodeType}]." );
262			next;
263			}
264			} else {
265			$logger->critical( __PACKAGE__ . "->touchNodeSet: Could not reach node \"$nodeName\" (accessorName=$accessorName, accessorType=$accessorType) at descent \"$descent\"" );
266			next;
267			}
268			}
269
270			}
271
272			# trace
273			#print Dumper($self->{meta});
274			#exit;
275
276
277			return 1;
278
279			}
280
281
282
283			sub _modifyNode {
284			my $self = shift;
285			my $descent = shift;
286			my $action = shift;
287			my $map = shift;
288			my $crit = shift;
289
290			# map for new style callbacks
291			my $map_callbacks = {};
292
293			# checks go first!
294
295			# TODO: this should be reviewed first - before extending ;-)
296			# TODO: this should be extended:
297			# count this cases inside the caller to this sub and provide a better overall message
298			# if this counts still zero in the end:
299			# "No nodes have been touched for modify: Do you have column-headers in your csv file?"
300			if (not defined $self->{node}) {
301			#$logger->critical( __PACKAGE__ . "->_modifyNode failed: \"$descent\" node is empty." );
302			#return;
303			}
304
305			# transfer callback nodes from value map to callback map - handle them afterwards! - (new style callbacks)
306			if (my $callbacks = $self->{meta}->{$descent}->{Callback}) {
307			foreach my $callback (keys %{$callbacks->{write}}) {
308			$map_callbacks->{write}->{$callback} = $map->{$callback};
309			delete $map->{$callback};
310			}
311			}
312
313
314			# trace
315			#print Dumper($self->{meta});
316
317
318			# --------------------------------------------------------------------------
319			# DBI speaks SQL
320			if ($self->{meta}->{$descent}->{storage}->{locator}->{type} eq 'DBI') {
321
322			# trace
323			#print Dumper($map);
324			#delete $map->{cs};
325
326			# transfer data
327			# TODO: wrap this around '$storageHandle->sendQuery(...)'!?
328			my $sql_main;
329			if (lc($action) eq 'insert') {
330			$sql_main = hash2Sql($self->{meta}->{$descent}->{accessorName}, $map, 'SQL_INSERT');
331			} elsif (lc $action eq 'update') {
332			$crit \|\|= "$self->{meta}->{$descent}->{IdentProvider}->{arg}='$self->{node}->{$descent}->{ident}'";
333			$sql_main = hash2Sql($self->{meta}->{$descent}->{accessorName}, $map, 'SQL_UPDATE', $crit);
334			}
335			my $sqlHandle = $self->{meta}->{$descent}->{storage}->sendCommand($sql_main);
336
337			# handle errors
338			if ($sqlHandle->err) {
339			#if ($self->{args}->{debug}) { print "sql-error with statement: $sql_main", "\n"; }
340			$self->{node}->{status}->{error} = {
341			statement => $sql_main,
342			state => $sqlHandle->state,
343			err => $sqlHandle->err,
344			errstr => $sqlHandle->errstr,
345			};
346			} else {
347			$self->{node}->{status}->{ok} = 1;
348			}
349
350
351			# --------------------------------------------------------------------------
352			# Tangram does it the oo-way (naturally)
353			} elsif ($self->{meta}->{$descent}->{storage}->{locator}->{type} eq 'Tangram') {
354			my $sql_main;
355			my $object;
356
357			# determine classname
358			my $classname = $self->{meta}->{$descent}->{nodeType};
359
360			# attributes/properties to exclude
361			# push declared ones from metadata
362			my @exclude = @{$self->{meta}->{$descent}->{subnodes_exclude}};
363			# push the attributes associated with the identifier
364			if (my $identProvider = $self->{meta}->{$descent}->{IdentProvider}) {
365			push @exclude, $identProvider->{arg};
366			}
367
368			# trace
369			#print Dumper($self->{meta});
370			#exit;
371
372			# new feature:
373			# - check TypeProvider metadata property from other side
374			# - use argument (arg) inside as a classname for object creation on this side
375			#my $otherSide = $self->_otherSide($descent);
376			if (my $typeProvider = $self->{meta}->{$descent}->{TypeProvider}) {
377			#print Dumper($map);
378			$classname = $map->{$typeProvider->{arg}};
379			# remove nodes from map also (push nodes to "subnodes_exclude" list)
380			push @exclude, $typeProvider->{arg};
381			}
382
383			# exclude banned properties (remove from map)
384			#map { delete $self->{node}->{map}->{$_} } @{$self->{args}->{exclude}};
385			map { delete $map->{$_} } @exclude;
386
387			# list of properties
388			my @props = keys %{$map};
389
390			# transfer data
391			if (lc $action eq 'insert') {
392
393			# make the object persistent in four steps:
394			# - raw create (perl / class tangram scope)
395			# - orm insert (tangram scope) ... this establishes inheritance - don't try to fill in inherited properties before!
396			# is this a Tangram bug?
397			# - raw fill-in from hash (perl scope)
398			# - orm update (tangram scope) ... this updates all properties just filled in
399
400
401			# ==========================
402			# TODO: REVIEW HERE!!!
403			# can't we achieve this more elegant?
404			# o use DesignPattern::Object???
405			# o use Hash::Merge!!! (take care about the cloning behaviour)
406
407			# check if object exists (is classname a valid perl package/module?)
408
409			# we can just check if the classname is valid here
410			if (!$classname) {
411			$logger->critical( __PACKAGE__ . "->_modifyNode: classname is undefined" );
412			# FIXME: stop syncing here?
413			return;
414			}
415
416			# try to match against the classes known by Class::Tangram
417			# FIXME: do "/i" on win32 only!
418			my $classname_find = quotemeta($classname);
419			if (!grep(m/$classname_find/i, Class::Tangram::known_classes())) {
420			$logger->critical( __PACKAGE__ . "->_modifyNode: Classname '$classname' is not known by Class::Tangram" );
421			# FIXME: stop syncing here?
422			return;
423			}
424
425			# create new object ...
426			# V1
427			# build array to initialize object
428			#my @initarray = ();
429			#map { push @initarray, $_, undef; } @props;
430			#my $object = $classname->new( @initarray );
431			# V2
432			$object = $classname->new();
433			# V3
434			# $object = DesignPattern::Object->new($data);
435
436			# ... pass to orm first ...
437			$self->{meta}->{$descent}->{storage}->insert($object);
438
439			# ... and initialize with empty (undef'd) properties afterwards.
440			map { $object->{$_} = undef; } @props;
441
442			# trace
443			#print "\n";
444			#print Dumper($map);
445			#print Dumper($object);
446			#exit;
447
448			# mix in (merge) values ...
449			# TODO: use Hash::Merge here? benchmark!
450			# no! we'd need a Object::Merge here! it's ...2object
451			hash2object($object, $map);
452
453			# trace
454			#print Dumper($object);
455			#exit;
456
457			# TODO: REVIEW HERE!!!
458			# ==========================
459
460			# ... and re-update@orm.
461			$self->{meta}->{$descent}->{storage}->update($object);
462
463			# asymmetry: get ident after insert
464			# TODO:
465			# - just do this if it is an IdentAuthority
466			# - use IdentProvider metadata here
467			#print Dumper($self->{meta}->{$descent});
468			my $oid = $self->{meta}->{$descent}->{storage}->id($object);
469			#print "oid: $oid", "\n";
470			$self->{node}->{$descent}->{ident} = $oid;
471
472
473			} elsif (lc $action eq 'update') {
474
475			# get fresh object from orm first
476			$object = $self->{meta}->{$descent}->{storage}->load($self->{node}->{$descent}->{ident});
477
478			#print Dumper($self->{node});
479
480			# mix in values
481			#print Dumper($object);
482			# TODO: use Hash::Merge here???
483			hash2object($object, $map);
484			#print Dumper($object);
485			#exit;
486
487			# update orm
488			$self->{meta}->{$descent}->{storage}->update($object);
489
490			}
491
492			#exit;
493
494			my $error = 0;
495
496			# handle new style callbacks - this is a HACK - do this without an eval!
497			#print Dumper($map);
498			#print "cb: ", Dumper($self->{meta}->{$descent}->{Callback});
499			#print Dumper($map_callbacks);
500			foreach my $node (keys %{$map_callbacks->{write}}) {
501			#print Dumper($node);
502	joko	1.4
503			# ------------ half-redundant: make $self->callCallback($object, $value, $opts)
504			my $perl_callback = $self->{meta}->{$descent}->{nodeType} . '::' . $node . '_write';
505	joko	1.2	my $evalstring = $perl_callback . '( { object => $object, value => $map_callbacks->{write}->{$node}, storage => $self->{meta}->{$descent}->{storage} } );';
506			#print $evalstring, "\n"; exit;
507			eval($evalstring);
508			if ($@) {
509			$error = 1;
510	joko	1.4	$logger->error( __PACKAGE__ . "->_modifyNode: $@" );
511			next;
512	joko	1.2	}
513	joko	1.4	# ------------ half-redundant: make $self->callCallback($object, $value, $opts)
514	joko	1.2
515			#print "after eval", "\n";
516
517			if (!$error) {
518			# re-update@orm
519			$self->{meta}->{$descent}->{storage}->update($object);
520			}
521			}
522
523			# handle errors
524			if ($error) {
525			#print "error", "\n";
526			=pod
527			my $sqlHandle;
528			#if ($self->{args}->{debug}) { print "sql-error with statement: $sql_main", "\n"; }
529			$self->{node}->{status}->{error} = {
530			statement => $sql_main,
531			state => $sqlHandle->state,
532			err => $sqlHandle->err,
533			errstr => $sqlHandle->errstr,
534			};
535			=cut
536			# rollback....
537			#print "rollback", "\n";
538			$self->{meta}->{$descent}->{storage}->erase($object);
539			#print "after rollback", "\n";
540			} else {
541			$self->{node}->{status}->{ok} = 1;
542			}
543
544			}
545
546	joko	1.1	}
547
548	joko	1.4	sub _erase_all {
549			my $self = shift;
550			my $descent = shift;
551			#my $node = shift;
552			#print Dumper($self->{meta}->{$descent});
553			#my $node = $self->{meta}->{$descent}->{nodeName};
554			my $node = $self->{meta}->{$descent}->{accessorName};
555			$logger->debug( __PACKAGE__ . "->_erase_all( node $node )" );
556			$self->{meta}->{$descent}->{storage}->eraseAll($node);
557			}
558	joko	1.1
559			1;
560	joko	1.4	__END__
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26