Open-ILS/src/perlmods/lib/OpenILS/Utils/Fieldmapper.pm

   1 package Fieldmapper;
   2 use OpenSRF::Utils::JSON;
   3 use Data::Dumper;
   4 use OpenSRF::Utils::Logger;
   5 use OpenSRF::Utils::SettingsClient;
   6 use OpenSRF::System;
   7 use XML::LibXML;
   8 use Scalar::Util 'blessed';
   9
  10 my $log = 'OpenSRF::Utils::Logger';
  11
  12 use vars qw/$fieldmap $VERSION/;
  13
  14 #
  15 # To dump the Javascript version of the fieldmapper struct use the command:
  16 #
  17 #   PERL5LIB=:~/vcs/ILS/Open-ILS/src/perlmods/lib/ GEN_JS=1 perl -MOpenILS::Utils::Fieldmapper -e 'print "\n";'
  18 #
  19 # ... adjusted for your VCS sandbox of choice, of course.
  20 #
  21
  22 sub classes {
  23     return () unless (defined $fieldmap);
  24     return keys %$fieldmap;
  25 }
  26
  27 # Find a Fieldmapper class given the json hint.
  28 sub class_for_hint {
  29     my $hint = shift;
  30     foreach (keys %$fieldmap) {
  31         return $_ if ($fieldmap->{$_}->{hint} eq $hint);
  32     }
  33     return undef;
  34 }
  35
  36 sub get_attribute {
  37     my $attr_list = shift;
  38     my $attr_name = shift;
  39
  40     my $attr = $attr_list->getNamedItem( $attr_name );
  41     if( defined( $attr ) ) {
  42         return $attr->getValue();
  43     }
  44     return undef;
  45 }
  46
  47 sub load_fields {
  48     my $field_list = shift;
  49     my $fm = shift;
  50
  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.
  54
  55     my $field_attr_list = $field_list->attributes();
  56
  57     my $sequence  = get_attribute( $field_attr_list, 'oils_persist:sequence' );
  58     if( ! defined( $sequence ) ) {
  59         $sequence = '';
  60     }
  61     my $primary   = get_attribute( $field_attr_list, 'oils_persist:primary' );
  62
  63     # Load attributes into the Fieldmapper ----------------------
  64
  65     $$fieldmap{$fm}{ sequence } = $sequence;
  66     $$fieldmap{$fm}{ identity } = $primary;
  67
  68     # Load each field -------------------------------------------
  69
  70     my $array_position = 0;
  71     for my $field ( $field_list->childNodes() ) {    # For each <field>
  72         if( $field->nodeName eq 'field' ) {
  73
  74             my $attribute_list = $field->attributes();
  75
  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 ) ) {
  82                 $virtual = "false";
  83             }
  84             my $selector = get_attribute( $attribute_list, 'reporter:selector' );
  85
  86             $$fieldmap{$fm}{fields}{ $name } =
  87                 { virtual => ( $virtual eq 'true' ) ? 1 : 0,
  88                   required => ( $required eq 'true' ) ? 1 : 0,
  89                   position => $array_position,
  90                 };
  91
  92             $$fieldmap{$fm}{fields}{ $name }{validate} = qr/$validate/ if (defined($validate));
  93
  94             # The selector attribute, if present at all, attaches to only one
  95             # of the fields in a given class.  So if we see it, we store it at
  96             # the level of the enclosing class.
  97
  98             if( defined( $selector ) ) {
  99                 $$fieldmap{$fm}{selector} = $selector;
 100             }
 101
 102             ++$array_position;
 103         }
 104     }
 105
 106     # Load the standard 3 virtual fields ------------------------
 107
 108     for my $vfield ( qw/isnew ischanged isdeleted/ ) {
 109         $$fieldmap{$fm}{fields}{ $vfield } =
 110             { position => $array_position,
 111               virtual => 1
 112             };
 113         ++$array_position;
 114     }
 115 }
 116
 117 sub load_links {
 118     my $link_list = shift;
 119     my $fm = shift;
 120
 121     for my $link ( $link_list->childNodes() ) {    # For each <link>
 122         if( $link->nodeName eq 'link' ) {
 123             my $attribute_list = $link->attributes();
 124
 125             my $field   = get_attribute( $attribute_list, 'field' );
 126             my $reltype = get_attribute( $attribute_list, 'reltype' );
 127             my $key     = get_attribute( $attribute_list, 'key' );
 128             my $class   = get_attribute( $attribute_list, 'class' );
 129             my $map     = get_attribute( $attribute_list, 'map' );
 130
 131             $$fieldmap{$fm}{links}{ $field } =
 132                 { class   => $class,
 133                   reltype => $reltype,
 134                   key     => $key,
 135                   map     => $map
 136                 };
 137         }
 138     }
 139 }
 140
 141 sub load_class {
 142     my $class_node = shift;
 143
 144     # Get attributes ---------------------------------------------
 145
 146     my $attribute_list = $class_node->attributes();
 147
 148     my $fm               = get_attribute( $attribute_list, 'oils_obj:fieldmapper' );
 149     $fm                  = 'Fieldmapper::' . $fm;
 150     my $id               = get_attribute( $attribute_list, 'id' );
 151     my $controller       = get_attribute( $attribute_list, 'controller' );
 152     my $virtual          = get_attribute( $attribute_list, 'virtual' );
 153     if( ! defined( $virtual ) ) {
 154         $virtual = 'false';
 155     }
 156     my $tablename        = get_attribute( $attribute_list, 'oils_persist:tablename' );
 157     if( ! defined( $tablename ) ) {
 158         $tablename = '';
 159     }
 160     my $restrict_primary = get_attribute( $attribute_list, 'oils_persist:restrict_primary' );
 161     my $field_safe = get_attribute( $attribute_list, 'oils_persist:field_safe' );
 162
 163     # Load the attributes into the Fieldmapper --------------------
 164
 165     $log->debug("Building Fieldmapper class for [$fm] from IDL");
 166
 167     $$fieldmap{$fm}{ hint }             = $id;
 168     $$fieldmap{$fm}{ virtual }          = ( $virtual eq 'true' ) ? 1 : 0;
 169     $$fieldmap{$fm}{ table }            = $tablename;
 170     $$fieldmap{$fm}{ controller }       = [ split ' ', $controller ];
 171     $$fieldmap{$fm}{ restrict_primary } = $restrict_primary;
 172     $$fieldmap{$fm}{ field_safe }       = $field_safe;
 173
 174     # Load fields and links
 175
 176     for my $child ( $class_node->childNodes() ) {
 177         my $nodeName = $child->nodeName;
 178         if( $nodeName eq 'fields' ) {
 179             load_fields( $child, $fm );
 180         } elsif( $nodeName eq 'links' ) {
 181             load_links( $child, $fm );
 182         }
 183     }
 184 }
 185
 186 import();
 187 sub import {
 188     my $class = shift;
 189     my %args = @_;
 190
 191     return if (keys %$fieldmap);
 192     return if (!OpenSRF::System->connected && !$args{IDL});
 193
 194     # parse the IDL ...
 195     my $parser = XML::LibXML->new();
 196     my $file = $args{IDL} || OpenSRF::Utils::SettingsClient->new->config_value( 'IDL' );
 197     my $fmdoc = $parser->parse_file( $file );
 198     my $rootnode = $fmdoc->documentElement();
 199
 200     for my $child ( $rootnode->childNodes() ) {    # For each <class>
 201         my $nodeName = $child->nodeName;
 202         if( $nodeName eq 'class' ) {
 203             load_class( $child );
 204         }
 205     }
 206
 207     #-------------------------------------------------------------------------------
 208     # Now comes the evil!  Generate classes
 209
 210     for my $pkg ( __PACKAGE__->classes ) {
 211         (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
 212
 213         eval <<"        PERL";
 214             package $pkg;
 215             use base 'Fieldmapper';
 216         PERL
 217
 218         if (exists $$fieldmap{$pkg}{proto_fields}) {
 219             for my $pfield ( sort keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
 220                 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
 221                 $pos++;
 222             }
 223         }
 224
 225         OpenSRF::Utils::JSON->register_class_hint(
 226             hint => $pkg->json_hint,
 227             name => $pkg,
 228             type => 'array',
 229         );
 230
 231     }
 232 }
 233
 234 sub new {
 235     my $self = shift;
 236     my $value = shift;
 237     $value = [] unless (defined $value);
 238     return bless $value => $self->class_name;
 239 }
 240
 241 sub decast {
 242     my $self = shift;
 243     return [ @$self ];
 244 }
 245
 246 sub DESTROY {}
 247
 248 sub AUTOLOAD {
 249     my $obj = shift;
 250     my $value = shift;
 251     (my $field = $AUTOLOAD) =~ s/^.*://o;
 252     my $class_name = $obj->class_name;
 253
 254     my $fpos = $field;
 255     $fpos  =~ s/^clear_//og ;
 256
 257     my $pos = $$fieldmap{$class_name}{fields}{$fpos}{position};
 258
 259     if ($field =~ /^clear_/o) {
 260         {   no strict 'subs';
 261             *{$obj->class_name."::$field"} = sub {
 262                 my $self = shift;
 263                 $self->[$pos] = undef;
 264                 return 1;
 265             };
 266         }
 267         return $obj->$field();
 268     }
 269
 270     die "No field by the name $field in $class_name!"
 271         unless (exists $$fieldmap{$class_name}{fields}{$field} && defined($pos));
 272
 273
 274     {   no strict 'subs';
 275         *{$obj->class_name."::$field"} = sub {
 276             my $self = shift;
 277             my $new_val = shift;
 278             $self->[$pos] = $new_val if (defined $new_val);
 279             return $self->[$pos];
 280         };
 281     }
 282     return $obj->$field($value);
 283 }
 284
 285 sub Selector {
 286     my $self = shift;
 287     return $$fieldmap{$self->class_name}{selector};
 288 }
 289
 290 sub Identity {
 291     my $self = shift;
 292     return $$fieldmap{$self->class_name}{identity};
 293 }
 294
 295 sub RestrictPrimary {
 296     my $self = shift;
 297     return $$fieldmap{$self->class_name}{restrict_primary};
 298 }
 299
 300 sub Sequence {
 301     my $self = shift;
 302     return $$fieldmap{$self->class_name}{sequence};
 303 }
 304
 305 sub Table {
 306     my $self = shift;
 307     return $$fieldmap{$self->class_name}{table};
 308 }
 309
 310 sub Controller {
 311     my $self = shift;
 312     return $$fieldmap{$self->class_name}{controller};
 313 }
 314
 315 sub RequiredField {
 316     my $self = shift;
 317     my $f = shift;
 318     return undef unless ($f);
 319     return $$fieldmap{$self->class_name}{fields}{$f}{required};
 320 }
 321
 322 sub toXML {
 323     my $self = shift;
 324     return undef unless (ref $self);
 325
 326     my $opts = shift || {};
 327     my $no_virt = $$opts{no_virt}; # skip virtual fields
 328     my $skip_fields = $$opts{skip_fields} || {}; # eg. {au => ['passwd']}
 329     my @to_skip = @{$$skip_fields{$self->json_hint}}
 330         if $$skip_fields{$self->json_hint};
 331
 332     my $dom = XML::LibXML::Document->new;
 333     my $root = $dom->createElement( $self->json_hint );
 334     $dom->setDocumentElement( $root );
 335
 336     my @field_names = $no_virt ? $self->real_fields : $self->properties;
 337
 338     for my $f (@field_names) {
 339         next if ($f eq 'isnew');
 340         next if ($f eq 'ischanged');
 341         next if ($f eq 'isdeleted');
 342         next if (grep {$_ eq $f} @to_skip);
 343
 344         my $value = $self->$f();
 345         my $element = $dom->createElement( $f );
 346
 347         $value = [$value] if (blessed($value)); # fm object
 348
 349         if (ref($value)) { # array
 350             for my $k (@$value) {
 351                 if (blessed($k)) {
 352                     my $subdoc = $k->toXML($opts);
 353                     next unless $subdoc;
 354                     my $subnode = $subdoc->documentElement;
 355                     $dom->adoptNode($subnode);
 356                     $element->appendChild($subnode);
 357                 } elsif (ref $k) { # not sure what to do here
 358                     $element->appendText($k);
 359                 } else { # meh .. just append, I guess
 360                     $element->appendText($k);
 361                 }
 362             }
 363         } else {
 364             $element->appendText($value);
 365         }
 366
 367         $root->appendChild($element);
 368     }
 369
 370     return $dom;
 371 }
 372
 373 sub ValidateField {
 374     my $self = shift;
 375     my $f = shift;
 376     return undef unless ($f);
 377     return 1 if (!exists($$fieldmap{$self->class_name}{fields}{$f}{validate}));
 378     return $self->$f =~ $$fieldmap{$self->class_name}{fields}{$f}{validate};
 379 }
 380
 381 sub class_name {
 382     my $class_name = shift;
 383     return ref($class_name) || $class_name;
 384 }
 385
 386 sub real_fields {
 387     my $self = shift;
 388     my $class_name = $self->class_name;
 389     my $fields = $$fieldmap{$class_name}{fields};
 390
 391     my @f = grep {
 392             !$$fields{$_}{virtual}
 393         } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
 394
 395     return @f;
 396 }
 397
 398 sub has_field {
 399     my $self = shift;
 400     my $field = shift;
 401     my $class_name = $self->class_name;
 402     return 1 if grep { $_ eq $field } keys %{$$fieldmap{$class_name}{fields}};
 403     return 0;
 404 }
 405
 406 sub properties {
 407     my $self = shift;
 408     my $class_name = $self->class_name;
 409     return keys %{$$fieldmap{$class_name}{fields}};
 410 }
 411
 412 sub to_bare_hash {
 413     my $self = shift;
 414
 415     my %hash = ();
 416     for my $f ($self->properties) {
 417         my $val = $self->$f;
 418         $hash{$f} = $val;
 419     }
 420
 421     return \%hash;
 422 }
 423
 424 sub clone {
 425     my $self = shift;
 426     return $self->new( [@$self] );
 427 }
 428
 429 sub api_level {
 430     my $self = shift;
 431     return $fieldmap->{$self->class_name}->{api_level};
 432 }
 433
 434 sub cdbi {
 435     my $self = shift;
 436     return $fieldmap->{$self->class_name}->{cdbi};
 437 }
 438
 439 sub is_virtual {
 440     my $self = shift;
 441     my $field = shift;
 442     return $fieldmap->{$self->class_name}->{proto_fields}->{$field} if ($field);
 443     return $fieldmap->{$self->class_name}->{virtual};
 444 }
 445
 446 sub is_readonly {
 447     my $self = shift;
 448     my $field = shift;
 449     return $fieldmap->{$self->class_name}->{readonly};
 450 }
 451
 452 sub json_hint {
 453     my $self = shift;
 454     return $fieldmap->{$self->class_name}->{hint};
 455 }
 456
 457
 458 1;