1 |
|
## ------------------------------------------------------------------------- |
2 |
|
## |
3 |
## $Id$ |
## $Id$ |
4 |
## |
## |
5 |
## Copyright (c) 2002 Andreas Motl <andreas.motl@ilo.de> |
## Copyright (c) 2002 Andreas Motl <andreas.motl@ilo.de> |
6 |
## |
## |
7 |
## See COPYRIGHT section in pod text below for usage and distribution rights. |
## See COPYRIGHT section in associated pod text |
8 |
|
## or below for usage and distribution rights. |
9 |
## |
## |
10 |
## ---------------------------------------------------------------------------------------- |
## ------------------------------------------------------------------------- |
11 |
## $Log$ |
## $Log$ |
12 |
|
## Revision 1.9 2003/05/13 08:16:44 joko |
13 |
|
## minor update: modified header |
14 |
|
## |
15 |
|
## Revision 1.8 2003/03/27 15:31:15 joko |
16 |
|
## fixes to modules regarding new namespace(s) below Data::Mungle::* |
17 |
|
## |
18 |
|
## Revision 1.7 2003/02/21 08:00:24 joko |
19 |
|
## debugging |
20 |
|
## |
21 |
|
## Revision 1.6 2003/02/14 12:58:47 joko |
22 |
|
## + re-enabled the erase-mechanism |
23 |
|
## |
24 |
|
## Revision 1.5 2003/02/11 05:26:04 joko |
25 |
|
## + sub _tellWhatIWillDo |
26 |
|
## + re-enabled "branch to execution path for special targets" mechanism |
27 |
|
## |
28 |
|
## Revision 1.4 2003/02/09 05:03:02 joko |
29 |
|
## + minor fix regarding namespace of api versioning extension module |
30 |
|
## |
31 |
|
## Revision 1.3 2003/02/09 04:59:27 joko |
32 |
|
## + api versioning mechanism |
33 |
|
## + major structure changes |
34 |
|
## - refactored code to sister modules |
35 |
|
## |
36 |
|
## Revision 1.2 2003/01/20 16:59:48 joko |
37 |
|
## + cosmetics and debugging |
38 |
|
## |
39 |
## Revision 1.1 2003/01/19 01:23:04 joko |
## Revision 1.1 2003/01/19 01:23:04 joko |
40 |
## + new from Data/Transfer/Sync.pm |
## + new from Data/Transfer/Sync.pm |
41 |
## |
## |
42 |
## ---------------------------------------------------------------------------------------- |
## ---------------------------------------------------------------------------------------- |
43 |
|
|
44 |
|
|
45 |
package Data::Transfer::Sync::API; |
package Data::Transfer::Sync::API; |
46 |
|
|
47 |
use strict; |
use strict; |
48 |
use warnings; |
use warnings; |
49 |
|
|
50 |
|
use base qw( DesignPattern::Bridge ); |
51 |
|
|
52 |
use mixin::with qw( Data::Transfer::Sync ); |
use mixin::with qw( Data::Transfer::Sync ); |
53 |
|
|
54 |
|
|
55 |
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - main |
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - main |
56 |
|
|
57 |
use Data::Dumper; |
use Data::Dumper; |
58 |
|
use Hash::Merge qw( merge ); |
59 |
use Data::Compare::Struct qw( getDifference isEmpty ); |
|
60 |
use Data::Transform::Deep qw( merge ); |
use Data::Mungle::Compare::Struct qw( isEmpty ); |
61 |
|
|
62 |
# get logger instance |
# get logger instance |
63 |
my $logger = Log::Dispatch::Config->instance; |
my $logger = Log::Dispatch::Config->instance; |
64 |
|
|
65 |
sub _init { |
|
66 |
|
sub api_constructor { |
67 |
my $self = shift; |
my $self = shift; |
68 |
|
$logger->debug( __PACKAGE__ . "->api_constructor: Loading API"); |
69 |
|
$self->_loadVersionExtensions(); |
70 |
} |
} |
|
|
|
|
sub checkOptions { |
|
|
my $self = shift; |
|
|
my $opts = shift; |
|
|
|
|
|
my $result = 1; |
|
|
|
|
|
# check - do we have a target node? |
|
|
if (!$opts->{target_node}) { |
|
|
$logger->warning( __PACKAGE__ . "->checkOptions: Error while resolving resource metadata - no 'target node' could be determined."); |
|
|
$result = 0; |
|
|
} |
|
71 |
|
|
72 |
# check - do we have a mapping? |
|
73 |
if (!$opts->{mapping} && !$opts->{mapping_module}) { |
sub _loadVersionExtensions { |
74 |
$logger->warning( __PACKAGE__ . "->checkOptions: Error while resolving resource metadata - no 'mapping' could be determined."); |
my $self = shift; |
75 |
$result = 0; |
my $syncVersion = $self->{sync_version}; |
76 |
} |
$syncVersion ||= ''; |
77 |
|
$logger->debug( __PACKAGE__ . "->loadVersionExtensions( version='$syncVersion' )"); |
78 |
return $result; |
#print Dumper($self); |
79 |
|
#exit; |
80 |
|
my $module = "API::$syncVersion"; |
81 |
|
$self->load($module); |
82 |
} |
} |
83 |
|
|
84 |
sub checkOptionsV2 { |
|
85 |
|
sub configure { |
86 |
my $self = shift; |
my $self = shift; |
87 |
|
|
88 |
#print Dumper($self->{options}); |
$logger->debug( __PACKAGE__ . "->configure"); |
89 |
|
|
90 |
my $result = 1; |
my @args = @_; |
91 |
|
|
92 |
# check - do we have a target node? |
if (!isEmpty(\@args)) { |
93 |
if (!$self->{options}->{target}->{nodeName}) { |
my %properties = @_; |
94 |
$logger->warning( __PACKAGE__ . "->checkOptionsV2: No target given - please check metadata declaration."); |
# merge args to properties |
95 |
$result = 0; |
#map { $self->{$_} = $properties{$_}; } keys %properties; |
96 |
} |
#print Dumper($self); |
97 |
|
#print Dumper(\%properties); |
98 |
# check - do we have a mapping? |
if ($self->{options}) { |
99 |
if (!$self->{options}->{fieldmap}) { |
my $options_new = merge($self->{options}, \%properties); |
100 |
$logger->warning( __PACKAGE__ . "->checkOptionsV2: Error while resolving resource metadata - no 'fieldmap' could be determined."); |
#print Dumper($options_new); |
101 |
$result = 0; |
$self->{options} = $options_new; |
102 |
|
#print Dumper($self->{options}); |
103 |
|
} else { |
104 |
|
$self->{options} = \%properties; |
105 |
|
} |
106 |
|
$self->_init(); |
107 |
|
#$self->_initV1(); |
108 |
|
} else { |
109 |
|
#print "no args!", "\n"; |
110 |
} |
} |
|
|
|
|
# TODO: extend! |
|
111 |
|
|
112 |
return $result; |
#print Dumper($self); |
113 |
|
#exit; |
114 |
|
|
115 |
|
$self->{state}->{configured} = 1; |
116 |
|
return 1; |
117 |
} |
} |
118 |
|
|
|
|
|
|
sub prepareOptions { |
|
119 |
|
|
120 |
|
sub setArguments { |
121 |
|
my $self = shift; |
122 |
|
my $args_raw = shift; |
123 |
|
$self->{args_raw} = $args_raw; |
124 |
|
} |
125 |
|
|
126 |
|
sub readArguments { |
127 |
my $self = shift; |
my $self = shift; |
|
my $opts = shift; |
|
128 |
|
|
129 |
#print Dumper($opts); |
my %syncConfig; |
130 |
|
tie %syncConfig, 'Tie::IxHash'; |
131 |
|
%syncConfig = ( |
132 |
|
map => { |
133 |
|
moduleName => $self->{args_raw}->{'mapping-module'}, |
134 |
|
}, |
135 |
|
source => { |
136 |
|
dbKey => $self->{args_raw}->{source}, |
137 |
|
nodeType => $self->{args_raw}->{'source-type'}, |
138 |
|
nodeName => $self->{args_raw}->{'source-node'}, |
139 |
|
}, |
140 |
|
target => { |
141 |
|
dbKey => $self->{args_raw}->{target}, |
142 |
|
nodeName => $self->{args_raw}->{'target-node'}, |
143 |
|
}, |
144 |
|
process => { |
145 |
|
mode => $self->{args_raw}->{mode}, |
146 |
|
erase => $self->{args_raw}->{erase}, |
147 |
|
import => $self->{args_raw}->{import}, |
148 |
|
prepare => $self->{args_raw}->{prepare}, |
149 |
|
}, |
150 |
|
# metadata => { |
151 |
|
# config => $self->{config_metadata}, |
152 |
|
# } |
153 |
|
); |
154 |
|
|
155 |
|
$self->{args} = \%syncConfig; |
156 |
|
|
157 |
|
} |
158 |
|
|
159 |
|
|
160 |
|
# TODO: some feature to show off the progress of synchronization (cur/max * 100) |
161 |
|
sub syncNodes { |
162 |
|
|
163 |
|
my $self = shift; |
164 |
|
my $args = shift; |
165 |
|
|
166 |
|
#$logger->notice( "========================== " . __PACKAGE__ . "->syncNodes =============="); |
167 |
|
$logger->debug( __PACKAGE__ . "->syncNodes: starting" ); |
168 |
|
|
169 |
|
#print Dumper($self); |
170 |
#exit; |
#exit; |
171 |
|
|
172 |
$opts->{mode} ||= ''; |
#print Dumper($self->{options}); |
173 |
$opts->{erase} ||= 0; |
$self->_prepareOptions(); |
|
$opts->{prepare} ||= 0; |
|
|
#$opts->{import} ||= 0; |
|
|
|
|
|
if (!$opts->{source_node}) { |
|
|
$logger->error( __PACKAGE__ . "->prepareOptions failed: Please specify source-node!"); |
|
|
return; |
|
|
} |
|
|
|
|
|
$logger->notice( __PACKAGE__ . "->prepareOptions( source_node $opts->{source_node} mode $opts->{mode} erase $opts->{erase} prepare $opts->{prepare} )"); |
|
174 |
|
|
175 |
#if (!$opts->{mapping} || !$opts->{mapping_module}) { |
# trace |
176 |
if (!$opts->{mapping}) { |
#print Dumper($self->{options}); |
177 |
$logger->warning( __PACKAGE__ . "->prepareOptions: No mapping supplied - please check key 'mappings' in global configuration or specify additional argument '--mapping'."); |
#exit; |
|
#return; |
|
|
} |
|
178 |
|
|
179 |
$opts->{mapping_module} ||= $opts->{mapping}; |
if (!$self->checkOptions()) { |
180 |
my $evstring = "use $opts->{mapping_module};"; |
$logger->critical( __PACKAGE__ . "->syncNodes: 'Data::Transfer::Sync::checkOptions' failed."); |
|
eval($evstring); |
|
|
if ($@) { |
|
|
$logger->warning( __PACKAGE__ . "->prepareOptions: error while trying to access mapping - $@"); |
|
181 |
return; |
return; |
182 |
} |
} |
183 |
|
|
184 |
# resolve mapping metadata (returned from sub) |
if (!$self->{state}->{configured}) { |
185 |
my $mapObject = $opts->{mapping_module}->new(); |
$logger->critical( __PACKAGE__ . "->syncNodes: Synchronization object is not configured/initialized correctly." ); |
|
#print Dumper($map); |
|
|
my $source_node_name = $opts->{source_node}; |
|
|
# check if mapping for certain node is contained in mapping object |
|
|
if (!$mapObject->can($source_node_name)) { |
|
|
$logger->warning( __PACKAGE__ . "->prepareOptions: Can't access mapping for node \"$source_node_name\" - please check $opts->{mapping_module}."); |
|
186 |
return; |
return; |
187 |
} |
} |
|
my $map = $mapObject->$source_node_name; |
|
188 |
|
|
189 |
#print Dumper($map); |
#print Dumper($args); |
190 |
|
|
191 |
# check here if "target" is actually a CODEref - in this case: resolve it - deprecated!!! ??? |
# remember arguments through the whole processing |
192 |
if (ref $map->{target} eq 'CODE') { |
$self->{args} = $args; |
193 |
$map->{target} = $map->{target}->($source_node_name); |
|
194 |
} |
# hash to hold and/or fill in metadata required for the processing |
195 |
|
$self->{meta} = {}; |
196 |
|
|
197 |
# resolve expressions (on nodename-level) here |
# hash to sum up results |
198 |
if ($map->{target} =~ m/^(code|expr):(.+?)$/) { |
# TODO: re-implement! (sync-statistics???) |
|
my $target_dynamic_type = $1; |
|
|
my $target_dynamic_expression = $2; |
|
|
if (lc $target_dynamic_type eq 'code') { |
|
|
# $map->{target} = $mapObject->$target_dynamic_expression($map); |
|
|
} |
|
|
} |
|
199 |
|
|
200 |
# remove asymmetries from $map (patch keys) |
#print Dumper($self->{options}->{process}); |
|
$map->{source_node} = $map->{source}; delete $map->{source}; |
|
|
$map->{target_node} = $map->{target}; delete $map->{target}; |
|
|
$map->{mapping} = $map->{details}; delete $map->{details}; |
|
|
$map->{direction} = $map->{mode}; delete $map->{mode}; |
|
|
|
|
|
# defaults (mostly for backward-compatibility) |
|
|
$map->{source_node} ||= $source_node_name; |
|
|
$map->{source_ident} ||= 'storage_method:id'; |
|
|
$map->{target_ident} ||= 'property:oid'; |
|
|
$map->{direction} ||= $opts->{mode}; # | PUSH | PULL | FULL |
|
|
$map->{method} ||= 'checksum'; # | timestamp |
|
|
$map->{source_exclude} ||= [qw( cs )]; |
|
201 |
|
|
202 |
# merge map to opts |
# detect synchronization method to determine which optical symbol (directed arrow) to use |
203 |
map { $opts->{$_} = $map->{$_}; } keys %$map; |
my $mode = $self->{args}->{mode}; # V1 |
204 |
|
$mode ||= $self->{options}->{process}->{mode}; # V2 |
205 |
|
my $direction_arrow = $self->_getDirectedArrow($mode); |
206 |
|
|
207 |
|
# determine code versions |
208 |
|
my $code_metadata_version; |
209 |
|
# first, try to use version supplied by mapping-metadata |
210 |
|
$code_metadata_version = $self->{options}->{metadata}->{version}; |
211 |
|
# if not set, inherit from global 'sync_version' |
212 |
|
$code_metadata_version ||= $self->{sync_version}; |
213 |
|
|
214 |
|
# load additional code from versioned namespace into current instance |
215 |
|
my $dynModule = "Metadata::$code_metadata_version"; |
216 |
|
$self->load($dynModule); |
217 |
|
|
218 |
#print Dumper($opts); |
# build metadata using versioned code and stuff |
219 |
|
$self->options2metadata(); |
220 |
|
$self->options2metadata_accessor(); |
221 |
|
|
222 |
|
# branch to execution path for special targets |
223 |
|
# detect for option 'handler' which could be a CODEref |
224 |
|
if ($self->{options}->{handler} && ref $self->{options}->{handler} eq 'CODE') { |
225 |
|
$logger->info( __PACKAGE__ . "->syncNodes: Running (special handler code - no generic sync!) on '$self->{options}->{target}->{dbKey}' with MODE $self->{options}->{process}->{mode}, NODE $self->{options}->{target}->{address}"); |
226 |
|
#print Dumper($self); |
227 |
|
#exit; |
228 |
|
# don't do this any more - it wasn't very nice somehow ... |
229 |
|
#$self->{options}->{handler}->($self->{app}, $self->{options}); |
230 |
|
# .... now: better let the parent application scope handle this via callback |
231 |
|
# not any more required for this: $self->{app} inside here (which isn't the app we mean here) |
232 |
|
# required for this: getting the options out of here: establish some getter method! ($self->getOptions(...)) |
233 |
|
# so.... |
234 |
|
#$self->{__bridge}->{parent_ref}-> |
235 |
|
|
236 |
|
# ahh okay, DesignPattern::Bridge moves closer to some Class::Inner!??? |
237 |
|
# so... |
238 |
|
# similar like above - but it isn't very nice anyway ... (no privateness, but: who cares?) |
239 |
|
#print Dumper($self->{__bridge}); |
240 |
|
# just take the global application instance and |
241 |
|
# throw it into the context of the mapping module - this is heavy! ;-) (but again, who cares...) |
242 |
|
# TODO: handle this more abstract *sometime* |
243 |
|
#$self->{options}->{handler}->($self->{__bridge}->{parent}->{app}, $self->{options}); |
244 |
|
$self->{options}->{handler}->($self->{__bridge}->{parent}->{process}, $self->{options}); |
245 |
|
|
246 |
|
return; |
247 |
|
} |
248 |
|
|
249 |
# TODO: move this to checkOptions... |
# TODO: execution path branch V2!!! |
250 |
|
# option1: wrap this via callback to parent scope (like current impl. mechanism) |
251 |
|
# option2: branch directly from here (this needs refactoring of the sub handler) |
252 |
|
|
253 |
|
# tracing |
254 |
|
#print Dumper($self); |
255 |
|
#exit; |
256 |
|
|
257 |
|
# V1: |
258 |
|
$logger->debug( __PACKAGE__ . "->syncNodes: source=$self->{meta}->{source}->{dbKey}/$self->{meta}->{source}->{nodeName} [$self->{meta}->{source}->{nodeType}] $direction_arrow target=$self->{meta}->{target}->{dbKey}/$self->{meta}->{target}->{nodeName} [$self->{meta}->{target}->{nodeType}]" ); |
259 |
|
|
260 |
|
# V2: |
261 |
|
my $what = "$self->{meta}->{source}->{dbKey}/$self->{meta}->{source}->{nodeName} [$self->{meta}->{source}->{nodeType}] $direction_arrow $self->{meta}->{target}->{dbKey}/$self->{meta}->{target}->{nodeName} [$self->{meta}->{target}->{nodeType}]"; |
262 |
|
#my $header = ("~.." x 7) . " " . $what . " " . ("~.." x 4); |
263 |
|
#my $header = ("= " x 7) . " " . $what . " " . ("= " x 4); |
264 |
|
#my $header = ("~=-_-=" x 3) . " " . $what . " " . ("~=-_-=" x 4); |
265 |
|
my $header = ("_-=~=-" x 4) . " " . $what . " " . ("_-=~=-" x 4); |
266 |
|
$logger->notice($header); |
267 |
|
|
268 |
|
|
269 |
|
return if !$self->buildFieldmapping(); |
270 |
|
return if !$self->_touchNodeSet(); |
271 |
|
return if !$self->_prepare_sync(); |
272 |
|
$self->_tellWhatIWillDo(); |
273 |
|
|
274 |
|
# tracing |
275 |
|
#print Dumper($self); |
276 |
|
#print Dumper($self->{args}); |
277 |
|
#print Dumper($self->{options}); |
278 |
|
#print Dumper($self->{meta}); |
279 |
|
#print Dumper($self->{metadata}); |
280 |
|
#exit; |
281 |
|
|
282 |
|
# finally, tell the core to start the synchronization process |
283 |
|
$self->_run(); |
284 |
|
|
285 |
# check - do we have a target? |
} |
|
if (!$opts->{target_node}) { |
|
|
$logger->warning( __PACKAGE__ . "->prepareOptions: No target given - please check metadata declaration."); |
|
|
return; |
|
|
} |
|
286 |
|
|
287 |
|
|
288 |
#return $opts; |
my $c_string_default = ''; |
289 |
return 1; |
sub c_string { |
290 |
|
my $value = shift; |
291 |
|
$value ||= "[$c_string_default]"; |
292 |
|
return $value; |
293 |
|
} |
294 |
|
|
295 |
|
sub _tellWhatIWillDo { |
296 |
|
my $self = shift; |
297 |
|
|
298 |
|
|
299 |
|
#return; |
300 |
|
|
301 |
|
# trace |
302 |
|
#print Dumper($self->{meta}); |
303 |
|
#exit; |
304 |
|
|
305 |
|
$c_string_default = 'n/a'; |
306 |
|
my $source = c_string($self->{opt}->{'source'}); |
307 |
|
my $source_node = c_string($self->{opt}->{'source-node'}); |
308 |
|
my $source_type = c_string($self->{opt}->{'source-type'}); |
309 |
|
my $target = c_string($self->{opt}->{'target'}); |
310 |
|
my $target_node = c_string($self->{opt}->{'target-node'}); |
311 |
|
my $target_type = c_string($self->{opt}->{'target-type'}); |
312 |
|
|
313 |
|
my $mapping_module = c_string($self->{opt}->{'mapping-module'}); |
314 |
|
my $mode = uc c_string($self->{opt}->{'mode'}); |
315 |
|
|
316 |
|
#my $ql = "$mode INTO $source NODE $source_node TYPE $source_type SELECT NODE $target_node TYPE $target_type FROM $target USING MODULE $mapping_module;"; |
317 |
|
#$logger->notice( __PACKAGE__ . ": $ql" ); |
318 |
|
my $ql = <<EOT; |
319 |
|
|
320 |
|
FETCH DATA |
321 |
|
FROM STORAGE $self->{meta}->{source}->{dbKey} |
322 |
|
AT NODE $self->{meta}->{source}->{accessorName}.$self->{meta}->{source}->{nodeName} |
323 |
|
USING IDENTIFIER $self->{meta}->{source}->{IdentProvider}->{method}.$self->{meta}->{source}->{IdentProvider}->{arg} |
324 |
|
CONVERT DATA |
325 |
|
CAST FROM $self->{meta}->{source}->{nodeType} TO $self->{meta}->{target}->{nodeType} |
326 |
|
MAP ATTRIBUTES FROM @{$self->{meta}->{source}->{childnodes}} TO @{$self->{meta}->{target}->{childnodes}} |
327 |
|
STORE DATA |
328 |
|
TO STORAGE $self->{meta}->{target}->{dbKey} |
329 |
|
AT NODE $self->{meta}->{target}->{accessorName}.$self->{meta}->{target}->{nodeName} |
330 |
|
USING IDENTIFIER $self->{meta}->{target}->{IdentProvider}->{method}.$self->{meta}->{target}->{IdentProvider}->{arg} |
331 |
|
EOT |
332 |
|
|
333 |
|
|
334 |
|
chomp($ql); |
335 |
|
$logger->info($ql); |
336 |
|
|
337 |
|
#exit; |
338 |
|
return; |
339 |
|
|
340 |
|
my $actioning = ucfirst $self->{opt}->{'action'} . 'ing'; |
341 |
|
|
342 |
|
# FIXME: this is weird! |
343 |
|
my $long = <<EOT; |
344 |
|
|
345 |
|
- $actioning data of type $target_type and |
346 |
|
filtered by $target_node from the storage named $target |
347 |
|
to the storage named $source - filtered by $source_node. |
348 |
|
- Will attempt to convert the data to $source_type. |
349 |
|
EOT |
350 |
|
chomp($long); |
351 |
|
$logger->notice( __PACKAGE__ . ": $long" ); |
352 |
|
|
353 |
} |
} |
354 |
|
|
355 |
sub prepareOptionsV2 { |
|
356 |
|
sub _prepareOptions { |
357 |
|
|
358 |
my $self = shift; |
my $self = shift; |
359 |
my $opts = shift; |
|
360 |
|
my $opts = $self->{args}; |
361 |
|
|
362 |
# patch options |
# patch options |
363 |
|
$opts->{source}->{nodeName} ||= ''; |
364 |
|
$opts->{target}->{nodeName} ||= ''; |
365 |
$opts->{process}->{mode} ||= ''; |
$opts->{process}->{mode} ||= ''; |
|
$opts->{process}->{prepare} ||= 0; |
|
366 |
$opts->{process}->{erase} ||= 0; |
$opts->{process}->{erase} ||= 0; |
367 |
|
$opts->{process}->{prepare} ||= 0; |
368 |
|
|
369 |
|
# defaults (mostly for backward-compatibility to V1 - |
370 |
|
# but code mungled here out of prepareOptions_V1 from Version::V1) |
371 |
|
$opts->{metadata}->{syncMethod} ||= 'checksum'; # | timestamp |
372 |
|
$opts->{source}->{ident} ||= 'storage_method:id'; |
373 |
|
$opts->{source}->{exclude} ||= [qw( cs )]; |
374 |
|
$opts->{target}->{ident} ||= 'property:oid'; |
375 |
|
#$map->{source_node} ||= $source_node_name; |
376 |
|
#$map->{direction} ||= $opts->{mode}; # | PUSH | PULL | FULL |
377 |
|
|
378 |
# pre-check options |
# pre-check options |
379 |
if (!$self->_preCheckOptions($opts)) { |
if (!$self->_preCheckOptions($opts)) { |
380 |
$logger->error( __PACKAGE__ . "->prepareOptionsV2: _preCheckOptions failed."); |
$logger->error( __PACKAGE__ . "->_prepareOptions: _preCheckOptions failed."); |
381 |
return; |
return; |
382 |
} |
} |
383 |
|
|
384 |
# inform user about option preparation |
# inform user about option preparation |
385 |
$logger->notice( __PACKAGE__ . "->prepareOptionsV2( mode='$opts->{process}->{mode}', source->node='$opts->{source}->{nodeName}', target->node='$opts->{target}->{nodeName}', erase='$opts->{process}->{erase}', prepare='$opts->{process}->{prepare}' )"); |
$logger->debug( __PACKAGE__ . "->_prepareOptions( source.node='$opts->{source}->{nodeName}', target.node='$opts->{target}->{nodeName}', mode='$opts->{process}->{mode}', e='$opts->{process}->{erase}', p='$opts->{process}->{prepare}' )"); |
386 |
|
|
387 |
# try to load mapping-metadata-container |
# try to load mapping-metadata-container |
388 |
#my $mapObject = getNewPerlObjectByPkgName($opts->{map}->{moduleName}); |
# How? Create a new instance of the given |
389 |
my $mapObject = DesignPattern::Object->fromPackage($opts->{map}->{moduleName}); |
# perl module/package name in ->{...}->{moduleName}. |
390 |
|
# This instance is used later in the innards of the sync, |
391 |
|
# that's why the module (class) should have a certain layout |
392 |
|
# enabling the core to use it for gathering metadata while processing. |
393 |
|
my $mapObject = DesignPattern::Object->fromPackage($opts->{map}->{moduleName}); |
394 |
|
|
395 |
# try to resolve map from metadata-container |
# try to resolve map from metadata-container |
396 |
|
|
398 |
my $source_nodeType = $opts->{source}->{nodeType}; |
my $source_nodeType = $opts->{source}->{nodeType}; |
399 |
|
|
400 |
# check if mapping for certain node is contained in mapping object |
# check if mapping for certain node is contained in mapping object |
401 |
if (!$mapObject->can($source_nodeType)) { |
if (!$mapObject || !$mapObject->can($source_nodeType)) { |
402 |
$logger->warning( __PACKAGE__ . "->prepareOptionsV2: Can't access mapping for source-type=\"$source_nodeType\" - please check \"$opts->{map}->{moduleName}\"."); |
$logger->warning( __PACKAGE__ . "->_prepareOptions: Can't access mapping for source-type=\"$source_nodeType\" - please check \"$opts->{map}->{moduleName}\"."); |
403 |
return; |
return; |
404 |
} |
} |
405 |
|
|
|
|
|
406 |
# get map |
# get map |
407 |
my $map = $mapObject->$source_nodeType; |
my $map = $mapObject->$source_nodeType; |
408 |
#print Dumper($map); |
#print Dumper($map); |
409 |
|
|
410 |
=pod |
my $map_version = $map->{metadata}->{version}; |
411 |
|
# FIXME: backward compatibility |
412 |
|
if (!$map_version) { |
413 |
|
$self->options_to_V2($map); |
414 |
|
} |
415 |
|
|
416 |
|
# trace |
417 |
|
#print Dumper($map); |
418 |
|
#exit; |
419 |
|
#print "ref: ", ref $map->{target}, "\n"; |
420 |
|
#print "target: ", $map->{target}, "\n"; |
421 |
|
|
422 |
# check here if "target" is actually a CODEref - in this case: resolve it - deprecated!!! ??? |
# check here if "target" is actually a CODEref - in this case: resolve it - deprecated!!! ??? |
423 |
if (ref $map->{target}->{address} eq 'CODE') { |
if (ref $map->{target}->{address} eq 'CODE') { |
424 |
$map->{target}->{address} = $map->{target}->{address}->($source_nodeType); |
$map->{target}->{address} = $map->{target}->{address}->($source_nodeType); |
425 |
} |
} |
426 |
|
|
427 |
# resolve expressions (on nodename-level) here |
# resolve expressions (on nodename-level) here |
428 |
if ($map->{target}->{address} =~ m/^(code|expr):(.+?)$/) { |
elsif ($map->{target}->{address} =~ m/^(code|expr):(.+?)$/) { |
429 |
my $target_dynamic_type = $1; |
my $target_dynamic_type = $1; |
430 |
my $target_dynamic_expression = $2; |
my $target_dynamic_expression = $2; |
431 |
if (lc $target_dynamic_type eq 'code') { |
if (lc $target_dynamic_type eq 'code') { |
432 |
$map->{target} = $mapObject->$target_dynamic_expression($map); |
$map->{target} = $mapObject->$target_dynamic_expression($map); |
433 |
} |
} |
434 |
} |
} |
|
=cut |
|
435 |
|
|
436 |
#map { $opts->{$_} = $map->{$_}; } keys %$map; |
# merging - V1 |
437 |
my $opts_merged = merge( $opts, $map ); |
#map { $opts->{$_} = $map->{$_}; } keys %$map; |
438 |
|
# trace |
439 |
|
#print Dumper($self->{options}); |
440 |
|
|
441 |
|
# merging - V2 |
442 |
|
|
443 |
|
# merge local map with local opts |
444 |
|
|
445 |
|
# delete undef'd items in $map |
446 |
|
|
447 |
|
# enable cloning |
448 |
|
# FIXME: do we really need cloning here? trade safety/encapsulation for speed? |
449 |
|
Hash::Merge::set_clone_behavior(1); |
450 |
|
Hash::Merge::set_behavior( 'RIGHT_PRECEDENT' ); |
451 |
|
#Hash::Merge::set_behavior( 'STORAGE_PRECEDENT' ); |
452 |
|
#Hash::Merge::set_behavior( 'RETAINMENT_PRECEDENT' ); |
453 |
|
# TODO: add an option to Hash::Merge not to overwrite set items with undefined/empty/not assigned ones |
454 |
|
my $locals_merged = merge( $opts, $map ); |
455 |
|
|
456 |
|
# trace |
457 |
|
#print Dumper($opts); |
458 |
|
#print Dumper($map); |
459 |
|
#print Dumper($locals_merged); |
460 |
|
#exit; |
461 |
|
|
462 |
|
# merge local-merged ones with instance-wide options |
463 |
|
Hash::Merge::set_clone_behavior(0); |
464 |
|
$self->{options} = merge( $self->{options}, $locals_merged ); |
465 |
|
|
466 |
|
# trace |
467 |
|
#print Dumper($self->{options}); |
468 |
|
#exit; |
469 |
|
|
470 |
|
|
|
$self->{options} = $opts_merged; |
|
471 |
$self->{state}->{options_ready} = 1; |
$self->{state}->{options_ready} = 1; |
472 |
|
|
473 |
return 1; |
return 1; |
474 |
|
|
475 |
} |
} |
|
|
|
|
|
|
|
sub configure { |
|
|
my $self = shift; |
|
|
my @args = @_; |
|
|
if (!isEmpty(\@args)) { |
|
|
my %properties = @_; |
|
|
# merge args to properties |
|
|
map { $self->{$_} = $properties{$_}; } keys %properties; |
|
|
$self->_init(); |
|
|
$self->_initV1(); |
|
|
} else { |
|
|
#print "no args!", "\n"; |
|
|
} |
|
|
#print Dumper($self); |
|
|
$self->{state}->{configured} = 1; |
|
|
return 1; |
|
|
} |
|
|
|
|
|
sub configureV2 { |
|
|
my $self = shift; |
|
|
my @args = @_; |
|
|
if (!isEmpty(\@args)) { |
|
|
my %properties = @_; |
|
|
# merge args to properties |
|
|
#map { $self->{$_} = $properties{$_}; } keys %properties; |
|
|
$self->{options} = merge($self->{options}, \%properties); |
|
|
$self->_init(); |
|
|
#$self->_initV1(); |
|
|
} else { |
|
|
#print "no args!", "\n"; |
|
|
} |
|
476 |
|
|
|
#print Dumper($self); |
|
477 |
|
|
478 |
$self->{state}->{configured} = 1; |
sub _preCheckOptions { |
|
return 1; |
|
|
} |
|
|
|
|
|
|
|
|
# TODO: some feature to show off the progress of synchronization (cur/max * 100) |
|
|
sub syncNodes { |
|
479 |
|
|
480 |
my $self = shift; |
my $self = shift; |
481 |
my $args = shift; |
my $opts = shift; |
482 |
|
|
483 |
if (!$self->{state}->{configured}) { |
# trace |
484 |
$logger->critical( __PACKAGE__ . "->syncNodes: Synchronization object is not configured/initialized correctly." ); |
#print Dumper($opts); |
485 |
|
#exit; |
486 |
|
|
487 |
|
if (!$opts->{process}->{mode}) { |
488 |
|
$logger->error( __PACKAGE__ . "->_preCheckOptions failed: Please specify \"--action=(load|save)\"."); |
489 |
return; |
return; |
490 |
} |
} |
491 |
|
|
492 |
# remember arguments through the whole processing |
# the type of the to-be-synced item |
493 |
$self->{args} = $args; |
if (!$opts->{source}->{nodeType}) { |
494 |
|
$logger->error( __PACKAGE__ . "->_preCheckOptions failed: Please specify \"source-type\"."); |
495 |
$logger->debug( __PACKAGE__ . "->syncNodes: starting" ); |
return; |
|
|
|
|
# hash to hold and/or fill in metadata required for the processing |
|
|
$self->{meta} = {}; |
|
|
|
|
|
# hash to sum up results |
|
|
my $direction_arrow = ''; |
|
|
|
|
|
# detect synchronization method to determine which optical symbol (directed arrow) to use |
|
|
if (lc $self->{args}->{direction} eq 'push') { |
|
|
$direction_arrow = '->'; |
|
|
} elsif (lc $self->{args}->{direction} eq 'pull') { |
|
|
$direction_arrow = '<-'; |
|
|
} elsif (lc $self->{args}->{direction} eq 'full') { |
|
|
$direction_arrow = '<->'; |
|
|
} else { |
|
496 |
} |
} |
497 |
|
# the name of the (container-) node the items are listed in |
498 |
print Dumper($self); |
if (!$opts->{source}->{nodeName}) { |
499 |
#exit; |
$logger->error( __PACKAGE__ . "->_preCheckOptions failed: Please specify \"source-node\"."); |
500 |
|
return; |
|
if (!$self->{metadata}->{version} || $self->{metadata}->{version} < 0.2) { |
|
|
$self->_buildMetadataV1(); |
|
|
} else { |
|
|
$self->_buildMetadataV1(); |
|
|
#$self->_buildMetadataV2(); |
|
501 |
} |
} |
502 |
|
|
503 |
#print Dumper($self); |
# a "map"-declaration which module to use for mapping- and/or lookup-purposes |
504 |
#print Dumper($self->{meta}); |
if (!$opts->{map}) { |
505 |
|
$logger->warning( __PACKAGE__ . "->_preCheckOptions: No mapping supplied - please check key 'map|mappings' in global configuration or specify additional argument '--mapping-module'."); |
506 |
|
return; |
507 |
|
} |
508 |
|
if (!$opts->{map}->{moduleName}) { |
509 |
|
$logger->warning( __PACKAGE__ . "->_preCheckOptions: Currently only perl-modules can provide mappings: Please specify one with '--mapping-module=My::Mapping::Module'."); |
510 |
|
return; |
511 |
|
} |
512 |
|
|
513 |
$logger->info( __PACKAGE__ . "->syncNodes: source=$self->{meta}->{source}->{dbkey}/$self->{meta}->{source}->{node} $direction_arrow target=$self->{meta}->{target}->{dbkey}/$self->{meta}->{target}->{node}" ); |
return 1; |
514 |
|
|
515 |
$self->_buildFieldmappingV1(); |
} |
516 |
|
|
|
#print Dumper($self->{meta}); |
|
|
|
|
|
# check partners/nodes: does partner exist / is node available? |
|
|
foreach my $partner (keys %{$self->{meta}}) { |
|
|
|
|
|
# 1. check partners & storages |
|
|
if (!$self->{meta}->{$partner}) { |
|
|
$logger->critical( __PACKAGE__ . "->syncNodes: Could not find partner '$partner' in configuration metadata." ); |
|
|
return; |
|
|
} |
|
517 |
|
|
|
my $dbkey = $self->{meta}->{$partner}->{dbkey}; |
|
518 |
|
|
519 |
#print Dumper($self->{meta}); |
sub _prepare_sync { |
520 |
|
|
521 |
if (!$self->{meta}->{$partner}->{storage}) { |
my $self = shift; |
|
$logger->critical( __PACKAGE__ . "->syncNodes: Could not access storage of partner '$partner' (named '$dbkey'), looks like a configuration-error." ); |
|
|
return; |
|
|
} |
|
|
|
|
|
# TODO: |
|
|
# 2. check if partners (and nodes?) are actually available.... |
|
|
# eventually pre-check mode of access-attempt (read/write) here to provide an "early-croak" if possible |
|
|
|
|
|
# print Dumper($self->{meta}->{$partner}->{storage}->{locator}); |
|
|
|
|
|
my $dbType = $self->{meta}->{$partner}->{storage}->{locator}->{type}; |
|
|
#print "dbType: $dbType", "\n"; |
|
|
|
|
|
# 3. check nodes |
|
|
next if $dbType eq 'DBI'; # HACK for DBD::CSV - re-enable for others |
|
|
# get node-name |
|
|
# print Dumper($self); |
|
|
#print Dumper($self->{meta}->{$partner}); |
|
|
#print "öö", $self->{meta}->{$partner}->{node}, "\n"; |
|
|
my $nodename = $self->{meta}->{$partner}->{node}; |
|
|
# check if nodename is actually a CODEref, execute it to get a mapped/filtered target-nodename |
|
|
|
|
|
#print "nodename: $nodename", "\n"; |
|
|
|
|
|
$logger->info( __PACKAGE__ . "->syncNodes: Accessing dbType=\"$dbType\", nodename=\"$nodename\"." ); |
|
|
|
|
|
=pod |
|
|
#print "----", ref $nodename, "\n"; |
|
|
if ($nodename =~ m/CODE/) { |
|
|
print Dumper($self); |
|
|
#exit; |
|
|
$nodename = $nodename->($nodename); |
|
|
} |
|
|
=cut |
|
|
|
|
|
if (!$self->{meta}->{$partner}->{storage}->existsChildNode($nodename)) { |
|
|
$logger->critical( __PACKAGE__ . "->syncNodes: Could not reach node \"$nodename\" at partner \"$partner\"." ); |
|
|
return; |
|
|
} |
|
|
|
|
|
} |
|
522 |
|
|
523 |
# TODO: |
# TODO: |
524 |
# + if action == PUSH: start processing |
# + if action == PUSH: start processing |
525 |
# -+ if action == PULL: swap metadata and start processing |
# -+ if action == PULL: swap metadata and start processing |
526 |
# - if action == FULL: start processing, then swap metadata and (re-)start processing |
# - if action == FULL: start processing, then swap metadata and (re-)start processing |
527 |
|
|
528 |
#print Dumper($self->{args}); |
#print "dir: ", $self->{args}->{direction}, "\n"; |
529 |
|
|
530 |
# manipulate metainfo according to direction of synchronization |
# manipulate metainfo according to direction of synchronization |
531 |
if (lc $self->{args}->{direction} eq 'push') { |
if (lc $self->{options}->{process}->{mode} eq 'push') { |
532 |
# just do it ... |
# just do it ... (don't modify any metadata) |
533 |
} elsif (lc $self->{args}->{direction} eq 'pull') { |
|
534 |
#print "=======SWAP", "\n"; |
} elsif (lc $self->{options}->{process}->{mode} eq 'pull') { |
535 |
# swap |
# swap source and target metadata |
536 |
|
# TODO: introduce different mechanism to make more then two partners (descents) possible |
537 |
($self->{meta}->{source}, $self->{meta}->{target}) = |
($self->{meta}->{source}, $self->{meta}->{target}) = |
538 |
($self->{meta}->{target}, $self->{meta}->{source}); |
($self->{meta}->{target}, $self->{meta}->{source}); |
539 |
} elsif (lc $self->{args}->{direction} eq 'full') { |
#($self->{options}->{source}, $self->{options}->{target}) = |
540 |
|
# ($self->{options}->{target}, $self->{options}->{source}); |
541 |
|
|
542 |
|
} elsif (lc $self->{options}->{process}->{mode} eq 'full') { |
543 |
|
# TODO: |
544 |
|
# do a pull first and a push afterwards |
545 |
|
# this requires us to be called somehow recursively - just one recursion level ;-) |
546 |
|
|
547 |
} else { |
} else { |
548 |
|
# TODO: are there any other synchronization modes besides PULL, PUSH, FULL? |
549 |
|
|
550 |
} |
} |
551 |
|
|
552 |
# import flag means: prepare the source node to be syncable |
# import flag means: prepare the source node to be syncable |
553 |
# this is useful if there are e.g. no "ident" or "checksum" columns yet inside a DBI like (row-based) storage |
# this is useful if there are e.g. no "ident" or "checksum" columns yet inside a DBI like (row-based) storage |
554 |
if ($self->{args}->{prepare}) { |
if ($self->{options}->{process}->{prepare}) { |
555 |
$self->_prepareNode_MetaProperties('source'); |
$self->_prepareNode_MetaProperties('source'); |
556 |
$self->_prepareNode_DummyIdent('source'); |
$self->_prepareNode_DummyIdent('source'); |
557 |
#return; |
#return; |
560 |
|
|
561 |
# erase flag means: erase the target |
# erase flag means: erase the target |
562 |
#if ($opts->{erase}) { |
#if ($opts->{erase}) { |
563 |
if ($self->{args}->{erase}) { |
if ($self->{options}->{process}->{erase}) { |
564 |
# TODO: move this method to the scope of the synchronization core and wrap it around different handlers |
# TODO: move this method to the scope of the synchronization core and wrap it around different handlers |
565 |
#print "ERASE", "\n"; |
#print "ERASE", "\n"; |
566 |
$self->_erase_all('target'); |
$self->_erase_all('target'); |
567 |
} |
} |
568 |
|
|
569 |
|
return 1; |
570 |
|
|
571 |
$self->_syncNodes(); |
} |
572 |
|
|
573 |
|
sub _getDirectedArrow { |
574 |
|
my $self = shift; |
575 |
|
my $mode = shift; |
576 |
|
$mode ||= ''; |
577 |
|
|
578 |
|
if (lc $mode eq 'push') { |
579 |
|
return '->'; |
580 |
|
} elsif (lc $mode eq 'pull') { |
581 |
|
return '<-'; |
582 |
|
} elsif (lc $mode eq 'full') { |
583 |
|
return '<->'; |
584 |
|
} else { |
585 |
|
return ''; |
586 |
|
} |
587 |
} |
} |
588 |
|
|
589 |
1; |
1; |