4 use base 'OpenSRF::Application';
6 use OpenSRF::Utils::Logger;
7 my $log = 'OpenSRF::Utils::Logger';
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;
19 use vars qw/$fieldmap $VERSION/;
23 sub publish_fieldmapper {
24 my ($self,$client,$class) = @_;
26 return $fieldmap unless (defined $class);
27 return undef unless (exists($$fieldmap{$class}));
28 return {$class => $$fieldmap{$class}};
30 __PACKAGE__->register_method(
31 api_name => 'opensrf.open-ils.system.fieldmapper',
33 method => 'publish_fieldmapper',
37 # To dump the Javascript version of the fieldmapper struct use the command:
39 # PERL5LIB=~/cvs/ILS/OpenSRF/src/perlmods/:~/cvs/ILS/Open-ILS/src/perlmods/ GEN_JS=1 perl -MOpenILS::Utils::Fieldmapper -e 'print "\n";'
41 # ... adjusted for your CVS sandbox, of course.
45 return () unless (defined $fieldmap);
46 return keys %$fieldmap;
50 return if (keys %$fieldmap);
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 } },
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' },
68 'Fieldmapper::action::survey' => { hint => 'asv',
69 proto_fields => { questions => 1,
71 'Fieldmapper::action::survey_question' => { hint => 'asvq',
72 proto_fields => { answers => 1,
74 'Fieldmapper::action::survey_answer' => { hint => 'asva',
75 proto_fields => { responses => 1 } },
76 'Fieldmapper::action::survey_response' => { hint => 'asvr' },
77 'Fieldmapper::action::circulation' => { hint => 'circ',
80 'Fieldmapper::action::open_circulation' => { hint => 'aoc',
83 'Fieldmapper::actor::user' => { hint => 'au',
84 proto_fields => { cards => 1,
85 survey_responses => 1,
86 stat_cat_entries => 1,
91 'Fieldmapper::actor::user_setting' => { hint => 'aus' },
92 'Fieldmapper::actor::org_unit_setting' => { hint => 'aous' },
93 'Fieldmapper::actor::user_address' => { hint => 'aua' },
94 'Fieldmapper::actor::org_address' => { hint => 'aoa' },
95 'Fieldmapper::actor::profile' => { hint => 'ap' },
96 'Fieldmapper::actor::card' => { hint => 'ac' },
97 'Fieldmapper::config::standing' => { hint => 'cst' },
98 'Fieldmapper::config::copy_status' => { hint => 'ccs' },
99 'Fieldmapper::actor::stat_cat' => { hint => 'actsc',
100 proto_fields => { entries => 1 } },
101 'Fieldmapper::actor::stat_cat_entry' => { hint => 'actsce' },
102 'Fieldmapper::actor::stat_cat_entry_user_map' => { hint => 'actscecm' },
103 'Fieldmapper::actor::org_unit' => { hint => 'aou',
104 proto_fields => { children => 1 } },
105 'Fieldmapper::actor::org_unit_type' => { hint => 'aout',
106 proto_fields => { children => 1 } },
108 'Fieldmapper::biblio::record_node' => { hint => 'brn',
110 proto_fields => { children => 1,
121 'Fieldmapper::metabib::virtual_record' => { hint => 'mvr',
123 proto_fields => { title => 1,
132 types_of_resource => 1,
142 'Fieldmapper::authority::record_entry' => { hint => 'are', },
143 'Fieldmapper::authority::record_note' => { hint => 'arn', },
144 'Fieldmapper::biblio::record_entry' => { hint => 'bre',
145 proto_fields => { call_numbers => 1,
146 fixed_fields => 1 } },
147 #'Fieldmapper::biblio::record_marc' => { hint => 'brx' }, # now it's inside record_entry
149 'Fieldmapper::money::payment' => { hint => 'mp',
152 'Fieldmapper::money::cash_payment' => { hint => 'mcp' },
153 'Fieldmapper::money::check_payment' => { hint => 'mckp' },
154 'Fieldmapper::money::credit_payment' => { hint => 'mcrp' },
155 'Fieldmapper::money::credit_card_payment' => { hint => 'mccp' },
156 'Fieldmapper::money::forgive_payment' => { hint => 'mfp' },
157 'Fieldmapper::money::work_payment' => { hint => 'mwp' },
159 'Fieldmapper::money::billing' => { hint => 'mb' },
160 'Fieldmapper::money::billable_transaction' => { hint => 'mbt' },
161 'Fieldmapper::money::grocery' => { hint => 'mg' },
163 'Fieldmapper::money::open_user_summary' => { hint => 'mous',
165 'Fieldmapper::money::user_summary' => { hint => 'mus',
168 'Fieldmapper::money::open_user_circulation_summary' => { hint => 'moucs',
170 'Fieldmapper::money::user_circulation_summary' => { hint => 'mucs',
173 'Fieldmapper::money::open_billable_transaction_summary' => { hint => 'mobts',
175 'Fieldmapper::money::billable_transaction_summary' => { hint => 'mbts',
178 'Fieldmapper::config::identification_type' => { hint => 'cit' },
179 'Fieldmapper::config::bib_source' => { hint => 'cbs' },
180 'Fieldmapper::config::metabib_field' => { hint => 'cmf' },
181 'Fieldmapper::config::rules::recuring_fine' => { hint => 'crrf' },
182 'Fieldmapper::config::rules::circ_duration' => { hint => 'crcd' },
183 'Fieldmapper::config::rules::max_fine' => { hint => 'crmf' },
185 'Fieldmapper::authority::full_rec' => { hint => 'afr' },
186 'Fieldmapper::authority::record_descriptor' => { hint => 'ard' },
188 'Fieldmapper::metabib::metarecord' => { hint => 'mmr' },
189 'Fieldmapper::metabib::title_field_entry' => { hint => 'mtfe' },
190 'Fieldmapper::metabib::author_field_entry' => { hint => 'mafe' },
191 'Fieldmapper::metabib::subject_field_entry' => { hint => 'msfe' },
192 'Fieldmapper::metabib::keyword_field_entry' => { hint => 'mkfe' },
193 'Fieldmapper::metabib::series_field_entry' => { hint => 'msefe' },
194 'Fieldmapper::metabib::full_rec' => { hint => 'mfr' },
195 'Fieldmapper::metabib::record_descriptor' => { hint => 'mrd' },
196 'Fieldmapper::metabib::metarecord_source_map' => { hint => 'mmrsm'},
198 'Fieldmapper::asset::copy' => { hint => 'acp',
199 proto_fields => { stat_cat_entries => 1 } },
200 'Fieldmapper::asset::stat_cat' => { hint => 'asc',
201 proto_fields => { entries => 1 } },
202 'Fieldmapper::asset::stat_cat_entry' => { hint => 'asce' },
203 'Fieldmapper::asset::stat_cat_entry_copy_map' => { hint => 'ascecm' },
204 'Fieldmapper::asset::copy_note' => { hint => 'acpn' },
205 'Fieldmapper::asset::copy_location' => { hint => 'acpl' },
206 'Fieldmapper::asset::call_number' => { hint => 'acn',
207 proto_fields => { copies => 1 } },
208 'Fieldmapper::asset::call_number_note' => { hint => 'acnn' },
210 'Fieldmapper::permission::perm_list' => { hint => 'ppl' },
211 'Fieldmapper::permission::grp_tree' => { hint => 'pgt', proto_fields => { children => 1 } },
212 'Fieldmapper::permission::usr_grp_map' => { hint => 'pugm' },
213 'Fieldmapper::permission::usr_perm_map' => { hint => 'pupm' },
214 'Fieldmapper::permission::grp_perm_map' => { hint => 'pgpm' },
215 'Fieldmapper::action::hold_request' => { hint => 'ahr', proto_fields => { status => 1 } },
216 'Fieldmapper::action::hold_notification' => { hint => 'ahn' },
217 'Fieldmapper::action::hold_copy_map' => { hint => 'ahcm' },
218 'Fieldmapper::action::hold_transit_copy' => { hint => 'ahtc' },
219 'Fieldmapper::action::transit_copy' => { hint => 'atc' },
220 'Fieldmapper::action::unfulfilled_hold_list' => { hint => 'aufh' },
223 'Fieldmapper::ex' => { hint => 'ex',
231 'Fieldmapper::perm_ex' => { hint => 'perm_ex',
242 #-------------------------------------------------------------------------------
243 # Now comes the evil! Generate classes
245 for my $pkg ( __PACKAGE__->classes ) {
246 (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
250 use base 'Fieldmapper';
254 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
255 $$fieldmap{$pkg}{fields}{$vfield} = { position => $pos, virtual => 1 };
259 if (exists $$fieldmap{$pkg}{proto_fields}) {
260 for my $pfield ( sort keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
261 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
266 unless ( $$fieldmap{$pkg}{virtual} ) {
267 $$fieldmap{$pkg}{cdbi} = $cdbi;
268 for my $col ( sort $cdbi->columns('All') ) {
269 $$fieldmap{$pkg}{fields}{$col} = { position => $pos, virtual => 0 };
274 JSON->register_class_hint(
275 hint => $pkg->json_hint,
286 $value = [] unless (defined $value);
287 return bless $value => $self->class_name;
300 (my $field = $AUTOLOAD) =~ s/^.*://o;
301 my $class_name = $obj->class_name;
304 $fpos =~ s/^clear_//og ;
306 my $pos = $$fieldmap{$class_name}{fields}{$fpos}{position};
308 if ($field =~ /^clear_/o) {
310 *{$obj->class_name."::$field"} = sub {
312 $self->[$pos] = undef;
316 return $obj->$field();
319 die "No field by the name $field in $class_name!"
320 unless (exists $$fieldmap{$class_name}{fields}{$field} && defined($pos));
324 *{$obj->class_name."::$field"} = sub {
327 $self->[$pos] = $new_val if (defined $new_val);
328 return $self->[$pos];
331 return $obj->$field($value);
335 my $class_name = shift;
336 return ref($class_name) || $class_name;
341 my $class_name = $self->class_name;
342 my $fields = $$fieldmap{$class_name}{fields};
345 !$$fields{$_}{virtual}
346 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
353 my $class_name = $self->class_name;
354 return keys %{$$fieldmap{$class_name}{fields}};
359 return $self->new( [@$self] );
364 return $fieldmap->{$self->class_name}->{api_level};
369 return $fieldmap->{$self->class_name}->{cdbi};
375 return $fieldmap->{$self->class_name}->{proto_fields}->{$field} if ($field);
376 return $fieldmap->{$self->class_name}->{virtual};
382 return $fieldmap->{$self->class_name}->{readonly};
387 return $fieldmap->{$self->class_name}->{hint};