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

   1 package Fieldmapper;
   2 use JSON;
   3 use Data::Dumper;
   4 use base 'OpenSRF::Application';
   5
   6 use OpenSRF::Utils::Logger;
   7 my $log = 'OpenSRF::Utils::Logger';
   8
   9 use OpenILS::Application::Storage::CDBI;
  10 use OpenILS::Application::Storage::CDBI::actor;
  11 use OpenILS::Application::Storage::CDBI::biblio;
  12 use OpenILS::Application::Storage::CDBI::config;
  13 use OpenILS::Application::Storage::CDBI::metabib;
  14
  15 use vars qw/$fieldmap $VERSION/;
  16
  17 _init();
  18
  19 sub publish_fieldmapper {
  20         my ($self,$client,$class) = @_;
  21
  22         return $fieldmap unless (defined $class);
  23         return undef unless (exists($$fieldmap{$class}));
  24         return {$class => $$fieldmap{$class}};
  25 }
  26 __PACKAGE__->register_method(
  27         api_name        => 'opensrf.open-ils.system.fieldmapper',
  28         api_level       => 1,
  29         method          => 'publish_fieldmapper',
  30 );
  31
  32 #
  33 # To dump the Javascript version of the fieldmapper struct use the command:
  34 #
  35 #       PERL5LIB=~/cvs/ILS/OpenSRF/src/perlmods/:~/cvs/ILS/Open-ILS/src/perlmods/ GEN_JS=1 perl -MOpenILS::Utils::Fieldmapper -e 'print "\n";'
  36 #
  37 # ... adjusted for your CVS sandbox, of course.
  38 #
  39
  40 sub classes {
  41         return () unless (defined $fieldmap);
  42         return keys %$fieldmap;
  43 }
  44
  45 sub _init {
  46         return if (defined $fieldmap);
  47
  48         $fieldmap =
  49         {
  50                 'Fieldmapper::actor::user'                      => { hint => 'au'   },
  51                 'Fieldmapper::actor::org_unit'                  => { hint               => 'aou',
  52                                                                      proto_fields       => { children => 1 } },
  53                 'Fieldmapper::actor::org_unit_type'             => { hint               => 'aout',
  54                                                                      proto_fields       => { children => 1 } },
  55
  56                 'Fieldmapper::biblio::record_node'              => { hint               => 'brn',
  57                                                                      proto_fields       => { children => 1 } },
  58                 'Fieldmapper::biblio::record_entry'             => { hint => 'bre'  },
  59                 'Fieldmapper::biblio::record_mods'              => { hint => 'brm'  },
  60                 'Fieldmapper::biblio::record_marc'              => { hint => 'brx'  },
  61
  62                 'Fieldmapper::config::bib_source'               => { hint => 'cbs'  },
  63                 'Fieldmapper::config::metabib_field'            => { hint => 'cmf'  },
  64
  65                 'Fieldmapper::metabib::metarecord'              => { hint => 'mmr'  },
  66                 'Fieldmapper::metabib::title_field_entry'       => { hint => 'mtfe' },
  67                 'Fieldmapper::metabib::author_field_entry'      => { hint => 'mafe' },
  68                 'Fieldmapper::metabib::subject_field_entry'     => { hint => 'msfe' },
  69                 'Fieldmapper::metabib::keyword_field_entry'     => { hint => 'mkfe' },
  70                 'Fieldmapper::metabib::full_rec'                => { hint => 'mfr'  },
  71
  72                 'Fieldmapper::asset::copy'                      => { hint => 'acp'  },
  73                 'Fieldmapper::asset::copy_note'                 => { hint => 'acpn' },
  74                 'Fieldmapper::asset::call_number'               => { hint => 'acn'  },
  75                 'Fieldmapper::asset::call_number_note'          => { hint => 'acnn' },
  76         };
  77
  78         #-------------------------------------------------------------------------------
  79         # Now comes the evil!  Generate classes
  80
  81         for my $pkg ( keys %$fieldmap ) {
  82                 (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
  83
  84                 eval <<"                PERL";
  85                         package $pkg;
  86                         use base 'Fieldmapper';
  87                 PERL
  88
  89                 $$fieldmap{$pkg}{cdbi} = $cdbi;
  90
  91                 my $pos = 0;
  92                 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
  93                         $$fieldmap{$pkg}{fields}{$vfield} = { position => $pos, virtual => 1 };
  94                         $pos++;
  95                 }
  96
  97                 if (exists $$fieldmap{$pkg}{proto_fields}) {
  98                         for my $pfield ( keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
  99                                 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
 100                                 $pos++;
 101                         }
 102                 }
 103
 104                 for my $col ( $cdbi->columns('All') ) {
 105                         $$fieldmap{$pkg}{fields}{$col} = { position => $pos, virtual => 0 };
 106                         $pos++;
 107                 }
 108
 109                 JSON->register_class_hint(
 110                         hint => $pkg->json_hint,
 111                         name => $pkg,
 112                         type => 'array',
 113                 );
 114
 115         }
 116
 117         print Fieldmapper->javascript() if ($ENV{GEN_JS});
 118 }
 119
 120 sub new {
 121         my $self = shift;
 122         my $value = shift;
 123         $value = [] unless (defined $value);
 124         return bless $value => $self->class_name;
 125 }
 126
 127 sub javascript {
 128         my $class_name = shift;
 129         return 'var fieldmap = ' . JSON->perl2JSON($fieldmap) . ';'
 130 }
 131
 132 sub DESTROY {}
 133
 134 sub AUTOLOAD {
 135         my $obj = shift;
 136         my $value = shift;
 137         (my $field = $AUTOLOAD) =~ s/^.*://o;
 138         my $class_name = $obj->class_name;
 139
 140
 141         if ($field =~ /^clear_/o) {
 142                 {       no strict 'subs';
 143                         *{$obj->class_name."::$field"} = sub {
 144                                 my $self = shift;
 145                                 $self->[$pos] = undef;
 146                                 return 1;
 147                         };
 148                 }
 149                 return $obj->$field();
 150         }
 151
 152         die "No field by the name $field in $class_name!"
 153                 unless (exists $$fieldmap{$class_name}{fields}{$field});
 154
 155         my $pos = $$fieldmap{$class_name}{fields}{$field}{position};
 156
 157         {       no strict 'subs';
 158                 *{$obj->class_name."::$field"} = sub {
 159                         my $self = shift;
 160                         my $new_val = shift;
 161                         $self->[$pos] = $new_val if (defined $new_val);
 162                         return $self->[$pos];
 163                 };
 164         }
 165         return $obj->$field($value);
 166 }
 167
 168 sub class_name {
 169         my $class_name = shift;
 170         return ref($class_name) || $class_name;
 171 }
 172
 173 sub real_fields {
 174         my $self = shift;
 175         my $class_name = $self->class_name;
 176         my $fields = $$fieldmap{$class_name}{fields};
 177
 178         my @f = grep {
 179                         !$$fields{$_}{virtual}
 180                 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
 181
 182         return @f;
 183 }
 184
 185 sub api_level {
 186         my $self = shift;
 187         return $fieldmap->{$self->class_name}->{api_level};
 188 }
 189
 190 sub json_hint {
 191         my $self = shift;
 192         return $fieldmap->{$self->class_name}->{hint};
 193 }
 194
 195
 196 1;