Transfer/Sync/Core.pm

## -------------------------------------------------------------------------
##
##    $Id: Core.pm,v 1.8 2003/03/27 15:31:15 joko Exp $
##
##    Copyright (c) 2002  Andreas Motl <andreas.motl@ilo.de>
##
##    See COPYRIGHT section in pod text below for usage and distribution rights.
##
## -------------------------------------------------------------------------
##    $Log: Core.pm,v $
##    Revision 1.8  2003/03/27 15:31:15  joko
##    fixes to modules regarding new namespace(s) below Data::Mungle::*
##
##    Revision 1.7  2003/02/21 08:01:11  joko
##    debugging, logging
##    renamed module
##
##    Revision 1.6  2003/02/14 14:03:49  joko
##    + logging, debugging
##    - refactored code to sister module
##
##    Revision 1.5  2003/02/11 05:30:47  joko
##    + minor fixes and some debugging mud
##
##    Revision 1.4  2003/02/09 05:01:10  joko
##    + major structure changes
##    - refactored code to sister modules
##
##    Revision 1.3  2003/01/20 17:01:14  joko
##    + cosmetics and debugging
##    + probably refactored code to new plugin-modules 'Metadata.pm' and/or 'StorageInterface.pm' (guess it was the last one...)
##
##    Revision 1.2  2003/01/19 02:05:42  joko
##    - removed pod-documentation: now in Data/Transfer/Sync.pod
##
##    Revision 1.1  2003/01/19 01:23:04  joko
##    + new from Data/Transfer/Sync.pm
##
##    Revision 1.11  2002/12/23 07:10:59  joko
##    + using MD5 for checksum generation again - the 32-bit integer hash from DBI seems to be too lazy
##
##    Revision 1.10  2002/12/19 01:07:16  joko
##    + fixed output done via $logger
##
##    Revision 1.9  2002/12/16 07:02:34  jonen
##    + added comment
##
##    Revision 1.8  2002/12/15 02:03:09  joko
##    + fixed logging-messages
##    + additional metadata-checks
##
##    Revision 1.7  2002/12/13 21:49:34  joko
##    + sub configure
##    + sub checkOptions
##
##    Revision 1.6  2002/12/06 04:49:10  jonen
##    + disabled output-puffer here
##
##    Revision 1.5  2002/12/05 08:06:05  joko
##    + bugfix with determining empty fields (Null) with DBD::CSV
##    + debugging
##    + updated comments
##
##    Revision 1.4  2002/12/03 15:54:07  joko
##    + {import}-flag is now {prepare}-flag
##
##    Revision 1.3  2002/12/01 22:26:59  joko
##    + minor cosmetics for logging
##
##    Revision 1.2  2002/12/01 04:43:25  joko
##    + mapping detail entries may now be either an ARRAY or a HASH
##    + erase flag is used now (for export-operations)
##    + expressions to refer to values inside deep nested structures
##    - removed old mappingV2-code
##    + cosmetics
##    + sub _erase_all
##
##    Revision 1.1  2002/11/29 04:45:50  joko
##    + initial check in
##
##    Revision 1.1  2002/10/10 03:44:21  cvsjoko
##    + new
## -------------------------------------------------------------------------


package Data::Transfer::Sync::Core;

use strict;
use warnings;

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


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

use Data::Dumper;

#use misc::HashExt;
use Hash::Serializer;
use Data::Mungle::Compare::Struct qw( getDifference isEmpty );
use Data::Storage::Container;
use DesignPattern::Object;
use shortcuts::database qw( quotesql );

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

$| = 1;

=pod
sub new {
  my $invocant = shift;
  my $class = ref($invocant) || $invocant;
  my $self = {};
  $logger->debug( __PACKAGE__ . "->new(@_)" );
  bless $self, $class;
  $self->configure(@_);
  return $self;
}
=cut


sub _init {
  my $self = shift;

  # build new container if necessary
  $self->{container} = Data::Storage::Container->new() if !$self->{container};
  
  # add storages to container (optional)
  foreach (keys %{$self->{storages}}) {
    $self->{container}->addStorage($_, $self->{storages}->{$_});
  }
  
  # trace
    #print Dumper($self);
    #exit;

  return 1;
  
}

sub _initV1 {
  my $self = shift;
  $logger->debug( __PACKAGE__ . "->_initV1" );
  die("this should not be reached!");
  # tag storages with id-authority and checksum-provider information
  # TODO: better store tag inside metadata to hold bits together!
  map { $self->{container}->{storage}->{$_}->{isIdentAuthority} = 1 } @{$self->{id_authorities}};
  map { $self->{container}->{storage}->{$_}->{isChecksumAuthority} = 1; } @{$self->{checksum_authorities}};
  map { $self->{container}->{storage}->{$_}->{isWriteProtected} = 1; } @{$self->{write_protected}};
}


# TODO: abstract the hardwired use of "source" and "target" in here somehow - hmmmm.......  /(="§/%???
sub _run {

  my $self = shift;
  
  #print "verbose: ", $self->{verbose}, "\n";
  $self->{verbose} = 1;
  
  $logger->debug( __PACKAGE__ . "->_run" );

  # for statistics
  my $tc = Hash::Serializer->new( {} );
  my $results;
  
  # set of objects is already in $self->{args}
  # TODO: make independent of the terminology "object..."
  $results = $self->{args}->{objectSet} if $self->{args}->{objectSet};

  # apply filter
  if (my $filter = $self->{meta}->{source}->{filter}) {
    #print Dumper($filter);
    #exit;
    $results ||= $self->_getNodeList('source', $filter);
  }
  
  # get reference to node list from convenient method provided by CORE-HANDLE
  $results ||= $self->_getNodeList('source');

  # checkpoint: do we actually have a list to iterate through?
  if (!$results || !@{$results}) {
    $logger->notice( __PACKAGE__ . "->_run: No nodes to synchronize." );
    return;
  }


  # check if we actually *have* a synchronization method
  if (!$self->{options}->{metadata}->{syncMethod}) {
    $logger->critical( __PACKAGE__ . "->_run: No synchronization method (checksum|timestamp) specified" );
    return;
  }
    
  
  # dereference
  my @results = @{$results};

  # iterate through set
  foreach my $source_node_real (@results) {

    print ":" if $self->{verbose};

    $tc->{total}++;

#print "========================  iter", "\n";

    # clone object (in case we have to modify it here)
    # TODO:
    #   - is a "deep_copy" needed here if occouring modifications take place?
    #   - puuhhhh, i guess a deep_copy would destroy tangram mechanisms?
    #   - after all, just take care for now that this object doesn't get updated!
    #   - so, just use its reference for now - if some cloning is needed in future, do this here!
    my $source_node = $source_node_real;

    # modify entry - handle new style callbacks (the readers)

    # trace
      #print Dumper($source_node);
      #exit;

    my $descent = 'source';

    # handle callbacks right now while scanning them (asymmetric to the writers)
    my $map_callbacks = {};
    if (my $callbacks = $self->{meta}->{$descent}->{Callback}) {

      # trace
        #print Dumper($callbacks);
        #exit;

      my $error = 0;

      foreach my $node (keys %{$callbacks->{read}}) {
        
        my $object = $source_node;
        my $value; # = $source_node->{$node};

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

        # ------------  half-redundant: make $self->callCallback($object, $value, $opts)
        #my $perl_callback = $self->{meta}->{$descent}->{node} . '::' . $node . '_read';
        my $perl_callback = $self->{meta}->{$descent}->{nodeType} . '::' . $node . '_read';
        my $evalstring = 'return ' . $perl_callback . '( { object => $object, property => $node, value => $value, storage => $self->{meta}->{$descent}->{storage} } );';
        #print $evalstring, "\n"; exit;
        my $cb_result = eval($evalstring);
        if ($@) {
          $error = 1;
          $logger->error( __PACKAGE__ . "->_run: $@" );
          next;
        }
        # ------------  half-redundant: make $self->callCallback($object, $value, $opts)
        
        $source_node->{$node} = $cb_result;

      }

    }

    # trace
      #print Dumper($source_node);

    # exclude defined fields  (simply delete from object)
    map { delete $source_node->{$_} } @{$self->{meta}->{source}->{subnodes_exclude}};
    
    # here we accumulate information about the status of the current node (payload/row/object/item/entry)
    $self->{node} = {};
    $self->{node}->{source}->{payload} = $source_node;

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

    # determine ident of entry
    my $identOK = $self->_resolveNodeIdent('source');
    #if (!$identOK && lc $self->{args}->{direction} ne 'import') {
    if (!$identOK) {
      #print Dumper($self->{meta}->{source});
      $logger->critical( __PACKAGE__ . "->_run: No ident found in source node ( nodeName='$self->{meta}->{source}->{nodeName}', nodeType='$self->{meta}->{source}->{nodeType}') try to \"prepare\" this node first?" );
      return;
    }

    #print "l" if $self->{verbose};
    my $statOK = $self->_statloadNode('target', $self->{node}->{source}->{ident});

    # mark node as new either if there's no ident or if stat/load failed
    if (!$statOK) {
      $self->{node}->{status}->{new} = 1;
      print "n" if $self->{verbose};
    }

#print "checksum", "\n";
    
    #print Dumper($self);
    
    # determine status of entry by synchronization method
    if ( lc $self->{options}->{metadata}->{syncMethod} eq 'checksum' ) {
    #if ( $statOK && (lc $self->{args}->{method} eq 'checksum') ) {
    #if ( !$self->{node}->{status}->{new} && (lc $self->{args}->{method} eq 'checksum') ) {
      
    # calculate checksum of source node
      #$self->_calcChecksum('source');
      if (!$self->_readChecksum('source')) {
        $logger->warning( __PACKAGE__ . "->_run: Could not find \"source\" entry with ident=\"$self->{node}->{source}->{ident}\"" );
        $tc->{skip}++;
        print "s" if $self->{verbose};
        next;
      }
      
      # get checksum from synchronization target
      $self->_readChecksum('target');
      #if (!$self->_readChecksum('target')) {
      #  $logger->critical( __PACKAGE__ . "->_readChecksum: Could not find \"target\" entry with ident=\"$self->{node}->{source}->{ident}\"" );
      #  next;
      #}
  
      # pre flight check: do we actually have a checksum provided?
      #if (!$self->{node}->{source}->{checksum}) {
      #  print "Source checksum for entry with ident \"$self->{node}->{source}->{ident}\" could not be calculated, maybe it's missing?.", "\n";
      #  return;
      #}
      
      # determine if entry is "new" or "dirty"
      # after all, this seems to be the point where the hammer falls.....
      print "c" if $self->{verbose};

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

      $self->{node}->{status}->{new} = !$self->{node}->{target}->{checksum};
      if (!$self->{node}->{status}->{new}) {
        $self->{node}->{status}->{dirty} = 
          $self->{node}->{status}->{new} || 
          (!$self->{node}->{source}->{checksum} || !$self->{node}->{target}->{checksum}) || 
          ($self->{node}->{source}->{checksum} ne $self->{node}->{target}->{checksum}) || 
          $self->{args}->{force};
      }

    } else {
      $logger->warning( __PACKAGE__ . "->_run: Synchronization method '$self->{options}->{metadata}->{syncMethod}' is not implemented" );
      $tc->{skip}++;
      print "s" if $self->{verbose};
      next;
    }

    # first reaction on entry-status: continue with next entry if the current is already "in sync"
    if (!$self->{node}->{status}->{new} && !$self->{node}->{status}->{dirty}) {
      $tc->{in_sync}++;
      next;
    }

    # build map to actually transfer the data from source to target
    if (!$self->buildAttributeMap()) {
      #$logger->warning( __PACKAGE__ . "->_run: Attribute Map could not be created. Will not insert or modify node.");
      $tc->{skip}++;
      print "e" if $self->{verbose};
      next;
    }

    # trace
      #print Dumper($self->{node}); exit;
      #print "attempt", "\n";

    # additional (new) checks for feature "write-protection"
    if ($self->{meta}->{target}->{storage}->{isWriteProtected}) {
      $tc->{attempt_transfer}++;
      print "\n" if $self->{verbose};
      $logger->notice( __PACKAGE__ . "->_run: Target is write-protected. Will not insert or modify node. " .
          "(Ident: $self->{node}->{source}->{ident} " . "Dump:\n" . Dumper($self->{node}->{source}->{payload}) . ")" );
      print "\n" if $self->{verbose};
      $tc->{skip}++;
      next;
    }

    # trace
      #print Dumper($self);
      #exit;

    # transfer contents of map to target
    if ($self->{node}->{status}->{new}) {
      $tc->{attempt_new}++;
      $self->_doTransferToTarget('insert');
      # asymmetry: refetch node from target to re-calculate new ident and checksum (TODO: is IdentAuthority of relevance here?)
      #print Dumper($self->{node});
      $self->_statloadNode('target', $self->{node}->{target}->{ident}, 1);
      $self->_readChecksum('target');

    } elsif ($self->{node}->{status}->{dirty}) {
      $tc->{attempt_modify}++;
      # asymmetry: get ident before updating (TODO: is IdentAuthority of relevance here?)
      $self->{node}->{target}->{ident} = $self->{node}->{map}->{$self->{meta}->{target}->{IdentProvider}->{arg}};
      $self->_doTransferToTarget('update');
      $self->_readChecksum('target');
    }

    if ($self->{node}->{status}->{ok}) {
      $tc->{ok}++;
      print "t" if $self->{verbose};
    }
    
    if ($self->{node}->{status}->{error}) {
      $tc->{error}++;
      push( @{$tc->{error_per_row}}, $self->{node}->{status}->{error} );
      print "e" if $self->{verbose};
    }
    
    # trace
      #print Dumper($self);
      #exit;
    
    # change ident in source (take from target), if transfer was ok and target is an IdentAuthority
    # this is (for now) called a "retransmit" indicated by a "r"-character when verbosing
    #if ($self->{node}->{status}->{ok} && $self->{options}->{target}->{storage}->{idAuthority}) {
    if ($self->{node}->{status}->{ok} && $self->{meta}->{target}->{isIdentAuthority}) {
      print "r" if $self->{verbose};
      #print Dumper($self->{meta});
      #print Dumper($self->{node});
      #exit;
      $self->_doModifySource_IdentChecksum($self->{node}->{target}->{ident});
    }

  }

  print "\n" if $self->{verbose};
  
  # build user-message from some stats
    my $msg = "statistics: $tc";
    
    if ($tc->{error_per_row}) {
      $msg .= "\n";
      $msg .= "errors from \"error_per_row\":" . "\n";
      $msg .= Dumper($tc->{error_per_row});
    }
    
    # todo!!!
    #sysevent( { usermsg => $msg, level => $level }, $taskEvent );
    #$logger->info( __PACKAGE__ . "->_run: $msg" );
    $logger->info($msg . "\n");

  return $tc;

}


# refactor this as some core-function to do a generic dump resolving data-encapsulations of e.g. Set::Object
sub _dumpCompact {
  my $self = shift;

  #my $vars = \@_;
  my @data = ();

  my $count = 0;
  foreach (@_) {
    my $item = {};
    foreach my $key (keys %$_) {
      my $val = $_->{$key};

#print Dumper($val);

      if (ref $val eq 'Set::Object') {
        #print "========================= SET", "\n";
#print Dumper($val);
        #print Dumper($val->members());
        #$val = $val->members();
        #$vars->[$count]->{$key} = $val->members() if $val->can("members");
        #$item->{$key} = $val->members() if $val->can("members");
        $item->{$key} = $val->members();
        #print Dumper($vars->[$count]->{$key});

      } else {
        $item->{$key} = $val;
      }

    }
    push @data, $item;
    $count++;
  }

#print "Dump:", Dumper(@data), "\n";

  $Data::Dumper::Indent = 0;
  my $result = Dumper(@data);
  $Data::Dumper::Indent = 2;
  return $result;
  
}


sub _doTransferToTarget {
  my $self = shift;
  my $action = shift;
    
  # trace
    #print Dumper($self->{meta});
    #print Dumper($self->{node});
    #exit;
    
  $self->_modifyNode('target', $action, $self->{node}->{map});
}


sub _doModifySource_IdentChecksum {
  my $self = shift;
  my $ident_new = shift;
  # this changes an old node to a new one including ident and checksum
  # TODO:
  #   - eventually introduce an external resource to store this data to
  #   - we won't have to "re"-modify the source node here
  my $map = {
    $self->{meta}->{source}->{IdentProvider}->{arg} => $ident_new,
    cs => $self->{node}->{target}->{checksum},
  };

#print Dumper($map);
#print Dumper($self->{node});
#exit;

  $self->_modifyNode('source', 'update', $map);
}


sub _prepareNode_MetaProperties {
  my $self = shift;
  my $descent = shift;

  $logger->info( __PACKAGE__ . "->_prepareNode_MetaProperties( descent $descent )" );
  
  # TODO: this should (better) be: "my $firstnode = $self->_getFirstNode($descent);"
  my $list = $self->_getNodeList($descent);
  
  # get first node
  my $firstnode = $list->[0];
  
  # check if node contains meta properties/nodes
  # TODO: "cs" is hardcoded here!
  my @required = ( $self->{meta}->{$descent}->{IdentProvider}->{arg}, 'cs' );
  my @found = keys %$firstnode;
  #my @diff = getDifference(\@found, \@required);
  my $diff = getDifference(\@required, \@found);
  #print Dumper(@found);
  #print Dumper(@required);
  #print Dumper(@diff);
  #if (!$#diff || $#diff == -1) {
  if (isEmpty($diff)) {
    $logger->warning( __PACKAGE__ . "->_prepareNode_MetaProperties: node is lacking meta properties - will try to alter..." );
    foreach (@required) {
      my $sql = "ALTER TABLE $self->{meta}->{$descent}->{node} ADD COLUMN $_";
      #print "sql: $sql", "\n";
      my $res = $self->{meta}->{$descent}->{storage}->sendCommand($sql);
      #print Dumper($res->getStatus());
    }
  }

}

sub _prepareNode_DummyIdent {
  my $self = shift;
  my $descent = shift;

  $logger->info( __PACKAGE__ . "->_prepareNode_DummyIdent( descent $descent )" );

  my $list = $self->_getNodeList($descent);
  #print Dumper($list);
  my $i = 0;
  my $ident_base = 5678983;
  my $ident_appendix = '0001';
  foreach my $node (@$list) {
    my $ident_dummy = $i + $ident_base;
    $ident_dummy .= $ident_appendix;
    my $map = {
      $self->{meta}->{$descent}->{IdentProvider}->{arg} => $ident_dummy,
      cs => undef,
    };
    
    # diff lists and ...
    my $diff = getDifference([keys %$node], [keys %$map]);
    next if $#{$diff} == -1;
    
    # ... build criteria including all columns
    my @crits;
    foreach my $property (@$diff) {
      next if !$property;
      my $value = $node->{$property};
      next if !$value;
      push @crits, "$property='" . quotesql($value) . "'";
    }
    my $crit = join ' AND ', @crits;
    print "p" if $self->{verbose};

#print Dumper($map);
#print Dumper($crit);

    $self->_modifyNode($descent, 'update', $map, $crit);
    $i++;
  }

  #print "\n" if $self->{verbose};
  
  if (!$i) {
    $logger->warning( __PACKAGE__ . "->_prepareNode_DummyIdent: no nodes touched" );
  }
  
}

# TODO: handle this in an abstract way (wipe out use of 'source' and/or 'target' inside core)
sub _otherSide {
  my $self = shift;
  my $descent = shift;
  return 'source' if $descent eq 'target';
  return 'target' if $descent eq 'source';
  return '';
}


1;
__END__
1	joko	1.9	## -------------------------------------------------------------------------
2			##
3			## $Id: Core.pm,v 1.8 2003/03/27 15:31:15 joko Exp $
4	joko	1.1	##
5			## 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	joko	1.9	## -------------------------------------------------------------------------
10	joko	1.2	## $Log: Core.pm,v $
11	joko	1.9	## Revision 1.8 2003/03/27 15:31:15 joko
12			## fixes to modules regarding new namespace(s) below Data::Mungle::*
13			##
14	joko	1.8	## Revision 1.7 2003/02/21 08:01:11 joko
15			## debugging, logging
16			## renamed module
17			##
18	joko	1.7	## Revision 1.6 2003/02/14 14:03:49 joko
19			## + logging, debugging
20			## - refactored code to sister module
21			##
22	joko	1.6	## Revision 1.5 2003/02/11 05:30:47 joko
23			## + minor fixes and some debugging mud
24			##
25	joko	1.5	## Revision 1.4 2003/02/09 05:01:10 joko
26			## + major structure changes
27			## - refactored code to sister modules
28			##
29	joko	1.4	## Revision 1.3 2003/01/20 17:01:14 joko
30			## + cosmetics and debugging
31			## + probably refactored code to new plugin-modules 'Metadata.pm' and/or 'StorageInterface.pm' (guess it was the last one...)
32			##
33	joko	1.3	## Revision 1.2 2003/01/19 02:05:42 joko
34			## - removed pod-documentation: now in Data/Transfer/Sync.pod
35			##
36	joko	1.2	## Revision 1.1 2003/01/19 01:23:04 joko
37			## + new from Data/Transfer/Sync.pm
38			##
39	joko	1.1	## Revision 1.11 2002/12/23 07:10:59 joko
40			## + using MD5 for checksum generation again - the 32-bit integer hash from DBI seems to be too lazy
41			##
42			## Revision 1.10 2002/12/19 01:07:16 joko
43			## + fixed output done via $logger
44			##
45			## Revision 1.9 2002/12/16 07:02:34 jonen
46			## + added comment
47			##
48			## Revision 1.8 2002/12/15 02:03:09 joko
49			## + fixed logging-messages
50			## + additional metadata-checks
51			##
52			## Revision 1.7 2002/12/13 21:49:34 joko
53			## + sub configure
54			## + sub checkOptions
55			##
56			## Revision 1.6 2002/12/06 04:49:10 jonen
57			## + disabled output-puffer here
58			##
59			## Revision 1.5 2002/12/05 08:06:05 joko
60			## + bugfix with determining empty fields (Null) with DBD::CSV
61			## + debugging
62			## + updated comments
63			##
64			## Revision 1.4 2002/12/03 15:54:07 joko
65			## + {import}-flag is now {prepare}-flag
66			##
67			## Revision 1.3 2002/12/01 22:26:59 joko
68			## + minor cosmetics for logging
69			##
70			## Revision 1.2 2002/12/01 04:43:25 joko
71	joko	1.9	## + mapping detail entries may now be either an ARRAY or a HASH
72	joko	1.1	## + erase flag is used now (for export-operations)
73			## + expressions to refer to values inside deep nested structures
74			## - removed old mappingV2-code
75			## + cosmetics
76			## + sub _erase_all
77			##
78			## Revision 1.1 2002/11/29 04:45:50 joko
79			## + initial check in
80			##
81			## Revision 1.1 2002/10/10 03:44:21 cvsjoko
82			## + new
83	joko	1.9	## -------------------------------------------------------------------------
84	joko	1.1
85
86			package Data::Transfer::Sync::Core;
87
88			use strict;
89			use warnings;
90
91			use mixin::with qw( Data::Transfer::Sync );
92
93
94			# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - main
95
96			use Data::Dumper;
97
98	joko	1.7	#use misc::HashExt;
99			use Hash::Serializer;
100	joko	1.8	use Data::Mungle::Compare::Struct qw( getDifference isEmpty );
101	joko	1.1	use Data::Storage::Container;
102			use DesignPattern::Object;
103	joko	1.9	use shortcuts::database qw( quotesql );
104	joko	1.1
105			# get logger instance
106			my $logger = Log::Dispatch::Config->instance;
107
108			$\| = 1;
109
110			=pod
111			sub new {
112			my $invocant = shift;
113			my $class = ref($invocant) \|\| $invocant;
114			my $self = {};
115			$logger->debug( __PACKAGE__ . "->new(@_)" );
116			bless $self, $class;
117			$self->configure(@_);
118			return $self;
119			}
120			=cut
121
122
123			sub _init {
124			my $self = shift;
125
126			# build new container if necessary
127			$self->{container} = Data::Storage::Container->new() if !$self->{container};
128
129			# add storages to container (optional)
130			foreach (keys %{$self->{storages}}) {
131			$self->{container}->addStorage($_, $self->{storages}->{$_});
132			}
133
134	joko	1.5	# trace
135			#print Dumper($self);
136			#exit;
137
138	joko	1.1	return 1;
139
140			}
141
142			sub _initV1 {
143			my $self = shift;
144	joko	1.4	$logger->debug( __PACKAGE__ . "->_initV1" );
145			die("this should not be reached!");
146	joko	1.1	# tag storages with id-authority and checksum-provider information
147			# TODO: better store tag inside metadata to hold bits together!
148			map { $self->{container}->{storage}->{$_}->{isIdentAuthority} = 1 } @{$self->{id_authorities}};
149			map { $self->{container}->{storage}->{$_}->{isChecksumAuthority} = 1; } @{$self->{checksum_authorities}};
150			map { $self->{container}->{storage}->{$_}->{isWriteProtected} = 1; } @{$self->{write_protected}};
151			}
152
153
154			# TODO: abstract the hardwired use of "source" and "target" in here somehow - hmmmm....... /(="§/%???
155	joko	1.4	sub _run {
156	joko	1.1
157			my $self = shift;
158
159	joko	1.4	#print "verbose: ", $self->{verbose}, "\n";
160			$self->{verbose} = 1;
161
162			$logger->debug( __PACKAGE__ . "->_run" );
163
164			# for statistics
165	joko	1.7	my $tc = Hash::Serializer->new( {} );
166	joko	1.1	my $results;
167
168			# set of objects is already in $self->{args}
169			# TODO: make independent of the terminology "object..."
170			$results = $self->{args}->{objectSet} if $self->{args}->{objectSet};
171
172			# apply filter
173			if (my $filter = $self->{meta}->{source}->{filter}) {
174			#print Dumper($filter);
175			#exit;
176			$results \|\|= $self->_getNodeList('source', $filter);
177			}
178
179			# get reference to node list from convenient method provided by CORE-HANDLE
180			$results \|\|= $self->_getNodeList('source');
181
182			# checkpoint: do we actually have a list to iterate through?
183			if (!$results \|\| !@{$results}) {
184	joko	1.4	$logger->notice( __PACKAGE__ . "->_run: No nodes to synchronize." );
185	joko	1.1	return;
186			}
187	joko	1.4
188
189
190			# check if we actually have a synchronization method
191			if (!$self->{options}->{metadata}->{syncMethod}) {
192			$logger->critical( __PACKAGE__ . "->_run: No synchronization method (checksum\|timestamp) specified" );
193			return;
194			}
195
196	joko	1.1
197			# dereference
198			my @results = @{$results};
199
200			# iterate through set
201			foreach my $source_node_real (@results) {
202
203	joko	1.5	print ":" if $self->{verbose};
204
205	joko	1.1	$tc->{total}++;
206
207			#print "======================== iter", "\n";
208
209			# clone object (in case we have to modify it here)
210			# TODO:
211			# - is a "deep_copy" needed here if occouring modifications take place?
212			# - puuhhhh, i guess a deep_copy would destroy tangram mechanisms?
213			# - after all, just take care for now that this object doesn't get updated!
214	joko	1.5	# - so, just use its reference for now - if some cloning is needed in future, do this here!
215	joko	1.1	my $source_node = $source_node_real;
216
217			# modify entry - handle new style callbacks (the readers)
218	joko	1.6
219			# trace
220			#print Dumper($source_node);
221			#exit;
222	joko	1.1
223			my $descent = 'source';
224
225			# handle callbacks right now while scanning them (asymmetric to the writers)
226			my $map_callbacks = {};
227			if (my $callbacks = $self->{meta}->{$descent}->{Callback}) {
228
229	joko	1.5	# trace
230			#print Dumper($callbacks);
231			#exit;
232
233	joko	1.1	my $error = 0;
234
235			foreach my $node (keys %{$callbacks->{read}}) {
236
237			my $object = $source_node;
238			my $value; # = $source_node->{$node};
239
240	joko	1.6	# trace
241			#print Dumper($self->{options});
242	joko	1.5
243	joko	1.1	# ------------ half-redundant: make $self->callCallback($object, $value, $opts)
244	joko	1.3	#my $perl_callback = $self->{meta}->{$descent}->{node} . '::' . $node . '_read';
245			my $perl_callback = $self->{meta}->{$descent}->{nodeType} . '::' . $node . '_read';
246	joko	1.1	my $evalstring = 'return ' . $perl_callback . '( { object => $object, property => $node, value => $value, storage => $self->{meta}->{$descent}->{storage} } );';
247			#print $evalstring, "\n"; exit;
248			my $cb_result = eval($evalstring);
249			if ($@) {
250	joko	1.6	$error = 1;
251	joko	1.5	$logger->error( __PACKAGE__ . "->_run: $@" );
252	joko	1.6	next;
253	joko	1.1	}
254			# ------------ half-redundant: make $self->callCallback($object, $value, $opts)
255
256			$source_node->{$node} = $cb_result;
257
258			}
259
260			}
261
262	joko	1.5	# trace
263			#print Dumper($source_node);
264	joko	1.1
265			# exclude defined fields (simply delete from object)
266			map { delete $source_node->{$_} } @{$self->{meta}->{source}->{subnodes_exclude}};
267
268			# here we accumulate information about the status of the current node (payload/row/object/item/entry)
269			$self->{node} = {};
270			$self->{node}->{source}->{payload} = $source_node;
271
272	joko	1.5	# trace
273			#print Dumper($self->{node});
274			#exit;
275	joko	1.1
276			# determine ident of entry
277			my $identOK = $self->_resolveNodeIdent('source');
278			#if (!$identOK && lc $self->{args}->{direction} ne 'import') {
279			if (!$identOK) {
280			#print Dumper($self->{meta}->{source});
281	joko	1.4	$logger->critical( __PACKAGE__ . "->_run: No ident found in source node ( nodeName='$self->{meta}->{source}->{nodeName}', nodeType='$self->{meta}->{source}->{nodeType}') try to \"prepare\" this node first?" );
282	joko	1.1	return;
283			}
284
285	joko	1.4	#print "l" if $self->{verbose};
286	joko	1.1	my $statOK = $self->_statloadNode('target', $self->{node}->{source}->{ident});
287
288			# mark node as new either if there's no ident or if stat/load failed
289			if (!$statOK) {
290			$self->{node}->{status}->{new} = 1;
291			print "n" if $self->{verbose};
292			}
293
294			#print "checksum", "\n";
295
296	joko	1.4	#print Dumper($self);
297
298	joko	1.1	# determine status of entry by synchronization method
299	joko	1.4	if ( lc $self->{options}->{metadata}->{syncMethod} eq 'checksum' ) {
300	joko	1.1	#if ( $statOK && (lc $self->{args}->{method} eq 'checksum') ) {
301			#if ( !$self->{node}->{status}->{new} && (lc $self->{args}->{method} eq 'checksum') ) {
302
303	joko	1.4	# calculate checksum of source node
304	joko	1.1	#$self->_calcChecksum('source');
305			if (!$self->_readChecksum('source')) {
306	joko	1.4	$logger->warning( __PACKAGE__ . "->_run: Could not find \"source\" entry with ident=\"$self->{node}->{source}->{ident}\"" );
307	joko	1.1	$tc->{skip}++;
308			print "s" if $self->{verbose};
309			next;
310			}
311
312			# get checksum from synchronization target
313			$self->_readChecksum('target');
314			#if (!$self->_readChecksum('target')) {
315			# $logger->critical( __PACKAGE__ . "->_readChecksum: Could not find \"target\" entry with ident=\"$self->{node}->{source}->{ident}\"" );
316			# next;
317			#}
318
319			# pre flight check: do we actually have a checksum provided?
320			#if (!$self->{node}->{source}->{checksum}) {
321			# print "Source checksum for entry with ident \"$self->{node}->{source}->{ident}\" could not be calculated, maybe it's missing?.", "\n";
322			# return;
323			#}
324
325			# determine if entry is "new" or "dirty"
326			# after all, this seems to be the point where the hammer falls.....
327			print "c" if $self->{verbose};
328	joko	1.5
329			# trace
330			#print Dumper($self->{node});
331			#exit;
332
333	joko	1.1	$self->{node}->{status}->{new} = !$self->{node}->{target}->{checksum};
334			if (!$self->{node}->{status}->{new}) {
335			$self->{node}->{status}->{dirty} =
336			$self->{node}->{status}->{new} \|\|
337			(!$self->{node}->{source}->{checksum} \|\| !$self->{node}->{target}->{checksum}) \|\|
338			($self->{node}->{source}->{checksum} ne $self->{node}->{target}->{checksum}) \|\|
339			$self->{args}->{force};
340			}
341
342	joko	1.4	} else {
343			$logger->warning( __PACKAGE__ . "->_run: Synchronization method '$self->{options}->{metadata}->{syncMethod}' is not implemented" );
344			$tc->{skip}++;
345			print "s" if $self->{verbose};
346			next;
347	joko	1.1	}
348
349			# first reaction on entry-status: continue with next entry if the current is already "in sync"
350			if (!$self->{node}->{status}->{new} && !$self->{node}->{status}->{dirty}) {
351			$tc->{in_sync}++;
352			next;
353			}
354
355			# build map to actually transfer the data from source to target
356	joko	1.9	if (!$self->buildAttributeMap()) {
357			#$logger->warning( __PACKAGE__ . "->_run: Attribute Map could not be created. Will not insert or modify node.");
358			$tc->{skip}++;
359			print "e" if $self->{verbose};
360			next;
361			}
362	joko	1.1
363	joko	1.5	# trace
364			#print Dumper($self->{node}); exit;
365			#print "attempt", "\n";
366	joko	1.1
367			# additional (new) checks for feature "write-protection"
368			if ($self->{meta}->{target}->{storage}->{isWriteProtected}) {
369			$tc->{attempt_transfer}++;
370			print "\n" if $self->{verbose};
371	joko	1.4	$logger->notice( __PACKAGE__ . "->_run: Target is write-protected. Will not insert or modify node. " .
372	joko	1.1	"(Ident: $self->{node}->{source}->{ident} " . "Dump:\n" . Dumper($self->{node}->{source}->{payload}) . ")" );
373			print "\n" if $self->{verbose};
374			$tc->{skip}++;
375			next;
376			}
377
378	joko	1.5	# trace
379			#print Dumper($self);
380			#exit;
381	joko	1.4
382	joko	1.1	# transfer contents of map to target
383			if ($self->{node}->{status}->{new}) {
384			$tc->{attempt_new}++;
385			$self->_doTransferToTarget('insert');
386			# asymmetry: refetch node from target to re-calculate new ident and checksum (TODO: is IdentAuthority of relevance here?)
387			#print Dumper($self->{node});
388			$self->_statloadNode('target', $self->{node}->{target}->{ident}, 1);
389			$self->_readChecksum('target');
390
391			} elsif ($self->{node}->{status}->{dirty}) {
392			$tc->{attempt_modify}++;
393			# asymmetry: get ident before updating (TODO: is IdentAuthority of relevance here?)
394			$self->{node}->{target}->{ident} = $self->{node}->{map}->{$self->{meta}->{target}->{IdentProvider}->{arg}};
395			$self->_doTransferToTarget('update');
396			$self->_readChecksum('target');
397			}
398
399			if ($self->{node}->{status}->{ok}) {
400			$tc->{ok}++;
401			print "t" if $self->{verbose};
402			}
403
404			if ($self->{node}->{status}->{error}) {
405			$tc->{error}++;
406			push( @{$tc->{error_per_row}}, $self->{node}->{status}->{error} );
407			print "e" if $self->{verbose};
408			}
409
410	joko	1.4	# trace
411			#print Dumper($self);
412			#exit;
413
414	joko	1.1	# change ident in source (take from target), if transfer was ok and target is an IdentAuthority
415			# this is (for now) called a "retransmit" indicated by a "r"-character when verbosing
416	joko	1.5	#if ($self->{node}->{status}->{ok} && $self->{options}->{target}->{storage}->{idAuthority}) {
417			if ($self->{node}->{status}->{ok} && $self->{meta}->{target}->{isIdentAuthority}) {
418	joko	1.1	print "r" if $self->{verbose};
419			#print Dumper($self->{meta});
420			#print Dumper($self->{node});
421			#exit;
422			$self->_doModifySource_IdentChecksum($self->{node}->{target}->{ident});
423			}
424
425			}
426
427			print "\n" if $self->{verbose};
428
429			# build user-message from some stats
430			my $msg = "statistics: $tc";
431
432			if ($tc->{error_per_row}) {
433			$msg .= "\n";
434			$msg .= "errors from \"error_per_row\":" . "\n";
435			$msg .= Dumper($tc->{error_per_row});
436			}
437
438			# todo!!!
439			#sysevent( { usermsg => $msg, level => $level }, $taskEvent );
440	joko	1.7	#$logger->info( __PACKAGE__ . "->_run: $msg" );
441			$logger->info($msg . "\n");
442	joko	1.1
443			return $tc;
444
445			}
446
447
448			# refactor this as some core-function to do a generic dump resolving data-encapsulations of e.g. Set::Object
449			sub _dumpCompact {
450			my $self = shift;
451
452			#my $vars = \@_;
453			my @data = ();
454
455			my $count = 0;
456			foreach (@_) {
457			my $item = {};
458			foreach my $key (keys %$_) {
459			my $val = $_->{$key};
460
461			#print Dumper($val);
462
463			if (ref $val eq 'Set::Object') {
464			#print "========================= SET", "\n";
465			#print Dumper($val);
466			#print Dumper($val->members());
467			#$val = $val->members();
468			#$vars->[$count]->{$key} = $val->members() if $val->can("members");
469			#$item->{$key} = $val->members() if $val->can("members");
470			$item->{$key} = $val->members();
471			#print Dumper($vars->[$count]->{$key});
472
473			} else {
474			$item->{$key} = $val;
475			}
476
477			}
478			push @data, $item;
479			$count++;
480			}
481
482			#print "Dump:", Dumper(@data), "\n";
483
484			$Data::Dumper::Indent = 0;
485			my $result = Dumper(@data);
486			$Data::Dumper::Indent = 2;
487			return $result;
488
489			}
490
491
492
493			sub _doTransferToTarget {
494			my $self = shift;
495			my $action = shift;
496	joko	1.5
497			# trace
498			#print Dumper($self->{meta});
499			#print Dumper($self->{node});
500			#exit;
501
502	joko	1.1	$self->_modifyNode('target', $action, $self->{node}->{map});
503			}
504	joko	1.4
505	joko	1.1
506			sub _doModifySource_IdentChecksum {
507			my $self = shift;
508			my $ident_new = shift;
509			# this changes an old node to a new one including ident and checksum
510			# TODO:
511			# - eventually introduce an external resource to store this data to
512			# - we won't have to "re"-modify the source node here
513			my $map = {
514			$self->{meta}->{source}->{IdentProvider}->{arg} => $ident_new,
515			cs => $self->{node}->{target}->{checksum},
516			};
517
518			#print Dumper($map);
519			#print Dumper($self->{node});
520			#exit;
521
522			$self->_modifyNode('source', 'update', $map);
523			}
524
525
526
527			sub _prepareNode_MetaProperties {
528			my $self = shift;
529			my $descent = shift;
530
531			$logger->info( __PACKAGE__ . "->_prepareNode_MetaProperties( descent $descent )" );
532
533			# TODO: this should (better) be: "my $firstnode = $self->_getFirstNode($descent);"
534			my $list = $self->_getNodeList($descent);
535
536			# get first node
537			my $firstnode = $list->[0];
538
539			# check if node contains meta properties/nodes
540			# TODO: "cs" is hardcoded here!
541			my @required = ( $self->{meta}->{$descent}->{IdentProvider}->{arg}, 'cs' );
542			my @found = keys %$firstnode;
543			#my @diff = getDifference(\@found, \@required);
544			my $diff = getDifference(\@required, \@found);
545			#print Dumper(@found);
546			#print Dumper(@required);
547			#print Dumper(@diff);
548			#if (!$#diff \|\| $#diff == -1) {
549			if (isEmpty($diff)) {
550			$logger->warning( __PACKAGE__ . "->_prepareNode_MetaProperties: node is lacking meta properties - will try to alter..." );
551			foreach (@required) {
552			my $sql = "ALTER TABLE $self->{meta}->{$descent}->{node} ADD COLUMN $_";
553			#print "sql: $sql", "\n";
554			my $res = $self->{meta}->{$descent}->{storage}->sendCommand($sql);
555			#print Dumper($res->getStatus());
556			}
557			}
558
559			}
560
561			sub _prepareNode_DummyIdent {
562			my $self = shift;
563			my $descent = shift;
564
565			$logger->info( __PACKAGE__ . "->_prepareNode_DummyIdent( descent $descent )" );
566
567			my $list = $self->_getNodeList($descent);
568			#print Dumper($list);
569			my $i = 0;
570			my $ident_base = 5678983;
571			my $ident_appendix = '0001';
572			foreach my $node (@$list) {
573			my $ident_dummy = $i + $ident_base;
574			$ident_dummy .= $ident_appendix;
575			my $map = {
576			$self->{meta}->{$descent}->{IdentProvider}->{arg} => $ident_dummy,
577			cs => undef,
578			};
579
580			# diff lists and ...
581			my $diff = getDifference([keys %$node], [keys %$map]);
582			next if $#{$diff} == -1;
583
584			# ... build criteria including all columns
585			my @crits;
586			foreach my $property (@$diff) {
587			next if !$property;
588			my $value = $node->{$property};
589			next if !$value;
590			push @crits, "$property='" . quotesql($value) . "'";
591			}
592			my $crit = join ' AND ', @crits;
593			print "p" if $self->{verbose};
594
595			#print Dumper($map);
596			#print Dumper($crit);
597
598			$self->_modifyNode($descent, 'update', $map, $crit);
599			$i++;
600			}
601
602	joko	1.7	#print "\n" if $self->{verbose};
603	joko	1.1
604			if (!$i) {
605			$logger->warning( __PACKAGE__ . "->_prepareNode_DummyIdent: no nodes touched" );
606			}
607
608			}
609
610			# TODO: handle this in an abstract way (wipe out use of 'source' and/or 'target' inside core)
611			sub _otherSide {
612			my $self = shift;
613			my $descent = shift;
614			return 'source' if $descent eq 'target';
615			return 'target' if $descent eq 'source';
616			return '';
617			}
618
619
620			1;
621	joko	1.6	__END__
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26