]> git.evergreen-ils.org Git - Evergreen.git/blob - Open-ILS/src/perlmods/OpenILS/Application/Storage/Publisher/metabib.pm
adding ou and sort support to z-style searches
[Evergreen.git] / Open-ILS / src / perlmods / OpenILS / Application / Storage / Publisher / metabib.pm
1 package OpenILS::Application::Storage::Publisher::metabib;
2 use base qw/OpenILS::Application::Storage::Publisher/;
3 use vars qw/$VERSION/;
4 use OpenSRF::EX qw/:try/;
5 use OpenILS::Application::Storage::FTS;
6 use OpenILS::Utils::Fieldmapper;
7 use OpenSRF::Utils::Logger qw/:level/;
8 use OpenSRF::Utils::Cache;
9 use Data::Dumper;
10 use Digest::MD5 qw/md5_hex/;
11
12
13 my $log = 'OpenSRF::Utils::Logger';
14
15 $VERSION = 1;
16
17 # need to order record IDs by:
18 #  1) format - text, movie, sound, software, images, maps, mixed, music, 3d
19 #  2) proximity --- XXX Can't do it cheap...
20 #  3) count
21 sub ordered_records_from_metarecord {
22         my $self = shift;
23         my $client = shift;
24         my $mr = shift;
25         my $formats = shift;
26
27         my (@types,@forms);
28
29         if ($formats) {
30                 my ($t, $f) = split '-', $formats;
31                 @types = split '', $t;
32                 @forms = split '', $f;
33         }
34
35         my $copies_visible = 'AND cp.opac_visible IS TRUE AND cs.holdable IS TRUE AND cl.opac_visible IS TRUE';
36         $copies_visible = '' if ($self->api_name =~ /staff/o);
37
38         my $sm_table = metabib::metarecord_source_map->table;
39         my $rd_table = metabib::record_descriptor->table;
40         my $cn_table = asset::call_number->table;
41         my $cl_table = asset::copy_location->table;
42         my $cp_table = asset::copy->table;
43         my $cs_table = config::copy_status->table;
44         my $out_table = actor::org_unit_type->table;
45
46         my $sql = <<"   SQL";
47          SELECT *
48            FROM (
49                 SELECT  rd.record,
50                         rd.item_type,
51                         rd.item_form,
52         SQL
53
54         if ($copies_visible) {
55                 $sql .= <<"             SQL"; 
56                         sum((SELECT     count(cp.id)
57                                FROM     $cp_table cp
58                                         JOIN $cs_table cs ON (cp.status = cs.id)
59                                         JOIN $cl_table cl ON (cp.location = cl.id)
60                                WHERE    cn.id = cp.call_number
61                                         $copies_visible
62                           )) AS count
63                 SQL
64         } else {
65                 $sql .= '0 AS count';
66         }
67
68         if ($copies_visible) {
69                 $sql .= <<"             SQL";
70                   FROM  $cn_table cn,
71                         $sm_table sm,
72                         $rd_table rd
73                   WHERE rd.record = sm.source
74                         AND cn.record = rd.record
75                         AND sm.metarecord = ?
76                 SQL
77         } else {
78                 $sql .= <<"             SQL";
79                   FROM  $sm_table sm,
80                         $rd_table rd
81                   WHERE rd.record = sm.source
82                         AND sm.metarecord = ?
83                 SQL
84         }
85
86         $sql .= <<"     SQL";
87                   GROUP BY rd.record, rd.item_type, rd.item_form
88                   ORDER BY
89                         CASE
90                                 WHEN rd.item_type IS NULL -- default
91                                         THEN 0
92                                 WHEN rd.item_type = '' -- default
93                                         THEN 0
94                                 WHEN rd.item_type IN ('a','t') -- books
95                                         THEN 1
96                                 WHEN rd.item_type = 'g' -- movies
97                                         THEN 2
98                                 WHEN rd.item_type IN ('i','j') -- sound recordings
99                                         THEN 3
100                                 WHEN rd.item_type = 'm' -- software
101                                         THEN 4
102                                 WHEN rd.item_type = 'k' -- images
103                                         THEN 5
104                                 WHEN rd.item_type IN ('e','f') -- maps
105                                         THEN 6
106                                 WHEN rd.item_type IN ('o','p') -- mixed
107                                         THEN 7
108                                 WHEN rd.item_type IN ('c','d') -- music
109                                         THEN 8
110                                 WHEN rd.item_type = 'r' -- 3d
111                                         THEN 9
112                         END,
113                         count DESC
114                 ) x
115         SQL
116
117         if ($copies_visible) {
118                 $sql .= ' WHERE x.count > 0'
119         }
120
121         if (@types) {
122                 $sql .= ' AND x.item_type IN ('.join(',',map{'?'}@types).')';
123         }
124
125         if (@forms) {
126                 $sql .= ' AND x.item_form IN ('.join(',',map{'?'}@forms).')';
127         }
128
129         my $sth = metabib::metarecord_source_map->db_Main->prepare_cached($sql);
130         $sth->execute("$mr", @types, @forms);
131         while ( my $row = $sth->fetchrow_arrayref ) {
132                 $client->respond( $$row[0] );
133         }
134         return undef;
135
136 }
137 __PACKAGE__->register_method(
138         api_name        => 'open-ils.storage.ordered.metabib.metarecord.records',
139         method          => 'ordered_records_from_metarecord',
140         api_level       => 1,
141         stream          => 1,
142         cachable        => 1,
143 );
144 __PACKAGE__->register_method(
145         api_name        => 'open-ils.storage.ordered.metabib.metarecord.records.staff',
146         method          => 'ordered_records_from_metarecord',
147         api_level       => 1,
148         stream          => 1,
149         cachable        => 1,
150 );
151
152
153 sub metarecord_copy_count {
154         my $self = shift;
155         my $client = shift;
156
157         my %args = @_;
158
159         my $sm_table = metabib::metarecord_source_map->table;
160         my $rd_table = metabib::record_descriptor->table;
161         my $cn_table = asset::call_number->table;
162         my $cp_table = asset::copy->table;
163         my $cl_table = asset::copy_location->table;
164         my $cs_table = config::copy_status->table;
165         my $out_table = actor::org_unit_type->table;
166         my $descendants = "actor.org_unit_descendants(u.id)";
167         my $ancestors = "actor.org_unit_ancestors(?)";
168
169         my $copies_visible = 'AND cp.opac_visible IS TRUE AND cs.holdable IS TRUE AND cl.opac_visible IS TRUE';
170         $copies_visible = '' if ($self->api_name =~ /staff/o);
171
172         my (@types,@forms);
173         my ($t_filter, $f_filter) = ('','');
174
175         if ($args{format}) {
176                 my ($t, $f) = split '-', $args{format};
177                 @types = split '', $t;
178                 @forms = split '', $f;
179                 if (@types) {
180                         $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
181                 }
182
183                 if (@forms) {
184                         $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
185                 }
186         }
187
188         my $sql = <<"   SQL";
189                 SELECT  t.depth,
190                         u.id AS org_unit,
191                         sum(
192                                 (SELECT count(cp.id)
193                                   FROM  $sm_table r
194                                         JOIN $cn_table cn ON (cn.record = r.source)
195                                         JOIN $rd_table rd ON (cn.record = rd.record)
196                                         JOIN $cp_table cp ON (cn.id = cp.call_number)
197                                         JOIN $cs_table cs ON (cp.status = cs.id)
198                                         JOIN $cl_table cl ON (cp.location = cl.id)
199                                         JOIN $descendants a ON (cp.circ_lib = a.id)
200                                   WHERE r.metarecord = ?
201                                         $copies_visible
202                                         $t_filter
203                                         $f_filter
204                                 )
205                         ) AS count,
206                         sum(
207                                 (SELECT count(cp.id)
208                                   FROM  $sm_table r
209                                         JOIN $cn_table cn ON (cn.record = r.source)
210                                         JOIN $rd_table rd ON (cn.record = rd.record)
211                                         JOIN $cp_table cp ON (cn.id = cp.call_number)
212                                         JOIN $cs_table cs ON (cp.status = cs.id)
213                                         JOIN $cl_table cl ON (cp.location = cl.id)
214                                         JOIN $descendants a ON (cp.circ_lib = a.id)
215                                   WHERE r.metarecord = ?
216                                         AND cp.status = 0
217                                         $copies_visible
218                                         $t_filter
219                                         $f_filter
220                                 )
221                         ) AS available
222
223                   FROM  $ancestors u
224                         JOIN $out_table t ON (u.ou_type = t.id)
225                   GROUP BY 1,2
226         SQL
227
228         my $sth = metabib::metarecord_source_map->db_Main->prepare_cached($sql);
229         $sth->execute(  ''.$args{metarecord},
230                         @types, 
231                         @forms,
232                         ''.$args{metarecord},
233                         @types, 
234                         @forms,
235                         ''.$args{org_unit}, 
236         ); 
237
238         while ( my $row = $sth->fetchrow_hashref ) {
239                 $client->respond( $row );
240         }
241         return undef;
242 }
243 __PACKAGE__->register_method(
244         api_name        => 'open-ils.storage.metabib.metarecord.copy_count',
245         method          => 'metarecord_copy_count',
246         api_level       => 1,
247         stream          => 1,
248         cachable        => 1,
249 );
250 __PACKAGE__->register_method(
251         api_name        => 'open-ils.storage.metabib.metarecord.copy_count.staff',
252         method          => 'metarecord_copy_count',
253         api_level       => 1,
254         stream          => 1,
255         cachable        => 1,
256 );
257
258 sub multi_search_full_rec {
259         my $self = shift;
260         my $client = shift;
261
262         my %args = @_;  
263         my $class_join = $args{class_join} || 'AND';
264         my $limit = $args{limit} || 100;
265         my $offset = $args{offset} || 0;
266         my @binds;
267         my @selects;
268
269         for my $arg (@{ $args{searches} }) {
270                 my $term = $$arg{term};
271                 my $limiters = $$arg{restrict};
272
273                 my ($index_col) = metabib::full_rec->columns('FTS');
274                 $index_col ||= 'value';
275                 my $search_table = metabib::full_rec->table;
276
277                 my $fts = OpenILS::Application::Storage::FTS->compile($term, 'value',"$index_col");
278
279                 my $fts_where = $fts->sql_where_clause();
280                 my @fts_ranks = $fts->fts_rank;
281
282                 my $rank = join(' + ', @fts_ranks);
283
284                 my @wheres;
285                 for my $limit (@$limiters) {
286                         push @wheres, "( tag = ? AND subfield LIKE ? AND $fts_where )";
287                         push @binds, $$limit{tag}, $$limit{subfield};
288                         $log->debug("Limiting query using { tag => $$limit{tag}, subfield => $$limit{subfield} }", DEBUG);
289                 }
290                 my $where = join(' OR ', @wheres);
291
292                 push @selects, "SELECT id, record, $rank as sum FROM $search_table WHERE $where";
293
294         }
295
296         my $descendants = defined($args{depth}) ?
297                                 "actor.org_unit_descendants($args{org_unit}, $args{depth})" :
298                                 "actor.org_unit_descendants($args{org_unit})" ;
299
300
301         my $metabib_record_descriptor = metabib::record_descriptor->table;
302         my $metabib_metarecord = metabib::metarecord->table;
303         my $metabib_metarecord_source_map_table = metabib::metarecord_source_map->table;
304         my $asset_call_number_table = asset::call_number->table;
305         my $asset_copy_table = asset::copy->table;
306         my $cs_table = config::copy_status->table;
307         my $cl_table = asset::copy_location->table;
308
309         my $cj = 'HAVING COUNT(x.id) = ' . scalar(@selects) if ($class_join eq 'AND');
310         my $search_table =
311                 '(SELECT x.record, sum(x.sum) FROM (('.
312                         join(') UNION ALL (', @selects).
313                         ")) x GROUP BY 1 $cj ORDER BY 2 DESC )";
314
315         my $has_vols = 'AND cn.owning_lib = d.id';
316         my $has_copies = 'AND cp.call_number = cn.id';
317         my $copies_visible = 'AND cp.opac_visible IS TRUE AND cs.holdable IS TRUE AND cl.opac_visible IS TRUE';
318
319         if ($self->api_name =~ /staff/o) {
320                 $copies_visible = '';
321                 $has_copies = '' if ($ou_type == 0);
322                 $has_vols = '' if ($ou_type == 0);
323         }
324
325         my ($t_filter, $f_filter) = ('','');
326
327         if ($args{format}) {
328                 my ($t, $f) = split '-', $args{format};
329                 my @types = split '', $t;
330                 my @forms = split '', $f;
331                 if (@types) {
332                         $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
333                 }
334
335                 if (@forms) {
336                         $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
337                 }
338                 push @binds, @types, @forms;
339         }
340
341
342         if ($copies_visible) {
343                 $select = <<"           SQL";
344                         SELECT  m.metarecord, sum(f.sum), count(DISTINCT cp.id), CASE WHEN COUNT(DISTINCT m.source) = 1 THEN MAX(m.source) ELSE MAX(0) END
345                         FROM    $search_table f,
346                                 $metabib_metarecord_source_map_table m,
347                                 $asset_call_number_table cn,
348                                 $asset_copy_table cp,
349                                 $cs_table cs,
350                                 $cl_table cl,
351                                 $metabib_record_descriptor rd,
352                                 $descendants d
353                         WHERE   m.source = f.record
354                                 AND cn.record = m.source
355                                 AND rd.record = m.source
356                                 AND cp.status = cs.id
357                                 AND cp.location = cl.id
358                                 $has_vols
359                                 $has_copies
360                                 $copies_visible
361                                 $t_filter
362                                 $f_filter
363                         GROUP BY m.metarecord HAVING count(DISTINCT cp.id) > 0
364                         ORDER BY 2 DESC,3 DESC
365                 SQL
366         } else {
367                 $select = <<"           SQL";
368                         SELECT  m.metarecord, 1, 0, CASE WHEN COUNT(DISTINCT m.source) = 1 THEN MAX(m.source) ELSE MAX(0) END
369                         FROM    $search_table f,
370                                 $metabib_metarecord_source_map_table m,
371                                 $metabib_record_descriptor rd
372                         WHERE   m.source = f.record
373                                 AND rd.record = m.source
374                                 $t_filter
375                                 $f_filter
376                         GROUP BY 1,2,3 
377                 SQL
378         }
379
380
381         $log->debug("Search SQL :: [$select]",DEBUG);
382
383         my $recs = metabib::full_rec->db_Main->selectall_arrayref("$select;", {}, @binds);
384         $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
385
386         my $count = @$recs;
387         for my $rec (@$recs[$offset .. $offset + $limit - 1]) {
388                 next unless ($$rec[0]);
389                 my ($mrid,$rank,$junk,$skip) = @$rec;
390                 $client->respond( [$mrid, sprintf('%0.3f',$rank), $skip, $count] );
391         }
392         return undef;
393 }
394 __PACKAGE__->register_method(
395         api_name        => 'open-ils.storage.metabib.full_rec.multi_search',
396         method          => 'multi_search_full_rec',
397         api_level       => 1,
398         stream          => 1,
399         cachable        => 1,
400 );
401 __PACKAGE__->register_method(
402         api_name        => 'open-ils.storage.metabib.full_rec.multi_search.staff',
403         method          => 'multi_search_full_rec',
404         api_level       => 1,
405         stream          => 1,
406         cachable        => 1,
407 );
408
409 sub search_full_rec {
410         my $self = shift;
411         my $client = shift;
412
413         my %args = @_;
414         
415         my $term = $args{term};
416         my $limiters = $args{restrict};
417
418         my ($index_col) = metabib::full_rec->columns('FTS');
419         $index_col ||= 'value';
420         my $search_table = metabib::full_rec->table;
421
422         my $fts = OpenILS::Application::Storage::FTS->compile($term, 'value',"$index_col");
423
424         my $fts_where = $fts->sql_where_clause();
425         my @fts_ranks = $fts->fts_rank;
426
427         my $rank = join(' + ', @fts_ranks);
428
429         my @binds;
430         my @wheres;
431         for my $limit (@$limiters) {
432                 push @wheres, "( tag = ? AND subfield LIKE ? AND $fts_where )";
433                 push @binds, $$limit{tag}, $$limit{subfield};
434                 $log->debug("Limiting query using { tag => $$limit{tag}, subfield => $$limit{subfield} }", DEBUG);
435         }
436         my $where = join(' OR ', @wheres);
437
438         my $select = "SELECT record, sum($rank) FROM $search_table WHERE $where GROUP BY 1 ORDER BY 2 DESC;";
439
440         $log->debug("Search SQL :: [$select]",DEBUG);
441
442         my $recs = metabib::full_rec->db_Main->selectall_arrayref($select, {}, @binds);
443         $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
444
445         $client->respond($_) for (@$recs);
446         return undef;
447 }
448 __PACKAGE__->register_method(
449         api_name        => 'open-ils.storage.direct.metabib.full_rec.search_fts.value',
450         method          => 'search_full_rec',
451         api_level       => 1,
452         stream          => 1,
453         cachable        => 1,
454 );
455 __PACKAGE__->register_method(
456         api_name        => 'open-ils.storage.direct.metabib.full_rec.search_fts.index_vector',
457         method          => 'search_full_rec',
458         api_level       => 1,
459         stream          => 1,
460         cachable        => 1,
461 );
462
463
464 # XXX factored most of the PG dependant stuff out of here... need to find a way to do "dependants".
465 sub search_class_fts {
466         my $self = shift;
467         my $client = shift;
468         my %args = @_;
469         
470         my $term = $args{term};
471         my $ou = $args{org_unit};
472         my $ou_type = $args{depth};
473         my $limit = $args{limit};
474         my $offset = $args{offset};
475
476         my $limit_clause = '';
477         my $offset_clause = '';
478
479         $limit_clause = "LIMIT $limit" if (defined $limit and int($limit) > 0);
480         $offset_clause = "OFFSET $offset" if (defined $offset and int($offset) > 0);
481
482         my (@types,@forms);
483         my ($t_filter, $f_filter) = ('','');
484
485         if ($args{format}) {
486                 my ($t, $f) = split '-', $args{format};
487                 @types = split '', $t;
488                 @forms = split '', $f;
489                 if (@types) {
490                         $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
491                 }
492
493                 if (@forms) {
494                         $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
495                 }
496         }
497
498
499
500         my $descendants = defined($ou_type) ?
501                                 "actor.org_unit_descendants($ou, $ou_type)" :
502                                 "actor.org_unit_descendants($ou)";
503
504         my $class = $self->{cdbi};
505         my $search_table = $class->table;
506
507         my $metabib_record_descriptor = metabib::record_descriptor->table;
508         my $metabib_metarecord = metabib::metarecord->table;
509         my $metabib_metarecord_source_map_table = metabib::metarecord_source_map->table;
510         my $asset_call_number_table = asset::call_number->table;
511         my $asset_copy_table = asset::copy->table;
512         my $cs_table = config::copy_status->table;
513         my $cl_table = asset::copy_location->table;
514
515         my ($index_col) = $class->columns('FTS');
516         $index_col ||= 'value';
517
518         my $fts = OpenILS::Application::Storage::FTS->compile($term, 'f.value', "f.$index_col");
519
520         my $fts_where = $fts->sql_where_clause;
521         my @fts_ranks = $fts->fts_rank;
522
523         my $rank = join(' + ', @fts_ranks);
524
525         my $has_vols = 'AND cn.owning_lib = d.id';
526         my $has_copies = 'AND cp.call_number = cn.id';
527         my $copies_visible = 'AND cp.opac_visible IS TRUE AND cs.holdable IS TRUE AND cl.opac_visible IS TRUE';
528
529         my $visible_count = ', count(DISTINCT cp.id)';
530         my $visible_count_test = 'HAVING count(DISTINCT cp.id) > 0';
531
532         if ($self->api_name =~ /staff/o) {
533                 $copies_visible = '';
534                 $visible_count_test = '';
535                 $has_copies = '' if ($ou_type == 0);
536                 $has_vols = '' if ($ou_type == 0);
537         }
538
539         my $rank_calc = <<"     RANK";
540                 , (SUM( $rank
541                         * CASE WHEN f.value ILIKE ? THEN 1.2 ELSE 1 END -- phrase order
542                         * CASE WHEN f.value ILIKE ? THEN 1.5 ELSE 1 END -- first word match
543                         * CASE WHEN f.value ~* ? THEN 2 ELSE 1 END -- only word match
544                 )/COUNT(m.source)), MIN(COALESCE(CHAR_LENGTH(f.value),1))
545         RANK
546
547         $rank_calc = ',1 , 1' if ($self->api_name =~ /unordered/o);
548
549         if ($copies_visible) {
550                 $select = <<"           SQL";
551                         SELECT  m.metarecord $rank_calc $visible_count, CASE WHEN COUNT(DISTINCT m.source) = 1 THEN MAX(m.source) ELSE MAX(0) END
552                         FROM    $search_table f,
553                                 $metabib_metarecord_source_map_table m,
554                                 $asset_call_number_table cn,
555                                 $asset_copy_table cp,
556                                 $cs_table cs,
557                                 $cl_table cl,
558                                 $metabib_record_descriptor rd,
559                                 $descendants d
560                         WHERE   $fts_where
561                                 AND m.source = f.source
562                                 AND cn.record = m.source
563                                 AND rd.record = m.source
564                                 AND cp.status = cs.id
565                                 AND cp.location = cl.id
566                                 $has_vols
567                                 $has_copies
568                                 $copies_visible
569                                 $t_filter
570                                 $f_filter
571                         GROUP BY 1 $visible_count_test
572                         ORDER BY 2 DESC,3
573                         $limit_clause $offset_clause
574                 SQL
575         } else {
576                 $select = <<"           SQL";
577                         SELECT  m.metarecord $rank_calc, 0, CASE WHEN COUNT(DISTINCT m.source) = 1 THEN MAX(m.source) ELSE MAX(0) END
578                         FROM    $search_table f,
579                                 $metabib_metarecord_source_map_table m,
580                                 $metabib_record_descriptor rd
581                         WHERE   $fts_where
582                                 AND m.source = f.source
583                                 AND rd.record = m.source
584                                 $t_filter
585                                 $f_filter
586                         GROUP BY 1, 4
587                         ORDER BY 2 DESC,3
588                         $limit_clause $offset_clause
589                 SQL
590         }
591
592         $log->debug("Field Search SQL :: [$select]",DEBUG);
593
594         my $SQLstring = join('%',$fts->words);
595         my $REstring = join('\\s+',$fts->words);
596         my $first_word = ($fts->words)[0].'%';
597         my $recs = ($self->api_name =~ /unordered/o) ? 
598                         $class->db_Main->selectall_arrayref($select, {}, @types, @forms) :
599                         $class->db_Main->selectall_arrayref($select, {},
600                                 '%'.lc($SQLstring).'%',                 # phrase order match
601                                 lc($first_word),                        # first word match
602                                 '^\\s*'.lc($REstring).'\\s*/?\s*$',     # full exact match
603                                 @types, @forms
604                         );
605         
606         $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
607
608         $client->respond($_) for (map { [@$_[0,1,3,4]] } @$recs);
609         return undef;
610 }
611
612 for my $class ( qw/title author subject keyword series/ ) {
613         __PACKAGE__->register_method(
614                 api_name        => "open-ils.storage.metabib.$class.search_fts.metarecord",
615                 method          => 'search_class_fts',
616                 api_level       => 1,
617                 stream          => 1,
618                 cdbi            => "metabib::${class}_field_entry",
619                 cachable        => 1,
620         );
621         __PACKAGE__->register_method(
622                 api_name        => "open-ils.storage.metabib.$class.search_fts.metarecord.unordered",
623                 method          => 'search_class_fts',
624                 api_level       => 1,
625                 stream          => 1,
626                 cdbi            => "metabib::${class}_field_entry",
627                 cachable        => 1,
628         );
629         __PACKAGE__->register_method(
630                 api_name        => "open-ils.storage.metabib.$class.search_fts.metarecord.staff",
631                 method          => 'search_class_fts',
632                 api_level       => 1,
633                 stream          => 1,
634                 cdbi            => "metabib::${class}_field_entry",
635                 cachable        => 1,
636         );
637         __PACKAGE__->register_method(
638                 api_name        => "open-ils.storage.metabib.$class.search_fts.metarecord.staff.unordered",
639                 method          => 'search_class_fts',
640                 api_level       => 1,
641                 stream          => 1,
642                 cdbi            => "metabib::${class}_field_entry",
643                 cachable        => 1,
644         );
645 }
646
647 # XXX factored most of the PG dependant stuff out of here... need to find a way to do "dependants".
648 sub search_class_fts_count {
649         my $self = shift;
650         my $client = shift;
651         my %args = @_;
652         
653         my $term = $args{term};
654         my $ou = $args{org_unit};
655         my $ou_type = $args{depth};
656         my $limit = $args{limit} || 100;
657         my $offset = $args{offset} || 0;
658
659         my $descendants = defined($ou_type) ?
660                                 "actor.org_unit_descendants($ou, $ou_type)" :
661                                 "actor.org_unit_descendants($ou)";
662                 
663         my (@types,@forms);
664         my ($t_filter, $f_filter) = ('','');
665
666         if ($args{format}) {
667                 my ($t, $f) = split '-', $args{format};
668                 @types = split '', $t;
669                 @forms = split '', $f;
670                 if (@types) {
671                         $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
672                 }
673
674                 if (@forms) {
675                         $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
676                 }
677         }
678
679
680         (my $search_class = $self->api_name) =~ s/.*metabib.(\w+).search_fts.*/$1/o;
681
682         my $class = $self->{cdbi};
683         my $search_table = $class->table;
684
685         my $metabib_record_descriptor = metabib::record_descriptor->table;
686         my $metabib_metarecord_source_map_table = metabib::metarecord_source_map->table;
687         my $asset_call_number_table = asset::call_number->table;
688         my $asset_copy_table = asset::copy->table;
689         my $cs_table = config::copy_status->table;
690         my $cl_table = asset::copy_location->table;
691
692         my ($index_col) = $class->columns('FTS');
693         $index_col ||= 'value';
694
695         my $fts = OpenILS::Application::Storage::FTS->compile($term, 'value',"$index_col");
696
697         my $fts_where = $fts->sql_where_clause;
698
699         my $has_vols = 'AND cn.owning_lib = d.id';
700         my $has_copies = 'AND cp.call_number = cn.id';
701         my $copies_visible = 'AND cp.opac_visible IS TRUE AND cs.holdable IS TRUE AND cl.opac_visible IS TRUE';
702         if ($self->api_name =~ /staff/o) {
703                 $copies_visible = '';
704                 $has_vols = '' if ($ou_type == 0);
705                 $has_copies = '' if ($ou_type == 0);
706         }
707
708         # XXX test an "EXISTS version of descendant checking...
709         my $select;
710         if ($copies_visible) {
711                 $select = <<"           SQL";
712                 SELECT  count(distinct  m.metarecord)
713                   FROM  $search_table f,
714                         $metabib_metarecord_source_map_table m,
715                         $metabib_metarecord_source_map_table mr,
716                         $asset_call_number_table cn,
717                         $asset_copy_table cp,
718                         $cs_table cs,
719                         $cl_table cl,
720                         $metabib_record_descriptor rd,
721                         $descendants d
722                   WHERE $fts_where
723                         AND mr.source = f.source
724                         AND mr.metarecord = m.metarecord
725                         AND cn.record = m.source
726                         AND rd.record = m.source
727                         AND cp.status = cs.id
728                         AND cp.location = cl.id
729                         $has_vols
730                         $has_copies
731                         $copies_visible
732                         $t_filter
733                         $f_filter
734                 SQL
735         } else {
736                 $select = <<"           SQL";
737                 SELECT  count(distinct  m.metarecord)
738                   FROM  $search_table f,
739                         $metabib_metarecord_source_map_table m,
740                         $metabib_metarecord_source_map_table mr,
741                         $metabib_record_descriptor rd
742                   WHERE $fts_where
743                         AND mr.source = f.source
744                         AND mr.metarecord = m.metarecord
745                         AND rd.record = m.source
746                         $t_filter
747                         $f_filter
748                 SQL
749         }
750
751         $log->debug("Field Search Count SQL :: [$select]",DEBUG);
752
753         my $recs = $class->db_Main->selectrow_arrayref($select, {}, @types, @forms)->[0];
754         
755         $log->debug("Count Search yielded $recs results.",DEBUG);
756
757         return $recs;
758
759 }
760 for my $class ( qw/title author subject keyword series/ ) {
761         __PACKAGE__->register_method(
762                 api_name        => "open-ils.storage.metabib.$class.search_fts.metarecord_count",
763                 method          => 'search_class_fts_count',
764                 api_level       => 1,
765                 stream          => 1,
766                 cdbi            => "metabib::${class}_field_entry",
767                 cachable        => 1,
768         );
769         __PACKAGE__->register_method(
770                 api_name        => "open-ils.storage.metabib.$class.search_fts.metarecord_count.staff",
771                 method          => 'search_class_fts_count',
772                 api_level       => 1,
773                 stream          => 1,
774                 cdbi            => "metabib::${class}_field_entry",
775                 cachable        => 1,
776         );
777 }
778
779
780 # XXX factored most of the PG dependant stuff out of here... need to find a way to do "dependants".
781 sub new_search_class_fts {
782         my $self = shift;
783         my $client = shift;
784         my %args = @_;
785         
786         my $term = $args{term};
787         my $ou = $args{org_unit};
788         my $ou_type = $args{depth};
789         my $limit = $args{limit};
790         my $offset = $args{offset} || 0;
791
792         my $limit_clause = '';
793         my $offset_clause = '';
794
795         $limit_clause = "LIMIT $limit" if (defined $limit and int($limit) > 0);
796         $offset_clause = "OFFSET $offset" if (defined $offset and int($offset) > 0);
797
798         my (@types,@forms);
799         my ($t_filter, $f_filter) = ('','');
800
801         if ($args{format}) {
802                 my ($t, $f) = split '-', $args{format};
803                 @types = split '', $t;
804                 @forms = split '', $f;
805                 if (@types) {
806                         $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
807                 }
808
809                 if (@forms) {
810                         $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
811                 }
812         }
813
814
815
816         my $descendants = defined($ou_type) ?
817                                 "actor.org_unit_descendants($ou, $ou_type)" :
818                                 "actor.org_unit_descendants($ou)";
819
820         my $class = $self->{cdbi};
821         my $search_table = $class->table;
822
823         my $metabib_record_descriptor = metabib::record_descriptor->table;
824         my $metabib_metarecord = metabib::metarecord->table;
825         my $metabib_metarecord_source_map_table = metabib::metarecord_source_map->table;
826         my $asset_call_number_table = asset::call_number->table;
827         my $asset_copy_table = asset::copy->table;
828         my $cs_table = config::copy_status->table;
829         my $cl_table = asset::copy_location->table;
830
831         my ($index_col) = $class->columns('FTS');
832         $index_col ||= 'value';
833
834         my $fts = OpenILS::Application::Storage::FTS->compile($term, 'f.value', "f.$index_col");
835
836         my $fts_where = $fts->sql_where_clause;
837         my @fts_ranks = $fts->fts_rank;
838
839         my $rank = join(' + ', @fts_ranks);
840
841         if ($self->api_name !~ /staff/o) {
842                 $select = <<"           SQL";
843                         SELECT  m.metarecord, 
844                                 (SUM(   $rank
845                                         * CASE WHEN f.value ILIKE ? THEN 1.2 ELSE 1 END -- phrase order
846                                         * CASE WHEN f.value ILIKE ? THEN 1.5 ELSE 1 END -- first word match
847                                         * CASE WHEN f.value ~* ? THEN 2 ELSE 1 END -- only word match
848                                 )/COUNT(m.source)),
849                                 CASE WHEN COUNT(DISTINCT rd.record) = 1 THEN MIN(m.source) ELSE 0 END
850                         FROM    $search_table f,
851                                 $metabib_metarecord_source_map_table m,
852                                 $metabib_metarecord_source_map_table mr,
853                                 $metabib_record_descriptor rd
854                         WHERE   $fts_where
855                                 AND mr.source = f.source
856                                 AND mr.metarecord = m.metarecord
857                                 AND rd.record = m.source
858                                 $t_filter
859                                 $f_filter
860                                 AND EXISTS (
861                                         SELECT  TRUE
862                                           FROM  $asset_call_number_table cn,
863                                                 $asset_copy_table cp,
864                                                 $cs_table cs,
865                                                 $cl_table cl,
866                                                 $descendants d
867                                           WHERE cn.record = mr.source
868                                                 AND cp.status = cs.id
869                                                 AND cp.location = cl.id
870                                                 AND cn.owning_lib = d.id
871                                                 AND cp.call_number = cn.id
872                                                 AND cp.opac_visible IS TRUE
873                                                 AND cs.holdable IS TRUE
874                                                 AND cl.opac_visible IS TRUE )
875                         GROUP BY m.metarecord
876                         ORDER BY 2 DESC, MIN(COALESCE(CHAR_LENGTH(f.value),1))
877                 SQL
878         } else {
879                 $select = <<"           SQL";
880                         SELECT  m.metarecord,
881                                 (SUM(   $rank
882                                         * CASE WHEN f.value ILIKE ? THEN 1.2 ELSE 1 END -- phrase order
883                                         * CASE WHEN f.value ILIKE ? THEN 1.5 ELSE 1 END -- first word match
884                                         * CASE WHEN f.value ~* ? THEN 2 ELSE 1 END -- only word match
885                                 )/COUNT(m.source)),
886                                 CASE WHEN COUNT(DISTINCT rd.record) = 1 THEN MIN(m.source) ELSE 0 END
887                         FROM    $search_table f,
888                                 $metabib_metarecord_source_map_table m,
889                                 $metabib_metarecord_source_map_table mr,
890                                 $metabib_record_descriptor rd
891                         WHERE   $fts_where
892                                 AND m.source = f.source
893                                 AND m.metarecord = mr.metarecord
894                                 AND rd.record = m.source
895                                 $t_filter
896                                 $f_filter
897                         GROUP BY m.metarecord
898                         ORDER BY 2 DESC, MIN(COALESCE(CHAR_LENGTH(f.value),1))
899                 SQL
900         }
901
902         $log->debug("Field Search SQL :: [$select]",DEBUG);
903
904         my $SQLstring = join('%',$fts->words);
905         my $REstring = join('\\s+',$fts->words);
906         my $first_word = ($fts->words)[0].'%';
907         my $recs = ($self->api_name =~ /unordered/o) ? 
908                         $class->db_Main->selectall_arrayref($select, {}, @types, @forms) :
909                         $class->db_Main->selectall_arrayref($select, {},
910                                 '%'.lc($SQLstring).'%',                 # phrase order match
911                                 lc($first_word),                        # first word match
912                                 '^\\s*'.lc($REstring).'\\s*/?\s*$',     # full exact match
913                                 @types, @forms
914                         );
915         
916         $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
917
918         my $count = scalar(@$recs);
919         for my $rec (@$recs[$offset .. $offset + $limit - 1]) {
920                 my ($mrid,$rank,$skip) = @$rec;
921                 $client->respond( [$mrid, sprintf('%0.3f',$rank), $skip, $count] );
922         }
923         return undef;
924 }
925
926 for my $class ( qw/title author subject keyword series/ ) {
927         __PACKAGE__->register_method(
928                 api_name        => "open-ils.storage.metabib.$class.new_search_fts.metarecord",
929                 method          => 'new_search_class_fts',
930                 api_level       => 1,
931                 stream          => 1,
932                 cdbi            => "metabib::${class}_field_entry",
933                 cachable        => 1,
934         );
935         __PACKAGE__->register_method(
936                 api_name        => "open-ils.storage.metabib.$class.new_search_fts.metarecord.staff",
937                 method          => 'new_search_class_fts',
938                 api_level       => 1,
939                 stream          => 1,
940                 cdbi            => "metabib::${class}_field_entry",
941                 cachable        => 1,
942         );
943 }
944
945
946
947
948 # XXX factored most of the PG dependant stuff out of here... need to find a way to do "dependants".
949 sub postfilter_search_class_fts {
950         my $self = shift;
951         my $client = shift;
952         my %args = @_;
953         
954         my $term = $args{term};
955         my $sort = $args{'sort'};
956         my $sort_dir = $args{sort_dir} || 'DESC';
957         my $ou = $args{org_unit};
958         my $ou_type = $args{depth};
959         my $limit = $args{limit};
960         my $offset = $args{offset} || 0;
961
962         my $outer_limit = 1000;
963
964         my $limit_clause = '';
965         my $offset_clause = '';
966
967         $limit_clause = "LIMIT $outer_limit";
968         $offset_clause = "OFFSET $offset" if (defined $offset and int($offset) > 0);
969
970         my (@types,@forms);
971         my ($t_filter, $f_filter) = ('','');
972         my ($ot_filter, $of_filter) = ('','');
973
974         if ($args{format}) {
975                 my ($t, $f) = split '-', $args{format};
976                 @types = split '', $t;
977                 @forms = split '', $f;
978                 if (@types) {
979                         $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
980                         $ot_filter = ' AND ord.item_type IN ('.join(',',map{'?'}@types).')';
981                 }
982
983                 if (@forms) {
984                         $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
985                         $of_filter .= ' AND ord.item_form IN ('.join(',',map{'?'}@forms).')';
986                 }
987         }
988
989
990
991         my $descendants = defined($ou_type) ?
992                                 "actor.org_unit_descendants($ou, $ou_type)" :
993                                 "actor.org_unit_descendants($ou)";
994
995         my $class = $self->{cdbi};
996         my $search_table = $class->table;
997
998         my $metabib_full_rec = metabib::full_rec->table;
999         my $metabib_record_descriptor = metabib::record_descriptor->table;
1000         my $metabib_metarecord = metabib::metarecord->table;
1001         my $metabib_metarecord_source_map_table = metabib::metarecord_source_map->table;
1002         my $asset_call_number_table = asset::call_number->table;
1003         my $asset_copy_table = asset::copy->table;
1004         my $cs_table = config::copy_status->table;
1005         my $cl_table = asset::copy_location->table;
1006         my $br_table = biblio::record_entry->table;
1007
1008         my ($index_col) = $class->columns('FTS');
1009         $index_col ||= 'value';
1010
1011         my $fts = OpenILS::Application::Storage::FTS->compile($term, 'f.value', "f.$index_col");
1012
1013         my $fts_where = $fts->sql_where_clause;
1014         my @fts_ranks = $fts->fts_rank;
1015
1016         my $relevance = join(' + ', @fts_ranks);
1017
1018         $relevance = <<"        RANK";
1019                         (SUM(   $relevance
1020                                 * CASE WHEN f.value ILIKE ? THEN 1.2 ELSE 1 END -- phrase order
1021                                 * CASE WHEN f.value ILIKE ? THEN 1.5 ELSE 1 END -- first word match
1022                                 * CASE WHEN f.value ~* ? THEN 2 ELSE 1 END -- only word match
1023                         )/COUNT(m.source))
1024         RANK
1025
1026         my $rank = $relevance;
1027         if (lc($sort) eq 'pubdate') {
1028                 $rank = <<"             RANK";
1029                         ( FIRST((
1030                                 SELECT  COALESCE(SUBSTRING(frp.value FROM '\\\\d+'),'9999')::INT
1031                                   FROM  $metabib_full_rec frp
1032                                   WHERE frp.record = mr.master_record
1033                                         AND frp.tag = '260'
1034                                         AND frp.subfield = 'c'
1035                         )) )
1036                 RANK
1037         } elsif (lc($sort) eq 'title') {
1038                 $rank = <<"             RANK";
1039                         ( FIRST((
1040                                 SELECT  COALESCE(LTRIM(SUBSTR( frt.value, frt.ind2::text::int )),'zzzzzzzz')
1041                                   FROM  $metabib_full_rec frt
1042                                   WHERE frt.record = mr.master_record
1043                                         AND frt.tag = '245'
1044                                         AND frt.subfield = 'a'
1045                         )) )
1046                 RANK
1047         } elsif (lc($sort) eq 'author') {
1048                 $rank = <<"             RANK";
1049                         ( FIRST((
1050                                 SELECT  COALESCE(LTRIM(fra.value),'zzzzzzzz')
1051                                   FROM  $metabib_full_rec fra
1052                                   WHERE fra.record = mr.master_record
1053                                         AND fra.tag LIKE '1%'
1054                                         AND fra.subfield = 'a'
1055                                         ORDER BY fra.tag::text::int
1056                         )) )
1057                 RANK
1058         } else {
1059                 $sort = undef;
1060         }
1061
1062         my $select = <<"        SQL";
1063                 SELECT  m.metarecord,
1064                         $relevance,
1065                         CASE WHEN COUNT(DISTINCT rd.record) = 1 THEN MIN(m.source) ELSE 0 END,
1066                         $rank
1067                 FROM    $search_table f,
1068                         $metabib_metarecord_source_map_table m,
1069                         $metabib_metarecord mr,
1070                         $metabib_record_descriptor rd
1071                 WHERE   $fts_where
1072                         AND m.source = f.source
1073                         AND m.metarecord = mr.id
1074                         AND rd.record = f.source
1075                         $t_filter
1076                         $f_filter
1077                 GROUP BY m.metarecord
1078                 ORDER BY 4 $sort_dir, MIN(COALESCE(CHAR_LENGTH(f.value),1))
1079                 LIMIT 10000
1080         SQL
1081
1082         if (0) {
1083                 $select = <<"           SQL";
1084
1085                         SELECT  DISTINCT s.*
1086                           FROM  $asset_call_number_table cn,
1087                                 $metabib_metarecord_source_map_table mrs,
1088                                 $asset_copy_table cp,
1089                                 $cs_table cs,
1090                                 $cl_table cl,
1091                                 $br_table br,
1092                                 $descendants d,
1093                                 $metabib_record_descriptor ord,
1094                                 ($select) s
1095                           WHERE mrs.metarecord = s.metarecord
1096                                 AND br.id = mrs.source
1097                                 AND cn.record = mrs.source
1098                                 AND cp.status = cs.id
1099                                 AND cp.location = cl.id
1100                                 AND cn.owning_lib = d.id
1101                                 AND cp.call_number = cn.id
1102                                 AND cp.opac_visible IS TRUE
1103                                 AND cs.holdable IS TRUE
1104                                 AND cl.opac_visible IS TRUE
1105                                 AND br.active IS TRUE
1106                                 AND br.deleted IS FALSE
1107                                 AND ord.record = mrs.source
1108                                 $ot_filter
1109                                 $of_filter
1110                           ORDER BY 4 $sort_dir
1111                 SQL
1112         } elsif ($self->api_name !~ /staff/o) {
1113                 $select = <<"           SQL";
1114
1115                         SELECT  DISTINCT s.*
1116                           FROM  ($select) s
1117                           WHERE EXISTS (
1118                                 SELECT  1
1119                                   FROM  $asset_call_number_table cn,
1120                                         $metabib_metarecord_source_map_table mrs,
1121                                         $asset_copy_table cp,
1122                                         $cs_table cs,
1123                                         $cl_table cl,
1124                                         $br_table br,
1125                                         $descendants d,
1126                                         $metabib_record_descriptor ord
1127                                 
1128                                   WHERE mrs.metarecord = s.metarecord
1129                                         AND br.id = mrs.source
1130                                         AND cn.record = mrs.source
1131                                         AND cp.status = cs.id
1132                                         AND cp.location = cl.id
1133                                         AND cn.owning_lib = d.id
1134                                         AND cp.call_number = cn.id
1135                                         AND cp.opac_visible IS TRUE
1136                                         AND cs.holdable IS TRUE
1137                                         AND cl.opac_visible IS TRUE
1138                                         AND br.active IS TRUE
1139                                         AND br.deleted IS FALSE
1140                                         AND ord.record = mrs.source
1141                                         $ot_filter
1142                                         $of_filter
1143                                   LIMIT 1
1144                                 )
1145                           ORDER BY 4 $sort_dir
1146                 SQL
1147         } else {
1148                 $select = <<"           SQL";
1149
1150                         SELECT  DISTINCT s.*
1151                           FROM  ($select) s
1152                           WHERE EXISTS (
1153                                 SELECT  1
1154                                   FROM  $asset_call_number_table cn,
1155                                         $metabib_metarecord_source_map_table mrs,
1156                                         $br_table br,
1157                                         $descendants d,
1158                                         $metabib_record_descriptor ord
1159                                 
1160                                   WHERE mrs.metarecord = s.metarecord
1161                                         AND br.id = mrs.source
1162                                         AND cn.record = mrs.source
1163                                         AND cn.owning_lib = d.id
1164                                         AND br.deleted IS FALSE
1165                                         AND ord.record = mrs.source
1166                                         $ot_filter
1167                                         $of_filter
1168                                   LIMIT 1
1169                                 )
1170                                 OR NOT EXISTS (
1171                                 SELECT  1
1172                                   FROM  $asset_call_number_table cn,
1173                                         $metabib_metarecord_source_map_table mrs,
1174                                         $metabib_record_descriptor ord
1175                                   WHERE mrs.metarecord = s.metarecord
1176                                         AND cn.record = mrs.source
1177                                         AND ord.record = mrs.source
1178                                         $ot_filter
1179                                         $of_filter
1180                                   LIMIT 1
1181                                 )
1182                           ORDER BY 4 $sort_dir
1183                 SQL
1184         }
1185
1186
1187         $log->debug("Field Search SQL :: [$select]",DEBUG);
1188
1189         my $SQLstring = join('%',$fts->words);
1190         my $REstring = join('\\s+',$fts->words);
1191         my $first_word = ($fts->words)[0].'%';
1192         my $recs = $class->db_Main->selectall_arrayref(
1193                         $select, {},
1194                         '%'.lc($SQLstring).'%',                 # phrase order match
1195                         lc($first_word),                        # first word match
1196                         '^\\s*'.lc($REstring).'\\s*/?\s*$',     # full exact match
1197                         ( !$sort ?
1198                                 ('%'.lc($SQLstring).'%',                        # phrase order match
1199                                  lc($first_word),                       # first word match
1200                                  '^\\s*'.lc($REstring).'\\s*/?\s*$',) : # full exact match
1201                                  ()
1202                         ),
1203                         @types, @forms, @types, @forms,  ($self->api_name =~ /staff/o ? (@types, @forms) : () ) );
1204         
1205         $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
1206
1207         my $count = scalar(@$recs);
1208         for my $rec (@$recs[$offset .. $offset + $limit - 1]) {
1209                 my ($mrid,$rank,$skip) = @$rec;
1210                 $client->respond( [$mrid, sprintf('%0.3f',$rank), $skip, $count] );
1211         }
1212         return undef;
1213 }
1214
1215 for my $class ( qw/title author subject keyword series/ ) {
1216         __PACKAGE__->register_method(
1217                 api_name        => "open-ils.storage.metabib.$class.post_filter.search_fts.metarecord",
1218                 method          => 'postfilter_search_class_fts',
1219                 api_level       => 1,
1220                 stream          => 1,
1221                 cdbi            => "metabib::${class}_field_entry",
1222                 cachable        => 1,
1223         );
1224         __PACKAGE__->register_method(
1225                 api_name        => "open-ils.storage.metabib.$class.post_filter.search_fts.metarecord.staff",
1226                 method          => 'postfilter_search_class_fts',
1227                 api_level       => 1,
1228                 stream          => 1,
1229                 cdbi            => "metabib::${class}_field_entry",
1230                 cachable        => 1,
1231         );
1232 }
1233
1234
1235
1236 my $_cdbi = {   title   => "metabib::title_field_entry",
1237                 author  => "metabib::author_field_entry",
1238                 subject => "metabib::subject_field_entry",
1239                 keyword => "metabib::keyword_field_entry",
1240                 series  => "metabib::series_field_entry",
1241 };
1242
1243 # XXX factored most of the PG dependant stuff out of here... need to find a way to do "dependants".
1244 sub postfilter_search_multi_class_fts {
1245         my $self = shift;
1246         my $client = shift;
1247         my %args = @_;
1248         
1249         my $sort = $args{'sort'};
1250         my $sort_dir = $args{sort_dir} || 'DESC';
1251         my $ou = $args{org_unit};
1252         my $ou_type = $args{depth};
1253         my $limit = $args{limit};
1254         my $offset = $args{offset} || 0;
1255
1256         if (! scalar( keys %{$args{searches}} )) {
1257                 die "No target organizational unit passed to ".$self->api_name;
1258         }
1259
1260         if (! scalar( keys %{$args{searches}} )) {
1261                 die "No search arguments were passed to ".$self->api_name;
1262         }
1263
1264         my $outer_limit = 1000;
1265
1266         my $limit_clause = '';
1267         my $offset_clause = '';
1268
1269         $limit_clause = "LIMIT $outer_limit";
1270         $offset_clause = "OFFSET $offset" if (defined $offset and int($offset) > 0);
1271
1272         my (@types,@forms);
1273         my ($t_filter, $f_filter) = ('','');
1274         my ($ot_filter, $of_filter) = ('','');
1275
1276         if ($args{format}) {
1277                 my ($t, $f) = split '-', $args{format};
1278                 @types = split '', $t;
1279                 @forms = split '', $f;
1280                 if (@types) {
1281                         $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
1282                         $ot_filter = ' AND ord.item_type IN ('.join(',',map{'?'}@types).')';
1283                 }
1284
1285                 if (@forms) {
1286                         $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
1287                         $of_filter .= ' AND ord.item_form IN ('.join(',',map{'?'}@forms).')';
1288                 }
1289         }
1290
1291
1292
1293         my $descendants = defined($ou_type) ?
1294                                 "actor.org_unit_descendants($ou, $ou_type)" :
1295                                 "actor.org_unit_descendants($ou)";
1296
1297         my $search_table_list = '';
1298         my $fts_list = '';
1299         my $join_table_list = '';
1300         my @rank_list;
1301
1302         my $prev_search_class;
1303         my $curr_search_class;
1304         for my $search_class (sort keys %{$args{searches}}) {
1305                 $prev_search_class = $curr_search_class if ($curr_search_class);
1306
1307                 $curr_search_class = $search_class;
1308
1309                 my $class = $_cdbi->{$search_class};
1310                 my $search_table = $class->table;
1311
1312                 my ($index_col) = $class->columns('FTS');
1313                 $index_col ||= 'value';
1314
1315                 
1316                 my $fts = OpenILS::Application::Storage::FTS->compile($args{searches}{$search_class}{term}, $search_class.'.value', "$search_class.$index_col");
1317
1318                 my $fts_where = $fts->sql_where_clause;
1319                 my @fts_ranks = $fts->fts_rank;
1320
1321                 my $rank = join(' + ', @fts_ranks);
1322
1323                 #---------------------
1324
1325                 $search_table_list .= "$search_table $search_class, ";
1326                 push @rank_list,$rank;
1327                 $fts_list .= " AND $fts_where AND m.source = $search_class.source";
1328
1329                 if ($prev_search_class) {
1330                         $join_table_list .= " AND $prev_search_class.source = $curr_search_class.source";
1331                 }
1332         }
1333
1334         my $metabib_record_descriptor = metabib::record_descriptor->table;
1335         my $metabib_full_rec = metabib::full_rec->table;
1336         my $metabib_metarecord = metabib::metarecord->table;
1337         my $metabib_metarecord_source_map_table = metabib::metarecord_source_map->table;
1338         my $asset_call_number_table = asset::call_number->table;
1339         my $asset_copy_table = asset::copy->table;
1340         my $cs_table = config::copy_status->table;
1341         my $cl_table = asset::copy_location->table;
1342         my $br_table = biblio::record_entry->table;
1343
1344         my $relevance = join (' + ', @rank_list);
1345         $relevance = "SUM( $relevance )";
1346
1347
1348         my $rank = $relevance;
1349         if (lc($sort) eq 'pubdate') {
1350                 $rank = <<"             RANK";
1351                         ( FIRST((
1352                                 SELECT  COALESCE(SUBSTRING(frp.value FROM '\\\\d+'),'9999')::INT
1353                                   FROM  $metabib_full_rec frp
1354                                   WHERE frp.record = mr.master_record
1355                                         AND frp.tag = '260'
1356                                         AND frp.subfield = 'c'
1357                         )) )
1358                 RANK
1359         } elsif (lc($sort) eq 'title') {
1360                 $rank = <<"             RANK";
1361                         ( FIRST((
1362                                 SELECT  COALESCE(LTRIM(SUBSTR( frt.value, frt.ind2::text::int )),'zzzzzzzz')
1363                                   FROM  $metabib_full_rec frt
1364                                   WHERE frt.record = mr.master_record
1365                                         AND frt.tag = '245'
1366                                         AND frt.subfield = 'a'
1367                         )) )
1368                 RANK
1369         } elsif (lc($sort) eq 'author') {
1370                 $rank = <<"             RANK";
1371                         ( FIRST((
1372                                 SELECT  COALESCE(LTRIM(fra.value),'zzzzzzzz')
1373                                   FROM  $metabib_full_rec fra
1374                                   WHERE fra.record = mr.master_record
1375                                         AND fra.tag LIKE '1%'
1376                                         AND fra.subfield = 'a'
1377                                         ORDER BY fra.tag::text::int
1378                         )) )
1379                 RANK
1380         }
1381
1382
1383         my $select = <<"        SQL";
1384                 SELECT  m.metarecord,
1385                         $relevance,
1386                         CASE WHEN COUNT(DISTINCT rd.record) = 1 THEN MIN(m.source) ELSE 0 END,
1387                         $rank
1388                 FROM    $search_table_list
1389                         $metabib_metarecord_source_map_table m,
1390                         $metabib_metarecord mr,
1391                         $metabib_record_descriptor rd
1392                 WHERE   m.metarecord = mr.id
1393                         $fts_list
1394                         $join_table_list
1395                         AND rd.record = m.source
1396                         $t_filter
1397                         $f_filter
1398                 GROUP BY m.metarecord
1399                 ORDER BY 4 $sort_dir
1400                 LIMIT 10000
1401         SQL
1402
1403         if ($self->api_name !~ /staff/o) {
1404                 $select = <<"           SQL";
1405
1406                         SELECT  DISTINCT s.*
1407                           FROM  ($select) s
1408                           WHERE EXISTS (
1409                                 SELECT  1
1410                                   FROM  $asset_call_number_table cn,
1411                                         $metabib_metarecord_source_map_table mrs,
1412                                         $asset_copy_table cp,
1413                                         $cs_table cs,
1414                                         $cl_table cl,
1415                                         $br_table br,
1416                                         $descendants d,
1417                                         $metabib_record_descriptor ord
1418                                   WHERE mrs.metarecord = s.metarecord
1419                                         AND br.id = mrs.source
1420                                         AND cn.record = mrs.source
1421                                         AND cp.status = cs.id
1422                                         AND cp.location = cl.id
1423                                         AND cn.owning_lib = d.id
1424                                         AND cp.call_number = cn.id
1425                                         AND cp.opac_visible IS TRUE
1426                                         AND cs.holdable IS TRUE
1427                                         AND cl.opac_visible IS TRUE
1428                                         AND br.active IS TRUE
1429                                         AND br.deleted IS FALSE
1430                                         AND ord.record = mrs.source
1431                                         $ot_filter
1432                                         $of_filter
1433                                   LIMIT 1
1434                                 )
1435                           ORDER BY 4 $sort_dir
1436                 SQL
1437         } else {
1438                 $select = <<"           SQL";
1439
1440                         SELECT  DISTINCT s.*
1441                           FROM  ($select) s
1442                           WHERE EXISTS (
1443                                 SELECT  1
1444                                   FROM  $asset_call_number_table cn,
1445                                         $metabib_metarecord_source_map_table mrs,
1446                                         $descendants d,
1447                                         $br_table br,
1448                                         $metabib_record_descriptor ord
1449                                   WHERE mrs.metarecord = s.metarecord
1450                                         AND br.id = mrs.source
1451                                         AND cn.record = mrs.source
1452                                         AND cn.owning_lib = d.id
1453                                         AND ord.record = mrs.source
1454                                         AND br.deleted IS FALSE
1455                                         $ot_filter
1456                                         $of_filter
1457                                   LIMIT 1
1458                                 )
1459                                 OR NOT EXISTS (
1460                                 SELECT  1
1461                                   FROM  $asset_call_number_table cn,
1462                                         $metabib_metarecord_source_map_table mrs,
1463                                         $metabib_record_descriptor ord
1464                                   WHERE mrs.metarecord = s.metarecord
1465                                         AND cn.record = mrs.source
1466                                         AND ord.record = mrs.source
1467                                         $ot_filter
1468                                         $of_filter
1469                                   LIMIT 1
1470                                 )
1471                           ORDER BY 4 $sort_dir
1472                 SQL
1473         }
1474
1475
1476         $log->debug("Field Search SQL :: [$select]",DEBUG);
1477
1478         my $recs = $_cdbi->{title}->db_Main->selectall_arrayref(
1479                         $select, {},
1480                         @types, @forms, @types, @forms,  ($self->api_name =~ /staff/o ? (@types, @forms) : () ) );
1481         
1482         $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
1483
1484         my $count = scalar(@$recs);
1485         for my $rec (@$recs[$offset .. $offset + $limit - 1]) {
1486                 next unless ($$rec[0]);
1487                 my ($mrid,$rank,$skip) = @$rec;
1488                 $client->respond( [$mrid, sprintf('%0.3f',$rank), $skip, $count] );
1489         }
1490         return undef;
1491 }
1492
1493 __PACKAGE__->register_method(
1494         api_name        => "open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord",
1495         method          => 'postfilter_search_multi_class_fts',
1496         api_level       => 1,
1497         stream          => 1,
1498         cachable        => 1,
1499 );
1500 __PACKAGE__->register_method(
1501         api_name        => "open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.staff",
1502         method          => 'postfilter_search_multi_class_fts',
1503         api_level       => 1,
1504         stream          => 1,
1505         cachable        => 1,
1506 );
1507
1508
1509
1510 # XXX factored most of the PG dependant stuff out of here... need to find a way to do "dependants".
1511 sub postfilter_Z_search_class_fts {
1512         my $self = shift;
1513         my $client = shift;
1514         my %args = @_;
1515         
1516         my $term = $args{term};
1517         my $sort = $args{'sort'};
1518         my $sort_dir = $args{sort_dir} || 'DESC';
1519         my $ou = $args{org_unit};
1520         my $ou_type = $args{depth};
1521         my $limit = $args{limit} || 10;
1522         my $offset = $args{offset} || 0;
1523
1524         my (@types,@forms);
1525         my ($t_filter, $f_filter) = ('','');
1526         my ($ot_filter, $of_filter) = ('','');
1527
1528         if ($args{format}) {
1529                 my ($t, $f) = split '-', $args{format};
1530                 @types = split '', $t;
1531                 @forms = split '', $f;
1532                 if (@types) {
1533                         $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
1534                         $ot_filter = ' AND ord.item_type IN ('.join(',',map{'?'}@types).')';
1535                 }
1536
1537                 if (@forms) {
1538                         $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
1539                         $of_filter .= ' AND ord.item_form IN ('.join(',',map{'?'}@forms).')';
1540                 }
1541         }
1542
1543
1544
1545         my $class = $self->{cdbi};
1546         my $search_table = $class->table;
1547         my $metabib_record_descriptor = metabib::record_descriptor->table;
1548         my $br_table = biblio::record_entry->table;
1549
1550         my ($index_col) = $class->columns('FTS');
1551         $index_col ||= 'value';
1552
1553         my $fts = OpenILS::Application::Storage::FTS->compile($term, 'f.value', "f.$index_col");
1554
1555         my $fts_where = $fts->sql_where_clause;
1556         my @fts_ranks = $fts->fts_rank;
1557
1558         my $relevance = join(' + ', @fts_ranks);
1559
1560         $relevance = <<"        RANK";
1561                         (SUM(   $relevance
1562                                 * CASE WHEN f.value ILIKE ? THEN 1.2 ELSE 1 END -- phrase order
1563                                 * CASE WHEN f.value ILIKE ? THEN 1.5 ELSE 1 END -- first word match
1564                                 * CASE WHEN f.value ~* ? THEN 2 ELSE 1 END -- only word match
1565                         )/COUNT(m.source))
1566         RANK
1567
1568         my $rank = $relevance;
1569         if (lc($sort) eq 'pubdate') {
1570                 $rank = <<"             RANK";
1571                         ( FIRST((
1572                                 SELECT  COALESCE(SUBSTRING(frp.value FROM '\\\\d+'),'9999')::INT
1573                                   FROM  $metabib_full_rec frp
1574                                   WHERE frp.record = s.source
1575                                         AND frp.tag = '260'
1576                                         AND frp.subfield = 'c'
1577                         )) )
1578                 RANK
1579         } elsif (lc($sort) eq 'title') {
1580                 $rank = <<"             RANK";
1581                         ( FIRST((
1582                                 SELECT  COALESCE(LTRIM(SUBSTR( frt.value, frt.ind2::text::int )),'zzzzzzzz')
1583                                   FROM  $metabib_full_rec frt
1584                                   WHERE frt.record = s.source
1585                                         AND frt.tag = '245'
1586                                         AND frt.subfield = 'a'
1587                         )) )
1588                 RANK
1589         } elsif (lc($sort) eq 'author') {
1590                 $rank = <<"             RANK";
1591                         ( FIRST((
1592                                 SELECT  COALESCE(LTRIM(fra.value),'zzzzzzzz')
1593                                   FROM  $metabib_full_rec fra
1594                                   WHERE fra.record = s.source
1595                                         AND fra.tag LIKE '1%'
1596                                         AND fra.subfield = 'a'
1597                                         ORDER BY fra.tag::text::int
1598                         )) )
1599                 RANK
1600         } else {
1601                 $sort = undef;
1602         }
1603
1604
1605
1606         my $select = <<"        SQL";
1607                 SELECT  f.source,
1608                         $rank,
1609                         $relevance
1610                 FROM    $search_table f,
1611                         $br_table br,
1612                         $descendants
1613                         $metabib_record_descriptor rd
1614                 WHERE   $fts_where
1615                         AND rd.record = f.source
1616                         AND br.id = f.source
1617                         AND br.deleted IS FALSE
1618                         $t_filter
1619                         $f_filter
1620                 GROUP BY 1
1621                 ORDER BY 2 $sort_dir, 3, MIN(COALESCE(CHAR_LENGTH(f.value),1))
1622         SQL
1623
1624
1625         if ($self->api_name !~ /Zsearch/o) {
1626
1627                 my $descendants = defined($ou_type) ?
1628                                 "actor.org_unit_descendants($ou, $ou_type)" :
1629                                 "actor.org_unit_descendants($ou)";
1630
1631                 if ($self->api_name !~ /staff/o) {
1632                         $select = <<"                   SQL";
1633
1634                         SELECT  DISTINCT s.*
1635                           FROM  ($select) s
1636                           WHERE EXISTS (
1637                                 SELECT  1
1638                                   FROM  $asset_call_number_table cn,
1639                                         $asset_copy_table cp,
1640                                         $cs_table cs,
1641                                         $cl_table cl,
1642                                         $br_table br,
1643                                         $descendants d
1644                                   WHERE br.id = s.source
1645                                         AND cn.record = s.source
1646                                         AND cp.status = cs.id
1647                                         AND cp.location = cl.id
1648                                         AND cn.owning_lib = d.id
1649                                         AND cp.call_number = cn.id
1650                                         AND cp.opac_visible IS TRUE
1651                                         AND cs.holdable IS TRUE
1652                                         AND cl.opac_visible IS TRUE
1653                                         AND br.active IS TRUE
1654                                         AND br.deleted IS FALSE
1655                                   LIMIT 1
1656                                 )
1657                           ORDER BY 2 $sort_dir, 3
1658
1659                         SQL
1660                 } else {
1661                         $select = <<"                   SQL";
1662
1663                         SELECT  DISTINCT s.*
1664                           FROM  ($select) s
1665                           WHERE EXISTS (
1666                                 SELECT  1
1667                                   FROM  $asset_call_number_table cn,
1668                                         $metabib_metarecord_source_map_table mrs,
1669                                         $descendants d,
1670                                         $br_table br
1671                                   WHERE br.id = s.source
1672                                         AND cn.record = s.source
1673                                         AND cn.owning_lib = d.id
1674                                         AND br.deleted IS FALSE
1675                                   LIMIT 1
1676                                 )
1677                                 OR NOT EXISTS (
1678                                 SELECT  1
1679                                   FROM  $asset_call_number_table cn
1680                                   WHERE cn.record = s.source
1681                                         AND ord.record = mrs.source
1682                                   LIMIT 1
1683                                 )
1684                           ORDER BY 2 $sort_dir, 3
1685
1686                         SQL
1687                 }
1688         }
1689
1690
1691         $log->debug("Z39.50 (Record) Search SQL :: [$select]",DEBUG);
1692
1693         my $SQLstring = join('%',$fts->words);
1694         my $REstring = join('\\s+',$fts->words);
1695         my $first_word = ($fts->words)[0].'%';
1696         my $recs =
1697                 $class->db_Main->selectall_arrayref(
1698                         $select, {},
1699                         '%'.lc($SQLstring).'%',                 # phrase order match
1700                         lc($first_word),                        # first word match
1701                         '^\\s*'.lc($REstring).'\\s*/?\s*$',     # full exact match
1702                         @types, @forms
1703                 );
1704         
1705         $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
1706
1707         my $count = scalar(@$recs);
1708         for my $rec (@$recs[$offset .. $offset + $limit - 1]) {
1709                 next unless ($rec);
1710                 my ($mrid,$junk,$rank) = @$rec;
1711                 $client->respond( [$mrid, sprintf('%0.3f',$rank), $count] );
1712         }
1713         return undef;
1714 }
1715
1716 for my $class ( qw/title author subject keyword series/ ) {
1717         __PACKAGE__->register_method(
1718                 api_name        => "open-ils.storage.metabib.$class.Zsearch",
1719                 method          => 'postfilter_Z_search_class_fts',
1720                 api_level       => 1,
1721                 stream          => 1,
1722                 cdbi            => "metabib::${class}_field_entry",
1723                 cachable        => 1,
1724         );
1725         __PACKAGE__->register_method(
1726                 api_name        => "open-ils.storage.biblio.$class.search_fts.record",
1727                 method          => 'postfilter_Z_search_class_fts',
1728                 api_level       => 1,
1729                 stream          => 1,
1730                 cdbi            => "metabib::${class}_field_entry",
1731                 cachable        => 1,
1732         );
1733         __PACKAGE__->register_method(
1734                 api_name        => "open-ils.storage.biblio.$class.search_fts.record.staff",
1735                 method          => 'postfilter_Z_search_class_fts',
1736                 api_level       => 1,
1737                 stream          => 1,
1738                 cdbi            => "metabib::${class}_field_entry",
1739                 cachable        => 1,
1740         );
1741 }
1742
1743
1744 sub multi_Z_search_full_rec {
1745         my $self = shift;
1746         my $client = shift;
1747
1748         my %args = @_;  
1749         my $class_join = $args{class_join} || 'AND';
1750         my $limit = $args{limit} || 10;
1751         my $offset = $args{offset} || 0;
1752         my @binds;
1753         my @selects;
1754
1755         my $limiter_count = 0;
1756
1757         for my $arg (@{ $args{searches} }) {
1758                 my $term = $$arg{term};
1759                 my $limiters = $$arg{restrict};
1760
1761                 my ($index_col) = metabib::full_rec->columns('FTS');
1762                 $index_col ||= 'value';
1763                 my $search_table = metabib::full_rec->table;
1764
1765                 my $fts = OpenILS::Application::Storage::FTS->compile($term, 'value',"$index_col");
1766
1767                 my $fts_where = $fts->sql_where_clause();
1768                 my @fts_ranks = $fts->fts_rank;
1769
1770                 my $rank = join(' + ', @fts_ranks);
1771
1772                 my @wheres;
1773                 for my $limit (@$limiters) {
1774                         push @wheres, "( tag = ? AND subfield LIKE ? AND $fts_where )";
1775                         push @binds, $$limit{tag}, ($$limit{subfield} ? $$limit{subfield} : '_');
1776                         $log->debug("Limiting query using { tag => $$limit{tag}, subfield => $$limit{subfield} }", DEBUG);
1777                 }
1778                 $limiter_count++;
1779                 my $where = join(' OR ', @wheres);
1780
1781                 push @selects, "SELECT FIRST(id), record, SUM($rank) as sum FROM $search_table WHERE $where GROUP BY 2";
1782
1783         }
1784
1785         my $metabib_record_descriptor = metabib::record_descriptor->table;
1786
1787         my $cj = 'HAVING COUNT(DISTINCT x.id) = ' . $limiter_count if ($class_join eq 'AND');
1788         my $search_table =
1789                 '(SELECT x.record, sum(x.sum) FROM (('.
1790                         join(') UNION ALL (', @selects).
1791                         ")) x GROUP BY 1 $cj ORDER BY 2 DESC )";
1792
1793         my ($t_filter, $f_filter) = ('','');
1794
1795         if ($args{format}) {
1796                 my ($t, $f) = split '-', $args{format};
1797                 my @types = split '', $t;
1798                 my @forms = split '', $f;
1799                 if (@types) {
1800                         $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
1801                 }
1802
1803                 if (@forms) {
1804                         $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
1805                 }
1806                 push @binds, @types, @forms;
1807         }
1808
1809
1810         my $select = <<"        SQL";
1811                 SELECT  f.record, f.sum
1812                 FROM    $search_table f,
1813                         $metabib_record_descriptor rd
1814                 WHERE   rd.record = f.record
1815                         $t_filter
1816                         $f_filter
1817                 ORDER BY 2
1818         SQL
1819
1820
1821         $log->debug("Search SQL :: [$select]",DEBUG);
1822
1823         my $recs = metabib::full_rec->db_Main->selectall_arrayref("$select;", {}, @binds);
1824         $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
1825
1826         my $count = @$recs;
1827         for my $rec (@$recs[$offset .. $offset + $limit - 1]) {
1828                 next unless ($$rec[0]);
1829                 my ($rid,$rank) = @$rec;
1830                 $client->respond( [$rid, sprintf('%0.3f',$rank), $count] );
1831         }
1832         return undef;
1833 }
1834 __PACKAGE__->register_method(
1835         api_name        => 'open-ils.storage.metabib.full_rec.Zmulti_search',
1836         method          => 'multi_Z_search_full_rec',
1837         api_level       => 1,
1838         stream          => 1,
1839         cachable        => 1,
1840 );
1841
1842 __PACKAGE__->register_method(
1843         api_name        => 'open-ils.storage.biblio.multiclass.search_fts.record',
1844         method          => 'multi_Z_search_full_rec',
1845         api_level       => 1,
1846         stream          => 1,
1847         cachable        => 1,
1848 );
1849
1850
1851 1;