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                 'Fieldmapper::actor::org_unit_type'             => { hint               => 'aout',
  53                                                                      proto_fields       => { children => 1 } },
  54
  55                 'Fieldmapper::biblio::record_node'              => { hint               => 'brn',
  56                                                                      proto_fields       => { children => 1 } },
  57                 'Fieldmapper::biblio::record_entry'             => { hint => 'bre'  },
  58                 'Fieldmapper::biblio::record_mods'              => { hint => 'brm'  },
  59                 'Fieldmapper::biblio::record_marc'              => { hint => 'brx'  },
  60
  61                 'Fieldmapper::config::bib_source'               => { hint => 'cbs'  },
  62                 'Fieldmapper::config::metabib_field'            => { hint => 'cmf'  },
  63
  64                 'Fieldmapper::metabib::metarecord'              => { hint => 'mmr'  },
  65                 'Fieldmapper::metabib::title_field_entry'       => { hint => 'mtfe' },
  66                 'Fieldmapper::metabib::author_field_entry'      => { hint => 'mafe' },
  67                 'Fieldmapper::metabib::subject_field_entry'     => { hint => 'msfe' },
  68                 'Fieldmapper::metabib::keyword_field_entry'     => { hint => 'mkfe' },
  69                 'Fieldmapper::metabib::full_rec'                => { hint => 'mfr'  },
  70
  71                 'Fieldmapper::asset::copy'                      => { hint => 'acp'  },
  72                 'Fieldmapper::asset::copy_note'                 => { hint => 'acpn' },
  73                 'Fieldmapper::asset::call_number'               => { hint => 'acn'  },
  74                 'Fieldmapper::asset::call_number_note'          => { hint => 'acnn' },
  75         };
  76
  77         #-------------------------------------------------------------------------------
  78         # Now comes the evil!  Generate classes
  79
  80         for my $pkg ( keys %$fieldmap ) {
  81                 (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
  82
  83                 eval <<"                PERL";
  84                         package $pkg;
  85                         use base 'Fieldmapper';
  86                 PERL
  87
  88                 $$fieldmap{$pkg}{cdbi} = $cdbi;
  89
  90                 my $pos = 0;
  91                 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
  92                         $$fieldmap{$pkg}{fields}{$vfield} = { position => $pos, virtual => 1 };
  93                         $pos++;
  94                 }
  95
  96                 if (exists $$fieldmap{$pkg}{proto_fields}) {
  97                         for my $pfield ( keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
  98                                 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
  99                                 $pos++;
 100                         }
 101                 }
 102
 103                 for my $col ( $cdbi->columns('All') ) {
 104                         $$fieldmap{$pkg}{fields}{$col} = { position => $pos, virtual => 0 };
 105                         $pos++;
 106                 }
 107
 108                 JSON->register_class_hint(
 109                         hint => $pkg->json_hint,
 110                         name => $pkg,
 111                         type => 'array',
 112                 );
 113
 114         }
 115
 116         print Fieldmapper->javascript() if ($ENV{GEN_JS});
 117 }
 118
 119 sub new {
 120         my $self = shift;
 121         my $value = shift;
 122         $value = [] unless (defined $value);
 123         return bless $value => $self->class_name;
 124 }
 125
 126 sub javascript {
 127         my $class_name = shift;
 128         return 'var fieldmap = ' . JSON->perl2JSON($fieldmap) . ';'
 129 }
 130
 131 sub DESTROY {}
 132
 133 sub AUTOLOAD {
 134         my $obj = shift;
 135         my $value = shift;
 136         (my $field = $AUTOLOAD) =~ s/^.*://o;
 137         my $class_name = $obj->class_name;
 138
 139
 140         if ($field =~ /^clear_/o) {
 141                 {       no strict 'subs';
 142                         *{$obj->class_name."::$field"} = sub {
 143                                 my $self = shift;
 144                                 $self->[$pos] = undef;
 145                                 return 1;
 146                         };
 147                 }
 148                 return $obj->$field();
 149         }
 150
 151         die "No field by the name $field in $class_name!"
 152                 unless (exists $$fieldmap{$class_name}{fields}{$field});
 153
 154         my $pos = $$fieldmap{$class_name}{fields}{$field}{position};
 155
 156         {       no strict 'subs';
 157                 *{$obj->class_name."::$field"} = sub {
 158                         my $self = shift;
 159                         my $new_val = shift;
 160                         $self->[$pos] = $new_val if (defined $new_val);
 161                         return $self->[$pos];
 162                 };
 163         }
 164         return $obj->$field($value);
 165 }
 166
 167 sub class_name {
 168         my $class_name = shift;
 169         return ref($class_name) || $class_name;
 170 }
 171
 172 sub real_fields {
 173         my $self = shift;
 174         my $class_name = $self->class_name;
 175         my $fields = $$fieldmap{$class_name}{fields};
 176
 177         my @f = grep {
 178                         !$$fields{$_}{virtual}
 179                 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
 180
 181         return @f;
 182 }
 183
 184 sub api_level {
 185         my $self = shift;
 186         return $fieldmap->{$self->class_name}->{api_level};
 187 }
 188
 189 sub json_hint {
 190         my $self = shift;
 191         return $fieldmap->{$self->class_name}->{hint};
 192 }
 193
 194
 195 1;