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         return () unless (defined $fieldmap);
  45         return keys %$fieldmap;
  46 }
  47
  48 sub _init {
  49         return if (keys %$fieldmap);
  50
  51         $fieldmap =
  52         {
  53                 'Fieldmapper::action::survey'                   => { hint               => 'asv',
  54                                                                      proto_fields       => { questions  => 1,
  55                                                                                              responses  => 1 } },
  56                 'Fieldmapper::action::survey_question'          => { hint               => 'asvq',
  57                                                                      proto_fields       => { answers    => 1,
  58                                                                                              responses  => 1 } },
  59                 'Fieldmapper::action::survey_answer'            => { hint               => 'asva',
  60                                                                      proto_fields       => { responses => 1 } },
  61                 'Fieldmapper::action::survey_response'          => { hint               => 'asvr'  },
  62                 'Fieldmapper::action::circulation'              => { hint               => 'circ',
  63                                                                      proto_fields       => {} },
  64
  65                 'Fieldmapper::action::open_circulation'         => { hint       => 'aoc',
  66                                                                      readonly   => 1 },
  67
  68                 'Fieldmapper::actor::user'                      => { hint               => 'au',
  69                                                                      proto_fields       => { cards              => 1,
  70                                                                                              survey_responses   => 1,
  71                                                                                              stat_cat_entries   => 1,
  72                                                                                              checkouts          => 1,
  73                                                                                              hold_requests      => 1,
  74                                                                                              settings           => 1,
  75                                                                                              addresses          => 1 } },
  76                 'Fieldmapper::actor::user_setting'              => { hint => 'aus'    },
  77                 'Fieldmapper::actor::user_address'              => { hint => 'aua'    },
  78                 'Fieldmapper::actor::org_address'               => { hint => 'aoa'    },
  79                 'Fieldmapper::actor::profile'                   => { hint => 'ap'    },
  80                 'Fieldmapper::actor::card'                      => { hint => 'ac'    },
  81                 'Fieldmapper::config::standing'                 => { hint => 'cst'   },
  82                 'Fieldmapper::config::copy_status'              => { hint => 'ccs'   },
  83                 'Fieldmapper::actor::stat_cat'                  => { hint               => 'actsc',
  84                                                                      proto_fields       => { entries => 1 } },
  85                 'Fieldmapper::actor::stat_cat_entry'            => { hint => 'actsce'    },
  86                 'Fieldmapper::actor::stat_cat_entry_user_map'   => { hint => 'actscecm'  },
  87                 'Fieldmapper::actor::org_unit'                  => { hint               => 'aou',
  88                                                                      proto_fields       => { children => 1 } },
  89                 'Fieldmapper::actor::org_unit_type'             => { hint               => 'aout',
  90                                                                      proto_fields       => { children => 1 } },
  91
  92                 'Fieldmapper::biblio::record_node'              => { hint               => 'brn',
  93                                                                      virtual            => 1,
  94                                                                      proto_fields       => { children           => 1,
  95                                                                                              id                 => 1,
  96                                                                                              owner_doc          => 1,
  97                                                                                              intra_doc_id       => 1,
  98                                                                                              parent_node        => 1,
  99                                                                                              node_type          => 1,
 100                                                                                              namespace_uri      => 1,
 101                                                                                              name               => 1,
 102                                                                                              value              => 1,
 103                                                                                            } },
 104
 105                 'Fieldmapper::metabib::virtual_record'          => { hint               => 'mvr',
 106                                                                      virtual            => 1,
 107                                                                      proto_fields       => { title              => 1,
 108                                                                                              author             => 1,
 109                                                                                              doc_id             => 1,
 110                                                                                              doc_type           => 1,
 111                                                                                              isbn               => 1,
 112                                                                                              pubdate            => 1,
 113                                                                                              publisher          => 1,
 114                                                                                              tcn                => 1,
 115                                                                                              subject            => 1,
 116                                                                                              types_of_resource  => 1,
 117                                                                                              call_numbers       => 1,
 118                                                                                                           edition       => 1,
 119                                                                                                           online_loc    => 1,
 120                                                                                                           synopsis      => 1,
 121                                                                                              copy_count         => 1,
 122                                                                                              series             => 1,
 123                                                                                              serials            => 1,
 124                                                                                            } },
 125
 126                 'Fieldmapper::biblio::record_entry'             => { hint               => 'bre',
 127                                                                      proto_fields       => { call_numbers => 1,
 128                                                                                              fixed_fields => 1 } },
 129                 #'Fieldmapper::biblio::record_marc'             => { hint => 'brx'  }, # now it's inside record_entry
 130
 131                 'Fieldmapper::money::payment'                   => { hint => 'mp'  },
 132                 'Fieldmapper::money::cash_payment'              => { hint => 'mcp'  },
 133                 'Fieldmapper::money::check_payment'             => { hint => 'mckp'  },
 134                 'Fieldmapper::money::credit_payment'            => { hint => 'mcrp'  },
 135                 'Fieldmapper::money::credit_card_payment'       => { hint => 'mccp'  },
 136                 'Fieldmapper::money::forgive_payment'           => { hint => 'mfp'  },
 137                 'Fieldmapper::money::work_payment'              => { hint => 'mwp'  },
 138
 139                 'Fieldmapper::money::billing'                   => { hint => 'mb'  },
 140                 'Fieldmapper::money::billable_transaction'      => { hint => 'mbt'  },
 141
 142                 'Fieldmapper::money::user_summary'              => { hint       => 'mus',
 143                                                                      readonly   => 1 },
 144
 145                 'Fieldmapper::money::user_circulation_summary'  => { hint       => 'mucs',
 146                                                                      readonly   => 1 },
 147
 148                 'Fieldmapper::money::billable_transaction_summary'      => { hint       => 'mbts',
 149                                                                              readonly   => 1 },
 150
 151                 'Fieldmapper::config::identification_type'      => { hint => 'cit'  },
 152                 'Fieldmapper::config::bib_source'               => { hint => 'cbs'  },
 153                 'Fieldmapper::config::metabib_field'            => { hint => 'cmf'  },
 154                 'Fieldmapper::config::rules::recuring_fine'     => { hint => 'crrf'  },
 155                 'Fieldmapper::config::rules::circ_duration'     => { hint => 'crcd'  },
 156                 'Fieldmapper::config::rules::max_fine'          => { hint => 'crmf'  },
 157
 158                 'Fieldmapper::metabib::metarecord'              => { hint => 'mmr'  },
 159                 'Fieldmapper::metabib::title_field_entry'       => { hint => 'mtfe' },
 160                 'Fieldmapper::metabib::author_field_entry'      => { hint => 'mafe' },
 161                 'Fieldmapper::metabib::subject_field_entry'     => { hint => 'msfe' },
 162                 'Fieldmapper::metabib::keyword_field_entry'     => { hint => 'mkfe' },
 163                 'Fieldmapper::metabib::series_field_entry'      => { hint => 'msefe' },
 164                 'Fieldmapper::metabib::full_rec'                => { hint => 'mfr'  },
 165                 'Fieldmapper::metabib::record_descriptor'       => { hint => 'mrd'  },
 166                 'Fieldmapper::metabib::metarecord_source_map'   => { hint => 'mmrsm'},
 167
 168                 'Fieldmapper::asset::copy'                      => { hint               => 'acp',
 169                                                                      proto_fields       => { stat_cat_entries => 1 } },
 170                 'Fieldmapper::asset::stat_cat'                  => { hint               => 'asc',
 171                                                                      proto_fields       => { entries => 1 } },
 172                 'Fieldmapper::asset::stat_cat_entry'            => { hint => 'asce'    },
 173                 'Fieldmapper::asset::stat_cat_entry_copy_map'   => { hint => 'ascecm'  },
 174                 'Fieldmapper::asset::copy_note'                 => { hint => 'acpn'    },
 175                 'Fieldmapper::asset::copy_location'             => { hint => 'acpl'    },
 176                 'Fieldmapper::asset::call_number'               => { hint               => 'acn',
 177                                                                      proto_fields       => { copies => 1 } },
 178                 'Fieldmapper::asset::call_number_note'          => { hint => 'acnn'    },
 179
 180                 'Fieldmapper::permission::perm_list'            => { hint => 'ppl'    },
 181                 'Fieldmapper::permission::grp_tree'             => { hint => 'pgt'    },
 182                 'Fieldmapper::permission::usr_grp_map'          => { hint => 'pugm'   },
 183                 'Fieldmapper::permission::usr_perm_map'         => { hint => 'pupm'   },
 184                 'Fieldmapper::permission::grp_perm_map'         => { hint => 'pgpm'   },
 185                 'Fieldmapper::action::hold_request'             => { hint => 'ahr', proto_fields => { status => 1 } },
 186                 'Fieldmapper::action::hold_notification'        => { hint => 'ahn'   },
 187                 'Fieldmapper::action::hold_copy_map'            => { hint => 'ahcm'   },
 188                 'Fieldmapper::action::hold_transit_copy'        => { hint => 'ahtc'   },
 189                 'Fieldmapper::action::transit_copy'     => { hint => 'atc'   },
 190
 191
 192                 'Fieldmapper::ex'                               => { hint           => 'ex',
 193                                                                      virtual        => 1,
 194                                                                      proto_fields   => {
 195                                                                         err_msg  => 1,
 196                                                                         type     => 1,
 197                                                                      } },
 198
 199
 200                 'Fieldmapper::perm_ex'                          => { hint           => 'perm_ex',
 201                                                                      virtual        => 1,
 202                                                                      proto_fields   => {
 203                                                                         err_msg => 1,
 204                                                                         type    => 1,
 205                                                                      } },
 206
 207
 208
 209         };
 210
 211         #-------------------------------------------------------------------------------
 212         # Now comes the evil!  Generate classes
 213
 214         for my $pkg ( __PACKAGE__->classes ) {
 215                 (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
 216
 217                 eval <<"                PERL";
 218                         package $pkg;
 219                         use base 'Fieldmapper';
 220                 PERL
 221
 222                 my $pos = 0;
 223                 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
 224                         $$fieldmap{$pkg}{fields}{$vfield} = { position => $pos, virtual => 1 };
 225                         $pos++;
 226                 }
 227
 228                 if (exists $$fieldmap{$pkg}{proto_fields}) {
 229                         for my $pfield ( sort keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
 230                                 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
 231                                 $pos++;
 232                         }
 233                 }
 234
 235                 unless ( $$fieldmap{$pkg}{virtual} ) {
 236                         $$fieldmap{$pkg}{cdbi} = $cdbi;
 237                         for my $col ( sort $cdbi->columns('All') ) {
 238                                 $$fieldmap{$pkg}{fields}{$col} = { position => $pos, virtual => 0 };
 239                                 $pos++;
 240                         }
 241                 }
 242
 243                 JSON->register_class_hint(
 244                         hint => $pkg->json_hint,
 245                         name => $pkg,
 246                         type => 'array',
 247                 );
 248
 249         }
 250 }
 251
 252 sub new {
 253         my $self = shift;
 254         my $value = shift;
 255         $value = [] unless (defined $value);
 256         return bless $value => $self->class_name;
 257 }
 258
 259 sub decast {
 260         my $self = shift;
 261         return [ @$self ];
 262 }
 263
 264 sub DESTROY {}
 265
 266 sub AUTOLOAD {
 267         my $obj = shift;
 268         my $value = shift;
 269         (my $field = $AUTOLOAD) =~ s/^.*://o;
 270         my $class_name = $obj->class_name;
 271
 272         my $fpos = $field;
 273         $fpos  =~ s/^clear_//og ;
 274
 275         my $pos = $$fieldmap{$class_name}{fields}{$fpos}{position};
 276
 277         if ($field =~ /^clear_/o) {
 278                 {       no strict 'subs';
 279                         *{$obj->class_name."::$field"} = sub {
 280                                 my $self = shift;
 281                                 $self->[$pos] = undef;
 282                                 return 1;
 283                         };
 284                 }
 285                 return $obj->$field();
 286         }
 287
 288         die "No field by the name $field in $class_name!"
 289                 unless (exists $$fieldmap{$class_name}{fields}{$field} && defined($pos));
 290
 291
 292         {       no strict 'subs';
 293                 *{$obj->class_name."::$field"} = sub {
 294                         my $self = shift;
 295                         my $new_val = shift;
 296                         $self->[$pos] = $new_val if (defined $new_val);
 297                         return $self->[$pos];
 298                 };
 299         }
 300         return $obj->$field($value);
 301 }
 302
 303 sub class_name {
 304         my $class_name = shift;
 305         return ref($class_name) || $class_name;
 306 }
 307
 308 sub real_fields {
 309         my $self = shift;
 310         my $class_name = $self->class_name;
 311         my $fields = $$fieldmap{$class_name}{fields};
 312
 313         my @f = grep {
 314                         !$$fields{$_}{virtual}
 315                 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
 316
 317         return @f;
 318 }
 319
 320 sub properties {
 321         my $self = shift;
 322         my $class_name = $self->class_name;
 323         return keys %{$$fieldmap{$class_name}{fields}};
 324 }
 325
 326 sub clone {
 327         my $self = shift;
 328         return $self->new( [@$self] );
 329 }
 330
 331 sub api_level {
 332         my $self = shift;
 333         return $fieldmap->{$self->class_name}->{api_level};
 334 }
 335
 336 sub cdbi {
 337         my $self = shift;
 338         return $fieldmap->{$self->class_name}->{cdbi};
 339 }
 340
 341 sub is_virtual {
 342         my $self = shift;
 343         my $field = shift;
 344         return $fieldmap->{$self->class_name}->{proto_fields}->{$field} if ($field);
 345         return $fieldmap->{$self->class_name}->{virtual};
 346 }
 347
 348 sub is_readonly {
 349         my $self = shift;
 350         my $field = shift;
 351         return $fieldmap->{$self->class_name}->{readonly};
 352 }
 353
 354 sub json_hint {
 355         my $self = shift;
 356         return $fieldmap->{$self->class_name}->{hint};
 357 }
 358
 359
 360 1;