2 use OpenSRF::Utils::JSON;
4 use OpenSRF::Utils::Logger;
5 use OpenSRF::Utils::SettingsClient;
8 use Scalar::Util 'blessed';
10 my $log = 'OpenSRF::Utils::Logger';
12 use vars qw/$fieldmap $VERSION/;
15 # To dump the Javascript version of the fieldmapper struct use the command:
17 # PERL5LIB=:~/vcs/ILS/Open-ILS/src/perlmods/lib/ GEN_JS=1 perl -MOpenILS::Utils::Fieldmapper -e 'print "\n";'
19 # ... adjusted for your VCS sandbox of choice, of course.
23 return () unless (defined $fieldmap);
24 return keys %$fieldmap;
27 # Find a Fieldmapper class given the json hint.
30 foreach (keys %$fieldmap) {
31 return $_ if ($fieldmap->{$_}->{hint} eq $hint);
37 my $attr_list = shift;
38 my $attr_name = shift;
40 my $attr = $attr_list->getNamedItem( $attr_name );
41 if( defined( $attr ) ) {
42 return $attr->getValue();
48 my $field_list = shift;
51 # Get attributes of the field list. Since there is only one
52 # <field> per class, these attributes logically belong to the
53 # enclosing class, and that's where we load them.
55 my $field_attr_list = $field_list->attributes();
57 my $sequence = get_attribute( $field_attr_list, 'oils_persist:sequence' );
58 if( ! defined( $sequence ) ) {
61 my $primary = get_attribute( $field_attr_list, 'oils_persist:primary' );
63 # Load attributes into the Fieldmapper ----------------------
65 $$fieldmap{$fm}{ sequence } = $sequence;
66 $$fieldmap{$fm}{ identity } = $primary;
68 # Load each field -------------------------------------------
70 my $array_position = 0;
71 for my $field ( $field_list->childNodes() ) { # For each <field>
72 if( $field->nodeName eq 'field' ) {
74 my $attribute_list = $field->attributes();
76 my $name = get_attribute( $attribute_list, 'name' );
77 next if( $name eq 'isnew' || $name eq 'ischanged' || $name eq 'isdeleted' );
78 my $required = get_attribute( $attribute_list, 'oils_obj:required' );
79 my $validate = get_attribute( $attribute_list, 'oils_obj:validate' );
80 my $virtual = get_attribute( $attribute_list, 'oils_persist:virtual' );
81 if( ! defined( $virtual ) ) {
84 my $selector = get_attribute( $attribute_list, 'reporter:selector' );
85 my $datatype = get_attribute( $attribute_list, 'reporter:datatype' );
87 $$fieldmap{$fm}{fields}{ $name } =
88 { virtual => ( $virtual eq 'true' ) ? 1 : 0,
89 required => ( $required eq 'true' ) ? 1 : 0,
90 position => $array_position,
91 datatype => $datatype,
94 $$fieldmap{$fm}{fields}{ $name }{validate} = qr/$validate/ if (defined($validate));
96 # The selector attribute, if present at all, attaches to only one
97 # of the fields in a given class. So if we see it, we store it at
98 # the level of the enclosing class.
100 if( defined( $selector ) ) {
101 $$fieldmap{$fm}{selector} = $selector;
108 # Load the standard 3 virtual fields ------------------------
110 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
111 $$fieldmap{$fm}{fields}{ $vfield } =
112 { position => $array_position,
120 my $link_list = shift;
123 for my $link ( $link_list->childNodes() ) { # For each <link>
124 if( $link->nodeName eq 'link' ) {
125 my $attribute_list = $link->attributes();
127 my $field = get_attribute( $attribute_list, 'field' );
128 my $reltype = get_attribute( $attribute_list, 'reltype' );
129 my $key = get_attribute( $attribute_list, 'key' );
130 my $class = get_attribute( $attribute_list, 'class' );
131 my $map = get_attribute( $attribute_list, 'map' );
133 $$fieldmap{$fm}{links}{ $field } =
144 my $class_node = shift;
146 # Get attributes ---------------------------------------------
148 my $attribute_list = $class_node->attributes();
150 my $fm = get_attribute( $attribute_list, 'oils_obj:fieldmapper' );
151 $fm = 'Fieldmapper::' . $fm;
152 my $id = get_attribute( $attribute_list, 'id' );
153 my $controller = get_attribute( $attribute_list, 'controller' );
154 my $virtual = get_attribute( $attribute_list, 'virtual' );
155 if( ! defined( $virtual ) ) {
158 my $tablename = get_attribute( $attribute_list, 'oils_persist:tablename' );
159 if( ! defined( $tablename ) ) {
162 my $restrict_primary = get_attribute( $attribute_list, 'oils_persist:restrict_primary' );
163 my $field_safe = get_attribute( $attribute_list, 'oils_persist:field_safe' );
165 # Load the attributes into the Fieldmapper --------------------
167 $log->debug("Building Fieldmapper class for [$fm] from IDL");
169 $$fieldmap{$fm}{ hint } = $id;
170 $$fieldmap{$fm}{ virtual } = ( $virtual eq 'true' ) ? 1 : 0;
171 $$fieldmap{$fm}{ table } = $tablename;
172 $$fieldmap{$fm}{ controller } = [ split ' ', $controller ];
173 $$fieldmap{$fm}{ restrict_primary } = $restrict_primary;
174 $$fieldmap{$fm}{ field_safe } = $field_safe;
176 # Load fields and links
178 for my $child ( $class_node->childNodes() ) {
179 my $nodeName = $child->nodeName;
180 if( $nodeName eq 'fields' ) {
181 load_fields( $child, $fm );
182 } elsif( $nodeName eq 'links' ) {
183 load_links( $child, $fm );
193 return if (keys %$fieldmap);
194 return if (!OpenSRF::System->connected && !$args{IDL});
197 my $parser = XML::LibXML->new();
198 my $file = $args{IDL} || OpenSRF::Utils::SettingsClient->new->config_value( 'IDL' );
199 my $fmdoc = $parser->parse_file( $file );
200 my $rootnode = $fmdoc->documentElement();
202 for my $child ( $rootnode->childNodes() ) { # For each <class>
203 my $nodeName = $child->nodeName;
204 if( $nodeName eq 'class' ) {
205 load_class( $child );
209 #-------------------------------------------------------------------------------
210 # Now comes the evil! Generate classes
212 for my $pkg ( __PACKAGE__->classes ) {
213 (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
217 use base 'Fieldmapper';
220 if (exists $$fieldmap{$pkg}{proto_fields}) {
221 for my $pfield ( sort keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
222 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
227 OpenSRF::Utils::JSON->register_class_hint(
228 hint => $pkg->json_hint,
239 $value = [] unless (defined $value);
240 return bless $value => $self->class_name;
253 (my $field = $AUTOLOAD) =~ s/^.*://o;
254 my $class_name = $obj->class_name;
257 $fpos =~ s/^clear_//og ;
259 my $pos = $$fieldmap{$class_name}{fields}{$fpos}{position};
261 if ($field =~ /^clear_/o) {
263 *{$obj->class_name."::$field"} = sub {
265 $self->[$pos] = undef;
269 return $obj->$field();
272 die "No field by the name $field in $class_name!"
273 unless (exists $$fieldmap{$class_name}{fields}{$field} && defined($pos));
277 *{$obj->class_name."::$field"} = sub {
280 $self->[$pos] = $new_val if (defined $new_val);
281 return $self->[$pos];
284 return $obj->$field($value);
289 return $$fieldmap{$self->class_name}{selector};
294 return $$fieldmap{$self->class_name}{identity};
297 sub RestrictPrimary {
299 return $$fieldmap{$self->class_name}{restrict_primary};
304 return $$fieldmap{$self->class_name}{sequence};
309 return $$fieldmap{$self->class_name}{table};
314 return $$fieldmap{$self->class_name}{controller};
320 return undef unless ($f);
321 return $$fieldmap{$self->class_name}{fields}{$f}{required};
326 return undef unless (ref $self);
328 my $opts = shift || {};
329 my $no_virt = $$opts{no_virt}; # skip virtual fields
330 my $skip_fields = $$opts{skip_fields} || {}; # eg. {au => ['passwd']}
331 my @to_skip = @{$$skip_fields{$self->json_hint}}
332 if $$skip_fields{$self->json_hint};
334 my $dom = XML::LibXML::Document->new;
335 my $root = $dom->createElement( $self->json_hint );
336 $dom->setDocumentElement( $root );
338 my @field_names = $no_virt ? $self->real_fields : $self->properties;
340 for my $f (@field_names) {
341 next if ($f eq 'isnew');
342 next if ($f eq 'ischanged');
343 next if ($f eq 'isdeleted');
344 next if (grep {$_ eq $f} @to_skip);
346 my $value = $self->$f();
347 my $element = $dom->createElement( $f );
349 $value = [$value] if (blessed($value)); # fm object
351 if (ref($value)) { # array
352 for my $k (@$value) {
354 my $subdoc = $k->toXML($opts);
356 my $subnode = $subdoc->documentElement;
357 $dom->adoptNode($subnode);
358 $element->appendChild($subnode);
359 } elsif (ref $k) { # not sure what to do here
360 $element->appendText($k);
361 } else { # meh .. just append, I guess
362 $element->appendText($k);
366 $element->appendText($value);
369 $root->appendChild($element);
378 return undef unless ($f);
379 return 1 if (!exists($$fieldmap{$self->class_name}{fields}{$f}{validate}));
380 return $self->$f =~ $$fieldmap{$self->class_name}{fields}{$f}{validate};
386 my $class_name = $self->class_name;
387 return undef unless ($field && $$fieldmap{$class_name}{fields}{$field});
388 return $$fieldmap{$class_name}{fields}{$field};
394 my $class_name = $self->class_name;
395 return undef unless ($field && $$fieldmap{$class_name}{fields}{$field});
396 return $$fieldmap{$class_name}{fields}{$field}{datatype};
400 my $class_name = shift;
401 return ref($class_name) || $class_name;
406 my $class_name = $self->class_name;
407 my $fields = $$fieldmap{$class_name}{fields};
410 !$$fields{$_}{virtual}
411 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
419 my $class_name = $self->class_name;
420 return 1 if grep { $_ eq $field } keys %{$$fieldmap{$class_name}{fields}};
426 my $class_name = $self->class_name;
427 return keys %{$$fieldmap{$class_name}{fields}};
434 for my $f ($self->properties) {
444 return $self->new( [@$self] );
449 return $fieldmap->{$self->class_name}->{api_level};
454 return $fieldmap->{$self->class_name}->{cdbi};
460 return $fieldmap->{$self->class_name}->{proto_fields}->{$field} if ($field);
461 return $fieldmap->{$self->class_name}->{virtual};
467 return $fieldmap->{$self->class_name}->{readonly};
472 return $fieldmap->{$self->class_name}->{hint};