fixing money::user_circulation_summary view class
[Evergreen.git] / Open-ILS / src / perlmods / OpenILS / Application / Storage / Publisher.pm
1 package OpenILS::Application::Storage::Publisher;
2 use base qw/OpenILS::Application::Storage/;
3 our $VERSION = 1;
4
5 use Digest::MD5 qw/md5_hex/;
6 use OpenSRF::EX qw/:try/;
7 use OpenSRF::Utils;
8 use OpenSRF::Utils::Logger qw/:level/;
9 use OpenILS::Utils::Fieldmapper;
10
11 my $log = 'OpenSRF::Utils::Logger';
12
13
14 sub register_method {
15         my $class = shift;
16         my %args = @_;
17         my %dup_args = %args;
18
19         $class = ref($class) || $class;
20
21         $args{package} ||= $class;
22         __PACKAGE__->SUPER::register_method( %args );
23
24         if (exists($dup_args{cachable}) and $dup_args{cachable}) {
25                 (my $name = $dup_args{api_name}) =~ s/^open-ils\.storage/open-ils.storage.cachable/o;
26                 if ($name ne $dup_args{api_name}) {
27                         $dup_args{real_api_name} = $dup_args{api_name};
28                         $dup_args{method} = 'cachable_wrapper';
29                         $dup_args{api_name} = $name;
30                         $dup_args{package} = __PACKAGE__;
31                         __PACKAGE__->SUPER::register_method( %dup_args );
32                 }
33         }
34 }
35
36 sub cachable_wrapper {
37         my $self = shift;
38         my $client = shift;
39         my @args = @_;
40
41         my %cache_args = (
42                 limit           => 100,
43                 offset          => 0,
44                 timeout         => 7200,
45                 cache_page_size => 1000,
46         );
47
48         my @real_args;
49         my $key_string = $self->api_name;
50         for (my $ind = 0; $ind < scalar(@args); $ind++) {
51                 if (    $args[$ind] eq 'limit' ||
52                         $args[$ind] eq 'offset' ||
53                         $args[$ind] eq 'cache_page_size' ||
54                         $args[$ind] eq 'timeout' ) {
55
56                         my $key_ind = $ind;
57                         $ind++;
58                         my $value_ind = $ind;
59                         $cache_args{$args[$key_ind]} = $args[$value_ind];
60                         $log->debug("Cache limiter value for $args[$key_ind] is $args[$value_ind]", INTERNAL);
61                         next;
62                 }
63                 $key_string .= $args[$ind];
64                 $log->debug("Partial cache key value is $args[$ind]", INTERNAL);
65                 push @real_args, $args[$ind];
66         }
67
68         my $cache_page = int($cache_args{offset} / $cache_args{cache_page_size});
69         my $cache_key;
70         {       use bytes;
71                 $cache_key = md5_hex($key_string.$cache_page);
72         }
73
74         $log->debug("Key string for cache lookup is $key_string -> $cache_key", DEBUG);
75         $log->debug("Cache page is $cache_page", DEBUG);
76
77         my $cached_res = OpenSRF::Utils::Cache->new->get_cache( $cache_key );
78         if (defined $cached_res) {
79                 $log->debug("Found ".scalar(@$cached_res)." records in the cache", INFO);
80                 $log->debug("Values from cache: ".join(', ', @$cached_res), INTERNAL);
81                 my $start = int($cache_args{offset} - ($cache_page * $cache_args{cache_page_size}));
82                 my $end = int($start + $cache_args{limit} - 1);
83                 $log->debug("Responding with values from ".$start.' to '.$end,DEBUG);
84                 $client->respond( $_ ) for ( grep { defined } @$cached_res[ $start .. $end ]);
85                 return undef;
86         }
87
88         my $method = $self->method_lookup($self->{real_api_name});
89         my @res = $method->run(@real_args);
90
91
92         $client->respond( $_ ) for ( grep { defined } @res[$cache_args{offset} .. int($cache_args{offset} + $cache_args{limit} - 1)] );
93
94         $log->debug("Saving values from ".int($cache_page * $cache_args{cache_page_size})." to ".
95                 int(($cache_page + 1) * $cache_args{cache_page_size}). "to the cache", INTERNAL);
96         try {
97                 OpenSRF::Utils::Cache->new->put_cache(
98                         $cache_key =>
99                         [@res[int($cache_page * $cache_args{cache_page_size}) .. int(($cache_page + 1) * $cache_args{cache_page_size}) ]] =>
100                         OpenSRF::Utils->interval_to_seconds( $cache_args{timeout} )
101                 );
102         } catch Error with {
103                 my $e = shift;
104                 $log->error("Cache seems to be down, $e");
105         };
106
107         return undef;
108 }
109
110 sub retrieve_node {
111         my $self = shift;
112         my $client = shift;
113         my @ids = @_;
114
115         my $cdbi = $self->{cdbi};
116
117         for my $id ( @ids ) {
118                 next unless ($id);
119
120                 my ($rec) = $cdbi->fast_fieldmapper($id);
121                 if ($self->api_name !~ /batch/o) {
122                         return $rec if ($rec);
123                 }
124                 $client->respond($rec);
125         }
126         return undef;
127 }
128
129 sub search_where {
130         my $self = shift;
131         my $client = shift;
132         my @args = @_;
133
134         my $cdbi = $self->{cdbi};
135
136         for my $obj ($cdbi->search_where(@args)) {
137                 next unless ref($obj);
138                 $client->respond( $obj->to_fieldmapper );
139         }
140         return undef;
141 }
142
143 sub search {
144         my $self = shift;
145         my $client = shift;
146         my @args = @_;
147
148         my $cdbi = $self->{cdbi};
149
150         (my $search_type = $self->api_name) =~ s/.*\.(search[^.]*).*/$1/o;
151
152         for my $obj ($cdbi->$search_type(@args)) {
153                 next unless ref($obj);
154                 $client->respond( $obj->to_fieldmapper );
155         }
156         return undef;
157 }
158
159 sub search_one_field {
160         my $self = shift;
161         my $client = shift;
162         my @args = @_;
163
164         (my $field = $self->api_name) =~ s/.*\.([^\.]+)$/$1/o;
165
166         return search( $self, $client, $field, @args );
167 }
168
169 sub old_search_one_field {
170         my $self = shift;
171         my $client = shift;
172         my @terms = @_;
173
174         (my $search_type = $self->api_name) =~ s/.*\.(search[^.]*).*/$1/o;
175         (my $col = $self->api_name) =~ s/.*\.$search_type\.([^.]+).*/$1/;
176         my $cdbi = $self->{cdbi};
177
178         my $like = 0;
179         $like = 1 if ($search_type =~ /like$/o);
180         $like = 2 if ($search_type =~ /fts$/o);
181         $like = 3 if ($search_type =~ /regex$/o);
182
183         for my $term (@terms) {
184                 $log->debug("Searching $cdbi for $col using type $search_type, value '$term'",DEBUG);
185                 if (@terms == 1) {
186                         return [ $cdbi->fast_fieldmapper($term,$col,$like) ];
187                 }
188                 $client->respond( [ $cdbi->fast_fieldmapper($term,$col,$like) ] );
189         }
190         return undef;
191 }
192
193
194 sub create_node {
195         my $self = shift;
196         my $client = shift;
197         my $node = shift;
198
199         my $cdbi = $self->{cdbi};
200
201         my $success;
202         try {
203                 my $rec = $cdbi->create($node);
204                 $success = $rec->id if ($rec);
205         } catch Error with {
206                 $success = 0;
207         };
208
209         return $success;
210 }
211
212 sub update_node {
213         my $self = shift;
214         my $client = shift;
215         my $node = shift;
216
217         my $cdbi = $self->{cdbi};
218
219         return $cdbi->update($node);
220 }
221
222 sub mass_delete {
223         my $self = shift;
224         my $client = shift;
225         my $search = shift;
226
227         my $where = 'WHERE ';
228
229         my $cdbi = $self->{cdbi};
230         my $table = $cdbi->table;
231
232         my @keys = sort keys %$search;
233         
234         my @binds;
235         my @wheres;
236         for my $col ( @keys ) {
237                 if (ref($$search{$col}) and ref($$search{$col}) =~ /ARRAY/o) {
238                         push @wheres, "$col IN (" . join(',', map { '?' } @{ $$search{$col} }) . ')';
239                         push @binds, map { "$_" } @{ $$search{$col} };
240                 } else {
241                         push @wheres, "$col = ?";
242                         push @binds, $$search{$col};
243                 }
244         }
245         $where .= join ' AND ', @wheres;
246
247         my $delete = "DELETE FROM $table $where";
248
249         $log->debug("Performing MASS deletion : $delete",DEBUG);
250
251         my $dbh = $cdbi->db_Main;
252         my $success = 1;
253         try {
254                 my $sth = $dbh->prepare($delete);
255                 $sth->execute( @binds );
256                 $sth->finish;
257                 $log->debug("MASS Delete succeeded",DEBUG);
258         } catch Error with {
259                 $log->debug("MASS Delete FAILED : ".shift(),DEBUG);
260                 $success = 0;
261         };
262         return $success;
263 }
264
265 sub remote_update_node {
266         my $self = shift;
267         my $client = shift;
268         my $keys = shift;
269         my $vals = shift;
270
271         my $cdbi = $self->{cdbi};
272
273         my $success = 1;
274         try {
275                 $success = $cdbi->remote_update($keys,$vals);
276         } catch Error with {
277                 $success = 0;
278         };
279         return $success;
280 }
281
282 sub merge_node {
283         my $self = shift;
284         my $client = shift;
285         my $keys = shift;
286         my $vals = shift;
287
288         my $cdbi = $self->{cdbi};
289
290         my $success = 1;
291         try {
292                 $success = $cdbi->merge($keys,$vals)->id;
293         } catch Error with {
294                 $success = 0;
295         };
296         return $success;
297 }
298
299 sub delete_node {
300         my $self = shift;
301         my $client = shift;
302         my $node = shift;
303
304         my $cdbi = $self->{cdbi};
305
306         my $success = 1;
307         try {
308                 $success = $cdbi->delete($node);
309         } catch Error with {
310                 $success = 0;
311         };
312         return $success;
313 }
314
315 sub batch_call {
316         my $self = shift;
317         my $client = shift;
318         my @nodes = @_;
319
320         my $unwrap = $self->{unwrap};
321
322         my $cdbi = $self->{cdbi};
323         my $api_name = $self->api_name;
324         (my $single_call_api_name = $api_name) =~ s/batch\.//o;
325
326         $log->debug("Default $api_name looking up $single_call_api_name...",INTERNAL);
327         my $method = $self->method_lookup($single_call_api_name);
328
329         my @success;
330         while ( my $node = shift(@nodes) ) {
331                 my ($res) = $method->run( ($unwrap ? (@$node) : ($node)) ); 
332                 push(@success, 1) if ($res >= 0);
333         }
334
335         my $insert_total = 0;
336         $insert_total += $_ for (@success);
337
338         return $insert_total;
339 }
340
341 eval '
342 use OpenILS::Application::Storage::Publisher::actor;
343 use OpenILS::Application::Storage::Publisher::action;
344 use OpenILS::Application::Storage::Publisher::asset;
345 use OpenILS::Application::Storage::Publisher::biblio;
346 use OpenILS::Application::Storage::Publisher::config;
347 use OpenILS::Application::Storage::Publisher::metabib;
348 use OpenILS::Application::Storage::Publisher::money;
349 use OpenILS::Application::Storage::Publisher::permission;
350 ';
351
352 if ($@) {
353         $log->debug("ARG! Couldn't load (at least one) class Publisher: $@", ERROR);
354         throw OpenSRF::EX::ERROR ("ARG! Couldn't load (at least one) class Publisher: $@");
355 }
356
357
358 for my $fmclass ( (Fieldmapper->classes) ) {
359
360         $log->debug("Generating methods for Fieldmapper class $fmclass", DEBUG);
361
362         next if ($fmclass->is_virtual);
363
364         (my $cdbi = $fmclass) =~ s/^Fieldmapper:://o;
365         (my $class = $cdbi) =~ s/::.*//o;
366         (my $api_class = $cdbi) =~ s/::/./go;
367         my $registration_class = __PACKAGE__ . "::$class";
368         my $api_prefix = 'open-ils.storage.direct.'.$api_class;
369
370         # Create the search methods
371         unless ( __PACKAGE__->is_registered( $api_prefix.'.search' ) ) {
372                 __PACKAGE__->register_method(
373                         api_name        => $api_prefix.'.search',
374                         method          => 'search',
375                         api_level       => 1,
376                         stream          => 1,
377                         cdbi            => $cdbi,
378                         cachable        => 1,
379                 );
380         }
381
382         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_where' ) ) {
383                 __PACKAGE__->register_method(
384                         api_name        => $api_prefix.'.search_where',
385                         method          => 'search_where',
386                         api_level       => 1,
387                         stream          => 1,
388                         cdbi            => $cdbi,
389                         cachable        => 1,
390                 );
391         }
392
393         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_like' ) ) {
394                 __PACKAGE__->register_method(
395                         api_name        => $api_prefix.'.search_like',
396                         method          => 'search',
397                         api_level       => 1,
398                         stream          => 1,
399                         cdbi            => $cdbi,
400                         cachable        => 1,
401                 );
402         }
403
404         if (\&Class::DBI::search_fts) {
405                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search_fts' ) ) {
406                         __PACKAGE__->register_method(
407                                 api_name        => $api_prefix.'.search_fts',
408                                 method          => 'search',
409                                 api_level       => 1,
410                                 stream          => 1,
411                                 cdbi            => $cdbi,
412                                 cachable        => 1,
413                         );
414                 }
415         }
416
417         if (\&Class::DBI::search_regex) {
418                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search_regex' ) ) {
419                         __PACKAGE__->register_method(
420                                 api_name        => $api_prefix.'.search_regex',
421                                 method          => 'search',
422                                 api_level       => 1,
423                                 stream          => 1,
424                                 cdbi            => $cdbi,
425                                 cachable        => 1,
426                         );
427                 }
428         }
429
430         if (\&Class::DBI::search_ilike) {
431                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search_ilike' ) ) {
432                         __PACKAGE__->register_method(
433                                 api_name        => $api_prefix.'.search_ilike',
434                                 method          => 'search',
435                                 api_level       => 1,
436                                 stream          => 1,
437                                 cdbi            => $cdbi,
438                                 cachable        => 1,
439                         );
440                 }
441         }
442
443         # Create the retrieve method
444         unless ( __PACKAGE__->is_registered( $api_prefix.'.retrieve' ) ) {
445                 __PACKAGE__->register_method(
446                         api_name        => $api_prefix.'.retrieve',
447                         method          => 'retrieve_node',
448                         api_level       => 1,
449                         cdbi            => $cdbi,
450                         cachable        => 1,
451                 );
452         }
453
454         # Create the batch retrieve method
455         unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.retrieve' ) ) {
456                 __PACKAGE__->register_method(
457                         api_name        => $api_prefix.'.batch.retrieve',
458                         method          => 'retrieve_node',
459                         api_level       => 1,
460                         stream          => 1,
461                         cdbi            => $cdbi,
462                         cachable        => 1,
463                 );
464         }
465
466         for my $field ($fmclass->real_fields) {
467                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search.'.$field ) ) {
468                         __PACKAGE__->register_method(
469                                 api_name        => $api_prefix.'.search.'.$field,
470                                 method          => 'search_one_field',
471                                 api_level       => 1,
472                                 cdbi            => $cdbi,
473                                 cachable        => 1,
474                                 stream          => 1,
475                         );
476                 }
477                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search_like.'.$field ) ) {
478                         __PACKAGE__->register_method(
479                                 api_name        => $api_prefix.'.search_like.'.$field,
480                                 method          => 'search_one_field',
481                                 api_level       => 1,
482                                 cdbi            => $cdbi,
483                                 cachable        => 1,
484                                 stream          => 1,
485                         );
486                 }
487                 if (\&Class::DBI::search_fts) {
488                         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_fts.'.$field ) ) {
489                                 __PACKAGE__->register_method(
490                                         api_name        => $api_prefix.'.search_fts.'.$field,
491                                         method          => 'search_one_field',
492                                         api_level       => 1,
493                                         cdbi            => $cdbi,
494                                         cachable        => 1,
495                                         stream          => 1,
496                                 );
497                         }
498                 }
499                 if (\&Class::DBI::search_regex) {
500                         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_regex.'.$field ) ) {
501                                 __PACKAGE__->register_method(
502                                         api_name        => $api_prefix.'.search_regex.'.$field,
503                                         method          => 'search_one_field',
504                                         api_level       => 1,
505                                         cdbi            => $cdbi,
506                                         cachable        => 1,
507                                         stream          => 1,
508                                 );
509                         }
510                 }
511                 if (\&Class::DBI::search_ilike) {
512                         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_ilike.'.$field ) ) {
513                                 __PACKAGE__->register_method(
514                                         api_name        => $api_prefix.'.search_ilike.'.$field,
515                                         method          => 'search_one_field',
516                                         api_level       => 1,
517                                         cdbi            => $cdbi,
518                                         cachable        => 1,
519                                         stream          => 1,
520                                 );
521                         }
522                 }
523         }
524
525
526         unless ($fmclass->is_readonly) {
527                 # Create the create method
528                 unless ( __PACKAGE__->is_registered( $api_prefix.'.create' ) ) {
529                         __PACKAGE__->register_method(
530                                 api_name        => $api_prefix.'.create',
531                                 method          => 'create_node',
532                                 api_level       => 1,
533                                 cdbi            => $cdbi,
534                         );
535                 }
536
537                 # Create the batch create method
538                 unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.create' ) ) {
539                         __PACKAGE__->register_method(
540                                 api_name        => $api_prefix.'.batch.create',
541                                 method          => 'batch_call',
542                                 api_level       => 1,
543                                 cdbi            => $cdbi,
544                         );
545                 }
546
547                 # Create the update method
548                 unless ( __PACKAGE__->is_registered( $api_prefix.'.update' ) ) {
549                         __PACKAGE__->register_method(
550                                 api_name        => $api_prefix.'.update',
551                                 method          => 'update_node',
552                                 api_level       => 1,
553                                 cdbi            => $cdbi,
554                         );
555                 }
556
557                 # Create the batch update method
558                 unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.update' ) ) {
559                         __PACKAGE__->register_method(
560                                 api_name        => $api_prefix.'.batch.update',
561                                 method          => 'batch_call',
562                                 api_level       => 1,
563                                 cdbi            => $cdbi,
564                         );
565                 }
566
567                 # Create the delete method
568                 unless ( __PACKAGE__->is_registered( $api_prefix.'.delete' ) ) {
569                         __PACKAGE__->register_method(
570                                 api_name        => $api_prefix.'.delete',
571                                 method          => 'delete_node',
572                                 api_level       => 1,
573                                 cdbi            => $cdbi,
574                         );
575                 }
576
577                 # Create the batch delete method
578                 unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.delete' ) ) {
579                         __PACKAGE__->register_method(
580                                 api_name        => $api_prefix.'.batch.delete',
581                                 method          => 'batch_call',
582                                 api_level       => 1,
583                                 cdbi            => $cdbi,
584                         );
585                 }
586
587                 # Create the merge method
588                 unless ( __PACKAGE__->is_registered( $api_prefix.'.merge' ) ) {
589                         __PACKAGE__->register_method(
590                                 api_name        => $api_prefix.'.merge',
591                                 method          => 'merge_node',
592                                 api_level       => 1,
593                                 cdbi            => $cdbi,
594                         );
595                 }
596
597                 # Create the batch merge method
598                 unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.merge' ) ) {
599                         __PACKAGE__->register_method(
600                                 api_name        => $api_prefix.'.batch.merge',
601                                 method          => 'batch_call',
602                                 unwrap          => 1,
603                                 api_level       => 1,
604                                 cdbi            => $cdbi,
605                         );
606                 }
607
608                 # Create the remote_update method
609                 unless ( __PACKAGE__->is_registered( $api_prefix.'.remote_update' ) ) {
610                         __PACKAGE__->register_method(
611                                 api_name        => $api_prefix.'.remote_update',
612                                 method          => 'remote_update_node',
613                                 api_level       => 1,
614                                 cdbi            => $cdbi,
615                         );
616                 }
617
618                 # Create the batch remote_update method
619                 unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.remote_update' ) ) {
620                         __PACKAGE__->register_method(
621                                 api_name        => $api_prefix.'.batch.remote_update',
622                                 method          => 'batch_call',
623                                 api_level       => 1,
624                                 unwrap          => 1,
625                                 cdbi            => $cdbi,
626                         );
627                 }
628
629                 # Create the search-based mass delete method
630                 unless ( __PACKAGE__->is_registered( $api_prefix.'.mass_delete' ) ) {
631                         __PACKAGE__->register_method(
632                                 api_name        => $api_prefix.'.mass_delete',
633                                 method          => 'mass_delete',
634                                 api_level       => 1,
635                                 cdbi            => $cdbi,
636                         );
637                 }
638         }
639 }
640
641 1;