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