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 $node = shift;
 269
 270         my $cdbi = $self->{cdbi};
 271
 272         my $success = 1;
 273         try {
 274                 $success = $cdbi->remote_update($node);
 275         } catch Error with {
 276                 $success = 0;
 277         };
 278         return $success;
 279 }
 280
 281 sub merge_node {
 282         my $self = shift;
 283         my $client = shift;
 284         my $node = shift;
 285
 286         my $cdbi = $self->{cdbi};
 287
 288         my $success = 1;
 289         try {
 290                 $success = $cdbi->merge($node)->id;
 291         } catch Error with {
 292                 $success = 0;
 293         };
 294         return $success;
 295 }
 296
 297 sub delete_node {
 298         my $self = shift;
 299         my $client = shift;
 300         my $node = shift;
 301
 302         my $cdbi = $self->{cdbi};
 303
 304         my $success = 1;
 305         try {
 306                 $success = $cdbi->delete($node);
 307         } catch Error with {
 308                 $success = 0;
 309         };
 310         return $success;
 311 }
 312
 313 sub batch_call {
 314         my $self = shift;
 315         my $client = shift;
 316         my @nodes = @_;
 317
 318         my $unwrap = $self->{unwrap};
 319
 320         my $cdbi = $self->{cdbi};
 321         my $api_name = $self->api_name;
 322         (my $single_call_api_name = $api_name) =~ s/batch\.//o;
 323
 324         $log->debug("Default $api_name looking up $single_call_api_name...",INTERNAL);
 325         my $method = $self->method_lookup($single_call_api_name);
 326
 327         my @success;
 328         while ( my $node = shift(@nodes) ) {
 329                 my ($res) = $method->run( ($unwrap ? (@$node) : ($node)) );
 330                 push(@success, 1) if ($res >= 0);
 331         }
 332
 333         my $insert_total = 0;
 334         $insert_total += $_ for (@success);
 335
 336         return $insert_total;
 337 }
 338
 339 eval '
 340 use OpenILS::Application::Storage::Publisher::actor;
 341 use OpenILS::Application::Storage::Publisher::action;
 342 use OpenILS::Application::Storage::Publisher::asset;
 343 use OpenILS::Application::Storage::Publisher::biblio;
 344 use OpenILS::Application::Storage::Publisher::config;
 345 use OpenILS::Application::Storage::Publisher::metabib;
 346 use OpenILS::Application::Storage::Publisher::money;
 347 use OpenILS::Application::Storage::Publisher::permission;
 348 ';
 349
 350 if ($@) {
 351         $log->debug("ARG! Couldn't load (at least one) class Publisher: $@", ERROR);
 352         throw OpenSRF::EX::ERROR ("ARG! Couldn't load (at least one) class Publisher: $@");
 353 }
 354
 355
 356 for my $fmclass ( (Fieldmapper->classes) ) {
 357
 358         next if ($fmclass->is_virtual);
 359
 360         $log->debug("Generating methods for Fieldmapper class $fmclass", DEBUG);
 361
 362         (my $cdbi = $fmclass) =~ s/^Fieldmapper:://o;
 363         (my $class = $cdbi) =~ s/::.*//o;
 364         (my $api_class = $cdbi) =~ s/::/./go;
 365         my $registration_class = __PACKAGE__ . "::$class";
 366         my $api_prefix = 'open-ils.storage.direct.'.$api_class;
 367
 368         # Create the search methods
 369         unless ( __PACKAGE__->is_registered( $api_prefix.'.search' ) ) {
 370                 __PACKAGE__->register_method(
 371                         api_name        => $api_prefix.'.search',
 372                         method          => 'search',
 373                         api_level       => 1,
 374                         stream          => 1,
 375                         cdbi            => $cdbi,
 376                         cachable        => 1,
 377                 );
 378         }
 379
 380         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_where' ) ) {
 381                 __PACKAGE__->register_method(
 382                         api_name        => $api_prefix.'.search_where',
 383                         method          => 'search_where',
 384                         api_level       => 1,
 385                         stream          => 1,
 386                         cdbi            => $cdbi,
 387                         cachable        => 1,
 388                 );
 389         }
 390
 391         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_like' ) ) {
 392                 __PACKAGE__->register_method(
 393                         api_name        => $api_prefix.'.search_like',
 394                         method          => 'search',
 395                         api_level       => 1,
 396                         stream          => 1,
 397                         cdbi            => $cdbi,
 398                         cachable        => 1,
 399                 );
 400         }
 401
 402         if (\&Class::DBI::search_fts) {
 403                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search_fts' ) ) {
 404                         __PACKAGE__->register_method(
 405                                 api_name        => $api_prefix.'.search_fts',
 406                                 method          => 'search',
 407                                 api_level       => 1,
 408                                 stream          => 1,
 409                                 cdbi            => $cdbi,
 410                                 cachable        => 1,
 411                         );
 412                 }
 413         }
 414
 415         if (\&Class::DBI::search_regex) {
 416                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search_regex' ) ) {
 417                         __PACKAGE__->register_method(
 418                                 api_name        => $api_prefix.'.search_regex',
 419                                 method          => 'search',
 420                                 api_level       => 1,
 421                                 stream          => 1,
 422                                 cdbi            => $cdbi,
 423                                 cachable        => 1,
 424                         );
 425                 }
 426         }
 427
 428         if (\&Class::DBI::search_ilike) {
 429                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search_ilike' ) ) {
 430                         __PACKAGE__->register_method(
 431                                 api_name        => $api_prefix.'.search_ilike',
 432                                 method          => 'search',
 433                                 api_level       => 1,
 434                                 stream          => 1,
 435                                 cdbi            => $cdbi,
 436                                 cachable        => 1,
 437                         );
 438                 }
 439         }
 440
 441         # Create the retrieve method
 442         unless ( __PACKAGE__->is_registered( $api_prefix.'.retrieve' ) ) {
 443                 __PACKAGE__->register_method(
 444                         api_name        => $api_prefix.'.retrieve',
 445                         method          => 'retrieve_node',
 446                         api_level       => 1,
 447                         cdbi            => $cdbi,
 448                         cachable        => 1,
 449                 );
 450         }
 451
 452         # Create the batch retrieve method
 453         unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.retrieve' ) ) {
 454                 __PACKAGE__->register_method(
 455                         api_name        => $api_prefix.'.batch.retrieve',
 456                         method          => 'retrieve_node',
 457                         api_level       => 1,
 458                         stream          => 1,
 459                         cdbi            => $cdbi,
 460                         cachable        => 1,
 461                 );
 462         }
 463
 464         for my $field ($fmclass->real_fields) {
 465                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search.'.$field ) ) {
 466                         __PACKAGE__->register_method(
 467                                 api_name        => $api_prefix.'.search.'.$field,
 468                                 method          => 'search_one_field',
 469                                 api_level       => 1,
 470                                 cdbi            => $cdbi,
 471                                 cachable        => 1,
 472                                 stream          => 1,
 473                         );
 474                 }
 475                 unless ( __PACKAGE__->is_registered( $api_prefix.'.search_like.'.$field ) ) {
 476                         __PACKAGE__->register_method(
 477                                 api_name        => $api_prefix.'.search_like.'.$field,
 478                                 method          => 'search_one_field',
 479                                 api_level       => 1,
 480                                 cdbi            => $cdbi,
 481                                 cachable        => 1,
 482                                 stream          => 1,
 483                         );
 484                 }
 485                 if (\&Class::DBI::search_fts) {
 486                         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_fts.'.$field ) ) {
 487                                 __PACKAGE__->register_method(
 488                                         api_name        => $api_prefix.'.search_fts.'.$field,
 489                                         method          => 'search_one_field',
 490                                         api_level       => 1,
 491                                         cdbi            => $cdbi,
 492                                         cachable        => 1,
 493                                         stream          => 1,
 494                                 );
 495                         }
 496                 }
 497                 if (\&Class::DBI::search_regex) {
 498                         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_regex.'.$field ) ) {
 499                                 __PACKAGE__->register_method(
 500                                         api_name        => $api_prefix.'.search_regex.'.$field,
 501                                         method          => 'search_one_field',
 502                                         api_level       => 1,
 503                                         cdbi            => $cdbi,
 504                                         cachable        => 1,
 505                                         stream          => 1,
 506                                 );
 507                         }
 508                 }
 509                 if (\&Class::DBI::search_ilike) {
 510                         unless ( __PACKAGE__->is_registered( $api_prefix.'.search_ilike.'.$field ) ) {
 511                                 __PACKAGE__->register_method(
 512                                         api_name        => $api_prefix.'.search_ilike.'.$field,
 513                                         method          => 'search_one_field',
 514                                         api_level       => 1,
 515                                         cdbi            => $cdbi,
 516                                         cachable        => 1,
 517                                         stream          => 1,
 518                                 );
 519                         }
 520                 }
 521         }
 522
 523
 524         unless ($fmclass->is_readonly) {
 525                 # Create the create method
 526                 unless ( __PACKAGE__->is_registered( $api_prefix.'.create' ) ) {
 527                         __PACKAGE__->register_method(
 528                                 api_name        => $api_prefix.'.create',
 529                                 method          => 'create_node',
 530                                 api_level       => 1,
 531                                 cdbi            => $cdbi,
 532                         );
 533                 }
 534
 535                 # Create the batch create method
 536                 unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.create' ) ) {
 537                         __PACKAGE__->register_method(
 538                                 api_name        => $api_prefix.'.batch.create',
 539                                 method          => 'batch_call',
 540                                 api_level       => 1,
 541                                 cdbi            => $cdbi,
 542                         );
 543                 }
 544
 545                 # Create the update method
 546                 unless ( __PACKAGE__->is_registered( $api_prefix.'.update' ) ) {
 547                         __PACKAGE__->register_method(
 548                                 api_name        => $api_prefix.'.update',
 549                                 method          => 'update_node',
 550                                 api_level       => 1,
 551                                 cdbi            => $cdbi,
 552                         );
 553                 }
 554
 555                 # Create the batch update method
 556                 unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.update' ) ) {
 557                         __PACKAGE__->register_method(
 558                                 api_name        => $api_prefix.'.batch.update',
 559                                 method          => 'batch_call',
 560                                 api_level       => 1,
 561                                 cdbi            => $cdbi,
 562                         );
 563                 }
 564
 565                 # Create the delete method
 566                 unless ( __PACKAGE__->is_registered( $api_prefix.'.delete' ) ) {
 567                         __PACKAGE__->register_method(
 568                                 api_name        => $api_prefix.'.delete',
 569                                 method          => 'delete_node',
 570                                 api_level       => 1,
 571                                 cdbi            => $cdbi,
 572                         );
 573                 }
 574
 575                 # Create the batch delete method
 576                 unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.delete' ) ) {
 577                         __PACKAGE__->register_method(
 578                                 api_name        => $api_prefix.'.batch.delete',
 579                                 method          => 'batch_call',
 580                                 api_level       => 1,
 581                                 cdbi            => $cdbi,
 582                         );
 583                 }
 584
 585                 # Create the merge method
 586                 unless ( __PACKAGE__->is_registered( $api_prefix.'.merge' ) ) {
 587                         __PACKAGE__->register_method(
 588                                 api_name        => $api_prefix.'.merge',
 589                                 method          => 'merge_node',
 590                                 api_level       => 1,
 591                                 cdbi            => $cdbi,
 592                         );
 593                 }
 594
 595                 # Create the batch merge method
 596                 unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.merge' ) ) {
 597                         __PACKAGE__->register_method(
 598                                 api_name        => $api_prefix.'.batch.merge',
 599                                 method          => 'batch_call',
 600                                 unwrap          => 1,
 601                                 api_level       => 1,
 602                                 cdbi            => $cdbi,
 603                         );
 604                 }
 605
 606                 # Create the remote_update method
 607                 unless ( __PACKAGE__->is_registered( $api_prefix.'.remote_update' ) ) {
 608                         __PACKAGE__->register_method(
 609                                 api_name        => $api_prefix.'.remote_update',
 610                                 method          => 'remote_update_node',
 611                                 api_level       => 1,
 612                                 cdbi            => $cdbi,
 613                         );
 614                 }
 615
 616                 # Create the batch remote_update method
 617                 unless ( __PACKAGE__->is_registered( $api_prefix.'.batch.remote_update' ) ) {
 618                         __PACKAGE__->register_method(
 619                                 api_name        => $api_prefix.'.batch.remote_update',
 620                                 method          => 'batch_call',
 621                                 api_level       => 1,
 622                                 unwrap          => 1,
 623                                 cdbi            => $cdbi,
 624                         );
 625                 }
 626
 627                 # Create the search-based mass delete method
 628                 unless ( __PACKAGE__->is_registered( $api_prefix.'.mass_delete' ) ) {
 629                         __PACKAGE__->register_method(
 630                                 api_name        => $api_prefix.'.mass_delete',
 631                                 method          => 'mass_delete',
 632                                 api_level       => 1,
 633                                 cdbi            => $cdbi,
 634                         );
 635                 }
 636         }
 637 }
 638
 639 1;