2 use OpenSRF::Utils::JSON;
4 use base 'OpenSRF::Application';
5 use OpenSRF::Utils::Logger;
6 use OpenSRF::Utils::SettingsClient;
10 my $log = 'OpenSRF::Utils::Logger';
12 use vars qw/$fieldmap $VERSION/;
14 sub publish_fieldmapper {
15 my ($self,$client,$class) = @_;
17 return $fieldmap unless (defined $class);
18 return undef unless (exists($$fieldmap{$class}));
19 return {$class => $$fieldmap{$class}};
21 __PACKAGE__->register_method(
22 api_name => 'opensrf.open-ils.system.fieldmapper',
24 method => 'publish_fieldmapper',
28 # To dump the Javascript version of the fieldmapper struct use the command:
30 # PERL5LIB=:~/vcs/ILS/Open-ILS/src/perlmods/lib/ GEN_JS=1 perl -MOpenILS::Utils::Fieldmapper -e 'print "\n";'
32 # ... adjusted for your VCS sandbox of choice, of course.
36 return () unless (defined $fieldmap);
37 return keys %$fieldmap;
41 my $attr_list = shift;
42 my $attr_name = shift;
44 my $attr = $attr_list->getNamedItem( $attr_name );
45 if( defined( $attr ) ) {
46 return $attr->getValue();
52 my $field_list = shift;
55 # Get attributes of the field list. Since there is only one
56 # <field> per class, these attributes logically belong to the
57 # enclosing class, and that's where we load them.
59 my $field_attr_list = $field_list->attributes();
61 my $sequence = get_attribute( $field_attr_list, 'oils_persist:sequence' );
62 if( ! defined( $sequence ) ) {
65 my $primary = get_attribute( $field_attr_list, 'oils_persist:primary' );
67 # Load attributes into the Fieldmapper ----------------------
69 $$fieldmap{$fm}{ sequence } = $sequence;
70 $$fieldmap{$fm}{ identity } = $primary;
72 # Load each field -------------------------------------------
74 my $array_position = 0;
75 for my $field ( $field_list->childNodes() ) { # For each <field>
76 if( $field->nodeName eq 'field' ) {
78 my $attribute_list = $field->attributes();
80 my $name = get_attribute( $attribute_list, 'name' );
81 next if( $name eq 'isnew' || $name eq 'ischanged' || $name eq 'isdeleted' );
82 my $required = get_attribute( $attribute_list, 'oils_obj:required' );
83 my $validate = get_attribute( $attribute_list, 'oils_obj:validate' );
84 my $virtual = get_attribute( $attribute_list, 'oils_persist:virtual' );
85 if( ! defined( $virtual ) ) {
88 my $selector = get_attribute( $attribute_list, 'reporter:selector' );
90 $$fieldmap{$fm}{fields}{ $name } =
91 { virtual => ( $virtual eq 'true' ) ? 1 : 0,
92 required => ( $required eq 'true' ) ? 1 : 0,
93 position => $array_position,
96 $$fieldmap{$fm}{fields}{ $name }{validate} = qr/$validate/ if (defined($validate));
98 # The selector attribute, if present at all, attaches to only one
99 # of the fields in a given class. So if we see it, we store it at
100 # the level of the enclosing class.
102 if( defined( $selector ) ) {
103 $$fieldmap{$fm}{selector} = $selector;
110 # Load the standard 3 virtual fields ------------------------
112 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
113 $$fieldmap{$fm}{fields}{ $vfield } =
114 { position => $array_position,
122 my $link_list = shift;
125 for my $link ( $link_list->childNodes() ) { # For each <link>
126 if( $link->nodeName eq 'link' ) {
127 my $attribute_list = $link->attributes();
129 my $field = get_attribute( $attribute_list, 'field' );
130 my $reltype = get_attribute( $attribute_list, 'reltype' );
131 my $key = get_attribute( $attribute_list, 'key' );
132 my $class = get_attribute( $attribute_list, 'class' );
134 $$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};
327 return undef unless ($f);
328 return 1 if (!exists($$fieldmap{$self->class_name}{fields}{$f}{validate}));
329 return $self->$f =~ $$fieldmap{$self->class_name}{fields}{$f}{validate};
333 my $class_name = shift;
334 return ref($class_name) || $class_name;
339 my $class_name = $self->class_name;
340 my $fields = $$fieldmap{$class_name}{fields};
343 !$$fields{$_}{virtual}
344 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
352 my $class_name = $self->class_name;
353 return 1 if grep { $_ eq $field } keys %{$$fieldmap{$class_name}{fields}};
359 my $class_name = $self->class_name;
360 return keys %{$$fieldmap{$class_name}{fields}};
367 for my $f ($self->properties) {
377 return $self->new( [@$self] );
382 return $fieldmap->{$self->class_name}->{api_level};
387 return $fieldmap->{$self->class_name}->{cdbi};
393 return $fieldmap->{$self->class_name}->{proto_fields}->{$field} if ($field);
394 return $fieldmap->{$self->class_name}->{virtual};
400 return $fieldmap->{$self->class_name}->{readonly};
405 return $fieldmap->{$self->class_name}->{hint};