Open-ILS/src/perlmods/OpenILS/Application/Acq/Search.pm

   1 package OpenILS::Application::Acq::Search;
   2 use base "OpenILS::Application";
   3
   4 use strict;
   5 use warnings;
   6
   7 use OpenILS::Event;
   8 use OpenILS::Utils::CStoreEditor q/:funcs/;
   9 use OpenILS::Utils::Fieldmapper;
  10 use OpenILS::Application::Acq::Lineitem;
  11 use OpenILS::Application::Acq::Financials;
  12 use OpenILS::Application::Acq::Picklist;
  13
  14 my %RETRIEVERS = (
  15     "lineitem" =>
  16         \&{"OpenILS::Application::Acq::Lineitem::retrieve_lineitem_impl"},
  17     "picklist" =>
  18         \&{"OpenILS::Application::Acq::Picklist::retrieve_picklist_impl"},
  19     "purchase_order" => \&{
  20         "OpenILS::Application::Acq::Financials::retrieve_purchase_order_impl"
  21     }
  22 );
  23
  24 sub F { $Fieldmapper::fieldmap->{"Fieldmapper::" . $_[0]}; }
  25
  26 # This subroutine returns 1 if the argument is a) a scalar OR
  27 # b) an array of ONLY scalars. Otherwise it returns 0.
  28 sub check_1d_max {
  29     my ($o) = @_;
  30     return 1 unless ref $o;
  31     if (ref($o) eq "ARRAY") {
  32         foreach (@$o) { return 0 if ref $_; }
  33         return 1;
  34     }
  35     0;
  36 }
  37
  38 # Returns 1 if and only if argument is an array of exactly two scalars.
  39 sub could_be_range {
  40     my ($o) = @_;
  41     if (ref $o eq "ARRAY") {
  42         return 1 if (scalar(@$o) == 2 && (!ref $o->[0] && !ref $o->[1]));
  43     }
  44     0;
  45 }
  46
  47 sub prepare_acqlia_search_and {
  48     my ($acqlia) = @_;
  49
  50     my @phrases = ();
  51     foreach my $unit (@{$acqlia}) {
  52         my $subquery = {
  53             "select" => {"acqlia" => ["id"]},
  54             "from" => "acqlia",
  55             "where" => {"-and" => [{"lineitem" => {"=" => {"+jub" => "id"}}}]}
  56         };
  57
  58         my ($k, $v, $fuzzy, $between, $not) = breakdown_term($unit);
  59         my $point = $subquery->{"where"}->{"-and"};
  60         my $term_clause;
  61
  62         push @$point, {"definition" => $k};
  63
  64         if ($fuzzy and not ref $v) {
  65             push @$point, {"attr_value" => {"ilike" => "%" . $v . "%"}};
  66         } elsif ($between and could_be_range($v)) {
  67             push @$point, {"attr_value" => {"between" => $v}};
  68         } elsif (check_1d_max($v)) {
  69             push @$point, {"attr_value" => $v};
  70         } else {
  71             next;
  72         }
  73
  74         my $operator = $not ? "-not-exists" : "-exists";
  75         push @phrases, {$operator => $subquery};
  76     }
  77     @phrases;
  78 }
  79
  80 sub prepare_acqlia_search_or {
  81     my ($acqlia) = @_;
  82
  83     my $point = [];
  84     my $result = {"+acqlia" => {"-or" => $point}};
  85
  86     foreach my $unit (@$acqlia) {
  87         my ($k, $v, $fuzzy, $between, $not) = breakdown_term($unit);
  88         my $term_clause;
  89         if ($fuzzy and not ref $v) {
  90             $term_clause = {
  91                 "-and" => {
  92                     "definition" => $k,
  93                     "attr_value" => {"ilike" => "%" . $v . "%"}
  94                 }
  95             };
  96         } elsif ($between and could_be_range($v)) {
  97             $term_clause = {
  98                 "-and" => {
  99                     "definition" => $k, "attr_value" => {"between" => $v}
 100                 }
 101             };
 102         } elsif (check_1d_max($v)) {
 103             $term_clause = {
 104                 "-and" => {"definition" => $k, "attr_value" => $v}
 105             };
 106         } else {
 107             next;
 108         }
 109
 110         push @$point, $not ? {"-not" => $term_clause} : $term_clause;
 111     }
 112     $result;
 113 }
 114
 115 sub breakdown_term {
 116     my ($term) = @_;
 117
 118     my $key = (grep { !/^__/ } keys %$term)[0];
 119     (
 120         $key, $term->{$key},
 121         $term->{"__fuzzy"} ? 1 : 0,
 122         $term->{"__between"} ? 1 : 0,
 123         $term->{"__not"} ? 1 : 0
 124     );
 125 }
 126
 127 sub get_fm_links_by_hint {
 128     my ($hint) = @_;
 129     foreach my $field (values %{$Fieldmapper::fieldmap}) {
 130         return $field->{"links"} if $field->{"hint"} eq $hint;
 131     }
 132     undef;
 133 }
 134
 135 sub gen_au_term {
 136     my ($value, $n) = @_;
 137     +{
 138         "-or" => [
 139             {"+au$n" => {"usrname" => $value}},
 140             {"+au$n" => {"first_given_name" => $value}},
 141             {"+au$n" => {"second_given_name" => $value}},
 142             {"+au$n" => {"family_name" => $value}},
 143             {"+ac$n" => {"barcode" => $value}}
 144         ]
 145     };
 146 }
 147
 148 # go through the terms hash, find keys that correspond to fields links
 149 # to actor.usr, and rewrite the search as one that searches not by
 150 # actor.usr.id but by any of these user properties: card barcode, username,
 151 # given names and family name.
 152 sub prepare_au_terms {
 153     my ($terms, $join_num) = @_;
 154
 155     my @joins = ();
 156     my $nots = 0;
 157     $join_num ||= 0;
 158
 159     foreach my $conj (qw/-and -or/) {
 160         next unless exists $terms->{$conj};
 161
 162         my @new_outer_terms = ();
 163         HINT_UNIT: foreach my $hint_unit (@{$terms->{$conj}}) {
 164             my $hint = (keys %$hint_unit)[0];
 165             (my $plain_hint = $hint) =~ y/+//d;
 166             if ($hint eq "-not") {
 167                 $hint_unit = $hint_unit->{$hint};
 168                 $nots++;
 169                 redo HINT_UNIT;
 170             }
 171
 172             if (my $links = get_fm_links_by_hint($plain_hint) and
 173                 $plain_hint ne "acqlia") {
 174                 my @new_terms = ();
 175                 my ($attr, $value) = breakdown_term($hint_unit->{$hint});
 176                 if ($links->{$attr} and
 177                     $links->{$attr}->{"class"} eq "au") {
 178                     push @joins, [$plain_hint, $attr, $join_num];
 179                     my $au_term = gen_au_term($value, $join_num);
 180                     if ($nots > 0) {
 181                         $au_term = {"-not" => $au_term};
 182                         $nots--;
 183                     }
 184                     push @new_outer_terms, $au_term;
 185                     $join_num++;
 186                     delete $hint_unit->{$hint};
 187                 }
 188             }
 189             if ($nots > 0) {
 190                 $hint_unit = {"-not" => $hint_unit};
 191                 $nots--;
 192             }
 193             push @new_outer_terms, $hint_unit if scalar keys %$hint_unit;
 194         }
 195         $terms->{$conj} = [ @new_outer_terms ];
 196     }
 197     @joins;
 198 }
 199
 200 sub prepare_terms {
 201     my ($terms, $is_and) = @_;
 202
 203     my $conj = $is_and ? "-and" : "-or";
 204     my $outer_clause = {};
 205
 206     foreach my $class (qw/acqpo acqpl jub/) {
 207         next if not exists $terms->{$class};
 208
 209         $outer_clause->{$conj} = [] unless $outer_clause->{$conj};
 210         foreach my $unit (@{$terms->{$class}}) {
 211             my ($k, $v, $fuzzy, $between, $not) = breakdown_term($unit);
 212             my $term_clause;
 213             if ($fuzzy and not ref $v) {
 214                 $term_clause = {$k => {"ilike" => "%" . $v . "%"}};
 215             } elsif ($between and could_be_range($v)) {
 216                 $term_clause = {$k => {"between" => $v}};
 217             } elsif (check_1d_max($v)) {
 218                 $term_clause = {$k => $v};
 219             } else {
 220                 next;
 221             }
 222
 223             my $clause = {"+" . $class => $term_clause};
 224             $clause = {"-not" => $clause} if $not;
 225             push @{$outer_clause->{$conj}}, $clause;
 226         }
 227     }
 228
 229     if ($terms->{"acqlia"}) {
 230         push @{$outer_clause->{$conj}},
 231             $is_and ? prepare_acqlia_search_and($terms->{"acqlia"}) :
 232                 prepare_acqlia_search_or($terms->{"acqlia"});
 233     }
 234
 235     return undef unless scalar keys %$outer_clause;
 236     $outer_clause;
 237 }
 238
 239 sub add_au_joins {
 240     my ($from) = shift;
 241
 242     my $n = 0;
 243     foreach my $join (@_) {
 244         my ($hint, $attr, $num) = @$join;
 245         my $start = $hint eq "jub" ? $from->{$hint} : $from->{"jub"}->{$hint};
 246         my $clause = {
 247             "class" => "au",
 248             "type" => "left",
 249             "field" => "id",
 250             "fkey" => $attr,
 251             "join" => {
 252                 "ac$num" => {
 253                     "class" => "ac",
 254                     "type" => "left",
 255                     "field" => "id",
 256                     "fkey" => "card"
 257                 }
 258             }
 259         };
 260         if ($hint eq "jub") {
 261             $start->{"au$num"} = $clause;
 262         } else {
 263             $start->{"join"} ||= {};
 264             $start->{"join"}->{"au$num"} = $clause;
 265         }
 266         $n++;
 267     }
 268     $n;
 269 }
 270
 271 __PACKAGE__->register_method(
 272     method    => "unified_search",
 273     api_name  => "open-ils.acq.lineitem.unified_search",
 274     stream    => 1,
 275     signature => {
 276         desc   => q/Returns lineitems based on flexible search terms./,
 277         params => [
 278             {desc => "Authentication token", type => "string"},
 279             {desc => "Field/value pairs for AND'ing", type => "object"},
 280             {desc => "Field/value pairs for OR'ing", type => "object"},
 281             {desc => "Conjunction between AND pairs and OR pairs " .
 282                 "(can be 'and' or 'or')", type => "string"},
 283             {desc => "Retrieval options (clear_marc, flesh_notes, etc) " .
 284                 "- XXX detail all the options",
 285                 type => "object"}
 286         ],
 287         return => {desc => "A stream of LIs on success, Event on failure"}
 288     }
 289 );
 290
 291 __PACKAGE__->register_method(
 292     method    => "unified_search",
 293     api_name  => "open-ils.acq.purchase_order.unified_search",
 294     stream    => 1,
 295     signature => {
 296         desc   => q/Returns purchase orders based on flexible search terms.
 297             See open-ils.acq.lineitem.unified_search/,
 298         return => {desc => "A stream of POs on success, Event on failure"}
 299     }
 300 );
 301
 302 __PACKAGE__->register_method(
 303     method    => "unified_search",
 304     api_name  => "open-ils.acq.picklist.unified_search",
 305     stream    => 1,
 306     signature => {
 307         desc   => q/Returns pick lists based on flexible search terms.
 308             See open-ils.acq.lineitem.unified_search/,
 309         return => {desc => "A stream of PLs on success, Event on failure"}
 310     }
 311 );
 312
 313 sub unified_search {
 314     my ($self, $conn, $auth, $and_terms, $or_terms, $conj, $options) = @_;
 315     $options ||= {};
 316
 317     my $e = new_editor("authtoken" => $auth);
 318     return $e->die_event unless $e->checkauth;
 319
 320     # What kind of object are we returning? Important: (\w+) had better be
 321     # a legit acq classname particle, so don't register any crazy api_names.
 322     my $ret_type = ($self->api_name =~ /cq.(\w+).un/)[0];
 323     my $retriever = $RETRIEVERS{$ret_type};
 324     my $hint = F("acq::$ret_type")->{"hint"};
 325
 326     my $query = {
 327         "select" => {
 328             $hint =>
 329                 [{"column" => "id", "transform" => "distinct"}]
 330         },
 331         "from" => {
 332             "jub" => {
 333                 "acqpo" => {
 334                     "type" => "full",
 335                     "field" => "id",
 336                     "fkey" => "purchase_order"
 337                 },
 338                 "acqpl" => {
 339                     "type" => "full",
 340                     "field" => "id",
 341                     "fkey" => "picklist"
 342                 }
 343             }
 344         },
 345         "order_by" => { $hint => {"id" => {}}},
 346         "offset" => ($options->{"offset"} || 0)
 347     };
 348
 349     $query->{"limit"} = $options->{"limit"} if $options->{"limit"};
 350
 351     $and_terms = prepare_terms($and_terms, 1);
 352     $or_terms = prepare_terms($or_terms, 0) and do {
 353         $query->{"from"}->{"jub"}->{"acqlia"} = {
 354             "type" => "left", "field" => "lineitem", "fkey" => "id",
 355         };
 356     };
 357
 358     # TODO find instances of fields of type "timestamp" and massage the
 359     # comparison to match search input (which is only at date precision,
 360     # not timestamp).
 361     my $offset = add_au_joins($query->{"from"}, prepare_au_terms($and_terms));
 362     add_au_joins($query->{"from"}, prepare_au_terms($or_terms, $offset));
 363
 364     if ($and_terms and $or_terms) {
 365         $query->{"where"} = {
 366             "-" . (lc $conj eq "or" ? "or" : "and") => [$and_terms, $or_terms]
 367         };
 368     } elsif ($and_terms) {
 369         $query->{"where"} = $and_terms;
 370     } elsif ($or_terms) {
 371         $query->{"where"} = $or_terms;
 372     } else {
 373         $e->disconnect;
 374         return new OpenILS::Event("BAD_PARAMS", "desc" => "No usable terms");
 375     }
 376
 377     my $results = $e->json_query($query) or return $e->die_event;
 378     if ($options->{"id_list"}) {
 379         foreach (@$results) {
 380             $conn->respond($_->{"id"}) if $_->{"id"};
 381         }
 382     } else {
 383         foreach (@$results) {
 384             $conn->respond($retriever->($e, $_->{"id"}, $options))
 385                 if $_->{"id"};
 386         }
 387     }
 388     $e->disconnect;
 389     undef;
 390 }
 391
 392 1;