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

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