8ce47d42a6767c256ae1c5b01854e3af7d85bfea
[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 delete_node {
266         my $self = shift;
267         my $client = shift;
268         my $node = shift;
269
270         my $cdbi = $self->{cdbi};
271
272         my $success = 1;
273         try {
274                 $success = $cdbi->delete($node);
275         } catch Error with {
276                 $success = 0;
277         };
278         return $success;
279 }
280
281 sub batch_call {
282         my $self = shift;
283         my $client = shift;
284         my @nodes = @_;
285
286         my $cdbi = $self->{cdbi};
287         my $api_name = $self->api_name;
288         (my $single_call_api_name = $api_name) =~ s/batch\.//o;
289
290         $log->debug("Default $api_name looking up $single_call_api_name...",INTERNAL);
291         my $method = $self->method_lookup($single_call_api_name);
292
293         my @success;
294         while ( my $node = shift(@nodes) ) {
295                 my ($res) = $method->run( $node ); 
296                 push(@success, 1) if ($res >= 0);
297         }
298
299         my $insert_total = 0;
300         $insert_total += $_ for (@success);
301
302         return $insert_total;
303 }
304
305 eval '
306 use OpenILS::Application::Storage::Publisher::actor;
307 use OpenILS::Application::Storage::Publisher::action;
308 use OpenILS::Application::Storage::Publisher::asset;
309 use OpenILS::Application::Storage::Publisher::biblio;
310 use OpenILS::Application::Storage::Publisher::config;
311 use OpenILS::Application::Storage::Publisher::metabib;
312 use OpenILS::Application::Storage::Publisher::money;
313 use OpenILS::Application::Storage::Publisher::permission;
314 ';
315
316 for my $fmclass ( (Fieldmapper->classes) ) {
317
318         next if ($fmclass->is_virtual);
319
320         $log->debug("Generating methods for Fieldmapper class $fmclass", DEBUG);
321
322         (my $cdbi = $fmclass) =~ s/^Fieldmapper:://o;
323         (my $class = $cdbi) =~ s/::.*//o;
324         (my $api_class = $cdbi) =~ s/::/./go;
325         my $registration_class = __PACKAGE__ . "::$class";
326         my $api_prefix = 'open-ils.storage.direct.'.$api_class;
327
328         # Create the search methods
329         unless ( __PACKAGE__->is_registered( $api_prefix.'.search' ) ) {
330                 __PACKAGE__->register_method(
331                         api_name        => $api_prefix.'.search',
332                         method          => 'search',
333                         api_level       => 1,
334                         stream          => 1,
335                         cdbi            => $cdbi,
336                         cachable        => 1,
337                 );
338         }
339
340         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_where' ) ) {
341                 __PACKAGE__->register_method(
342                         api_name        => $api_prefix.'.search_where',
343                         method          => 'search_where',
344                         api_level       => 1,
345                         stream          => 1,
346                         cdbi            => $cdbi,
347                         cachable        => 1,
348                 );
349         }
350
351         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_like' ) ) {
352                 __PACKAGE__->register_method(
353                         api_name        => $api_prefix.'.search_like',
354                         method          => 'search',
355                         api_level       => 1,
356                         stream          => 1,
357                         cdbi            => $cdbi,
358                         cachable        => 1,
359                 );
360         }
361
362         if (\&Class::DBI::search_fts) {
363                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search_fts' ) ) {
364                         __PACKAGE__->register_method(
365                                 api_name        => $api_prefix.'.search_fts',
366                                 method          => 'search',
367                                 api_level       => 1,
368                                 stream          => 1,
369                                 cdbi            => $cdbi,
370                                 cachable        => 1,
371                         );
372                 }
373         }
374
375         if (\&Class::DBI::search_regex) {
376                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search_regex' ) ) {
377                         __PACKAGE__->register_method(
378                                 api_name        => $api_prefix.'.search_regex',
379                                 method          => 'search',
380                                 api_level       => 1,
381                                 stream          => 1,
382                                 cdbi            => $cdbi,
383                                 cachable        => 1,
384                         );
385                 }
386         }
387
388         if (\&Class::DBI::search_ilike) {
389                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search_ilike' ) ) {
390                         __PACKAGE__->register_method(
391                                 api_name        => $api_prefix.'.search_ilike',
392                                 method          => 'search',
393                                 api_level       => 1,
394                                 stream          => 1,
395                                 cdbi            => $cdbi,
396                                 cachable        => 1,
397                         );
398                 }
399         }
400
401         # Create the retrieve method
402         unless ( __PACKAGE__->is_registered( $api_prefix.'.retrieve' ) ) {
403                 __PACKAGE__->register_method(
404                         api_name        => $api_prefix.'.retrieve',
405                         method          => 'retrieve_node',
406                         api_level       => 1,
407                         cdbi            => $cdbi,
408                         cachable        => 1,
409                 );
410         }
411
412         # Create the batch retrieve method
413         unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.retrieve' ) ) {
414                 __PACKAGE__->register_method(
415                         api_name        => $api_prefix.'.batch.retrieve',
416                         method          => 'retrieve_node',
417                         api_level       => 1,
418                         stream          => 1,
419                         cdbi            => $cdbi,
420                         cachable        => 1,
421                 );
422         }
423
424         for my $field ($fmclass->real_fields) {
425                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search.'.$field ) ) {
426                         __PACKAGE__->register_method(
427                                 api_name        => $api_prefix.'.search.'.$field,
428                                 method          => 'search_one_field',
429                                 api_level       => 1,
430                                 cdbi            => $cdbi,
431                                 cachable        => 1,
432                                 stream          => 1,
433                         );
434                 }
435                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search_like.'.$field ) ) {
436                         __PACKAGE__->register_method(
437                                 api_name        => $api_prefix.'.search_like.'.$field,
438                                 method          => 'search_one_field',
439                                 api_level       => 1,
440                                 cdbi            => $cdbi,
441                                 cachable        => 1,
442                                 stream          => 1,
443                         );
444                 }
445                 if (\&Class::DBI::search_fts) {
446                         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_fts.'.$field ) ) {
447                                 __PACKAGE__->register_method(
448                                         api_name        => $api_prefix.'.search_fts.'.$field,
449                                         method          => 'search_one_field',
450                                         api_level       => 1,
451                                         cdbi            => $cdbi,
452                                         cachable        => 1,
453                                         stream          => 1,
454                                 );
455                         }
456                 }
457                 if (\&Class::DBI::search_regex) {
458                         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_regex.'.$field ) ) {
459                                 __PACKAGE__->register_method(
460                                         api_name        => $api_prefix.'.search_regex.'.$field,
461                                         method          => 'search_one_field',
462                                         api_level       => 1,
463                                         cdbi            => $cdbi,
464                                         cachable        => 1,
465                                         stream          => 1,
466                                 );
467                         }
468                 }
469                 if (\&Class::DBI::search_ilike) {
470                         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_ilike.'.$field ) ) {
471                                 __PACKAGE__->register_method(
472                                         api_name        => $api_prefix.'.search_ilike.'.$field,
473                                         method          => 'search_one_field',
474                                         api_level       => 1,
475                                         cdbi            => $cdbi,
476                                         cachable        => 1,
477                                         stream          => 1,
478                                 );
479                         }
480                 }
481         }
482
483
484         # Create the create method
485         unless ( __PACKAGE__->is_registered( $api_prefix.'.create' ) ) {
486                 __PACKAGE__->register_method(
487                         api_name        => $api_prefix.'.create',
488                         method          => 'create_node',
489                         api_level       => 1,
490                         cdbi            => $cdbi,
491                 );
492         }
493
494         # Create the batch create method
495         unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.create' ) ) {
496                 __PACKAGE__->register_method(
497                         api_name        => $api_prefix.'.batch.create',
498                         method          => 'batch_call',
499                         api_level       => 1,
500                         cdbi            => $cdbi,
501                 );
502         }
503
504         # Create the update method
505         unless ( __PACKAGE__->is_registered( $api_prefix.'.update' ) ) {
506                 __PACKAGE__->register_method(
507                         api_name        => $api_prefix.'.update',
508                         method          => 'update_node',
509                         api_level       => 1,
510                         cdbi            => $cdbi,
511                 );
512         }
513
514         # Create the batch update method
515         unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.update' ) ) {
516                 __PACKAGE__->register_method(
517                         api_name        => $api_prefix.'.batch.update',
518                         method          => 'batch_call',
519                         api_level       => 1,
520                         cdbi            => $cdbi,
521                 );
522         }
523
524         # Create the delete method
525         unless ( __PACKAGE__->is_registered( $api_prefix.'.delete' ) ) {
526                 __PACKAGE__->register_method(
527                         api_name        => $api_prefix.'.delete',
528                         method          => 'delete_node',
529                         api_level       => 1,
530                         cdbi            => $cdbi,
531                 );
532         }
533
534         # Create the batch delete method
535         unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.delete' ) ) {
536                 __PACKAGE__->register_method(
537                         api_name        => $api_prefix.'.batch.delete',
538                         method          => 'batch_call',
539                         api_level       => 1,
540                         cdbi            => $cdbi,
541                 );
542         }
543
544         # Create the search-based mass delete method
545         unless ( __PACKAGE__->is_registered( $api_prefix.'.mass_delete' ) ) {
546                 __PACKAGE__->register_method(
547                         api_name        => $api_prefix.'.mass_delete',
548                         method          => 'mass_delete',
549                         api_level       => 1,
550                         cdbi            => $cdbi,
551                 );
552         }
553
554 }
555
556 1;