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