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