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 @class_name_list $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 _init {
  23         return if (defined $fieldmap);
  24
  25         $fieldmap =
  26         {
  27                 'Fieldmapper::actor::user'                      => { hint => 'au'   },
  28                 'Fieldmapper::actor::org_unit'                  => { hint => 'aou'  },
  29                 'Fieldmapper::actor::org_unit_type'             => { hint => 'aout' },
  30                 'Fieldmapper::biblio::record_node'              => { hint               => 'brn',
  31                                                                      proto_fields       => { children => 1 } },
  32                 'Fieldmapper::biblio::record_entry'             => { hint => 'bre'  },
  33                 'Fieldmapper::config::bib_source'               => { hint => 'cbs'  },
  34                 'Fieldmapper::config::metabib_field'            => { hint => 'cmf'  },
  35                 'Fieldmapper::metabib::metarecord'              => { hint => 'mmr'  },
  36                 'Fieldmapper::metabib::title_field_entry'       => { hint => 'mmr'  },
  37                 'Fieldmapper::metabib::author_field_entry'      => { hint => 'mmr'  },
  38                 'Fieldmapper::metabib::subject_field_entry'     => { hint => 'mmr'  },
  39                 'Fieldmapper::metabib::keyword_field_entry'     => { hint => 'mmr'  },
  40                 'Fieldmapper::metabib::full_rec'                => { hint => 'mmr'  },
  41         };
  42
  43         #-------------------------------------------------------------------------------
  44         # Now comes the evil!  Generate classes
  45
  46         for my $pkg ( keys %$fieldmap ) {
  47                 (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
  48
  49                 eval <<"                PERL";
  50                         package $pkg;
  51                         use base 'Fieldmapper';
  52                 PERL
  53
  54                 push @class_name_list, $pkg;
  55
  56                 $$fieldmapp{$pkg}{cdbi} = $cdbi;
  57
  58                 my $pos = 0;
  59                 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
  60                         $$fieldmap{$pkg}{fields}{$vfield} = { position => $pos, virtual => 1 };
  61                         $pos++;
  62                 }
  63
  64                 if (exists $$fieldmap{$pkg}{proto_fields}) {
  65                         for my $pfield ( keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
  66                                 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
  67                                 $pos++;
  68                         }
  69                 }
  70
  71                 for my $col ( $cdbi->columns('All') ) {
  72                         $$fieldmap{$pkg}{fields}{$col} = { position => $pos, virtual => 0 };
  73                         $pos++;
  74                 }
  75
  76                 JSON->register_class_hint(
  77                         hint => $pkg->json_hint,
  78                         name => $pkg,
  79                         type => 'array',
  80                 );
  81
  82         }
  83
  84         print Fieldmapper->javascript() if ($ENV{GEN_JS});
  85 }
  86
  87 sub new {
  88         my $self = shift;
  89         my $value = shift;
  90         $value = [] unless (defined $value);
  91         return bless $value => $self->class_name;
  92 }
  93
  94 sub javascript {
  95         my $class_name = shift;
  96         return 'var fieldmap = ' . JSON->perl2JSON($fieldmap) . ';'
  97 }
  98
  99 sub DESTROY {}
 100
 101 sub AUTOLOAD {
 102         my $obj = shift;
 103         my $value = shift;
 104         (my $field = $AUTOLOAD) =~ s/^.*://o;
 105         my $class_name = $obj->class_name;
 106
 107         die "No field by the name $field in $class_name!"
 108                 unless (exists $$fieldmap{$class_name}{fields}{$field});
 109
 110         my $pos = $$fieldmap{$class_name}{fields}{$field}{position};
 111
 112         {       no strict 'subs';
 113                 *{$obj->class_name."::$field"} = sub {
 114                         my $self = shift;
 115                         my $new_val = shift;
 116                         $self->[$pos] = $new_val if (defined $new_val);
 117                         return $self->[$pos];
 118                 };
 119         }
 120
 121         return $obj->$field($value);
 122 }
 123
 124 sub class_name {
 125         my $class_name = shift;
 126         return ref($class_name) || $class_name;
 127 }
 128
 129 sub real_fields {
 130         my $self = shift;
 131         my $class_name = $self->class_name;
 132         my $fields = $$fieldmap{$class_name}{fields};
 133
 134         my @f = grep {
 135                         !$$fields{$_}{virtual}
 136                 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
 137
 138         return @f;
 139 }
 140
 141 sub api_level {
 142         my $self = shift;
 143         return $fieldmap->{$self->class_name}->{api_level};
 144 }
 145
 146 sub api_level {
 147         my $self = shift;
 148         return $fieldmap->{$self->class_name}->{api_level};
 149 }
 150
 151 sub json_hint {
 152         my $self = shift;
 153         return $fieldmap->{$self->class_name}->{hint};
 154 }
 155
 156
 157 1;