Open-ILS/src/perlmods/lib/OpenILS/Application/Storage/Driver/Pg/QueryParser.pm

   1 use strict;
   2 use warnings;
   3
   4 package OpenILS::Application::Storage::Driver::Pg::QueryParser;
   5 use OpenILS::Application::Storage::QueryParser;
   6 use base 'QueryParser';
   7 use OpenSRF::Utils::JSON;
   8 use OpenILS::Application::AppUtils;
   9 use OpenILS::Utils::CStoreEditor;
  10 my $U = 'OpenILS::Application::AppUtils';
  11
  12 my ${spc} = ' ' x 2;
  13 sub subquery_callback {
  14     my ($invocant, $self, $struct, $filter, $params, $negate) = @_;
  15
  16     return sprintf(' ((%s)) ',
  17         join(
  18             ') || (',
  19             map {
  20                 $_->query_text
  21             } @{
  22                 OpenILS::Utils::CStoreEditor
  23                     ->new
  24                     ->search_actor_search_query({ id => $params })
  25             }
  26         )
  27     );
  28 }
  29
  30 sub filter_group_entry_callback {
  31     my ($invocant, $self, $struct, $filter, $params, $negate) = @_;
  32
  33     return sprintf(' saved_query(%s)',
  34         join(
  35             ',',
  36             map {
  37                 $_->query
  38             } @{
  39                 OpenILS::Utils::CStoreEditor
  40                     ->new
  41                     ->search_actor_search_filter_group_entry({ id => $params })
  42             }
  43         )
  44     );
  45 }
  46
  47 sub quote_value {
  48     my $self = shift;
  49     my $value = shift;
  50
  51     if ($value =~ /^\d/) { # may have to use non-$ quoting
  52         $value =~ s/'/''/g;
  53         $value =~ s/\\/\\\\/g;
  54         return "E'$value'";
  55     }
  56     return "\$_$$\$$value\$_$$\$";
  57 }
  58
  59 sub quote_phrase_value {
  60     my $self = shift;
  61     my $value = shift;
  62
  63     my $left_anchored  = $value =~ m/^\^/;
  64     my $right_anchored = $value =~ m/\$$/;
  65     $value =~ s/\^//   if $left_anchored;
  66     $value =~ s/\$$//  if $right_anchored;
  67     $value = quotemeta($value);
  68     $value = '^' . $value if $left_anchored;
  69     $value = "$value\$"   if $right_anchored;
  70     return $self->quote_value($value);
  71 }
  72
  73 sub init {
  74     my $class = shift;
  75 }
  76
  77 sub default_preferred_language {
  78     my $self = shift;
  79     my $lang = shift;
  80
  81     $self->custom_data->{default_preferred_language} = $lang if ($lang);
  82     return $self->custom_data->{default_preferred_language};
  83 }
  84
  85 sub default_preferred_language_multiplier {
  86     my $self = shift;
  87     my $lang = shift;
  88
  89     $self->custom_data->{default_preferred_language_multiplier} = $lang if ($lang);
  90     return $self->custom_data->{default_preferred_language_multiplier};
  91 }
  92
  93 sub simple_plan {
  94     my $self = shift;
  95
  96     return 0 unless $self->parse_tree;
  97     return 0 if @{$self->parse_tree->filters};
  98     return 0 if @{$self->parse_tree->modifiers};
  99     for my $node ( @{ $self->parse_tree->query_nodes } ) {
 100         return 0 if (!ref($node) && $node eq '|');
 101         next unless (ref($node));
 102         return 0 if ($node->isa('QueryParser::query_plan'));
 103     }
 104
 105     return 1;
 106 }
 107
 108 sub toSQL {
 109     my $self = shift;
 110     return $self->parse_tree->toSQL;
 111 }
 112
 113 sub dynamic_filters {
 114     my $self = shift;
 115     my $new = shift;
 116
 117     $self->custom_data->{dynamic_filters} ||= [];
 118     push(@{$self->custom_data->{dynamic_filters}}, $new) if ($new);
 119     return $self->custom_data->{dynamic_filters};
 120 }
 121
 122 sub dynamic_sorters {
 123     my $self = shift;
 124     my $new = shift;
 125
 126     $self->custom_data->{dynamic_sorters} ||= [];
 127     push(@{$self->custom_data->{dynamic_sorters}}, $new) if ($new);
 128     return $self->custom_data->{dynamic_sorters};
 129 }
 130
 131 sub facet_field_id_map {
 132     my $self = shift;
 133     my $map = shift;
 134
 135     $self->custom_data->{facet_field_id_map} ||= {};
 136     $self->custom_data->{facet_field_id_map} = $map if ($map);
 137     return $self->custom_data->{facet_field_id_map};
 138 }
 139
 140 sub add_facet_field_id_map {
 141     my $self = shift;
 142     my $class = shift;
 143     my $field = shift;
 144     my $id = shift;
 145     my $weight = shift;
 146
 147     $self->add_facet_field( $class => $field );
 148     $self->facet_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
 149     $self->facet_field_id_map->{by_class}{$class}{$field} = $id;
 150
 151     return {
 152         by_id => { $id => { classname => $class, field => $field, weight => $weight } },
 153         by_class => { $class => { $field => $id } }
 154     };
 155 }
 156
 157 sub facet_field_class_by_id {
 158     my $self = shift;
 159     my $id = shift;
 160
 161     return $self->facet_field_id_map->{by_id}{$id};
 162 }
 163
 164 sub facet_field_ids_by_class {
 165     my $self = shift;
 166     my $class = shift;
 167     my $field = shift;
 168
 169     return undef unless ($class);
 170
 171     if ($field) {
 172         return [$self->facet_field_id_map->{by_class}{$class}{$field}];
 173     }
 174
 175     return [values( %{ $self->facet_field_id_map->{by_class}{$class} } )];
 176 }
 177
 178 sub search_field_id_map {
 179     my $self = shift;
 180     my $map = shift;
 181
 182     $self->custom_data->{search_field_id_map} ||= {};
 183     $self->custom_data->{search_field_id_map} = $map if ($map);
 184     return $self->custom_data->{search_field_id_map};
 185 }
 186
 187 sub add_search_field_id_map {
 188     my $self = shift;
 189     my $class = shift;
 190     my $field = shift;
 191     my $id = shift;
 192     my $weight = shift;
 193
 194     $self->add_search_field( $class => $field );
 195     $self->search_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
 196     $self->search_field_id_map->{by_class}{$class}{$field} = $id;
 197
 198     return {
 199         by_id => { $id => { classname => $class, field => $field, weight => $weight } },
 200         by_class => { $class => { $field => $id } }
 201     };
 202 }
 203
 204 sub search_field_class_by_id {
 205     my $self = shift;
 206     my $id = shift;
 207
 208     return $self->search_field_id_map->{by_id}{$id};
 209 }
 210
 211 sub search_field_ids_by_class {
 212     my $self = shift;
 213     my $class = shift;
 214     my $field = shift;
 215
 216     return undef unless ($class);
 217
 218     if ($field) {
 219         return [$self->search_field_id_map->{by_class}{$class}{$field}];
 220     }
 221
 222     return [values( %{ $self->search_field_id_map->{by_class}{$class} } )];
 223 }
 224
 225 sub relevance_bumps {
 226     my $self = shift;
 227     my $bumps = shift;
 228
 229     $self->custom_data->{rel_bumps} ||= {};
 230     $self->custom_data->{rel_bumps} = $bumps if ($bumps);
 231     return $self->custom_data->{rel_bumps};
 232 }
 233
 234 sub find_relevance_bumps {
 235     my $self = shift;
 236     my $class = shift;
 237     my $field = shift;
 238
 239     return $self->relevance_bumps->{$class}{$field};
 240 }
 241
 242 sub add_relevance_bump {
 243     my $self = shift;
 244     my $class = shift;
 245     my $field = shift;
 246     my $type = shift;
 247     my $multiplier = shift;
 248     my $active = shift;
 249
 250     if (defined($active) and $active eq 'f') {
 251         $active = 0;
 252     } else {
 253         $active = 1;
 254     }
 255
 256     $self->relevance_bumps->{$class}{$field}{$type} = { multiplier => $multiplier, active => $active };
 257
 258     return { $class => { $field => { $type => { multiplier => $multiplier, active => $active } } } };
 259 }
 260
 261
 262 sub initialize_search_field_id_map {
 263     my $self = shift;
 264     my $cmf_list = shift;
 265
 266     for my $cmf (@$cmf_list) {
 267         __PACKAGE__->add_search_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->search_field));
 268         __PACKAGE__->add_facet_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->facet_field));
 269     }
 270
 271     return $self->search_field_id_map;
 272 }
 273
 274 sub initialize_aliases {
 275     my $self = shift;
 276     my $cmsa_list = shift;
 277
 278     for my $cmsa (@$cmsa_list) {
 279         if (!$cmsa->field) {
 280             __PACKAGE__->add_search_class_alias( $cmsa->field_class, $cmsa->alias );
 281         } else {
 282             my $c = $self->search_field_class_by_id( $cmsa->field );
 283             __PACKAGE__->add_search_field_alias( $cmsa->field_class, $c->{field}, $cmsa->alias );
 284         }
 285     }
 286 }
 287
 288 sub initialize_relevance_bumps {
 289     my $self = shift;
 290     my $sra_list = shift;
 291
 292     for my $sra (@$sra_list) {
 293         my $c = $self->search_field_class_by_id( $sra->field );
 294         __PACKAGE__->add_relevance_bump( $c->{classname}, $c->{field}, $sra->bump_type, $sra->multiplier, $sra->active );
 295     }
 296
 297     return $self->relevance_bumps;
 298 }
 299
 300 sub initialize_query_normalizers {
 301     my $self = shift;
 302     my $tree = shift; # open-ils.cstore.direct.config.metabib_field_index_norm_map.search.atomic { "id" : { "!=" : null } }, { "flesh" : 1, "flesh_fields" : { "cmfinm" : ["norm"] }, "order_by" : [{ "class" : "cmfinm", "field" : "pos" }] }
 303
 304     for my $cmfinm ( @$tree ) {
 305         my $field_info = $self->search_field_class_by_id( $cmfinm->field );
 306         __PACKAGE__->add_query_normalizer( $field_info->{classname}, $field_info->{field}, $cmfinm->norm->func, OpenSRF::Utils::JSON->JSON2perl($cmfinm->params) );
 307     }
 308 }
 309
 310 sub initialize_dynamic_filters {
 311     my $self = shift;
 312     my $list = shift; # open-ils.cstore.direct.config.record_attr_definition.search.atomic { "id" : { "!=" : null } }
 313
 314     for my $crad ( @$list ) {
 315         __PACKAGE__->dynamic_filters( __PACKAGE__->add_search_filter( $crad->name ) ) if ($U->is_true($crad->filter));
 316         __PACKAGE__->dynamic_sorters( $crad->name ) if ($U->is_true($crad->sorter));
 317     }
 318 }
 319
 320 sub initialize_filter_normalizers {
 321     my $self = shift;
 322     my $tree = shift; # open-ils.cstore.direct.config.record_attr_index_norm_map.search.atomic { "id" : { "!=" : null } }, { "flesh" : 1, "flesh_fields" : { "crainm" : ["norm"] }, "order_by" : [{ "class" : "crainm", "field" : "pos" }] }
 323
 324     for my $crainm ( @$tree ) {
 325         __PACKAGE__->add_filter_normalizer( $crainm->attr, $crainm->norm->func, OpenSRF::Utils::JSON->JSON2perl($crainm->params) );
 326     }
 327 }
 328
 329 our $_complete = 0;
 330 sub initialization_complete {
 331     return $_complete;
 332 }
 333
 334 sub initialize {
 335     my $self = shift;
 336     my %args = @_;
 337
 338     return $_complete if ($_complete);
 339
 340     # tsearch rank normalization adjustments. see http://www.postgresql.org/docs/9.0/interactive/textsearch-controls.html#TEXTSEARCH-RANKING for details
 341     $self->custom_data->{rank_cd_weight_map} = {
 342         CD_logDocumentLength    => 1,
 343         CD_documentLength       => 2,
 344         CD_meanHarmonic         => 4,
 345         CD_uniqueWords          => 8,
 346         CD_logUniqueWords       => 16,
 347         CD_selfPlusOne          => 32
 348     };
 349
 350     $self->add_search_modifier( $_ ) for (keys %{ $self->custom_data->{rank_cd_weight_map} });
 351
 352     $self->initialize_search_field_id_map( $args{config_metabib_field} )
 353         if ($args{config_metabib_field});
 354
 355     $self->initialize_aliases( $args{config_metabib_search_alias} )
 356         if ($args{config_metabib_search_alias});
 357
 358     $self->initialize_relevance_bumps( $args{search_relevance_adjustment} )
 359         if ($args{search_relevance_adjustment});
 360
 361     $self->initialize_query_normalizers( $args{config_metabib_field_index_norm_map} )
 362         if ($args{config_metabib_field_index_norm_map});
 363
 364     $self->initialize_dynamic_filters( $args{config_record_attr_definition} )
 365         if ($args{config_record_attr_definition});
 366
 367     $self->initialize_filter_normalizers( $args{config_record_attr_index_norm_map} )
 368         if ($args{config_record_attr_index_norm_map});
 369
 370     $_complete = 1 if (
 371         $args{config_metabib_field_index_norm_map} &&
 372         $args{search_relevance_adjustment} &&
 373         $args{config_metabib_search_alias} &&
 374         $args{config_metabib_field} &&
 375         $args{config_record_attr_definition}
 376     );
 377
 378     return $_complete;
 379 }
 380
 381 sub TEST_SETUP {
 382
 383     __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
 384
 385     __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
 386     __PACKAGE__->add_relevance_bump( series => seriestitle => first_word => 1.5 );
 387     __PACKAGE__->add_relevance_bump( series => seriestitle => full_match => 20 );
 388
 389     __PACKAGE__->add_search_field_id_map( title => abbreviated => 2 => 1 );
 390     __PACKAGE__->add_relevance_bump( title => abbreviated => first_word => 1.5 );
 391     __PACKAGE__->add_relevance_bump( title => abbreviated => full_match => 20 );
 392
 393     __PACKAGE__->add_search_field_id_map( title => translated => 3 => 1 );
 394     __PACKAGE__->add_relevance_bump( title => translated => first_word => 1.5 );
 395     __PACKAGE__->add_relevance_bump( title => translated => full_match => 20 );
 396
 397     __PACKAGE__->add_search_field_id_map( title => proper => 6 => 1 );
 398     __PACKAGE__->add_query_normalizer( title => proper => 'search_normalize' );
 399     __PACKAGE__->add_relevance_bump( title => proper => first_word => 1.5 );
 400     __PACKAGE__->add_relevance_bump( title => proper => full_match => 20 );
 401     __PACKAGE__->add_relevance_bump( title => proper => word_order => 10 );
 402
 403     __PACKAGE__->add_search_field_id_map( author => corporate => 7 => 1 );
 404     __PACKAGE__->add_relevance_bump( author => corporate => first_word => 1.5 );
 405     __PACKAGE__->add_relevance_bump( author => corporate => full_match => 20 );
 406
 407     __PACKAGE__->add_facet_field_id_map( author => personal => 8 => 1 );
 408
 409     __PACKAGE__->add_search_field_id_map( author => personal => 8 => 1 );
 410     __PACKAGE__->add_relevance_bump( author => personal => first_word => 1.5 );
 411     __PACKAGE__->add_relevance_bump( author => personal => full_match => 20 );
 412     __PACKAGE__->add_query_normalizer( author => personal => 'search_normalize' );
 413     __PACKAGE__->add_query_normalizer( author => personal => 'split_date_range' );
 414
 415     __PACKAGE__->add_facet_field_id_map( subject => topic => 14 => 1 );
 416
 417     __PACKAGE__->add_search_field_id_map( subject => topic => 14 => 1 );
 418     __PACKAGE__->add_relevance_bump( subject => topic => first_word => 1 );
 419     __PACKAGE__->add_relevance_bump( subject => topic => full_match => 1 );
 420
 421     __PACKAGE__->add_search_field_id_map( subject => complete => 16 => 1 );
 422     __PACKAGE__->add_relevance_bump( subject => complete => first_word => 1 );
 423     __PACKAGE__->add_relevance_bump( subject => complete => full_match => 1 );
 424
 425     __PACKAGE__->add_search_field_id_map( keyword => keyword => 15 => 1 );
 426     __PACKAGE__->add_relevance_bump( keyword => keyword => first_word => 1 );
 427     __PACKAGE__->add_relevance_bump( keyword => keyword => full_match => 1 );
 428
 429
 430     __PACKAGE__->add_search_class_alias( keyword => 'kw' );
 431     __PACKAGE__->add_search_class_alias( title => 'ti' );
 432     __PACKAGE__->add_search_class_alias( author => 'au' );
 433     __PACKAGE__->add_search_class_alias( author => 'name' );
 434     __PACKAGE__->add_search_class_alias( author => 'dc.contributor' );
 435     __PACKAGE__->add_search_class_alias( subject => 'su' );
 436     __PACKAGE__->add_search_class_alias( subject => 'bib.subject(?:Title|Place|Occupation)' );
 437     __PACKAGE__->add_search_class_alias( series => 'se' );
 438     __PACKAGE__->add_search_class_alias( keyword => 'dc.identifier' );
 439
 440     __PACKAGE__->add_query_normalizer( author => corporate => 'search_normalize' );
 441     __PACKAGE__->add_query_normalizer( keyword => keyword => 'search_normalize' );
 442
 443     __PACKAGE__->add_search_field_alias( subject => name => 'bib.subjectName' );
 444
 445 }
 446
 447 __PACKAGE__->default_search_class( 'keyword' );
 448
 449 # implements EG-specific stored subqueries
 450 __PACKAGE__->add_search_filter( 'saved_query', sub { return __PACKAGE__->subquery_callback(@_) } );
 451 __PACKAGE__->add_search_filter( 'filter_group_entry', sub { return __PACKAGE__->filter_group_entry_callback(@_) } );
 452
 453 # will be retained simply for back-compat
 454 __PACKAGE__->add_search_filter( 'format' );
 455
 456 # grumble grumble, special cases against date1 and date2
 457 __PACKAGE__->add_search_filter( 'before' );
 458 __PACKAGE__->add_search_filter( 'after' );
 459 __PACKAGE__->add_search_filter( 'between' );
 460 __PACKAGE__->add_search_filter( 'during' );
 461
 462 # used by layers above this
 463 __PACKAGE__->add_search_filter( 'statuses' );
 464 __PACKAGE__->add_search_filter( 'locations' );
 465 __PACKAGE__->add_search_filter( 'location_groups' );
 466 __PACKAGE__->add_search_filter( 'site' );
 467 __PACKAGE__->add_search_filter( 'pref_ou' );
 468 __PACKAGE__->add_search_filter( 'lasso' );
 469 __PACKAGE__->add_search_filter( 'my_lasso' );
 470 __PACKAGE__->add_search_filter( 'depth' );
 471 __PACKAGE__->add_search_filter( 'language' );
 472 __PACKAGE__->add_search_filter( 'offset' );
 473 __PACKAGE__->add_search_filter( 'limit' );
 474 __PACKAGE__->add_search_filter( 'check_limit' );
 475 __PACKAGE__->add_search_filter( 'skip_check' );
 476 __PACKAGE__->add_search_filter( 'superpage' );
 477 __PACKAGE__->add_search_filter( 'superpage_size' );
 478 __PACKAGE__->add_search_filter( 'estimation_strategy' );
 479 __PACKAGE__->add_search_modifier( 'available' );
 480 __PACKAGE__->add_search_modifier( 'staff' );
 481
 482 # Start from container data (bre, acn, acp): container(bre,bookbag,123,deadb33fdeadb33fdeadb33fdeadb33f)
 483 __PACKAGE__->add_search_filter( 'container' );
 484
 485 # Start from a list of record ids, either bre or metarecords, depending on the #metabib modifier
 486 __PACKAGE__->add_search_filter( 'record_list' );
 487
 488 # used internally, but generally not user-settable
 489 __PACKAGE__->add_search_filter( 'preferred_language' );
 490 __PACKAGE__->add_search_filter( 'preferred_language_weight' );
 491 __PACKAGE__->add_search_filter( 'preferred_language_multiplier' );
 492 __PACKAGE__->add_search_filter( 'core_limit' );
 493
 494 # XXX Valid values to be supplied by SVF
 495 __PACKAGE__->add_search_filter( 'sort' );
 496
 497 # modifies core query, not configurable
 498 __PACKAGE__->add_search_modifier( 'descending' );
 499 __PACKAGE__->add_search_modifier( 'ascending' );
 500 __PACKAGE__->add_search_modifier( 'nullsfirst' );
 501 __PACKAGE__->add_search_modifier( 'nullslast' );
 502 __PACKAGE__->add_search_modifier( 'metarecord' );
 503 __PACKAGE__->add_search_modifier( 'metabib' );
 504
 505
 506 #-------------------------------
 507 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan;
 508 use base 'QueryParser::query_plan';
 509 use OpenSRF::Utils::Logger qw($logger);
 510 use Data::Dumper;
 511 use OpenILS::Application::AppUtils;
 512 my $apputils = "OpenILS::Application::AppUtils";
 513
 514
 515 sub toSQL {
 516     my $self = shift;
 517
 518     my %filters;
 519     my ($format) = $self->find_filter('format');
 520     if ($format) {
 521         my ($t,$f) = split('-', $format->args->[0]);
 522         $self->new_filter( item_type => [ split '', $t ] ) if ($t);
 523         $self->new_filter( item_form => [ split '', $f ] ) if ($f);
 524     }
 525
 526     for my $f ( qw/preferred_language preferred_language_multiplier preferred_language_weight core_limit check_limit skip_check superpage superpage_size/ ) {
 527         my $col = $f;
 528         $col = 'preferred_language_multiplier' if ($f eq 'preferred_language_weight');
 529         my ($filter) = $self->find_filter($f);
 530         if ($filter and @{$filter->args}) {
 531             $filters{$col} = $filter->args->[0];
 532         }
 533     }
 534
 535     $self->QueryParser->superpage($filters{superpage}) if ($filters{superpage});
 536     $self->QueryParser->superpage_size($filters{superpage_size}) if ($filters{superpage_size});
 537     $self->QueryParser->core_limit($filters{core_limit}) if ($filters{core_limit});
 538
 539     $logger->debug("Query plan:\n".Dumper($self));
 540
 541     my $flat_plan = $self->flatten;
 542
 543     # generate the relevance ranking
 544     my $rel = "AVG(\n${spc}${spc}(" . join(")+\n${spc}${spc}(", @{$$flat_plan{rank_list}}) . ")\n${spc})+1";
 545
 546     # find any supplied sort option
 547     my ($sort_filter) = $self->find_filter('sort');
 548     if ($sort_filter) {
 549         $sort_filter = $sort_filter->args->[0];
 550     } else {
 551         $sort_filter = 'rel';
 552     }
 553
 554     if (($filters{preferred_language} || $self->QueryParser->default_preferred_language) && ($filters{preferred_language_multiplier} || $self->QueryParser->default_preferred_language_multiplier)) {
 555         my $pl = $self->QueryParser->quote_value( $filters{preferred_language} ? $filters{preferred_language} : $self->QueryParser->default_preferred_language );
 556         my $plw = $filters{preferred_language_multiplier} ? $filters{preferred_language_multiplier} : $self->QueryParser->default_preferred_language_multiplier;
 557         $rel = "($rel * COALESCE( NULLIF( FIRST(mrd.attrs \@> hstore('item_lang', $pl)), FALSE )::INT * $plw, 1))";
 558     }
 559     $rel = "1.0/($rel)::NUMERIC";
 560
 561     my $mra_join = 'INNER JOIN metabib.record_attr mrd ON (m.source = mrd.id';
 562     $mra_join .= ' AND '. $flat_plan->{fwhere} if $flat_plan->{fwhere};
 563     $mra_join .= ')';
 564
 565     my $rank = $rel;
 566
 567     my $desc = 'ASC';
 568     $desc = 'DESC' if ($self->find_modifier('descending'));
 569
 570     my $nullpos = 'NULLS LAST';
 571     $nullpos = 'NULLS FIRST' if ($self->find_modifier('nullsfirst'));
 572
 573     if (grep {$_ eq $sort_filter} @{$self->QueryParser->dynamic_sorters}) {
 574         $rank = "FIRST(mrd.attrs->'$sort_filter')"
 575     } elsif ($sort_filter eq 'create_date') {
 576         $rank = "FIRST((SELECT create_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
 577     } elsif ($sort_filter eq 'edit_date') {
 578         $rank = "FIRST((SELECT edit_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
 579     } else {
 580         # default to rel ranking
 581         $rank = $rel;
 582     }
 583
 584     my $key = 'm.source';
 585     $key = 'm.metarecord' if (grep {$_->name eq 'metarecord' or $_->name eq 'metabib'} @{$self->modifiers});
 586
 587     my ($before) = $self->find_filter('before');
 588     my ($after) = $self->find_filter('after');
 589     my ($during) = $self->find_filter('during');
 590     my ($between) = $self->find_filter('between');
 591     my ($container) = $self->find_filter('container');
 592     my ($record_list) = $self->find_filter('record_list');
 593
 594     if ($before and @{$before->args} == 1) {
 595         $before = "AND (mrd.attrs->'date1') <= " . $self->QueryParser->quote_value($before->args->[0]);
 596     } else {
 597         $before = '';
 598     }
 599
 600     if ($after and @{$after->args} == 1) {
 601         $after = "AND (mrd.attrs->'date1') >= " . $self->QueryParser->quote_value($after->args->[0]);
 602     } else {
 603         $after = '';
 604     }
 605
 606     if ($during and @{$during->args} == 1) {
 607         $during = "AND " . $self->QueryParser->quote_value($during->args->[0]) . " BETWEEN (mrd.attrs->'date1') AND (mrd.attrs->'date2')";
 608     } else {
 609         $during = '';
 610     }
 611
 612     if ($between and @{$between->args} == 2) {
 613         $between = "AND (mrd.attrs->'date1') BETWEEN " . $self->QueryParser->quote_value($between->args->[0]) . " AND " . $self->QueryParser->quote_value($between->args->[1]);
 614     } else {
 615         $between = '';
 616     }
 617
 618     if ($container and @{$container->args} >= 3) {
 619         my ($class, $ctype, $cid, $token) = @{ $container->args };
 620
 621         my $perm_join = '';
 622         my $rec_join = '';
 623         my $rec_field = 'ci.target_biblio_record_entry';
 624
 625         if ($class eq 'bre') {
 626             $class = 'biblio_record_entry';
 627         } elsif ($class eq 'acn') {
 628             $class = 'call_number';
 629             $rec_field = 'cn.record';
 630             $rec_join = 'JOIN asset.call_number cn ON (ci.target_call_number = cn.id)';
 631         } elsif ($class eq 'acp') {
 632             $class = 'copy';
 633             $rec_field = 'cn.record';
 634             $rec_join = 'JOIN asset.copy cp ON (ci.target_copy = cp.id) JOIN asset.call_number cn ON (cp.call_number = cn.id)';
 635 #        } elsif ($class eq 'au') {
 636 #            $class = 'user';
 637 #            $rec_field = 'cn.record';
 638 #            $rec_join = 'JOIN asset.call_number cn ON ci.target_call_number = cn.id';
 639         } else { $class = undef };
 640
 641         if ($class) {
 642             my ($u,$e) = $apputils->checksesperm($token) if ($token);
 643             $perm_join = 'OR c.owner = ' . $u->id if ($u && !$e);
 644
 645             $container = qq<
 646         JOIN ( SELECT $rec_field AS container_item
 647                 FROM  container.${class}_bucket_item ci
 648                       JOIN container.${class}_bucket c ON (c.id = ci.bucket)
 649                       $rec_join
 650                 WHERE c.btype = > . $self->QueryParser->quote_value($ctype) .
 651                     qq< AND c.id = > . $self->QueryParser->quote_value($cid) .
 652                     qq< AND (c.pub IS TRUE $perm_join)) container ON (container.container_item = m.source) >;
 653         } else {$container = ''};
 654     } else {
 655         $container = '';
 656     }
 657
 658     if ($record_list and @{$record_list->args} > 0) {
 659         $record_list = 'JOIN (VALUES (' . join('),(', map  { $self->QueryParser->quote_value($_) } @{ $record_list->args}) . ")) record_list(id) ON (record_list.id::BIGINT = $key)"
 660     } else {
 661         $record_list = '';
 662     }
 663
 664     my $core_limit = $self->QueryParser->core_limit || 25000;
 665
 666     my $flat_where = $$flat_plan{where};
 667     if ($flat_where eq '()') {
 668         $flat_where = '';
 669     } else {
 670         $flat_where = "AND $flat_where";
 671     }
 672     my $with = $$flat_plan{with};
 673     $with= "\nWITH $with" if $with;
 674
 675     # Need an array for query parser db function; this gives a better plan
 676     # than the ARRAY_AGG(DISTINCT m.source) option as of PostgreSQL 9.1
 677     my $agg_records = 'ARRAY[m.source] AS records';
 678     if ($key =~ /metarecord/) {
 679         # metarecord searches still require the ARRAY_AGG approach
 680         $agg_records = 'ARRAY_AGG(DISTINCT m.source) AS records';
 681     }
 682
 683     my $sql = <<SQL;
 684 $with
 685 SELECT  $key AS id,
 686         $agg_records,
 687         $rel AS rel,
 688         $rank AS rank,
 689         FIRST(mrd.attrs->'date1') AS tie_break
 690   FROM  metabib.metarecord_source_map m
 691         $container
 692         $record_list
 693         $$flat_plan{from}
 694         $mra_join
 695   WHERE 1=1
 696         $before
 697         $after
 698         $during
 699         $between
 700         $flat_where
 701   GROUP BY 1
 702   ORDER BY 4 $desc $nullpos, 5 DESC $nullpos, 3 DESC
 703   LIMIT $core_limit
 704 SQL
 705
 706     warn $sql if $self->QueryParser->debug;
 707     return $sql;
 708
 709 }
 710
 711
 712 sub rel_bump {
 713     my $self = shift;
 714     my $node = shift;
 715     my $bump = shift;
 716     my $multiplier = shift;
 717
 718     my $only_atoms = $node->only_atoms;
 719     return '' if (!@$only_atoms);
 720
 721     if ($bump eq 'first_word') {
 722         return " /* first_word */ COALESCE(NULLIF( (search_normalize(".$node->table_alias.".value) ~ ('^'||search_normalize(".$self->QueryParser->quote_phrase_value($only_atoms->[0]->content)."))), FALSE )::INT * $multiplier, 1)";
 723     } elsif ($bump eq 'full_match') {
 724         return " /* full_match */ COALESCE(NULLIF( (search_normalize(".$node->table_alias.".value) ~ ('^'||".
 725                     join( "||' '||", map { "search_normalize(".$self->QueryParser->quote_phrase_value($_->content).")" } @$only_atoms )."||'\$')), FALSE )::INT * $multiplier, 1)";
 726     } elsif ($bump eq 'word_order') {
 727         return " /* word_order */ COALESCE(NULLIF( (search_normalize(".$node->table_alias.".value) ~ (".
 728                     join( "||'.*'||", map { "search_normalize(".$self->QueryParser->quote_phrase_value($_->content).")" } @$only_atoms ).")), FALSE )::INT * $multiplier, 1)";
 729     }
 730
 731     return '';
 732 }
 733
 734 sub flatten {
 735     my $self = shift;
 736
 737     my $from = shift || '';
 738     my $where = shift || '(';
 739     my $with = '';
 740     my $fwhere = shift || ''; # for joining dynamic filters (mra)
 741
 742     my @dyn_filters;
 743     for my $filter (@{$self->filters}) {
 744         push(@dyn_filters, $filter) if
 745             grep { $_ eq $filter->name }
 746                 @{ $self->QueryParser->dynamic_filters };
 747     };
 748
 749     my @rank_list;
 750     for my $node ( @{$self->query_nodes} ) {
 751
 752         if (ref($node)) {
 753             if ($node->isa( 'QueryParser::query_plan::node' )) {
 754
 755                 unless (@{$node->only_atoms}) {
 756                     push @rank_list, '1';
 757                     $where .= 'TRUE';
 758                     next;
 759                 }
 760
 761                 my $table = $node->table;
 762                 my $talias = $node->table_alias;
 763
 764                 my $node_rank = 'COALESCE(' . $node->rank . " * ${talias}.weight, 0.0)";
 765
 766                 my $core_limit = $self->QueryParser->core_limit || 25000;
 767                 $from .= "\n${spc}LEFT JOIN (\n${spc}${spc}SELECT fe.*, fe_weight.weight, ${talias}_xq.tsq /* search */\n${spc}${spc}  FROM  $table AS fe";
 768                 $from .= "\n${spc}${spc}${spc}JOIN config.metabib_field AS fe_weight ON (fe_weight.id = fe.field)";
 769
 770                 if ($node->dummy_count < @{$node->only_atoms} ) {
 771                     $with .= ",\n" if $with;
 772                     $with .= "${talias}_xq AS (SELECT ". $node->tsquery ." AS tsq )";
 773                     $from .= "\n${spc}${spc}${spc}JOIN ${talias}_xq ON (fe.index_vector @@ ${talias}_xq.tsq)";
 774                 } else {
 775                     $from .= "\n${spc}${spc}${spc}, (SELECT NULL::tsquery AS tsq ) AS x";
 776                 }
 777
 778                 my @bump_fields;
 779                 if (@{$node->fields} > 0) {
 780                     @bump_fields = @{$node->fields};
 781
 782                     my @field_ids = grep defined, (
 783                         map {
 784                             $self->QueryParser->search_field_ids_by_class(
 785                                 $node->classname, $_
 786                             )->[0]
 787                         } @bump_fields
 788                     );
 789                     if (@field_ids) {
 790                         $from .= "\n${spc}${spc}${spc}WHERE fe_weight.id IN  (" .
 791                             join(',', @field_ids) . ")";
 792                     }
 793
 794                 } else {
 795                     @bump_fields = @{$self->QueryParser->search_fields->{$node->classname}};
 796                 }
 797
 798                 ###$from .= "\n${spc}${spc}LIMIT $core_limit";
 799                 $from .= "\n${spc}) AS $talias ON (m.source = ${talias}.source)";
 800
 801
 802                 my %used_bumps;
 803                 for my $field ( @bump_fields ) {
 804                     my $bumps = $self->QueryParser->find_relevance_bumps( $node->classname => $field );
 805                     for my $b (keys %$bumps) {
 806                         next if (!$$bumps{$b}{active});
 807                         next if ($used_bumps{$b});
 808                         $used_bumps{$b} = 1;
 809
 810                         next if ($$bumps{$b}{multiplier} == 1); # optimization to remove unneeded bumps
 811
 812                         my $bump_case = $self->rel_bump( $node, $b, $$bumps{$b}{multiplier} );
 813                         $node_rank .= "\n${spc}${spc}${spc}${spc} * " . $bump_case if ($bump_case);
 814                     }
 815                 }
 816
 817
 818                 my $twhere .= '(' . $talias . ".id IS NOT NULL";
 819                 $twhere .= ' AND ' . join(' AND ', map {"${talias}.value ~* ".$self->QueryParser->quote_phrase_value($_)} @{$node->phrases}) if (@{$node->phrases});
 820                 $twhere .= ' AND ' . join(' AND ', map {"${talias}.value !~* ".$self->QueryParser->quote_phrase_value($_)} @{$node->unphrases}) if (@{$node->unphrases});
 821                 $twhere .= ')';
 822
 823                 if (@dyn_filters or !$self->top_plan) {
 824                     # if this WHERE is represented within the dynamic
 825                     # filter's ON clause, it's not also needed in the main WHERE.
 826                     $fwhere .= $twhere;
 827                 } else {
 828                     $where .= $twhere;
 829                 }
 830
 831                 push @rank_list, $node_rank;
 832
 833             } elsif ($node->isa( 'QueryParser::query_plan::facet' )) {
 834
 835                 my $table = $node->table;
 836                 my $talias = $node->table_alias;
 837
 838                 my @field_ids;
 839                 if (@{$node->fields} > 0) {
 840                     push(@field_ids, $self->QueryParser->facet_field_ids_by_class( $node->classname, $_ )->[0]) for (@{$node->fields});
 841                 } else {
 842                     @field_ids = @{ $self->QueryParser->facet_field_ids_by_class( $node->classname ) };
 843                 }
 844
 845                 my $join_type = ($node->negate or @dyn_filters or !$self->top_plan) ? 'LEFT' : 'INNER';
 846                 $from .= "\n${spc}$join_type JOIN /* facet */ metabib.facet_entry $talias ON (\n${spc}${spc}m.source = ${talias}.source\n${spc}${spc}".
 847                          "AND SUBSTRING(${talias}.value,1,1024) IN (" . join(",", map { $self->QueryParser->quote_value($_) } @{$node->values}) . ")\n${spc}${spc}".
 848                          "AND ${talias}.field IN (". join(',', @field_ids) . ")\n${spc})";
 849
 850                 if (@dyn_filters or !$self->top_plan) {
 851                     my $NOT = $node->negate ? '' : ' NOT';
 852                     $fwhere .= "${talias}.id IS$NOT NULL";
 853                 } else {
 854                     $where .= $node->negate ? "${talias}.id IS NULL" : 'TRUE';
 855                 }
 856
 857             } else {
 858                 my $subnode = $node->flatten;
 859
 860                 # strip the trailing bool from the previous loop if there is
 861                 # nothing to add to the where/fwhere within this loop.
 862                 if ($$subnode{where} eq '()') {
 863                     $where =~ s/\s(AND|OR)\s$//;
 864
 865                 } elsif ($$subnode{fwhere} eq '') {
 866                     $fwhere =~ s/\s(AND|OR)\s$//;
 867                 }
 868
 869                 push(@rank_list, @{$$subnode{rank_list}});
 870                 $from .= $$subnode{from};
 871
 872                 $where .= "($$subnode{where})" unless $$subnode{where} eq '()';
 873                 $fwhere .= "($$subnode{fwhere})" if $$subnode{fwhere};
 874
 875                 if ($$subnode{with}) {
 876                     $with .= ', ' if $with;
 877                     $with .= " " . $$subnode{with};
 878                 }
 879             }
 880         } else {
 881
 882             warn "flatten(): appending WHERE bool to: $where\n" if $self->QueryParser->debug;
 883
 884             if ($fwhere) {
 885                 # bool joiner for inter-plan filters
 886                 $fwhere .= ' AND ' if ($node eq '&');
 887                 $fwhere .= ' OR ' if ($node eq '|');
 888
 889             } elsif ($where ne '(') {
 890
 891                 $where .= ' AND ' if ($node eq '&');
 892                 $where .= ' OR ' if ($node eq '|');
 893             }
 894         }
 895     }
 896
 897     # for each dynamic filter, build the ON clause for the JOIN
 898     for my $filter (@dyn_filters) {
 899
 900         warn "flatten(): processing dynamic filter ". $filter->name ."\n"
 901             if $self->QueryParser->debug;
 902
 903         # bool joiner for intra-plan nodes/filters
 904         $fwhere .= sprintf(" %s ", ($self->joiner eq '&' ? 'AND' : 'OR')) if $fwhere;
 905
 906         my @fargs = @{$filter->args};
 907         my $NOT = $filter->negate ? ' NOT' : '';
 908         my $fname = $filter->name;
 909         $fname = 'item_lang' if $fname eq 'language'; #XXX filter aliases
 910
 911         $fwhere .= sprintf(
 912             "attrs->'%s'$NOT IN (%s)", $fname,
 913             join(',', map { $self->QueryParser->quote_value($_) } @fargs)
 914         );
 915
 916         warn "flatten(): filter where => $fwhere\n"
 917             if $self->QueryParser->debug;
 918     }
 919     warn "flatten(): full filter where => $fwhere\n" if $self->QueryParser->debug;
 920
 921     return { rank_list => \@rank_list, from => $from, where => $where.')',  with => $with, fwhere => $fwhere };
 922 }
 923
 924
 925 #-------------------------------
 926 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::filter;
 927 use base 'QueryParser::query_plan::filter';
 928
 929 #-------------------------------
 930 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::facet;
 931 use base 'QueryParser::query_plan::facet';
 932
 933 sub classname {
 934     my $self = shift;
 935     my ($classname) = split '\|', $self->name;
 936     return $classname;
 937 }
 938
 939 sub table {
 940     my $self = shift;
 941     return 'metabib.' . $self->classname . '_field_entry';
 942 }
 943
 944 sub fields {
 945     my $self = shift;
 946     my ($classname,@fields) = split '\|', $self->name;
 947     return \@fields;
 948 }
 949
 950 sub table_alias {
 951     my $self = shift;
 952
 953     my $table_alias = "$self";
 954     $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
 955     $table_alias .= '_' . $self->name;
 956     $table_alias =~ s/\|/_/go;
 957
 958     return $table_alias;
 959 }
 960
 961
 962 #-------------------------------
 963 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::modifier;
 964 use base 'QueryParser::query_plan::modifier';
 965
 966 #-------------------------------
 967 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node::atom;
 968 use base 'QueryParser::query_plan::node::atom';
 969
 970 sub sql {
 971     my $self = shift;
 972     my $sql = shift;
 973
 974     $self->{sql} = $sql if ($sql);
 975
 976     return $self->{sql} if ($self->{sql});
 977     return $self->buildSQL;
 978 }
 979
 980 sub buildSQL {
 981     my $self = shift;
 982
 983     my $classname = $self->node->classname;
 984
 985     return $self->sql("to_tsquery('$classname','')") if $self->{dummy};
 986
 987     my $normalizers = $self->node->plan->QueryParser->query_normalizers( $classname );
 988     my $fields = $self->node->fields;
 989
 990     $fields = $self->node->plan->QueryParser->search_fields->{$classname} if (!@$fields);
 991
 992     my %norms;
 993     my $pos = 0;
 994     for my $field (@$fields) {
 995         for my $nfield (keys %$normalizers) {
 996             for my $nizer ( @{$$normalizers{$nfield}} ) {
 997                 if ($field eq $nfield) {
 998                     my $param_string = OpenSRF::Utils::JSON->perl2JSON($nizer->{params});
 999                     if (!exists($norms{$nizer->{function}.$param_string})) {
1000                         $norms{$nizer->{function}.$param_string} = {p=>$pos++,n=>$nizer};
1001                     }
1002                 }
1003             }
1004         }
1005     }
1006
1007     my $sql = $self->node->plan->QueryParser->quote_value($self->content);
1008
1009     for my $n ( map { $$_{n} } sort { $$a{p} <=> $$b{p} } values %norms ) {
1010         $sql = join(', ', $sql, map { $self->node->plan->QueryParser->quote_value($_) } @{ $n->{params} });
1011         $sql = $n->{function}."($sql)";
1012     }
1013
1014     my $prefix = $self->prefix || '';
1015     my $suffix = $self->suffix || '';
1016
1017     $prefix = "'$prefix' ||" if $prefix;
1018     my $suffix_op = '';
1019     my $suffix_after = '';
1020
1021     $suffix_op = ":$suffix" if $suffix;
1022     $suffix_after = "|| '$suffix_op'" if $suffix;
1023
1024     $sql = "to_tsquery('$classname', COALESCE(NULLIF($prefix '(' || btrim(regexp_replace($sql,E'(?:\\\\s+|:)','$suffix_op&','g'),'&|') $suffix_after || ')', '()'), ''))";
1025
1026     return $self->sql($sql);
1027 }
1028
1029 #-------------------------------
1030 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node;
1031 use base 'QueryParser::query_plan::node';
1032
1033 sub only_atoms {
1034     my $self = shift;
1035
1036     $self->{dummy_count} = 0;
1037
1038     my $atoms = $self->query_atoms;
1039     my @only_atoms;
1040     for my $a (@$atoms) {
1041         push(@only_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom'));
1042         $self->{dummy_count}++ if (ref($a) && $a->{dummy});
1043     }
1044
1045     return \@only_atoms;
1046 }
1047
1048 sub dummy_count {
1049     my $self = shift;
1050     return $self->{dummy_count};
1051 }
1052
1053 sub table {
1054     my $self = shift;
1055     my $table = shift;
1056     $self->{table} = $table if ($table);
1057     return $self->{table} if $self->{table};
1058     return $self->table( 'metabib.' . $self->classname . '_field_entry' );
1059 }
1060
1061 sub table_alias {
1062     my $self = shift;
1063     my $table_alias = shift;
1064     $self->{table_alias} = $table_alias if ($table_alias);
1065     return $self->{table_alias} if ($self->{table_alias});
1066
1067     $table_alias = "$self";
1068     $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1069     $table_alias .= '_' . $self->requested_class;
1070     $table_alias =~ s/\|/_/go;
1071
1072     return $self->table_alias( $table_alias );
1073 }
1074
1075 sub tsquery {
1076     my $self = shift;
1077     return $self->{tsquery} if ($self->{tsquery});
1078
1079     for my $atom (@{$self->query_atoms}) {
1080         if (ref($atom)) {
1081             $self->{tsquery} .= "\n${spc}${spc}${spc}" .$atom->sql;
1082         } else {
1083             $self->{tsquery} .= $atom x 2;
1084         }
1085     }
1086
1087     return $self->{tsquery};
1088 }
1089
1090 sub rank {
1091     my $self = shift;
1092
1093     my $rank_norm_map = $self->plan->QueryParser->custom_data->{rank_cd_weight_map};
1094
1095     my $cover_density = 0;
1096     for my $norm ( keys %$rank_norm_map) {
1097         $cover_density += $$rank_norm_map{$norm} if ($self->plan->find_modifier($norm));
1098     }
1099
1100     return $self->{rank} if ($self->{rank});
1101     return $self->{rank} = 'ts_rank_cd(' . $self->table_alias . '.index_vector, ' . $self->table_alias . ".tsq, $cover_density)";
1102 }
1103
1104
1105 1;
1106