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 use OpenILS::Application::Storage::CDBI::container;
  18
  19 use vars qw/$fieldmap $VERSION/;
  20
  21 _init();
  22
  23 sub publish_fieldmapper {
  24         my ($self,$client,$class) = @_;
  25
  26         return $fieldmap unless (defined $class);
  27         return undef unless (exists($$fieldmap{$class}));
  28         return {$class => $$fieldmap{$class}};
  29 }
  30 __PACKAGE__->register_method(
  31         api_name        => 'opensrf.open-ils.system.fieldmapper',
  32         api_level       => 1,
  33         method          => 'publish_fieldmapper',
  34 );
  35
  36 #
  37 # To dump the Javascript version of the fieldmapper struct use the command:
  38 #
  39 #       PERL5LIB=~/cvs/ILS/OpenSRF/src/perlmods/:~/cvs/ILS/Open-ILS/src/perlmods/ GEN_JS=1 perl -MOpenILS::Utils::Fieldmapper -e 'print "\n";'
  40 #
  41 # ... adjusted for your CVS sandbox, of course.
  42 #
  43
  44 sub classes {
  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::container::user_bucket'           => { hint => 'cub',
  55                                                                      proto_fields       => { items => 1 } },
  56                 'Fieldmapper::container::copy_bucket'           => { hint => 'ccb',
  57                                                                      proto_fields       => { items => 1 } },
  58                 'Fieldmapper::container::call_number_bucket'    => { hint => 'ccnb',
  59                                                                      proto_fields       => { items => 1 } },
  60                 'Fieldmapper::container::biblio_record_entry_bucket'            => { hint => 'cbreb',
  61                                                                                      proto_fields       => { items => 1 } },
  62
  63                 'Fieldmapper::container::user_bucket_item'              => { hint => 'cubi'   },
  64                 'Fieldmapper::container::copy_bucket_item'              => { hint => 'ccbi'   },
  65                 'Fieldmapper::container::call_number_bucket_item'       => { hint => 'ccnbi'   },
  66                 'Fieldmapper::container::biblio_record_entry_bucket_item'               => { hint => 'cbrebi'   },
  67
  68                 'Fieldmapper::action::in_house_use'             => { hint => 'aihu'   },
  69                 'Fieldmapper::action::non_cataloged_circulation'=> { hint => 'ancc'   },
  70
  71                 'Fieldmapper::action::survey'                   => { hint               => 'asv',
  72                                                                      proto_fields       => { questions  => 1,
  73                                                                                              responses  => 1 } },
  74                 'Fieldmapper::action::survey_question'          => { hint               => 'asvq',
  75                                                                      proto_fields       => { answers    => 1,
  76                                                                                              responses  => 1 } },
  77                 'Fieldmapper::action::survey_answer'            => { hint               => 'asva',
  78                                                                      proto_fields       => { responses => 1 } },
  79                 'Fieldmapper::action::survey_response'          => { hint               => 'asvr'  },
  80                 'Fieldmapper::action::circulation'              => { hint               => 'circ',
  81                                                                      proto_fields       => {} },
  82
  83                 'Fieldmapper::action::open_circulation'         => { hint       => 'aoc',
  84                                                                      readonly   => 1 },
  85
  86                 'Fieldmapper::actor::workstation'               => { hint       => 'aws' },
  87
  88                 'Fieldmapper::actor::user'                      => { hint               => 'au',
  89                                                                      proto_fields       => { cards              => 1,
  90                                                                                              survey_responses   => 1,
  91                                                                                              stat_cat_entries   => 1,
  92                                                                                              checkouts          => 1,
  93                                                                                              wsid               => 1,
  94                                                                                              ws_ou              => 1,
  95                                                                                              hold_requests      => 1,
  96                                                                                              settings           => 1,
  97                                                                                              permissions        => 1,
  98                                                                                              standing_penalties => 1,
  99                                                                                              addresses          => 1 } },
 100                 'Fieldmapper::actor::user_setting'              => { hint => 'aus'    },
 101                 'Fieldmapper::actor::user_standing_penalty'     => { hint => 'ausp'    },
 102                 'Fieldmapper::actor::org_unit_setting'          => { hint => 'aous'    },
 103                 'Fieldmapper::actor::user_address'              => { hint => 'aua'    },
 104                 'Fieldmapper::actor::org_address'               => { hint => 'aoa'    },
 105                 'Fieldmapper::actor::profile'                   => { hint => 'ap'    },
 106                 'Fieldmapper::actor::card'                      => { hint => 'ac'    },
 107                 'Fieldmapper::actor::stat_cat'                  => { hint               => 'actsc',
 108                                                                      proto_fields       => { entries => 1 } },
 109                 'Fieldmapper::actor::stat_cat_entry'            => { hint => 'actsce'    },
 110                 'Fieldmapper::actor::stat_cat_entry_user_map'   => { hint => 'actscecm'  },
 111                 'Fieldmapper::actor::org_unit'                  => { hint               => 'aou',
 112                                                                      proto_fields       => { children => 1 } },
 113                 'Fieldmapper::actor::org_unit_type'             => { hint               => 'aout',
 114                                                                      proto_fields       => { children => 1 } },
 115
 116                 'Fieldmapper::biblio::record_node'              => { hint               => 'brn',
 117                                                                      virtual            => 1,
 118                                                                      proto_fields       => { children           => 1,
 119                                                                                              id                 => 1,
 120                                                                                              owner_doc          => 1,
 121                                                                                              intra_doc_id       => 1,
 122                                                                                              parent_node        => 1,
 123                                                                                              node_type          => 1,
 124                                                                                              namespace_uri      => 1,
 125                                                                                              name               => 1,
 126                                                                                              value              => 1,
 127                                                                                            } },
 128
 129                 'Fieldmapper::metabib::virtual_record'          => { hint               => 'mvr',
 130                                                                      virtual            => 1,
 131                                                                      proto_fields       => { title              => 1,
 132                                                                                              author             => 1,
 133                                                                                              doc_id             => 1,
 134                                                                                              doc_type           => 1,
 135                                                                                              isbn               => 1,
 136                                                                                              pubdate            => 1,
 137                                                                                              publisher          => 1,
 138                                                                                              tcn                => 1,
 139                                                                                              subject            => 1,
 140                                                                                              types_of_resource  => 1,
 141                                                                                              call_numbers       => 1,
 142                                                                                                           edition       => 1,
 143                                                                                                           online_loc    => 1,
 144                                                                                                           synopsis      => 1,
 145                                                                                                           physical_description  => 1,
 146                                                                                                           toc => 1,
 147                                                                                              copy_count         => 1,
 148                                                                                              series             => 1,
 149                                                                                              serials            => 1,
 150                                                                                            } },
 151
 152                 'Fieldmapper::authority::record_entry'          => { hint               => 'are', },
 153                 'Fieldmapper::authority::record_note'           => { hint               => 'arn', },
 154                 'Fieldmapper::biblio::record_note'              => { hint               => 'bren', },
 155                 'Fieldmapper::biblio::record_entry'             => { hint               => 'bre',
 156                                                                      proto_fields       => { call_numbers => 1,
 157                                                                                              fixed_fields => 1 } },
 158                 #'Fieldmapper::biblio::record_marc'             => { hint => 'brx'  }, # now it's inside record_entry
 159
 160                 'Fieldmapper::money::payment'                   => { hint => 'mp',
 161                                                                      readonly   => 1 },
 162
 163                 'Fieldmapper::money::cash_payment'              => { hint => 'mcp'  },
 164                 'Fieldmapper::money::check_payment'             => { hint => 'mckp'  },
 165                 'Fieldmapper::money::credit_payment'            => { hint => 'mcrp'  },
 166                 'Fieldmapper::money::credit_card_payment'       => { hint => 'mccp'  },
 167                 'Fieldmapper::money::forgive_payment'           => { hint => 'mfp'  },
 168                 'Fieldmapper::money::work_payment'              => { hint => 'mwp'  },
 169
 170                 'Fieldmapper::money::billing'                   => { hint => 'mb'  },
 171                 'Fieldmapper::money::billable_transaction'      => { hint => 'mbt'  },
 172                 'Fieldmapper::money::grocery'                   => { hint => 'mg'  },
 173
 174                 'Fieldmapper::money::open_user_summary'         => { hint       => 'mous',
 175                                                                      readonly   => 1 },
 176                 'Fieldmapper::money::user_summary'              => { hint       => 'mus',
 177                                                                      readonly   => 1 },
 178
 179                 'Fieldmapper::money::open_user_circulation_summary'     => { hint       => 'moucs',
 180                                                                              readonly   => 1 },
 181                 'Fieldmapper::money::user_circulation_summary'  => { hint       => 'mucs',
 182                                                                      readonly   => 1 },
 183
 184                 'Fieldmapper::money::open_billable_transaction_summary' => { hint       => 'mobts',
 185                                                                              readonly   => 1 },
 186                 'Fieldmapper::money::billable_transaction_summary'      => { hint       => 'mbts',
 187                                                                              readonly   => 1 },
 188
 189                 'Fieldmapper::config::identification_type'      => { hint => 'cit'  },
 190                 'Fieldmapper::config::bib_source'               => { hint => 'cbs'  },
 191                 'Fieldmapper::config::metabib_field'            => { hint => 'cmf'  },
 192                 'Fieldmapper::config::rules::recuring_fine'     => { hint => 'crrf'  },
 193                 'Fieldmapper::config::rules::circ_duration'     => { hint => 'crcd'  },
 194                 'Fieldmapper::config::rules::max_fine'          => { hint => 'crmf'  },
 195                 'Fieldmapper::config::non_cataloged_type'       => { hint => 'cnct'   },
 196                 'Fieldmapper::config::standing'                 => { hint => 'cst'   },
 197                 'Fieldmapper::config::copy_status'              => { hint => 'ccs'   },
 198
 199                 'Fieldmapper::authority::full_rec'              => { hint => 'afr'  },
 200                 'Fieldmapper::authority::record_descriptor'     => { hint => 'ard'  },
 201
 202                 'Fieldmapper::metabib::metarecord'              => { hint => 'mmr'  },
 203                 'Fieldmapper::metabib::title_field_entry'       => { hint => 'mtfe' },
 204                 'Fieldmapper::metabib::author_field_entry'      => { hint => 'mafe' },
 205                 'Fieldmapper::metabib::subject_field_entry'     => { hint => 'msfe' },
 206                 'Fieldmapper::metabib::keyword_field_entry'     => { hint => 'mkfe' },
 207                 'Fieldmapper::metabib::series_field_entry'      => { hint => 'msefe' },
 208                 'Fieldmapper::metabib::full_rec'                => { hint => 'mfr'  },
 209                 'Fieldmapper::metabib::record_descriptor'       => { hint => 'mrd'  },
 210                 'Fieldmapper::metabib::metarecord_source_map'   => { hint => 'mmrsm'},
 211
 212                 'Fieldmapper::asset::copy'                      => { hint               => 'acp',
 213                                                                      proto_fields       => { stat_cat_entries => 1 } },
 214                 'Fieldmapper::asset::stat_cat'                  => { hint               => 'asc',
 215                                                                      proto_fields       => { entries => 1 } },
 216                 'Fieldmapper::asset::stat_cat_entry'            => { hint => 'asce'    },
 217                 'Fieldmapper::asset::stat_cat_entry_copy_map'   => { hint => 'ascecm'  },
 218                 'Fieldmapper::asset::copy_note'                 => { hint => 'acpn'    },
 219                 'Fieldmapper::asset::copy_location'             => { hint => 'acpl'    },
 220                 'Fieldmapper::asset::call_number'               => { hint               => 'acn',
 221                                                                      proto_fields       => { copies => 1 } },
 222                 'Fieldmapper::asset::call_number_note'          => { hint => 'acnn'    },
 223
 224                 'Fieldmapper::permission::perm_list'            => { hint => 'ppl'    },
 225                 'Fieldmapper::permission::grp_tree'             => { hint => 'pgt', proto_fields => { children => 1 } },
 226                 'Fieldmapper::permission::usr_grp_map'          => { hint => 'pugm'   },
 227                 'Fieldmapper::permission::usr_perm_map'         => { hint => 'pupm'   },
 228                 'Fieldmapper::permission::grp_perm_map'         => { hint => 'pgpm'   },
 229                 'Fieldmapper::action::hold_request'             => { hint => 'ahr', proto_fields => { status => 1 } },
 230                 'Fieldmapper::action::hold_notification'        => { hint => 'ahn'    },
 231                 'Fieldmapper::action::hold_copy_map'            => { hint => 'ahcm'   },
 232                 'Fieldmapper::action::hold_transit_copy'        => { hint => 'ahtc'   },
 233                 'Fieldmapper::action::transit_copy'             => { hint => 'atc'    },
 234                 'Fieldmapper::action::unfulfilled_hold_list'    => { hint => 'aufh'   },
 235
 236
 237                 'Fieldmapper::ex'                               => { hint           => 'ex',
 238                                                                      virtual        => 1,
 239                                                                      proto_fields   => {
 240                                                                         err_msg  => 1,
 241                                                                         type     => 1,
 242                                                                      } },
 243
 244
 245                 'Fieldmapper::perm_ex'                          => { hint           => 'perm_ex',
 246                                                                      virtual        => 1,
 247                                                                      proto_fields   => {
 248                                                                         err_msg => 1,
 249                                                                         type    => 1,
 250                                                                      } },
 251
 252
 253
 254         };
 255
 256         #-------------------------------------------------------------------------------
 257         # Now comes the evil!  Generate classes
 258
 259         for my $pkg ( __PACKAGE__->classes ) {
 260                 (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
 261
 262                 eval <<"                PERL";
 263                         package $pkg;
 264                         use base 'Fieldmapper';
 265                 PERL
 266
 267                 my $pos = 0;
 268                 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
 269                         $$fieldmap{$pkg}{fields}{$vfield} = { position => $pos, virtual => 1 };
 270                         $pos++;
 271                 }
 272
 273                 if (exists $$fieldmap{$pkg}{proto_fields}) {
 274                         for my $pfield ( sort keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
 275                                 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
 276                                 $pos++;
 277                         }
 278                 }
 279
 280                 unless ( $$fieldmap{$pkg}{virtual} ) {
 281                         $$fieldmap{$pkg}{cdbi} = $cdbi;
 282                         for my $col ( sort $cdbi->columns('Essential') ) {
 283                                 $$fieldmap{$pkg}{fields}{$col} = { position => $pos, virtual => 0 };
 284                                 $pos++;
 285                         }
 286                 }
 287
 288                 JSON->register_class_hint(
 289                         hint => $pkg->json_hint,
 290                         name => $pkg,
 291                         type => 'array',
 292                 );
 293
 294         }
 295 }
 296
 297 sub new {
 298         my $self = shift;
 299         my $value = shift;
 300         $value = [] unless (defined $value);
 301         return bless $value => $self->class_name;
 302 }
 303
 304 sub decast {
 305         my $self = shift;
 306         return [ @$self ];
 307 }
 308
 309 sub DESTROY {}
 310
 311 sub AUTOLOAD {
 312         my $obj = shift;
 313         my $value = shift;
 314         (my $field = $AUTOLOAD) =~ s/^.*://o;
 315         my $class_name = $obj->class_name;
 316
 317         my $fpos = $field;
 318         $fpos  =~ s/^clear_//og ;
 319
 320         my $pos = $$fieldmap{$class_name}{fields}{$fpos}{position};
 321
 322         if ($field =~ /^clear_/o) {
 323                 {       no strict 'subs';
 324                         *{$obj->class_name."::$field"} = sub {
 325                                 my $self = shift;
 326                                 $self->[$pos] = undef;
 327                                 return 1;
 328                         };
 329                 }
 330                 return $obj->$field();
 331         }
 332
 333         die "No field by the name $field in $class_name!"
 334                 unless (exists $$fieldmap{$class_name}{fields}{$field} && defined($pos));
 335
 336
 337         {       no strict 'subs';
 338                 *{$obj->class_name."::$field"} = sub {
 339                         my $self = shift;
 340                         my $new_val = shift;
 341                         $self->[$pos] = $new_val if (defined $new_val);
 342                         return $self->[$pos];
 343                 };
 344         }
 345         return $obj->$field($value);
 346 }
 347
 348 sub class_name {
 349         my $class_name = shift;
 350         return ref($class_name) || $class_name;
 351 }
 352
 353 sub real_fields {
 354         my $self = shift;
 355         my $class_name = $self->class_name;
 356         my $fields = $$fieldmap{$class_name}{fields};
 357
 358         my @f = grep {
 359                         !$$fields{$_}{virtual}
 360                 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
 361
 362         return @f;
 363 }
 364
 365 sub has_field {
 366         my $self = shift;
 367         my $field = shift;
 368         my $class_name = $self->class_name;
 369         return 1 if grep { $_ eq $field } keys %{$$fieldmap{$class_name}{fields}};
 370         return 0;
 371 }
 372
 373 sub properties {
 374         my $self = shift;
 375         my $class_name = $self->class_name;
 376         return keys %{$$fieldmap{$class_name}{fields}};
 377 }
 378
 379 sub clone {
 380         my $self = shift;
 381         return $self->new( [@$self] );
 382 }
 383
 384 sub api_level {
 385         my $self = shift;
 386         return $fieldmap->{$self->class_name}->{api_level};
 387 }
 388
 389 sub cdbi {
 390         my $self = shift;
 391         return $fieldmap->{$self->class_name}->{cdbi};
 392 }
 393
 394 sub is_virtual {
 395         my $self = shift;
 396         my $field = shift;
 397         return $fieldmap->{$self->class_name}->{proto_fields}->{$field} if ($field);
 398         return $fieldmap->{$self->class_name}->{virtual};
 399 }
 400
 401 sub is_readonly {
 402         my $self = shift;
 403         my $field = shift;
 404         return $fieldmap->{$self->class_name}->{readonly};
 405 }
 406
 407 sub json_hint {
 408         my $self = shift;
 409         return $fieldmap->{$self->class_name}->{hint};
 410 }
 411
 412
 413 1;