2 use OpenSRF::Utils::JSON;
4 use base 'OpenSRF::Application';
5 use OpenSRF::Utils::Logger;
6 use OpenSRF::Utils::SettingsClient;
9 use Scalar::Util 'blessed';
11 my $log = 'OpenSRF::Utils::Logger';
13 use vars qw/$fieldmap $VERSION/;
15 sub publish_fieldmapper {
16 my ($self,$client,$class) = @_;
18 return $fieldmap unless (defined $class);
19 return undef unless (exists($$fieldmap{$class}));
20 return {$class => $$fieldmap{$class}};
22 __PACKAGE__->register_method(
23 api_name => 'opensrf.open-ils.system.fieldmapper',
25 method => 'publish_fieldmapper',
29 # To dump the Javascript version of the fieldmapper struct use the command:
31 # PERL5LIB=:~/vcs/ILS/Open-ILS/src/perlmods/lib/ GEN_JS=1 perl -MOpenILS::Utils::Fieldmapper -e 'print "\n";'
33 # ... adjusted for your VCS sandbox of choice, of course.
37 return () unless (defined $fieldmap);
38 return keys %$fieldmap;
41 # Find a Fieldmapper class given the json hint.
44 foreach (keys %$fieldmap) {
45 return $_ if ($fieldmap->{$_}->{hint} eq $hint);
51 my $attr_list = shift;
52 my $attr_name = shift;
54 my $attr = $attr_list->getNamedItem( $attr_name );
55 if( defined( $attr ) ) {
56 return $attr->getValue();
62 my $field_list = shift;
65 # Get attributes of the field list. Since there is only one
66 # <field> per class, these attributes logically belong to the
67 # enclosing class, and that's where we load them.
69 my $field_attr_list = $field_list->attributes();
71 my $sequence = get_attribute( $field_attr_list, 'oils_persist:sequence' );
72 if( ! defined( $sequence ) ) {
75 my $primary = get_attribute( $field_attr_list, 'oils_persist:primary' );
77 # Load attributes into the Fieldmapper ----------------------
79 $$fieldmap{$fm}{ sequence } = $sequence;
80 $$fieldmap{$fm}{ identity } = $primary;
82 # Load each field -------------------------------------------
84 my $array_position = 0;
85 for my $field ( $field_list->childNodes() ) { # For each <field>
86 if( $field->nodeName eq 'field' ) {
88 my $attribute_list = $field->attributes();
90 my $name = get_attribute( $attribute_list, 'name' );
91 next if( $name eq 'isnew' || $name eq 'ischanged' || $name eq 'isdeleted' );
92 my $required = get_attribute( $attribute_list, 'oils_obj:required' );
93 my $validate = get_attribute( $attribute_list, 'oils_obj:validate' );
94 my $virtual = get_attribute( $attribute_list, 'oils_persist:virtual' );
95 if( ! defined( $virtual ) ) {
98 my $selector = get_attribute( $attribute_list, 'reporter:selector' );
100 $$fieldmap{$fm}{fields}{ $name } =
101 { virtual => ( $virtual eq 'true' ) ? 1 : 0,
102 required => ( $required eq 'true' ) ? 1 : 0,
103 position => $array_position,
106 $$fieldmap{$fm}{fields}{ $name }{validate} = qr/$validate/ if (defined($validate));
108 # The selector attribute, if present at all, attaches to only one
109 # of the fields in a given class. So if we see it, we store it at
110 # the level of the enclosing class.
112 if( defined( $selector ) ) {
113 $$fieldmap{$fm}{selector} = $selector;
120 # Load the standard 3 virtual fields ------------------------
122 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
123 $$fieldmap{$fm}{fields}{ $vfield } =
124 { position => $array_position,
132 my $link_list = shift;
135 for my $link ( $link_list->childNodes() ) { # For each <link>
136 if( $link->nodeName eq 'link' ) {
137 my $attribute_list = $link->attributes();
139 my $field = get_attribute( $attribute_list, 'field' );
140 my $reltype = get_attribute( $attribute_list, 'reltype' );
141 my $key = get_attribute( $attribute_list, 'key' );
142 my $class = get_attribute( $attribute_list, 'class' );
143 my $map = get_attribute( $attribute_list, 'map' );
145 $$fieldmap{$fm}{links}{ $field } =
156 my $class_node = shift;
158 # Get attributes ---------------------------------------------
160 my $attribute_list = $class_node->attributes();
162 my $fm = get_attribute( $attribute_list, 'oils_obj:fieldmapper' );
163 $fm = 'Fieldmapper::' . $fm;
164 my $id = get_attribute( $attribute_list, 'id' );
165 my $controller = get_attribute( $attribute_list, 'controller' );
166 my $virtual = get_attribute( $attribute_list, 'virtual' );
167 if( ! defined( $virtual ) ) {
170 my $tablename = get_attribute( $attribute_list, 'oils_persist:tablename' );
171 if( ! defined( $tablename ) ) {
174 my $restrict_primary = get_attribute( $attribute_list, 'oils_persist:restrict_primary' );
175 my $field_safe = get_attribute( $attribute_list, 'oils_persist:field_safe' );
177 # Load the attributes into the Fieldmapper --------------------
179 $log->debug("Building Fieldmapper class for [$fm] from IDL");
181 $$fieldmap{$fm}{ hint } = $id;
182 $$fieldmap{$fm}{ virtual } = ( $virtual eq 'true' ) ? 1 : 0;
183 $$fieldmap{$fm}{ table } = $tablename;
184 $$fieldmap{$fm}{ controller } = [ split ' ', $controller ];
185 $$fieldmap{$fm}{ restrict_primary } = $restrict_primary;
186 $$fieldmap{$fm}{ field_safe } = $field_safe;
188 # Load fields and links
190 for my $child ( $class_node->childNodes() ) {
191 my $nodeName = $child->nodeName;
192 if( $nodeName eq 'fields' ) {
193 load_fields( $child, $fm );
194 } elsif( $nodeName eq 'links' ) {
195 load_links( $child, $fm );
205 return if (keys %$fieldmap);
206 return if (!OpenSRF::System->connected && !$args{IDL});
209 my $parser = XML::LibXML->new();
210 my $file = $args{IDL} || OpenSRF::Utils::SettingsClient->new->config_value( 'IDL' );
211 my $fmdoc = $parser->parse_file( $file );
212 my $rootnode = $fmdoc->documentElement();
214 for my $child ( $rootnode->childNodes() ) { # For each <class>
215 my $nodeName = $child->nodeName;
216 if( $nodeName eq 'class' ) {
217 load_class( $child );
221 #-------------------------------------------------------------------------------
222 # Now comes the evil! Generate classes
224 for my $pkg ( __PACKAGE__->classes ) {
225 (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
229 use base 'Fieldmapper';
232 if (exists $$fieldmap{$pkg}{proto_fields}) {
233 for my $pfield ( sort keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
234 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
239 OpenSRF::Utils::JSON->register_class_hint(
240 hint => $pkg->json_hint,
251 $value = [] unless (defined $value);
252 return bless $value => $self->class_name;
265 (my $field = $AUTOLOAD) =~ s/^.*://o;
266 my $class_name = $obj->class_name;
269 $fpos =~ s/^clear_//og ;
271 my $pos = $$fieldmap{$class_name}{fields}{$fpos}{position};
273 if ($field =~ /^clear_/o) {
275 *{$obj->class_name."::$field"} = sub {
277 $self->[$pos] = undef;
281 return $obj->$field();
284 die "No field by the name $field in $class_name!"
285 unless (exists $$fieldmap{$class_name}{fields}{$field} && defined($pos));
289 *{$obj->class_name."::$field"} = sub {
292 $self->[$pos] = $new_val if (defined $new_val);
293 return $self->[$pos];
296 return $obj->$field($value);
301 return $$fieldmap{$self->class_name}{selector};
306 return $$fieldmap{$self->class_name}{identity};
309 sub RestrictPrimary {
311 return $$fieldmap{$self->class_name}{restrict_primary};
316 return $$fieldmap{$self->class_name}{sequence};
321 return $$fieldmap{$self->class_name}{table};
326 return $$fieldmap{$self->class_name}{controller};
332 return undef unless ($f);
333 return $$fieldmap{$self->class_name}{fields}{$f}{required};
338 return undef unless (ref $self);
340 my $opts = shift || {};
341 my $no_virt = $$opts{no_virt}; # skip virtual fields
342 my $skip_fields = $$opts{skip_fields} || {}; # eg. {au => ['passwd']}
343 my @to_skip = @{$$skip_fields{$self->json_hint}}
344 if $$skip_fields{$self->json_hint};
346 my $dom = XML::LibXML::Document->new;
347 my $root = $dom->createElement( $self->json_hint );
348 $dom->setDocumentElement( $root );
350 my @field_names = $no_virt ? $self->real_fields : $self->properties;
352 for my $f (@field_names) {
353 next if ($f eq 'isnew');
354 next if ($f eq 'ischanged');
355 next if ($f eq 'isdeleted');
356 next if (grep {$_ eq $f} @to_skip);
358 my $value = $self->$f();
359 my $element = $dom->createElement( $f );
361 $value = [$value] if (blessed($value)); # fm object
363 if (ref($value)) { # array
364 for my $k (@$value) {
366 my $subdoc = $k->toXML($opts);
368 my $subnode = $subdoc->documentElement;
369 $dom->adoptNode($subnode);
370 $element->appendChild($subnode);
371 } elsif (ref $k) { # not sure what to do here
372 $element->appendText($k);
373 } else { # meh .. just append, I guess
374 $element->appendText($k);
378 $element->appendText($value);
381 $root->appendChild($element);
390 return undef unless ($f);
391 return 1 if (!exists($$fieldmap{$self->class_name}{fields}{$f}{validate}));
392 return $self->$f =~ $$fieldmap{$self->class_name}{fields}{$f}{validate};
396 my $class_name = shift;
397 return ref($class_name) || $class_name;
402 my $class_name = $self->class_name;
403 my $fields = $$fieldmap{$class_name}{fields};
406 !$$fields{$_}{virtual}
407 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
415 my $class_name = $self->class_name;
416 return 1 if grep { $_ eq $field } keys %{$$fieldmap{$class_name}{fields}};
422 my $class_name = $self->class_name;
423 return keys %{$$fieldmap{$class_name}{fields}};
430 for my $f ($self->properties) {
440 return $self->new( [@$self] );
445 return $fieldmap->{$self->class_name}->{api_level};
450 return $fieldmap->{$self->class_name}->{cdbi};
456 return $fieldmap->{$self->class_name}->{proto_fields}->{$field} if ($field);
457 return $fieldmap->{$self->class_name}->{virtual};
463 return $fieldmap->{$self->class_name}->{readonly};
468 return $fieldmap->{$self->class_name}->{hint};