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::action;
  12 use OpenILS::Application::Storage::CDBI::asset;
  13 use OpenILS::Application::Storage::CDBI::biblio;
  14 use OpenILS::Application::Storage::CDBI::config;
  15 use OpenILS::Application::Storage::CDBI::metabib;
  16 use OpenILS::Application::Storage::CDBI::money;
  17
  18 use vars qw/$fieldmap $VERSION/;
  19
  20 _init();
  21
  22 sub publish_fieldmapper {
  23         my ($self,$client,$class) = @_;
  24
  25         return $fieldmap unless (defined $class);
  26         return undef unless (exists($$fieldmap{$class}));
  27         return {$class => $$fieldmap{$class}};
  28 }
  29 __PACKAGE__->register_method(
  30         api_name        => 'opensrf.open-ils.system.fieldmapper',
  31         api_level       => 1,
  32         method          => 'publish_fieldmapper',
  33 );
  34
  35 #
  36 # To dump the Javascript version of the fieldmapper struct use the command:
  37 #
  38 #       PERL5LIB=~/cvs/ILS/OpenSRF/src/perlmods/:~/cvs/ILS/Open-ILS/src/perlmods/ GEN_JS=1 perl -MOpenILS::Utils::Fieldmapper -e 'print "\n";'
  39 #
  40 # ... adjusted for your CVS sandbox, of course.
  41 #
  42
  43 sub classes {
  44         $log->debug("classes: ".join(' -- ', keys %$fieldmap), DEBUG);
  45         return () unless (defined $fieldmap);
  46         return keys %$fieldmap;
  47 }
  48
  49 sub _init {
  50         return if (keys %$fieldmap);
  51
  52         $fieldmap =
  53         {
  54                 'Fieldmapper::action::survey'                   => { hint               => 'asv',
  55                                                                      proto_fields       => { questions  => 1,
  56                                                                                              responses  => 1 } },
  57                 'Fieldmapper::action::survey_question'          => { hint               => 'asvq',
  58                                                                      proto_fields       => { answers    => 1,
  59                                                                                              responses  => 1 } },
  60                 'Fieldmapper::action::survey_answer'            => { hint               => 'asva',
  61                                                                      proto_fields       => { responses => 1 } },
  62                 'Fieldmapper::action::survey_response'          => { hint               => 'asvr'  },
  63                 'Fieldmapper::action::circulation'              => { hint               => 'ac'    },
  64                 'Fieldmapper::actor::user'                      => { hint               => 'au',
  65                                                                      proto_fields       => { cards      => 1,
  66                                                                                              addresses  => 1 } },
  67                 'Fieldmapper::actor::user_address'              => { hint => 'aua'    },
  68                 'Fieldmapper::actor::org_address'               => { hint => 'aoa'    },
  69                 'Fieldmapper::actor::profile'                   => { hint => 'ap'    },
  70                 'Fieldmapper::actor::card'                      => { hint => 'ac'    },
  71                 'Fieldmapper::config::standing'                 => { hint => 'cst'   },
  72                 'Fieldmapper::config::copy_status'              => { hint => 'ccs'   },
  73                 'Fieldmapper::actor::stat_cat'                  => { hint               => 'asc',
  74                                                                      proto_fields       => { entries => 1 } },
  75                 'Fieldmapper::actor::stat_cat_entry'            => { hint => 'asce'    },
  76                 'Fieldmapper::actor::stat_cat_entry_user_map'   => { hint => 'ascecm'  },
  77                 'Fieldmapper::actor::org_unit'                  => { hint               => 'aou',
  78                                                                      proto_fields       => { children => 1 } },
  79                 'Fieldmapper::actor::org_unit_type'             => { hint               => 'aout',
  80                                                                      proto_fields       => { children => 1 } },
  81
  82                 'Fieldmapper::biblio::record_node'              => { hint               => 'brn',
  83                                                                      virtual            => 1,
  84                                                                      proto_fields       => { children           => 1,
  85                                                                                              id                 => 1,
  86                                                                                              owner_doc          => 1,
  87                                                                                              intra_doc_id       => 1,
  88                                                                                              parent_node        => 1,
  89                                                                                              node_type          => 1,
  90                                                                                              namepsace_uri      => 1,
  91                                                                                              name               => 1,
  92                                                                                              value              => 1,
  93                                                                                            } },
  94
  95                 'Fieldmapper::metabib::virtual_record'          => { hint               => 'mvr',
  96                                                                      virtual            => 1,
  97                                                                      proto_fields       => { title              => 1,
  98                                                                                              author             => 1,
  99                                                                                              doc_id             => 1,
 100                                                                                              doc_type           => 1,
 101                                                                                              isbn               => 1,
 102                                                                                              pubdate            => 1,
 103                                                                                              publisher          => 1,
 104                                                                                              tcn                => 1,
 105                                                                                              subject            => 1,
 106                                                                                              types_of_resource  => 1,
 107                                                                                              call_numbers       => 1,
 108                                                                                              copy_count         => 1,
 109                                                                                            } },
 110
 111                 'Fieldmapper::biblio::record_entry'             => { hint               => 'bre',
 112                                                                      proto_fields       => { call_numbers => 1 } },
 113                 #'Fieldmapper::biblio::record_marc'             => { hint => 'brx'  }, # now it's inside record_entry
 114
 115                 'Fieldmapper::money::cash_payment'              => { hint => 'mcp'  },
 116                 'Fieldmapper::money::billing'                   => { hint => 'mb'  },
 117
 118                 'Fieldmapper::config::identification_type'      => { hint => 'cit'  },
 119                 'Fieldmapper::config::bib_source'               => { hint => 'cbs'  },
 120                 'Fieldmapper::config::metabib_field'            => { hint => 'cmf'  },
 121
 122                 'Fieldmapper::metabib::metarecord'              => { hint => 'mmr'  },
 123                 'Fieldmapper::metabib::title_field_entry'       => { hint => 'mtfe' },
 124                 'Fieldmapper::metabib::author_field_entry'      => { hint => 'mafe' },
 125                 'Fieldmapper::metabib::subject_field_entry'     => { hint => 'msfe' },
 126                 'Fieldmapper::metabib::keyword_field_entry'     => { hint => 'mkfe' },
 127                 'Fieldmapper::metabib::full_rec'                => { hint => 'mfr'  },
 128                 'Fieldmapper::metabib::record_descriptor'       => { hint => 'mrd'  },
 129                 'Fieldmapper::metabib::metarecord_source_map'   => { hint => 'mmrsm'},
 130
 131                 'Fieldmapper::asset::copy'                      => { hint               => 'acp',
 132                                                                      proto_fields       => { stat_cat_entries => 1 } },
 133                 'Fieldmapper::asset::stat_cat'                  => { hint               => 'asc',
 134                                                                      proto_fields       => { entries => 1 } },
 135                 'Fieldmapper::asset::stat_cat_entry'            => { hint => 'asce'    },
 136                 'Fieldmapper::asset::stat_cat_entry_copy_map'   => { hint => 'ascecm'  },
 137                 'Fieldmapper::asset::copy_note'                 => { hint => 'acpn'    },
 138                 'Fieldmapper::asset::call_number'               => { hint               => 'acn',
 139                                                                      proto_fields       => { copies => 1 } },
 140                 'Fieldmapper::asset::call_number_note'          => { hint => 'acnn'    },
 141         };
 142
 143         #-------------------------------------------------------------------------------
 144         # Now comes the evil!  Generate classes
 145
 146         for my $pkg ( __PACKAGE__->classes ) {
 147                 $log->debug("Generating FM class for $pkg", DEBUG);
 148                 (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
 149
 150                 eval <<"                PERL";
 151                         package $pkg;
 152                         use base 'Fieldmapper';
 153                 PERL
 154
 155                 $$fieldmap{$pkg}{cdbi} = $cdbi;
 156
 157                 my $pos = 0;
 158                 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
 159                         $$fieldmap{$pkg}{fields}{$vfield} = { position => $pos, virtual => 1 };
 160                         $pos++;
 161                 }
 162
 163                 if (exists $$fieldmap{$pkg}{proto_fields}) {
 164                         for my $pfield ( keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
 165                                 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
 166                                 $pos++;
 167                         }
 168                 }
 169
 170                 unless ( $$fieldmap{$pkg}{virtual} ) {
 171                         for my $col ( sort $cdbi->columns('All') ) {
 172                                 $$fieldmap{$pkg}{fields}{$col} = { position => $pos, virtual => 0 };
 173                                 $pos++;
 174                         }
 175                 }
 176
 177                 JSON->register_class_hint(
 178                         hint => $pkg->json_hint,
 179                         name => $pkg,
 180                         type => 'array',
 181                 );
 182
 183         }
 184 }
 185
 186 sub new {
 187         my $self = shift;
 188         my $value = shift;
 189         $value = [] unless (defined $value);
 190         return bless $value => $self->class_name;
 191 }
 192
 193 sub decast {
 194         my $self = shift;
 195         return [ @$self ];
 196 }
 197
 198 sub DESTROY {}
 199
 200 sub AUTOLOAD {
 201         my $obj = shift;
 202         my $value = shift;
 203         (my $field = $AUTOLOAD) =~ s/^.*://o;
 204         my $class_name = $obj->class_name;
 205
 206         my $fpos = $field;
 207         $fpos  =~ s/^clear_//og ;
 208
 209         my $pos = $$fieldmap{$class_name}{fields}{$fpos}{position};
 210
 211         if ($field =~ /^clear_/o) {
 212                 {       no strict 'subs';
 213                         *{$obj->class_name."::$field"} = sub {
 214                                 my $self = shift;
 215                                 $self->[$pos] = undef;
 216                                 return 1;
 217                         };
 218                 }
 219                 return $obj->$field();
 220         }
 221
 222         die "No field by the name $field in $class_name!"
 223                 unless (exists $$fieldmap{$class_name}{fields}{$field});
 224
 225
 226         {       no strict 'subs';
 227                 *{$obj->class_name."::$field"} = sub {
 228                         my $self = shift;
 229                         my $new_val = shift;
 230                         $self->[$pos] = $new_val if (defined $new_val);
 231                         return $self->[$pos];
 232                 };
 233         }
 234         return $obj->$field($value);
 235 }
 236
 237 sub class_name {
 238         my $class_name = shift;
 239         return ref($class_name) || $class_name;
 240 }
 241
 242 sub real_fields {
 243         my $self = shift;
 244         my $class_name = $self->class_name;
 245         my $fields = $$fieldmap{$class_name}{fields};
 246
 247         my @f = grep {
 248                         !$$fields{$_}{virtual}
 249                 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
 250
 251         return @f;
 252 }
 253
 254 sub api_level {
 255         my $self = shift;
 256         return $fieldmap->{$self->class_name}->{api_level};
 257 }
 258
 259
 260 sub is_virtual {
 261         my $self = shift;
 262         return $fieldmap->{$self->class_name}->{virtual};
 263 }
 264
 265 sub json_hint {
 266         my $self = shift;
 267         return $fieldmap->{$self->class_name}->{hint};
 268 }
 269
 270
 271 1;