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

   1 package Fieldmapper;
   2 use JSON;
   3 use Data::Dumper;
   4 use base 'OpenSRF::Application';
   5 use OpenSRF::Utils::Logger;
   6 use OpenSRF::Utils::SettingsClient;
   7 use OpenSRF::System;
   8 use XML::Simple;
   9
  10 my $log = 'OpenSRF::Utils::Logger';
  11
  12 use vars qw/$fieldmap $VERSION/;
  13
  14 sub publish_fieldmapper {
  15         my ($self,$client,$class) = @_;
  16
  17         return $fieldmap unless (defined $class);
  18         return undef unless (exists($$fieldmap{$class}));
  19         return {$class => $$fieldmap{$class}};
  20 }
  21 __PACKAGE__->register_method(
  22         api_name        => 'opensrf.open-ils.system.fieldmapper',
  23         api_level       => 1,
  24         method          => 'publish_fieldmapper',
  25 );
  26
  27 #
  28 # To dump the Javascript version of the fieldmapper struct use the command:
  29 #
  30 #       PERL5LIB=~/cvs/ILS/OpenSRF/src/perlmods/:~/cvs/ILS/Open-ILS/src/perlmods/ GEN_JS=1 perl -MOpenILS::Utils::Fieldmapper -e 'print "\n";'
  31 #
  32 # ... adjusted for your CVS sandbox, of course.
  33 #
  34
  35 sub classes {
  36         return () unless (defined $fieldmap);
  37         return keys %$fieldmap;
  38 }
  39
  40 import();
  41 sub import {
  42         my $class = shift;
  43         my %args = @_;
  44
  45         return if (keys %$fieldmap);
  46         return if (!OpenSRF::System->connected && !$args{IDL});
  47
  48         # parse the IDL ...
  49         my $file = $args{IDL} || OpenSRF::Utils::SettingsClient->new->config_value( 'IDL' );
  50         my $idl = XMLin( $file, ForceArray => 0, KeyAttr => ['name', 'key', 'id'] )->{class};
  51         for my $c ( keys %$idl ) {
  52                 next unless ($idl->{$c}{'oils_obj:fieldmapper'});
  53                 my $n = 'Fieldmapper::'.$idl->{$c}{'oils_obj:fieldmapper'};
  54
  55                 $log->debug("Building Fieldmapper clas for [$n] from IDL");
  56
  57                 $$fieldmap{$n}{hint} = $c;
  58                 $$fieldmap{$n}{virtual} = ($idl->{$c}{'oils_persist:virtual'} eq 'true') ? 1 : 0;
  59                 $$fieldmap{$n}{table} = $idl->{$c}{'oils_persist:tablename'};
  60                 $$fieldmap{$n}{sequence} = $idl->{$c}{fields}{'oils_persist:sequence'};
  61                 $$fieldmap{$n}{identity} = $idl->{$c}{fields}{'oils_persist:primary'};
  62
  63                 for my $f ( keys %{ $idl->{$c}{fields}{field} } ) {
  64                         $$fieldmap{$n}{fields}{$f} =
  65                                 { virtual => ($idl->{$c}{fields}{field}{$f}{'oils_persist:virtual'} eq 'true') ? 1 : 0,
  66                                   position => $idl->{$c}{fields}{field}{$f}{'oils_obj:array_position'},
  67                                 };
  68                 }
  69         }
  70
  71
  72         #-------------------------------------------------------------------------------
  73         # Now comes the evil!  Generate classes
  74
  75         for my $pkg ( __PACKAGE__->classes ) {
  76                 (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
  77
  78                 eval <<"                PERL";
  79                         package $pkg;
  80                         use base 'Fieldmapper';
  81                 PERL
  82
  83                 my $pos = 0;
  84                 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
  85                         $$fieldmap{$pkg}{fields}{$vfield} = { position => $pos, virtual => 1 };
  86                         $pos++;
  87                 }
  88
  89                 if (exists $$fieldmap{$pkg}{proto_fields}) {
  90                         for my $pfield ( sort keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
  91                                 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
  92                                 $pos++;
  93                         }
  94                 }
  95
  96                 JSON->register_class_hint(
  97                         hint => $pkg->json_hint,
  98                         name => $pkg,
  99                         type => 'array',
 100                 );
 101
 102         }
 103 }
 104
 105 sub new {
 106         my $self = shift;
 107         my $value = shift;
 108         $value = [] unless (defined $value);
 109         return bless $value => $self->class_name;
 110 }
 111
 112 sub decast {
 113         my $self = shift;
 114         return [ @$self ];
 115 }
 116
 117 sub DESTROY {}
 118
 119 sub AUTOLOAD {
 120         my $obj = shift;
 121         my $value = shift;
 122         (my $field = $AUTOLOAD) =~ s/^.*://o;
 123         my $class_name = $obj->class_name;
 124
 125         my $fpos = $field;
 126         $fpos  =~ s/^clear_//og ;
 127
 128         my $pos = $$fieldmap{$class_name}{fields}{$fpos}{position};
 129
 130         if ($field =~ /^clear_/o) {
 131                 {       no strict 'subs';
 132                         *{$obj->class_name."::$field"} = sub {
 133                                 my $self = shift;
 134                                 $self->[$pos] = undef;
 135                                 return 1;
 136                         };
 137                 }
 138                 return $obj->$field();
 139         }
 140
 141         die "No field by the name $field in $class_name!"
 142                 unless (exists $$fieldmap{$class_name}{fields}{$field} && defined($pos));
 143
 144
 145         {       no strict 'subs';
 146                 *{$obj->class_name."::$field"} = sub {
 147                         my $self = shift;
 148                         my $new_val = shift;
 149                         $self->[$pos] = $new_val if (defined $new_val);
 150                         return $self->[$pos];
 151                 };
 152         }
 153         return $obj->$field($value);
 154 }
 155
 156 sub Identity {
 157         my $class_name = shift;
 158         return $$fieldmap{$class_name}{identity};
 159 }
 160
 161 sub Sequence {
 162         my $class_name = shift;
 163         return $$fieldmap{$class_name}{sequence};
 164 }
 165
 166 sub Table {
 167         my $class_name = shift;
 168         return $$fieldmap{$class_name}{table};
 169 }
 170
 171 sub class_name {
 172         my $class_name = shift;
 173         return ref($class_name) || $class_name;
 174 }
 175
 176 sub real_fields {
 177         my $self = shift;
 178         my $class_name = $self->class_name;
 179         my $fields = $$fieldmap{$class_name}{fields};
 180
 181         my @f = grep {
 182                         !$$fields{$_}{virtual}
 183                 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
 184
 185         return @f;
 186 }
 187
 188 sub has_field {
 189         my $self = shift;
 190         my $field = shift;
 191         my $class_name = $self->class_name;
 192         return 1 if grep { $_ eq $field } keys %{$$fieldmap{$class_name}{fields}};
 193         return 0;
 194 }
 195
 196 sub properties {
 197         my $self = shift;
 198         my $class_name = $self->class_name;
 199         return keys %{$$fieldmap{$class_name}{fields}};
 200 }
 201
 202 sub to_bare_hash {
 203         my $self = shift;
 204
 205         my %hash = ();
 206         for my $f ($self->properties) {
 207                 my $val = $self->$f;
 208                 $hash{$f} = $val;
 209         }
 210
 211         return \%hash;
 212 }
 213
 214 sub clone {
 215         my $self = shift;
 216         return $self->new( [@$self] );
 217 }
 218
 219 sub api_level {
 220         my $self = shift;
 221         return $fieldmap->{$self->class_name}->{api_level};
 222 }
 223
 224 sub cdbi {
 225         my $self = shift;
 226         return $fieldmap->{$self->class_name}->{cdbi};
 227 }
 228
 229 sub is_virtual {
 230         my $self = shift;
 231         my $field = shift;
 232         return $fieldmap->{$self->class_name}->{proto_fields}->{$field} if ($field);
 233         return $fieldmap->{$self->class_name}->{virtual};
 234 }
 235
 236 sub is_readonly {
 237         my $self = shift;
 238         my $field = shift;
 239         return $fieldmap->{$self->class_name}->{readonly};
 240 }
 241
 242 sub json_hint {
 243         my $self = shift;
 244         return $fieldmap->{$self->class_name}->{hint};
 245 }
 246
 247
 248 1;