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                                                                                              copy_count         => 1,
 146                                                                                              series             => 1,
 147                                                                                              serials            => 1,
 148                                                                                            } },
 149
 150                 'Fieldmapper::authority::record_entry'          => { hint               => 'are', },
 151                 'Fieldmapper::authority::record_note'           => { hint               => 'arn', },
 152                 'Fieldmapper::biblio::record_note'              => { hint               => 'bren', },
 153                 'Fieldmapper::biblio::record_entry'             => { hint               => 'bre',
 154                                                                      proto_fields       => { call_numbers => 1,
 155                                                                                              fixed_fields => 1 } },
 156                 #'Fieldmapper::biblio::record_marc'             => { hint => 'brx'  }, # now it's inside record_entry
 157
 158                 'Fieldmapper::money::payment'                   => { hint => 'mp',
 159                                                                      readonly   => 1 },
 160
 161                 'Fieldmapper::money::cash_payment'              => { hint => 'mcp'  },
 162                 'Fieldmapper::money::check_payment'             => { hint => 'mckp'  },
 163                 'Fieldmapper::money::credit_payment'            => { hint => 'mcrp'  },
 164                 'Fieldmapper::money::credit_card_payment'       => { hint => 'mccp'  },
 165                 'Fieldmapper::money::forgive_payment'           => { hint => 'mfp'  },
 166                 'Fieldmapper::money::work_payment'              => { hint => 'mwp'  },
 167
 168                 'Fieldmapper::money::billing'                   => { hint => 'mb'  },
 169                 'Fieldmapper::money::billable_transaction'      => { hint => 'mbt'  },
 170                 'Fieldmapper::money::grocery'                   => { hint => 'mg'  },
 171
 172                 'Fieldmapper::money::open_user_summary'         => { hint       => 'mous',
 173                                                                      readonly   => 1 },
 174                 'Fieldmapper::money::user_summary'              => { hint       => 'mus',
 175                                                                      readonly   => 1 },
 176
 177                 'Fieldmapper::money::open_user_circulation_summary'     => { hint       => 'moucs',
 178                                                                              readonly   => 1 },
 179                 'Fieldmapper::money::user_circulation_summary'  => { hint       => 'mucs',
 180                                                                      readonly   => 1 },
 181
 182                 'Fieldmapper::money::open_billable_transaction_summary' => { hint       => 'mobts',
 183                                                                              readonly   => 1 },
 184                 'Fieldmapper::money::billable_transaction_summary'      => { hint       => 'mbts',
 185                                                                              readonly   => 1 },
 186
 187                 'Fieldmapper::config::identification_type'      => { hint => 'cit'  },
 188                 'Fieldmapper::config::bib_source'               => { hint => 'cbs'  },
 189                 'Fieldmapper::config::metabib_field'            => { hint => 'cmf'  },
 190                 'Fieldmapper::config::rules::recuring_fine'     => { hint => 'crrf'  },
 191                 'Fieldmapper::config::rules::circ_duration'     => { hint => 'crcd'  },
 192                 'Fieldmapper::config::rules::max_fine'          => { hint => 'crmf'  },
 193                 'Fieldmapper::config::non_cataloged_type'       => { hint => 'cnct'   },
 194                 'Fieldmapper::config::standing'                 => { hint => 'cst'   },
 195                 'Fieldmapper::config::copy_status'              => { hint => 'ccs'   },
 196
 197                 'Fieldmapper::authority::full_rec'              => { hint => 'afr'  },
 198                 'Fieldmapper::authority::record_descriptor'     => { hint => 'ard'  },
 199
 200                 'Fieldmapper::metabib::metarecord'              => { hint => 'mmr'  },
 201                 'Fieldmapper::metabib::title_field_entry'       => { hint => 'mtfe' },
 202                 'Fieldmapper::metabib::author_field_entry'      => { hint => 'mafe' },
 203                 'Fieldmapper::metabib::subject_field_entry'     => { hint => 'msfe' },
 204                 'Fieldmapper::metabib::keyword_field_entry'     => { hint => 'mkfe' },
 205                 'Fieldmapper::metabib::series_field_entry'      => { hint => 'msefe' },
 206                 'Fieldmapper::metabib::full_rec'                => { hint => 'mfr'  },
 207                 'Fieldmapper::metabib::record_descriptor'       => { hint => 'mrd'  },
 208                 'Fieldmapper::metabib::metarecord_source_map'   => { hint => 'mmrsm'},
 209
 210                 'Fieldmapper::asset::copy'                      => { hint               => 'acp',
 211                                                                      proto_fields       => { stat_cat_entries => 1 } },
 212                 'Fieldmapper::asset::stat_cat'                  => { hint               => 'asc',
 213                                                                      proto_fields       => { entries => 1 } },
 214                 'Fieldmapper::asset::stat_cat_entry'            => { hint => 'asce'    },
 215                 'Fieldmapper::asset::stat_cat_entry_copy_map'   => { hint => 'ascecm'  },
 216                 'Fieldmapper::asset::copy_note'                 => { hint => 'acpn'    },
 217                 'Fieldmapper::asset::copy_location'             => { hint => 'acpl'    },
 218                 'Fieldmapper::asset::call_number'               => { hint               => 'acn',
 219                                                                      proto_fields       => { copies => 1 } },
 220                 'Fieldmapper::asset::call_number_note'          => { hint => 'acnn'    },
 221
 222                 'Fieldmapper::permission::perm_list'            => { hint => 'ppl'    },
 223                 'Fieldmapper::permission::grp_tree'             => { hint => 'pgt', proto_fields => { children => 1 } },
 224                 'Fieldmapper::permission::usr_grp_map'          => { hint => 'pugm'   },
 225                 'Fieldmapper::permission::usr_perm_map'         => { hint => 'pupm'   },
 226                 'Fieldmapper::permission::grp_perm_map'         => { hint => 'pgpm'   },
 227                 'Fieldmapper::action::hold_request'             => { hint => 'ahr', proto_fields => { status => 1 } },
 228                 'Fieldmapper::action::hold_notification'        => { hint => 'ahn'    },
 229                 'Fieldmapper::action::hold_copy_map'            => { hint => 'ahcm'   },
 230                 'Fieldmapper::action::hold_transit_copy'        => { hint => 'ahtc'   },
 231                 'Fieldmapper::action::transit_copy'             => { hint => 'atc'    },
 232                 'Fieldmapper::action::unfulfilled_hold_list'    => { hint => 'aufh'   },
 233
 234
 235                 'Fieldmapper::ex'                               => { hint           => 'ex',
 236                                                                      virtual        => 1,
 237                                                                      proto_fields   => {
 238                                                                         err_msg  => 1,
 239                                                                         type     => 1,
 240                                                                      } },
 241
 242
 243                 'Fieldmapper::perm_ex'                          => { hint           => 'perm_ex',
 244                                                                      virtual        => 1,
 245                                                                      proto_fields   => {
 246                                                                         err_msg => 1,
 247                                                                         type    => 1,
 248                                                                      } },
 249
 250
 251
 252         };
 253
 254         #-------------------------------------------------------------------------------
 255         # Now comes the evil!  Generate classes
 256
 257         for my $pkg ( __PACKAGE__->classes ) {
 258                 (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
 259
 260                 eval <<"                PERL";
 261                         package $pkg;
 262                         use base 'Fieldmapper';
 263                 PERL
 264
 265                 my $pos = 0;
 266                 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
 267                         $$fieldmap{$pkg}{fields}{$vfield} = { position => $pos, virtual => 1 };
 268                         $pos++;
 269                 }
 270
 271                 if (exists $$fieldmap{$pkg}{proto_fields}) {
 272                         for my $pfield ( sort keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
 273                                 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
 274                                 $pos++;
 275                         }
 276                 }
 277
 278                 unless ( $$fieldmap{$pkg}{virtual} ) {
 279                         $$fieldmap{$pkg}{cdbi} = $cdbi;
 280                         for my $col ( sort $cdbi->columns('Essential') ) {
 281                                 $$fieldmap{$pkg}{fields}{$col} = { position => $pos, virtual => 0 };
 282                                 $pos++;
 283                         }
 284                 }
 285
 286                 JSON->register_class_hint(
 287                         hint => $pkg->json_hint,
 288                         name => $pkg,
 289                         type => 'array',
 290                 );
 291
 292         }
 293 }
 294
 295 sub new {
 296         my $self = shift;
 297         my $value = shift;
 298         $value = [] unless (defined $value);
 299         return bless $value => $self->class_name;
 300 }
 301
 302 sub decast {
 303         my $self = shift;
 304         return [ @$self ];
 305 }
 306
 307 sub DESTROY {}
 308
 309 sub AUTOLOAD {
 310         my $obj = shift;
 311         my $value = shift;
 312         (my $field = $AUTOLOAD) =~ s/^.*://o;
 313         my $class_name = $obj->class_name;
 314
 315         my $fpos = $field;
 316         $fpos  =~ s/^clear_//og ;
 317
 318         my $pos = $$fieldmap{$class_name}{fields}{$fpos}{position};
 319
 320         if ($field =~ /^clear_/o) {
 321                 {       no strict 'subs';
 322                         *{$obj->class_name."::$field"} = sub {
 323                                 my $self = shift;
 324                                 $self->[$pos] = undef;
 325                                 return 1;
 326                         };
 327                 }
 328                 return $obj->$field();
 329         }
 330
 331         die "No field by the name $field in $class_name!"
 332                 unless (exists $$fieldmap{$class_name}{fields}{$field} && defined($pos));
 333
 334
 335         {       no strict 'subs';
 336                 *{$obj->class_name."::$field"} = sub {
 337                         my $self = shift;
 338                         my $new_val = shift;
 339                         $self->[$pos] = $new_val if (defined $new_val);
 340                         return $self->[$pos];
 341                 };
 342         }
 343         return $obj->$field($value);
 344 }
 345
 346 sub class_name {
 347         my $class_name = shift;
 348         return ref($class_name) || $class_name;
 349 }
 350
 351 sub real_fields {
 352         my $self = shift;
 353         my $class_name = $self->class_name;
 354         my $fields = $$fieldmap{$class_name}{fields};
 355
 356         my @f = grep {
 357                         !$$fields{$_}{virtual}
 358                 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
 359
 360         return @f;
 361 }
 362
 363 sub has_field {
 364         my $self = shift;
 365         my $field = shift;
 366         my $class_name = $self->class_name;
 367         return 1 if grep { $_ eq $field } keys %{$$fieldmap{$class_name}{fields}};
 368         return 0;
 369 }
 370
 371 sub properties {
 372         my $self = shift;
 373         my $class_name = $self->class_name;
 374         return keys %{$$fieldmap{$class_name}{fields}};
 375 }
 376
 377 sub clone {
 378         my $self = shift;
 379         return $self->new( [@$self] );
 380 }
 381
 382 sub api_level {
 383         my $self = shift;
 384         return $fieldmap->{$self->class_name}->{api_level};
 385 }
 386
 387 sub cdbi {
 388         my $self = shift;
 389         return $fieldmap->{$self->class_name}->{cdbi};
 390 }
 391
 392 sub is_virtual {
 393         my $self = shift;
 394         my $field = shift;
 395         return $fieldmap->{$self->class_name}->{proto_fields}->{$field} if ($field);
 396         return $fieldmap->{$self->class_name}->{virtual};
 397 }
 398
 399 sub is_readonly {
 400         my $self = shift;
 401         my $field = shift;
 402         return $fieldmap->{$self->class_name}->{readonly};
 403 }
 404
 405 sub json_hint {
 406         my $self = shift;
 407         return $fieldmap->{$self->class_name}->{hint};
 408 }
 409
 410
 411 1;