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" => {
 140                 "-or" => {
 141                     "usrname" => $value,
 142                     "alias" => $value,
 143                     "first_given_name" => $value,
 144                     "second_given_name" => $value,
 145                     "family_name" => $value
 146                 }
 147             },
 148             "+ac$n" => {"barcode" => $value}
 149         }
 150     };
 151 }
 152
 153 # go through the terms hash, find keys that correspond to fields links
 154 # to actor.usr, and rewrite the search as one that searches not by
 155 # actor.usr.id but by any of these user properties: card barcode, username,
 156 # alias, given names and family name.
 157 sub prepare_au_terms {
 158     my ($terms, $join_num) = @_;
 159     my @joins = ();
 160     $join_num ||= 0;
 161
 162     foreach my $conj (qw/-and -or/) {
 163         next unless exists $terms->{$conj};
 164
 165         my @new_outer_terms = ();
 166         foreach my $hint_unit (@{$terms->{$conj}}) {
 167             my $hint = (keys %$hint_unit)[0];
 168             (my $plain_hint = $hint) =~ y/+//d;
 169
 170             if (my $links = get_fm_links_by_hint($plain_hint) and
 171                 $plain_hint ne "acqlia") {
 172                 my @new_terms = ();
 173                 foreach my $pair (@{$hint_unit->{$hint}}) {
 174                     my ($attr, $value) = breakdown_term($pair);
 175                     if ($links->{$attr} and
 176                         $links->{$attr}->{"class"} eq "au") {
 177                         push @joins, [$plain_hint, $attr, $join_num];
 178                         push @new_outer_terms, gen_au_term($value, $join_num);
 179                         $join_num++;
 180                     } else {
 181                         push @new_terms, $pair;
 182                     }
 183                 }
 184                 if (@new_terms) {
 185                     $hint_unit->{$hint} = [ @new_terms ];
 186                 } else {
 187                     delete $hint_unit->{$hint};
 188                 }
 189             }
 190             push @new_outer_terms, $hint_unit if scalar keys %$hint_unit;
 191         }
 192         $terms->{$conj} = [ @new_outer_terms ];
 193     }
 194     @joins;
 195 }
 196
 197 sub prepare_terms {
 198     my ($terms, $is_and) = @_;
 199
 200     my $conj = $is_and ? "-and" : "-or";
 201     my $outer_clause = {};
 202
 203     foreach my $class (qw/acqpo acqpl jub/) {
 204         next if not exists $terms->{$class};
 205
 206         my $clause = [];
 207         $outer_clause->{$conj} = [] unless $outer_clause->{$conj};
 208         foreach my $unit (@{$terms->{$class}}) {
 209             my ($k, $v, $fuzzy, $between, $not) = breakdown_term($unit);
 210             my $term_clause;
 211             if ($fuzzy and not ref $v) {
 212                 $term_clause = {$k => {"ilike" => "%" . $v . "%"}};
 213             } elsif ($between and could_be_range($v)) {
 214                 $term_clause = {$k => {"between" => $v}};
 215             } elsif (check_1d_max($v)) {
 216                 $term_clause = {$k => $v};
 217             } else {
 218                 next;
 219             }
 220
 221             push @$clause, $not ? {"-not" => $term_clause} : $term_clause;
 222         }
 223         push @{$outer_clause->{$conj}}, {"+" . $class => $clause};
 224     }
 225
 226     if ($terms->{"acqlia"}) {
 227         push @{$outer_clause->{$conj}},
 228             $is_and ? prepare_acqlia_search_and($terms->{"acqlia"}) :
 229                 prepare_acqlia_search_or($terms->{"acqlia"});
 230     }
 231
 232     return undef unless scalar keys %$outer_clause;
 233     $outer_clause;
 234 }
 235
 236 sub add_au_joins {
 237     my ($from) = shift;
 238
 239     my $n = 0;
 240     foreach my $join (@_) {
 241         my ($hint, $attr, $num) = @$join;
 242         my $start = $hint eq "jub" ? $from->{$hint} : $from->{"jub"}->{$hint};
 243         my $clause = {
 244             "class" => "au",
 245             "type" => "left",
 246             "field" => "id",
 247             "fkey" => $attr,
 248             "join" => {
 249                 "ac$num" => {
 250                     "class" => "ac",
 251                     "type" => "left",
 252                     "field" => "id",
 253                     "fkey" => "card"
 254                 }
 255             }
 256         };
 257         if ($hint eq "jub") {
 258             $start->{"au$num"} = $clause;
 259         } else {
 260             $start->{"join"} ||= {};
 261             $start->{"join"}->{"au$num"} = $clause;
 262         }
 263         $n++;
 264     }
 265     $n;
 266 }
 267
 268 __PACKAGE__->register_method(
 269     method    => "unified_search",
 270     api_name  => "open-ils.acq.lineitem.unified_search",
 271     stream    => 1,
 272     signature => {
 273         desc   => q/Returns lineitems based on flexible search terms./,
 274         params => [
 275             {desc => "Authentication token", type => "string"},
 276             {desc => "Field/value pairs for AND'ing", type => "object"},
 277             {desc => "Field/value pairs for OR'ing", type => "object"},
 278             {desc => "Conjunction between AND pairs and OR pairs " .
 279                 "(can be 'and' or 'or')", type => "string"},
 280             {desc => "Retrieval options (clear_marc, flesh_notes, etc) " .
 281                 "- XXX detail all the options",
 282                 type => "object"}
 283         ],
 284         return => {desc => "A stream of LIs on success, Event on failure"}
 285     }
 286 );
 287
 288 __PACKAGE__->register_method(
 289     method    => "unified_search",
 290     api_name  => "open-ils.acq.purchase_order.unified_search",
 291     stream    => 1,
 292     signature => {
 293         desc   => q/Returns purchase orders based on flexible search terms.
 294             See open-ils.acq.lineitem.unified_search/,
 295         return => {desc => "A stream of POs on success, Event on failure"}
 296     }
 297 );
 298
 299 __PACKAGE__->register_method(
 300     method    => "unified_search",
 301     api_name  => "open-ils.acq.picklist.unified_search",
 302     stream    => 1,
 303     signature => {
 304         desc   => q/Returns pick lists based on flexible search terms.
 305             See open-ils.acq.lineitem.unified_search/,
 306         return => {desc => "A stream of PLs on success, Event on failure"}
 307     }
 308 );
 309
 310 sub unified_search {
 311     my ($self, $conn, $auth, $and_terms, $or_terms, $conj, $options) = @_;
 312     $options ||= {};
 313
 314     my $e = new_editor("authtoken" => $auth);
 315     return $e->die_event unless $e->checkauth;
 316
 317     # What kind of object are we returning? Important: (\w+) had better be
 318     # a legit acq classname particle, so don't register any crazy api_names.
 319     my $ret_type = ($self->api_name =~ /cq.(\w+).un/)[0];
 320     my $retriever = $RETRIEVERS{$ret_type};
 321     my $hint = F("acq::$ret_type")->{"hint"};
 322
 323     my $query = {
 324         "select" => {
 325             $hint =>
 326                 [{"column" => "id", "transform" => "distinct"}]
 327         },
 328         "from" => {
 329             "jub" => {
 330                 "acqpo" => {
 331                     "type" => "left",
 332                     "field" => "id",
 333                     "fkey" => "purchase_order"
 334                 },
 335                 "acqpl" => {
 336                     "type" => "left",
 337                     "field" => "id",
 338                     "fkey" => "picklist"
 339                 }
 340             }
 341         },
 342         "order_by" => { $hint => {"id" => {}}},
 343         "offset" => ($options->{"offset"} || 0)
 344     };
 345
 346     $query->{"limit"} = $options->{"limit"} if $options->{"limit"};
 347
 348     $and_terms = prepare_terms($and_terms, 1);
 349     $or_terms = prepare_terms($or_terms, 0) and do {
 350         $query->{"from"}->{"jub"}->{"acqlia"} = {
 351             "type" => "left", "field" => "lineitem", "fkey" => "id",
 352         };
 353     };
 354
 355     my $offset = add_au_joins($query->{"from"}, prepare_au_terms($and_terms));
 356     add_au_joins($query->{"from"}, prepare_au_terms($or_terms, $offset));
 357
 358     if ($and_terms and $or_terms) {
 359         $query->{"where"} = {
 360             "-" . (lc $conj eq "or" ? "or" : "and") => [$and_terms, $or_terms]
 361         };
 362     } elsif ($and_terms) {
 363         $query->{"where"} = $and_terms;
 364     } elsif ($or_terms) {
 365         $query->{"where"} = $or_terms;
 366     } else {
 367         $e->disconnect;
 368         return new OpenILS::Event("BAD_PARAMS", "desc" => "No usable terms");
 369     }
 370
 371     my $results = $e->json_query($query) or return $e->die_event;
 372     $conn->respond($retriever->($e, $_->{"id"}, $options)) foreach (@$results);
 373     $e->disconnect;
 374     undef;
 375 }
 376
 377 1;