9176210d2c8d953ae7220ec2b13870f00e7e2855
[Evergreen.git] / Open-ILS / src / perlmods / OpenILS / Application / Storage / CDBI.pm
1 package OpenILS::Application::Storage::CDBI;
2 use base qw/Class::DBI/;
3 use Class::DBI;
4 use Class::DBI::AbstractSearch;
5
6 use OpenILS::Application::Storage::CDBI::actor;
7 use OpenILS::Application::Storage::CDBI::action;
8 use OpenILS::Application::Storage::CDBI::asset;
9 use OpenILS::Application::Storage::CDBI::biblio;
10 use OpenILS::Application::Storage::CDBI::config;
11 use OpenILS::Application::Storage::CDBI::metabib;
12 use OpenILS::Application::Storage::CDBI::money;
13 use OpenILS::Application::Storage::CDBI::permission;
14
15 use OpenSRF::Utils::Logger;
16 use OpenSRF::EX qw/:try/;
17
18 our $VERSION = undef;
19 my $log = 'OpenSRF::Utils::Logger';
20
21 sub child_init {
22         my $self = shift;
23
24         $log->debug("Creating ImaDBI Querys", DEBUG);
25         __PACKAGE__->set_sql( 'OILSFastSearch', <<"     SQL", 'Main');
26                 SELECT  %s
27                   FROM  %s
28                   WHERE %s = ?
29         SQL
30
31         __PACKAGE__->set_sql( 'OILSFastOrderedSearchLike', <<"  SQL", 'Main');
32                 SELECT  %s
33                   FROM  %s
34                   WHERE %s LIKE ?
35                   ORDER BY %s
36         SQL
37
38         __PACKAGE__->set_sql( 'OILSFastOrderedSearch', <<"      SQL", 'Main');
39                 SELECT  %s
40                   FROM  %s
41                   WHERE %s = ?
42                   ORDER BY %s
43         SQL
44
45         $log->debug("Calling Driver child_init", DEBUG);
46         $self->SUPER::child_init(@_);
47
48 }
49
50 sub fast_flesh_sth {
51         my $class = shift;
52         $class = ref($class) || $class;
53
54         my $field = shift;
55         my $value = shift;
56         my $order = shift;
57         my $like = shift;
58
59
60         if (!(defined($order) and ref($order) and ref($order) eq 'HASH')) {
61                 if (defined($value) and ref($value) and ref($value) eq 'HASH') {
62                         $order = $value;
63                         $value = undef;
64                 } else {
65                         $order = { order_by => $class->columns('Primary') }
66                 }
67         }
68
69         unless (defined $value) {
70                 $value = $field;
71                 $field = $class->primary_column;
72         }
73
74         unless (defined $field) {
75                 $field = $class->primary_column;
76         }
77
78         unless ($order->{order_by}) {
79                 $order = { order_by => $class->columns('Primary') }
80         }
81
82         my $fm_class = 'Fieldmapper::'.$class;
83         my $field_list = join ',', $class->columns('All');
84         
85         my $sth;
86         if (!$like) {
87                 $sth = $class->sql_OILSFastOrderedSearch( $field_list, $class->table, $field, $order->{order_by});
88         } else {
89                 $sth = $class->sql_OILSFastOrderedSearchLike( $field_list, $class->table, $field, $order->{order_by});
90         }
91         $sth->execute($value);
92         return $sth;
93 }
94
95 sub fast_flesh {
96         my $self = shift;
97         return map $class->construct($_), $self->fast_flesh_sth(@_)->fetchall_hash;
98 }
99
100 sub fast_fieldmapper {
101         my $self = shift;
102         my $id = shift;
103         my $col = shift;
104         my $like = shift;
105         my $options = shift;
106         my $class = ref($self) || $self;
107         my $fm_class = 'Fieldmapper::'.$class;
108         my @fms;
109         $log->debug("fast_fieldmapper() ==> Retrieving $fm_class", INTERNAL);
110         if ($like < 2) {
111                 for my $hash ($self->fast_flesh_sth( $col, "$id", { order_by => $col }, $like )->fetchall_hash) {
112                         my $fm = $fm_class->new;
113                         for my $field ( $fm_class->real_fields ) {
114                                 $fm->$field( $$hash{$field} );
115                         }
116                         push @fms, $fm;
117                 }
118         } else {
119                 my $search_type = 'search';
120                 if ($like == 2) {
121                         $search_type = 'search_fts'
122                 } elsif ($like == 3) {
123                         $search_type = 'search_regex'
124                 }
125
126                 for my $obj ($class->$search_type({ $col => $id}, $options)) {
127                         push @fms, $obj->to_fieldmapper;
128                 }
129         }
130         return @fms;
131 }
132
133 sub retrieve {
134         my $self = shift;
135         my $arg = shift;
136         if (ref($arg) and UNIVERSAL::isa($arg => 'Fieldmapper')) {
137                 $arg = $arg->id;
138         }
139         $log->debug("Retrieving $self with $arg", INTERNAL);
140         my $rec;
141         try {
142                 $rec = $self->SUPER::retrieve("$arg");
143         } catch Error with {
144                 $log->debug("Could not retrieve $self with $arg! -- ".shift(), DEBUG);
145                 return undef;
146         };
147         return $rec;
148 }
149
150 sub to_fieldmapper {
151         my $obj = shift;
152         my $class = ref($obj) || $obj;
153
154         my $fm_class = 'Fieldmapper::'.$class;
155         my $fm = $fm_class->new;
156
157         if (ref($obj)) {
158                 for my $field ( $fm->real_fields ) {
159                         $fm->$field( $obj->$field );
160                 }
161         }
162
163         return $fm;
164 }
165
166 sub create {
167         my $self = shift;
168         my $arg = shift;
169
170         $log->debug("\$arg is $arg (".ref($arg).")",DEBUG);
171
172         if (ref($arg) and UNIVERSAL::isa($arg => 'Fieldmapper')) {
173                 return $self->create_from_fieldmapper($arg,@_);
174         }
175
176         return $self->SUPER::create($arg,@_);
177 }
178
179 sub create_from_fieldmapper {
180         my $obj = shift;
181         my $fm = shift;
182         my @params = @_;
183
184         $log->debug("Creating node of type ".ref($fm), DEBUG);
185
186         my $class = ref($obj) || $obj;
187         my $primary = $class->primary_column;
188
189         if (ref $fm) {
190                 my %hash = map { defined $fm->$_ ?
191                                         ($_ => $fm->$_) :
192                                         ()
193                                 } grep { $_ ne $primary } $class->columns('All');
194
195                 if ($class->find_column( 'last_xact_id' )) {
196                         my $xact_id = $class->current_xact_id;
197                         throw Error unless ($xact_id);
198                         $hash{last_xact_id} = $xact_id;
199                 }
200
201                 return $class->create( \%hash, @params );
202         } else {
203                 return undef;
204         }
205 }
206
207 sub delete {
208         my $self = shift;
209         my $arg = shift;
210
211         my $class = ref($self) || $self;
212
213         if (ref($arg) and UNIVERSAL::isa($arg => 'Fieldmapper')) {
214                 $self = $self->retrieve($arg);
215                 unless (defined $self) {
216                         $log->debug("ARG! Couldn't retrieve record ".$arg->id, DEBUG);
217                         throw OpenSRF::EX::WARN ("ARG! Couldn't retrieve record ");
218                 }
219         }
220
221         if ($class->find_column( 'last_xact_id' )) {
222                 my $xact_id = $self->current_xact_id;
223                 throw Error unless ($xact_id);
224                 $self->last_xact_id( $class->current_xact_id );
225                 $self->SUPER::update;
226         }
227
228         $self->SUPER::delete;
229         return 1;
230 }
231
232 sub update {
233         my $self = shift;
234         my $arg = shift;
235
236         $log->debug("Attempting to update using $arg", DEBUG) if ($arg);
237
238         if (ref($arg) and UNIVERSAL::isa($arg => 'Fieldmapper')) {
239                 $self = $self->modify_from_fieldmapper($arg);
240                 $log->debug("Modification of $self seems to have failed....", DEBUG);
241                 return undef unless (defined $self);
242         }
243
244         $log->debug("Calling Class::DBI->update on modified object $self", DEBUG);
245         return $self->SUPER::update if ($self->is_changed);
246         return 0;
247 }
248
249 sub modify_from_fieldmapper {
250         my $obj = shift;
251         my $fm = shift;
252
253         $log->debug("Modifying object using fieldmapper", DEBUG);
254
255         my $class = ref($obj) || $obj;
256
257         if (!ref($obj)) {
258                 $obj = $class->retrieve($fm);
259                 unless ($obj) {
260                         $log->debug("Retrieve of $class using $fm (".$fm->id.") failed! -- ".shift(), ERROR);
261                         throw OpenSRF::EX::WARN ("No $class with id of ".$fm->id."!!");
262                 }
263         }
264
265         my %hash = map { defined $fm->$_ ?
266                                 ($_ => ''.$fm->$_) :
267                                 ()
268                         } $fm->real_fields;
269
270         my $au = $obj->autoupdate;
271         $obj->autoupdate(0);
272         
273         for my $field ( keys %hash ) {
274                 $obj->$field( $hash{$field} ) if ($obj->$field ne $hash{$field});
275                 $log->debug("Setting field $field on $obj to $hash{$field}",INTERNAL);
276         }
277
278         if ($class->find_column( 'last_xact_id' ) and $obj->is_changed) {
279                 my $xact_id = $obj->current_xact_id;
280                 throw Error unless ($xact_id);
281                 $obj->last_xact_id( $xact_id );
282         } else {
283                 $obj->autoupdate($au)
284         }
285
286         return $obj;
287 }
288
289
290
291         #-------------------------------------------------------------------------------
292         actor::user->has_a( home_ou => 'actor::org_unit' );
293         actor::user->has_a( card => 'actor::card' );
294         actor::user->has_a( standing => 'config::standing' );
295         actor::user->has_a( profile => 'actor::profile' );
296         actor::user->has_a( mailing_address => 'actor::user_address' );
297         actor::user->has_a( billing_address => 'actor::user_address' );
298         actor::user->has_a( ident_type => 'config::identification_type' );
299         actor::user->has_a( ident_type2 => 'config::identification_type' );
300         actor::user->has_a( net_access_level => 'config::net_access_level' );
301
302         actor::user_address->has_a( usr => 'actor::user' );
303         
304         actor::card->has_a( usr => 'actor::user' );
305         
306         actor::org_unit->has_a( parent_ou => 'actor::org_unit' );
307         actor::org_unit->has_a( ou_type => 'actor::org_unit_type' );
308         #actor::org_unit->has_a( address => 'actor::org_address' );
309
310         actor::stat_cat_entry->has_a( stat_cat => 'actor::stat_cat' );
311         actor::stat_cat->has_many( entries => 'actor::stat_cat_entry' );
312         actor::stat_cat_entry_user_map->has_a( stat_cat => 'actor::stat_cat' );
313         actor::stat_cat_entry_user_map->has_a( stat_cat_entry => 'actor::stat_cat_entry' );
314         actor::stat_cat_entry_user_map->has_a( target_usr => 'actor::user' );
315
316         asset::stat_cat_entry->has_a( stat_cat => 'asset::stat_cat' );
317         asset::stat_cat->has_many( entries => 'asset::stat_cat_entry' );
318         asset::stat_cat_entry_copy_map->has_a( stat_cat => 'asset::stat_cat' );
319         asset::stat_cat_entry_copy_map->has_a( stat_cat_entry => 'asset::stat_cat_entry' );
320         asset::stat_cat_entry_copy_map->has_a( owning_copy => 'asset::copy' );
321
322         action::survey_response->has_a( usr => 'actor::user' );
323         action::survey_response->has_a( survey => 'action::survey' );
324         action::survey_response->has_a( question => 'action::survey_question' );
325         action::survey_response->has_a( answer => 'action::survey_answer' );
326
327         action::survey_question->has_a( survey => 'action::survey' );
328
329         action::survey_answer->has_a( question => 'action::survey' );
330
331         asset::copy_note->has_a( owning_copy => 'asset::copy' );
332
333         actor::user->has_many( stat_cat_entries => [ 'actor::stat_cat_entry_user_map' => 'stat_cat_entry' ] );
334         actor::user->has_many( stat_cat_entry_user_maps => 'actor::stat_cat_entry_user_map' );
335
336         asset::copy->has_many( stat_cat_entries => [ 'asset::stat_cat_entry_copy_map' => 'stat_cat_entry' ] );
337         asset::copy->has_many( stat_cat_entry_copy_maps => 'asset::stat_cat_entry_copy_map' );
338
339         asset::copy->has_a( call_number => 'asset::call_number' );
340         asset::copy->has_a( creator => 'actor::user' );
341         asset::copy->has_a( editor => 'actor::user' );
342         asset::copy->has_a( status => 'config::copy_status' );
343         asset::copy->has_a( location => 'asset::copy_location' );
344         asset::copy->has_a( circ_lib => 'actor::org_unit' );
345
346         asset::call_number_note->has_a( call_number => 'asset::call_number' );
347
348         asset::call_number->has_a( record => 'biblio::record_entry' );
349         asset::call_number->has_a( creator => 'actor::user' );
350         asset::call_number->has_a( editor => 'actor::user' );
351
352         biblio::record_note->has_a( record => 'biblio::record_entry' );
353         
354         biblio::record_entry->has_a( creator => 'actor::user' );
355         biblio::record_entry->has_a( editor => 'actor::user' );
356         
357         metabib::metarecord->has_a( master_record => 'biblio::record_entry' );
358         
359         metabib::record_descriptor->has_a( record => 'biblio::record_entry' );
360         
361         metabib::full_rec->has_a( record => 'biblio::record_entry' );
362         
363         metabib::title_field_entry->has_a( source => 'biblio::record_entry' );
364         metabib::title_field_entry->has_a( field => 'config::metabib_field' );
365         
366         metabib::author_field_entry->has_a( source => 'biblio::record_entry' );
367         metabib::author_field_entry->has_a( field => 'config::metabib_field' );
368         
369         metabib::subject_field_entry->has_a( source => 'biblio::record_entry' );
370         metabib::subject_field_entry->has_a( field => 'config::metabib_field' );
371         
372         metabib::keyword_field_entry->has_a( source => 'biblio::record_entry' );
373         metabib::keyword_field_entry->has_a( field => 'config::metabib_field' );
374         
375         metabib::series_field_entry->has_a( source => 'biblio::record_entry' );
376         metabib::series_field_entry->has_a( field => 'config::metabib_field' );
377         
378         metabib::metarecord_source_map->has_a( metarecord => 'metabib::metarecord' );
379         metabib::metarecord_source_map->has_a( source => 'biblio::record_entry' );
380
381         action::circulation->has_a( usr => 'actor::user' );
382         action::circulation->has_a( target_copy => 'asset::copy' );
383         action::circulation->has_a( circ_lib => 'actor::org_unit' );
384
385         money::billable_transaction->has_a( usr => 'actor::user' );
386         
387         
388         #-------------------------------------------------------------------------------
389         actor::user->has_many( survey_responses => 'action::survey_response' );
390         actor::user->has_many( addresses => 'actor::user_address' );
391         actor::user->has_many( cards => 'actor::card' );
392
393         actor::org_unit->has_many( users => 'actor::user' );
394         actor::profile->has_many( users => 'actor::user' );
395
396         action::survey->has_many( questions => 'action::survey_question' );
397         action::survey->has_many( responses => 'action::survey_response' );
398         
399         action::survey_question->has_many( answers => 'action::survey_answer' );
400         action::survey_question->has_many( responses => 'action::survey_response' );
401
402         action::survey_answer->has_many( responses => 'action::survey_response' );
403
404         asset::copy->has_many( notes => 'asset::copy_note' );
405         asset::call_number->has_many( copies => 'asset::copy' );
406         asset::call_number->has_many( notes => 'asset::call_number_note' );
407
408         biblio::record_entry->has_many( record_descriptor => 'metabib::record_descriptor' );
409         biblio::record_entry->has_many( notes => 'biblio::record_note' );
410         biblio::record_entry->has_many( call_numbers => 'asset::call_number' );
411         biblio::record_entry->has_many( full_record_entries => 'metabib::full_rec' );
412         biblio::record_entry->has_many( title_field_entries => 'metabib::title_field_entry' );
413         biblio::record_entry->has_many( author_field_entries => 'metabib::author_field_entry' );
414         biblio::record_entry->has_many( subject_field_entries => 'metabib::subject_field_entry' );
415         biblio::record_entry->has_many( keyword_field_entries => 'metabib::keyword_field_entry' );
416         biblio::record_entry->has_many( series_field_entries => 'metabib::series_field_entry' );
417
418         metabib::metarecord->has_many( source_records => [ 'metabib::metarecord_source_map' => 'source'] );
419
420         money::billable_transaction->has_many( billings => 'money::billing' );
421         money::billable_transaction->has_many( payments => 'money::payment' );
422
423         money::billing->has_a( xact => 'money::billable_transaction' );
424         money::payment->has_a( xact => 'money::billable_transaction' );
425
426         money::cash_payment->has_a( xact => 'money::billable_transaction' );
427         money::cash_payment->has_a( accepting_usr => 'actor::user' );
428
429         money::check_payment->has_a( xact => 'money::billable_transaction' );
430         money::check_payment->has_a( accepting_usr => 'actor::user' );
431
432         money::credit_card_payment->has_a( xact => 'money::billable_transaction' );
433         money::credit_card_payment->has_a( accepting_usr => 'actor::user' );
434
435         money::forgive_payment->has_a( xact => 'money::billable_transaction' );
436         money::forgive_payment->has_a( accepting_usr => 'actor::user' );
437
438         money::work_payment->has_a( xact => 'money::billable_transaction' );
439         money::work_payment->has_a( accepting_usr => 'actor::user' );
440
441         money::credit_payment->has_a( xact => 'money::billable_transaction' );
442         money::credit_payment->has_a( accepting_usr => 'actor::user' );
443
444         permission::grp_tree->has_a( parent => 'permission::grp_tree' );
445
446         permission::grp_perm_map->has_a( grp => 'permission::grp_tree' );
447         permission::grp_perm_map->has_a(  perm => 'permission::perm_list' );
448         permission::grp_perm_map->has_a(  depth => 'actor::org_unit_type' );
449         
450         permission::usr_perm_map->has_a( usr => 'actor::user' );
451         permission::usr_perm_map->has_a(  perm => 'permission::perm_list' );
452         permission::usr_perm_map->has_a(  depth => 'actor::org_unit_type' );
453         
454         permission::usr_grp_map->has_a(  usr => 'actor::user' );
455         permission::usr_grp_map->has_a(  grp => 'permission::grp_tree' );
456
457         action::hold_notification->has_a(  hold => 'action::hold_request' );
458         
459         action::hold_copy_map->has_a(  hold => 'action::hold_request' );
460         action::hold_copy_map->has_a(  target_copy => 'asset::copy' );
461
462         action::hold_request->has_a(  current_copy => 'asset::copy' );
463         action::hold_request->has_a(  requestor => 'actor::user' );
464         action::hold_request->has_a(  usr => 'actor::user' );
465         action::hold_request->has_a(  pickup_lib => 'actor::org_unit' );
466
467         action::hold_request->has_many(  notifications => 'action::hold_notification' );
468         action::hold_request->has_many(  copy_maps => 'action::hold_copy_map' );
469
470         asset::copy->has_many(  hold_maps => 'action::hold_copy_map' );
471
472 1;