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;
18 use vars qw/$fieldmap $VERSION/;
22 sub publish_fieldmapper {
23 my ($self,$client,$class) = @_;
25 return $fieldmap unless (defined $class);
26 return undef unless (exists($$fieldmap{$class}));
27 return {$class => $$fieldmap{$class}};
29 __PACKAGE__->register_method(
30 api_name => 'opensrf.open-ils.system.fieldmapper',
32 method => 'publish_fieldmapper',
36 # To dump the Javascript version of the fieldmapper struct use the command:
38 # PERL5LIB=~/cvs/ILS/OpenSRF/src/perlmods/:~/cvs/ILS/Open-ILS/src/perlmods/ GEN_JS=1 perl -MOpenILS::Utils::Fieldmapper -e 'print "\n";'
40 # ... adjusted for your CVS sandbox, of course.
44 return () unless (defined $fieldmap);
45 return keys %$fieldmap;
49 return if (keys %$fieldmap);
53 'Fieldmapper::action::survey' => { hint => 'asv',
54 proto_fields => { questions => 1,
56 'Fieldmapper::action::survey_question' => { hint => 'asvq',
57 proto_fields => { answers => 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',
65 'Fieldmapper::action::open_circulation' => { hint => 'aoc',
68 'Fieldmapper::actor::user' => { hint => 'au',
69 proto_fields => { cards => 1,
70 survey_responses => 1,
71 stat_cat_entries => 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 } },
93 'Fieldmapper::biblio::record_node' => { hint => 'brn',
95 proto_fields => { children => 1,
106 'Fieldmapper::metabib::virtual_record' => { hint => 'mvr',
108 proto_fields => { title => 1,
117 types_of_resource => 1,
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
134 'Fieldmapper::money::payment' => { hint => 'mp',
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' },
144 'Fieldmapper::money::billing' => { hint => 'mb' },
145 'Fieldmapper::money::billable_transaction' => { hint => 'mbt' },
147 'Fieldmapper::money::open_user_summary' => { hint => 'mous',
149 'Fieldmapper::money::user_summary' => { hint => 'mus',
152 'Fieldmapper::money::open_user_circulation_summary' => { hint => 'moucs',
154 'Fieldmapper::money::user_circulation_summary' => { hint => 'mucs',
157 'Fieldmapper::money::open_billable_transaction_summary' => { hint => 'mobts',
159 'Fieldmapper::money::billable_transaction_summary' => { hint => 'mbts',
162 'Fieldmapper::config::identification_type' => { hint => 'cit' },
163 'Fieldmapper::config::bib_source' => { hint => 'cbs' },
164 'Fieldmapper::config::metabib_field' => { hint => 'cmf' },
165 'Fieldmapper::config::rules::recuring_fine' => { hint => 'crrf' },
166 'Fieldmapper::config::rules::circ_duration' => { hint => 'crcd' },
167 'Fieldmapper::config::rules::max_fine' => { hint => 'crmf' },
169 'Fieldmapper::authority::full_rec' => { hint => 'afr' },
170 'Fieldmapper::authority::record_descriptor' => { hint => 'ard' },
172 'Fieldmapper::metabib::metarecord' => { hint => 'mmr' },
173 'Fieldmapper::metabib::title_field_entry' => { hint => 'mtfe' },
174 'Fieldmapper::metabib::author_field_entry' => { hint => 'mafe' },
175 'Fieldmapper::metabib::subject_field_entry' => { hint => 'msfe' },
176 'Fieldmapper::metabib::keyword_field_entry' => { hint => 'mkfe' },
177 'Fieldmapper::metabib::series_field_entry' => { hint => 'msefe' },
178 'Fieldmapper::metabib::full_rec' => { hint => 'mfr' },
179 'Fieldmapper::metabib::record_descriptor' => { hint => 'mrd' },
180 'Fieldmapper::metabib::metarecord_source_map' => { hint => 'mmrsm'},
182 'Fieldmapper::asset::copy' => { hint => 'acp',
183 proto_fields => { stat_cat_entries => 1 } },
184 'Fieldmapper::asset::stat_cat' => { hint => 'asc',
185 proto_fields => { entries => 1 } },
186 'Fieldmapper::asset::stat_cat_entry' => { hint => 'asce' },
187 'Fieldmapper::asset::stat_cat_entry_copy_map' => { hint => 'ascecm' },
188 'Fieldmapper::asset::copy_note' => { hint => 'acpn' },
189 'Fieldmapper::asset::copy_location' => { hint => 'acpl' },
190 'Fieldmapper::asset::call_number' => { hint => 'acn',
191 proto_fields => { copies => 1 } },
192 'Fieldmapper::asset::call_number_note' => { hint => 'acnn' },
194 'Fieldmapper::permission::perm_list' => { hint => 'ppl' },
195 'Fieldmapper::permission::grp_tree' => { hint => 'pgt' },
196 'Fieldmapper::permission::usr_grp_map' => { hint => 'pugm' },
197 'Fieldmapper::permission::usr_perm_map' => { hint => 'pupm' },
198 'Fieldmapper::permission::grp_perm_map' => { hint => 'pgpm' },
199 'Fieldmapper::action::hold_request' => { hint => 'ahr', proto_fields => { status => 1 } },
200 'Fieldmapper::action::hold_notification' => { hint => 'ahn' },
201 'Fieldmapper::action::hold_copy_map' => { hint => 'ahcm' },
202 'Fieldmapper::action::hold_transit_copy' => { hint => 'ahtc' },
203 'Fieldmapper::action::transit_copy' => { hint => 'atc' },
204 'Fieldmapper::action::unfulfilled_hold_list' => { hint => 'aufh' },
207 'Fieldmapper::ex' => { hint => 'ex',
215 'Fieldmapper::perm_ex' => { hint => 'perm_ex',
226 #-------------------------------------------------------------------------------
227 # Now comes the evil! Generate classes
229 for my $pkg ( __PACKAGE__->classes ) {
230 (my $cdbi = $pkg) =~ s/^Fieldmapper:://o;
234 use base 'Fieldmapper';
238 for my $vfield ( qw/isnew ischanged isdeleted/ ) {
239 $$fieldmap{$pkg}{fields}{$vfield} = { position => $pos, virtual => 1 };
243 if (exists $$fieldmap{$pkg}{proto_fields}) {
244 for my $pfield ( sort keys %{ $$fieldmap{$pkg}{proto_fields} } ) {
245 $$fieldmap{$pkg}{fields}{$pfield} = { position => $pos, virtual => $$fieldmap{$pkg}{proto_fields}{$pfield} };
250 unless ( $$fieldmap{$pkg}{virtual} ) {
251 $$fieldmap{$pkg}{cdbi} = $cdbi;
252 for my $col ( sort $cdbi->columns('All') ) {
253 $$fieldmap{$pkg}{fields}{$col} = { position => $pos, virtual => 0 };
258 JSON->register_class_hint(
259 hint => $pkg->json_hint,
270 $value = [] unless (defined $value);
271 return bless $value => $self->class_name;
284 (my $field = $AUTOLOAD) =~ s/^.*://o;
285 my $class_name = $obj->class_name;
288 $fpos =~ s/^clear_//og ;
290 my $pos = $$fieldmap{$class_name}{fields}{$fpos}{position};
292 if ($field =~ /^clear_/o) {
294 *{$obj->class_name."::$field"} = sub {
296 $self->[$pos] = undef;
300 return $obj->$field();
303 die "No field by the name $field in $class_name!"
304 unless (exists $$fieldmap{$class_name}{fields}{$field} && defined($pos));
308 *{$obj->class_name."::$field"} = sub {
311 $self->[$pos] = $new_val if (defined $new_val);
312 return $self->[$pos];
315 return $obj->$field($value);
319 my $class_name = shift;
320 return ref($class_name) || $class_name;
325 my $class_name = $self->class_name;
326 my $fields = $$fieldmap{$class_name}{fields};
329 !$$fields{$_}{virtual}
330 } sort {$$fields{$a}{position} <=> $$fields{$b}{position}} keys %$fields;
337 my $class_name = $self->class_name;
338 return keys %{$$fieldmap{$class_name}{fields}};
343 return $self->new( [@$self] );
348 return $fieldmap->{$self->class_name}->{api_level};
353 return $fieldmap->{$self->class_name}->{cdbi};
359 return $fieldmap->{$self->class_name}->{proto_fields}->{$field} if ($field);
360 return $fieldmap->{$self->class_name}->{virtual};
366 return $fieldmap->{$self->class_name}->{readonly};
371 return $fieldmap->{$self->class_name}->{hint};