]> git.evergreen-ils.org Git - Evergreen.git/blob - Open-ILS/src/perlmods/OpenILS/Application/Storage/Publisher/metabib.pm
bb73e383c21551955420f7bfe6dcb210c35ef636
[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                                   LIMIT 1
1036                         )) )
1037                 RANK
1038         } elsif (lc($sort) eq 'title') {
1039                 $rank = <<"             RANK";
1040                         ( FIRST ((
1041                                 SELECT  COALESCE(LTRIM(SUBSTR( frt.value, frt.ind2::text::int )),'zzzzzzzz')
1042                                   FROM  $metabib_full_rec frt
1043                                   WHERE frt.record = mr.master_record
1044                                         AND frt.tag = '245'
1045                                         AND frt.subfield = 'a'
1046                                   LIMIT 1
1047                         )) )
1048                 RANK
1049         } elsif (lc($sort) eq 'author') {
1050                 $rank = <<"             RANK";
1051                         ( FIRST((
1052                                 SELECT  COALESCE(LTRIM(fra.value),'zzzzzzzz')
1053                                   FROM  $metabib_full_rec fra
1054                                   WHERE fra.record = mr.master_record
1055                                         AND fra.tag LIKE '1%'
1056                                         AND fra.subfield = 'a'
1057                                   ORDER BY fra.tag::text::int
1058                                   LIMIT 1
1059                         )) )
1060                 RANK
1061         } else {
1062                 $sort = undef;
1063         }
1064
1065         my $select = <<"        SQL";
1066                 SELECT  m.metarecord,
1067                         $relevance,
1068                         CASE WHEN COUNT(DISTINCT smrs.source) = 1 THEN MIN(m.source) ELSE 0 END,
1069                         $rank
1070                 FROM    $search_table f,
1071                         $metabib_metarecord_source_map_table m,
1072                         $metabib_metarecord_source_map_table smrs,
1073                         $metabib_metarecord mr,
1074                         $metabib_record_descriptor rd
1075                 WHERE   $fts_where
1076                         AND smrs.metarecord = mr.id
1077                         AND m.source = f.source
1078                         AND m.metarecord = mr.id
1079                         AND rd.record = smrs.source
1080                         $t_filter
1081                         $f_filter
1082                 GROUP BY m.metarecord
1083                 ORDER BY 4 $sort_dir, MIN(COALESCE(CHAR_LENGTH(f.value),1))
1084                 LIMIT 10000
1085         SQL
1086
1087         if (0) {
1088                 $select = <<"           SQL";
1089
1090                         SELECT  DISTINCT s.*
1091                           FROM  $asset_call_number_table cn,
1092                                 $metabib_metarecord_source_map_table mrs,
1093                                 $asset_copy_table cp,
1094                                 $cs_table cs,
1095                                 $cl_table cl,
1096                                 $br_table br,
1097                                 $descendants d,
1098                                 $metabib_record_descriptor ord,
1099                                 ($select) s
1100                           WHERE mrs.metarecord = s.metarecord
1101                                 AND br.id = mrs.source
1102                                 AND cn.record = mrs.source
1103                                 AND cp.status = cs.id
1104                                 AND cp.location = cl.id
1105                                 AND cn.owning_lib = d.id
1106                                 AND cp.call_number = cn.id
1107                                 AND cp.opac_visible IS TRUE
1108                                 AND cs.holdable IS TRUE
1109                                 AND cl.opac_visible IS TRUE
1110                                 AND br.active IS TRUE
1111                                 AND br.deleted IS FALSE
1112                                 AND ord.record = mrs.source
1113                                 $ot_filter
1114                                 $of_filter
1115                           ORDER BY 4 $sort_dir
1116                 SQL
1117         } elsif ($self->api_name !~ /staff/o) {
1118                 $select = <<"           SQL";
1119
1120                         SELECT  DISTINCT s.*
1121                           FROM  ($select) s
1122                           WHERE EXISTS (
1123                                 SELECT  1
1124                                   FROM  $asset_call_number_table cn,
1125                                         $metabib_metarecord_source_map_table mrs,
1126                                         $asset_copy_table cp,
1127                                         $cs_table cs,
1128                                         $cl_table cl,
1129                                         $br_table br,
1130                                         $descendants d,
1131                                         $metabib_record_descriptor ord
1132                                 
1133                                   WHERE mrs.metarecord = s.metarecord
1134                                         AND br.id = mrs.source
1135                                         AND cn.record = mrs.source
1136                                         AND cp.status = cs.id
1137                                         AND cp.location = cl.id
1138                                         AND cn.owning_lib = d.id
1139                                         AND cp.call_number = cn.id
1140                                         AND cp.opac_visible IS TRUE
1141                                         AND cs.holdable IS TRUE
1142                                         AND cl.opac_visible IS TRUE
1143                                         AND br.active IS TRUE
1144                                         AND br.deleted IS FALSE
1145                                         AND ord.record = mrs.source
1146                                         $ot_filter
1147                                         $of_filter
1148                                   LIMIT 1
1149                                 )
1150                           ORDER BY 4 $sort_dir
1151                 SQL
1152         } else {
1153                 $select = <<"           SQL";
1154
1155                         SELECT  DISTINCT s.*
1156                           FROM  ($select) s
1157                           WHERE EXISTS (
1158                                 SELECT  1
1159                                   FROM  $asset_call_number_table cn,
1160                                         $metabib_metarecord_source_map_table mrs,
1161                                         $br_table br,
1162                                         $descendants d,
1163                                         $metabib_record_descriptor ord
1164                                 
1165                                   WHERE mrs.metarecord = s.metarecord
1166                                         AND br.id = mrs.source
1167                                         AND cn.record = mrs.source
1168                                         AND cn.owning_lib = d.id
1169                                         AND br.deleted IS FALSE
1170                                         AND ord.record = mrs.source
1171                                         $ot_filter
1172                                         $of_filter
1173                                   LIMIT 1
1174                                 )
1175                                 OR NOT EXISTS (
1176                                 SELECT  1
1177                                   FROM  $asset_call_number_table cn,
1178                                         $metabib_metarecord_source_map_table mrs,
1179                                         $metabib_record_descriptor ord
1180                                   WHERE mrs.metarecord = s.metarecord
1181                                         AND cn.record = mrs.source
1182                                         AND ord.record = mrs.source
1183                                         $ot_filter
1184                                         $of_filter
1185                                   LIMIT 1
1186                                 )
1187                           ORDER BY 4 $sort_dir
1188                 SQL
1189         }
1190
1191
1192         $log->debug("Field Search SQL :: [$select]",DEBUG);
1193
1194         my $SQLstring = join('%',$fts->words);
1195         my $REstring = join('\\s+',$fts->words);
1196         my $first_word = ($fts->words)[0].'%';
1197         my $recs = $class->db_Main->selectall_arrayref(
1198                         $select, {},
1199                         '%'.lc($SQLstring).'%',                 # phrase order match
1200                         lc($first_word),                        # first word match
1201                         '^\\s*'.lc($REstring).'\\s*/?\s*$',     # full exact match
1202                         ( !$sort ?
1203                                 ('%'.lc($SQLstring).'%',                        # phrase order match
1204                                  lc($first_word),                       # first word match
1205                                  '^\\s*'.lc($REstring).'\\s*/?\s*$',) : # full exact match
1206                                  ()
1207                         ),
1208                         @types, @forms, @types, @forms,  ($self->api_name =~ /staff/o ? (@types, @forms) : () ) );
1209         
1210         $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
1211
1212         my $max = 0;
1213         $max = 1 if (!@$recs);
1214         for (@$recs) {
1215                 $max = $$_[1] if ($$_[1] > $max);
1216         }
1217
1218         my $count = scalar(@$recs);
1219         for my $rec (@$recs[$offset .. $offset + $limit - 1]) {
1220                 my ($mrid,$rank,$skip) = @$rec;
1221                 $client->respond( [$mrid, sprintf('%0.3f',$rank/$max), $skip, $count] );
1222         }
1223         return undef;
1224 }
1225
1226 for my $class ( qw/title author subject keyword series/ ) {
1227         __PACKAGE__->register_method(
1228                 api_name        => "open-ils.storage.metabib.$class.post_filter.search_fts.metarecord",
1229                 method          => 'postfilter_search_class_fts',
1230                 api_level       => 1,
1231                 stream          => 1,
1232                 cdbi            => "metabib::${class}_field_entry",
1233                 cachable        => 1,
1234         );
1235         __PACKAGE__->register_method(
1236                 api_name        => "open-ils.storage.metabib.$class.post_filter.search_fts.metarecord.staff",
1237                 method          => 'postfilter_search_class_fts',
1238                 api_level       => 1,
1239                 stream          => 1,
1240                 cdbi            => "metabib::${class}_field_entry",
1241                 cachable        => 1,
1242         );
1243 }
1244
1245
1246
1247 my $_cdbi = {   title   => "metabib::title_field_entry",
1248                 author  => "metabib::author_field_entry",
1249                 subject => "metabib::subject_field_entry",
1250                 keyword => "metabib::keyword_field_entry",
1251                 series  => "metabib::series_field_entry",
1252 };
1253
1254 # XXX factored most of the PG dependant stuff out of here... need to find a way to do "dependants".
1255 sub postfilter_search_multi_class_fts {
1256         my $self = shift;
1257         my $client = shift;
1258         my %args = @_;
1259         
1260         my $sort = $args{'sort'};
1261         my $sort_dir = $args{sort_dir} || 'DESC';
1262         my $ou = $args{org_unit};
1263         my $ou_type = $args{depth};
1264         my $limit = $args{limit};
1265         my $offset = $args{offset} || 0;
1266
1267         if (! scalar( keys %{$args{searches}} )) {
1268                 die "No target organizational unit passed to ".$self->api_name;
1269         }
1270
1271         if (! scalar( keys %{$args{searches}} )) {
1272                 die "No search arguments were passed to ".$self->api_name;
1273         }
1274
1275         my $outer_limit = 1000;
1276
1277         my $limit_clause = '';
1278         my $offset_clause = '';
1279
1280         $limit_clause = "LIMIT $outer_limit";
1281         $offset_clause = "OFFSET $offset" if (defined $offset and int($offset) > 0);
1282
1283         my (@types,@forms);
1284         my ($t_filter, $f_filter) = ('','');
1285         my ($ot_filter, $of_filter) = ('','');
1286
1287         if ($args{format}) {
1288                 my ($t, $f) = split '-', $args{format};
1289                 @types = split '', $t;
1290                 @forms = split '', $f;
1291                 if (@types) {
1292                         $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
1293                         $ot_filter = ' AND ord.item_type IN ('.join(',',map{'?'}@types).')';
1294                 }
1295
1296                 if (@forms) {
1297                         $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
1298                         $of_filter .= ' AND ord.item_form IN ('.join(',',map{'?'}@forms).')';
1299                 }
1300         }
1301
1302
1303
1304         my $descendants = defined($ou_type) ?
1305                                 "actor.org_unit_descendants($ou, $ou_type)" :
1306                                 "actor.org_unit_descendants($ou)";
1307
1308         my $search_table_list = '';
1309         my $fts_list = '';
1310         my $join_table_list = '';
1311         my @rank_list;
1312
1313         my $prev_search_class;
1314         my $curr_search_class;
1315         for my $search_class (sort keys %{$args{searches}}) {
1316                 $prev_search_class = $curr_search_class if ($curr_search_class);
1317
1318                 $curr_search_class = $search_class;
1319
1320                 my $class = $_cdbi->{$search_class};
1321                 my $search_table = $class->table;
1322
1323                 my ($index_col) = $class->columns('FTS');
1324                 $index_col ||= 'value';
1325
1326                 
1327                 my $fts = OpenILS::Application::Storage::FTS->compile($args{searches}{$search_class}{term}, $search_class.'.value', "$search_class.$index_col");
1328
1329                 my $fts_where = $fts->sql_where_clause;
1330                 my @fts_ranks = $fts->fts_rank;
1331
1332                 my $rank = join(' + ', @fts_ranks);
1333
1334                 #---------------------
1335
1336                 $search_table_list .= "$search_table $search_class, ";
1337                 push @rank_list,$rank;
1338                 $fts_list .= " AND $fts_where AND m.source = $search_class.source";
1339
1340                 if ($prev_search_class) {
1341                         $join_table_list .= " AND $prev_search_class.source = $curr_search_class.source";
1342                 }
1343         }
1344
1345         my $metabib_record_descriptor = metabib::record_descriptor->table;
1346         my $metabib_full_rec = metabib::full_rec->table;
1347         my $metabib_metarecord = metabib::metarecord->table;
1348         my $metabib_metarecord_source_map_table = metabib::metarecord_source_map->table;
1349         my $asset_call_number_table = asset::call_number->table;
1350         my $asset_copy_table = asset::copy->table;
1351         my $cs_table = config::copy_status->table;
1352         my $cl_table = asset::copy_location->table;
1353         my $br_table = biblio::record_entry->table;
1354
1355         my $relevance = join (' + ', @rank_list);
1356         $relevance = "SUM( $relevance )";
1357
1358
1359         my $rank = $relevance;
1360         if (lc($sort) eq 'pubdate') {
1361                 $rank = <<"             RANK";
1362                         ( FIRST ((
1363                                 SELECT  COALESCE(SUBSTRING(frp.value FROM '\\\\d+'),'9999')::INT
1364                                   FROM  $metabib_full_rec frp
1365                                   WHERE frp.record = mr.master_record
1366                                         AND frp.tag = '260'
1367                                         AND frp.subfield = 'c'
1368                                   LIMIT 1
1369                         )) )
1370                 RANK
1371         } elsif (lc($sort) eq 'title') {
1372                 $rank = <<"             RANK";
1373                         ( FIRST ((
1374                                 SELECT  COALESCE(LTRIM(SUBSTR( frt.value, frt.ind2::text::int )),'zzzzzzzz')
1375                                   FROM  $metabib_full_rec frt
1376                                   WHERE frt.record = mr.master_record
1377                                         AND frt.tag = '245'
1378                                         AND frt.subfield = 'a'
1379                                   LIMIT 1
1380                         )) )
1381                 RANK
1382         } elsif (lc($sort) eq 'author') {
1383                 $rank = <<"             RANK";
1384                         ( FIRST((
1385                                 SELECT  COALESCE(LTRIM(fra.value),'zzzzzzzz')
1386                                   FROM  $metabib_full_rec fra
1387                                   WHERE fra.record = mr.master_record
1388                                         AND fra.tag LIKE '1%'
1389                                         AND fra.subfield = 'a'
1390                                   ORDER BY fra.tag::text::int
1391                                   LIMIT 1
1392                         )) )
1393                 RANK
1394         }
1395
1396
1397         my $select = <<"        SQL";
1398                 SELECT  m.metarecord,
1399                         $relevance,
1400                         CASE WHEN COUNT(DISTINCT smrs.source) = 1 THEN MIN(m.source) ELSE 0 END,
1401                         $rank
1402                 FROM    $search_table_list
1403                         $metabib_metarecord_source_map_table m,
1404                         $metabib_metarecord_source_map_table smrs,
1405                         $metabib_metarecord mr,
1406                         $metabib_record_descriptor rd
1407                 WHERE   m.metarecord = mr.id
1408                         smrs.metarecord = mr.id
1409                         $fts_list
1410                         $join_table_list
1411                         AND rd.record = smrs.source
1412                         $t_filter
1413                         $f_filter
1414                 GROUP BY m.metarecord
1415                 ORDER BY 4 $sort_dir
1416                 LIMIT 10000
1417         SQL
1418
1419         if ($self->api_name !~ /staff/o) {
1420                 $select = <<"           SQL";
1421
1422                         SELECT  DISTINCT s.*
1423                           FROM  ($select) s
1424                           WHERE EXISTS (
1425                                 SELECT  1
1426                                   FROM  $asset_call_number_table cn,
1427                                         $metabib_metarecord_source_map_table mrs,
1428                                         $asset_copy_table cp,
1429                                         $cs_table cs,
1430                                         $cl_table cl,
1431                                         $br_table br,
1432                                         $descendants d,
1433                                         $metabib_record_descriptor ord
1434                                   WHERE mrs.metarecord = s.metarecord
1435                                         AND br.id = mrs.source
1436                                         AND cn.record = mrs.source
1437                                         AND cp.status = cs.id
1438                                         AND cp.location = cl.id
1439                                         AND cn.owning_lib = d.id
1440                                         AND cp.call_number = cn.id
1441                                         AND cp.opac_visible IS TRUE
1442                                         AND cs.holdable IS TRUE
1443                                         AND cl.opac_visible IS TRUE
1444                                         AND br.active IS TRUE
1445                                         AND br.deleted IS FALSE
1446                                         AND ord.record = mrs.source
1447                                         $ot_filter
1448                                         $of_filter
1449                                   LIMIT 1
1450                                 )
1451                           ORDER BY 4 $sort_dir
1452                 SQL
1453         } else {
1454                 $select = <<"           SQL";
1455
1456                         SELECT  DISTINCT s.*
1457                           FROM  ($select) s
1458                           WHERE EXISTS (
1459                                 SELECT  1
1460                                   FROM  $asset_call_number_table cn,
1461                                         $metabib_metarecord_source_map_table mrs,
1462                                         $descendants d,
1463                                         $br_table br,
1464                                         $metabib_record_descriptor ord
1465                                   WHERE mrs.metarecord = s.metarecord
1466                                         AND br.id = mrs.source
1467                                         AND cn.record = mrs.source
1468                                         AND cn.owning_lib = d.id
1469                                         AND ord.record = mrs.source
1470                                         AND br.deleted IS FALSE
1471                                         $ot_filter
1472                                         $of_filter
1473                                   LIMIT 1
1474                                 )
1475                                 OR NOT EXISTS (
1476                                 SELECT  1
1477                                   FROM  $asset_call_number_table cn,
1478                                         $metabib_metarecord_source_map_table mrs,
1479                                         $metabib_record_descriptor ord
1480                                   WHERE mrs.metarecord = s.metarecord
1481                                         AND cn.record = mrs.source
1482                                         AND ord.record = mrs.source
1483                                         $ot_filter
1484                                         $of_filter
1485                                   LIMIT 1
1486                                 )
1487                           ORDER BY 4 $sort_dir
1488                 SQL
1489         }
1490
1491
1492         $log->debug("Field Search SQL :: [$select]",DEBUG);
1493
1494         my $recs = $_cdbi->{title}->db_Main->selectall_arrayref(
1495                         $select, {},
1496                         @types, @forms, @types, @forms,  ($self->api_name =~ /staff/o ? (@types, @forms) : () ) );
1497         
1498         $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
1499
1500         my $max = 0;
1501         $max = 1 if (!@$recs);
1502         for (@$recs) {
1503                 $max = $$_[1] if ($$_[1] > $max);
1504         }
1505
1506         my $count = scalar(@$recs);
1507         for my $rec (@$recs[$offset .. $offset + $limit - 1]) {
1508                 next unless ($$rec[0]);
1509                 my ($mrid,$rank,$skip) = @$rec;
1510                 $client->respond( [$mrid, sprintf('%0.3f',$rank/$max), $skip, $count] );
1511         }
1512         return undef;
1513 }
1514
1515 __PACKAGE__->register_method(
1516         api_name        => "open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord",
1517         method          => 'postfilter_search_multi_class_fts',
1518         api_level       => 1,
1519         stream          => 1,
1520         cachable        => 1,
1521 );
1522 __PACKAGE__->register_method(
1523         api_name        => "open-ils.storage.metabib.post_filter.multiclass.search_fts.metarecord.staff",
1524         method          => 'postfilter_search_multi_class_fts',
1525         api_level       => 1,
1526         stream          => 1,
1527         cachable        => 1,
1528 );
1529
1530
1531
1532 # XXX factored most of the PG dependant stuff out of here... need to find a way to do "dependants".
1533 sub postfilter_Z_search_class_fts {
1534         my $self = shift;
1535         my $client = shift;
1536         my %args = @_;
1537         
1538         my $term = $args{term};
1539         my $sort = $args{'sort'};
1540         my $sort_dir = $args{sort_dir} || 'DESC';
1541         my $ou = $args{org_unit};
1542         my $ou_type = $args{depth};
1543         my $limit = $args{limit} || 10;
1544         my $offset = $args{offset} || 0;
1545
1546         my (@types,@forms);
1547         my ($t_filter, $f_filter) = ('','');
1548         my ($ot_filter, $of_filter) = ('','');
1549
1550         if ($args{format}) {
1551                 my ($t, $f) = split '-', $args{format};
1552                 @types = split '', $t;
1553                 @forms = split '', $f;
1554                 if (@types) {
1555                         $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
1556                         $ot_filter = ' AND ord.item_type IN ('.join(',',map{'?'}@types).')';
1557                 }
1558
1559                 if (@forms) {
1560                         $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
1561                         $of_filter .= ' AND ord.item_form IN ('.join(',',map{'?'}@forms).')';
1562                 }
1563         }
1564
1565
1566
1567         my $class = $self->{cdbi};
1568         my $search_table = $class->table;
1569         my $metabib_record_descriptor = metabib::record_descriptor->table;
1570         my $metabib_full_rec = metabib::full_rec->table;
1571         my $asset_call_number_table = asset::call_number->table;
1572         my $asset_copy_table = asset::copy->table;
1573         my $cs_table = config::copy_status->table;
1574         my $cl_table = asset::copy_location->table;
1575         my $br_table = biblio::record_entry->table;
1576
1577         my ($index_col) = $class->columns('FTS');
1578         $index_col ||= 'value';
1579
1580         my $fts = OpenILS::Application::Storage::FTS->compile($term, 'f.value', "f.$index_col");
1581
1582         my $fts_where = $fts->sql_where_clause;
1583         my @fts_ranks = $fts->fts_rank;
1584
1585         my $relevance = join(' + ', @fts_ranks);
1586
1587         $relevance = <<"        RANK";
1588                         (SUM(   ($relevance)
1589                                 * CASE WHEN f.value ILIKE ? THEN 1.2 ELSE 1 END -- phrase order
1590                                 * CASE WHEN f.value ILIKE ? THEN 1.5 ELSE 1 END -- first word match
1591                                 * CASE WHEN f.value ~* ? THEN 2 ELSE 1 END -- only word match
1592                         )/COUNT(f.id))
1593         RANK
1594
1595         my $rank = $relevance;
1596         if (lc($sort) eq 'pubdate') {
1597                 $rank = <<"             RANK";
1598                         (
1599                                 SELECT  FIRST(COALESCE(SUBSTRING(frp.value FROM '\\\\d+'),'9999')::INT)
1600                                   FROM  $metabib_full_rec frp
1601                                   WHERE frp.record = f.source
1602                                         AND frp.tag = '260'
1603                                         AND frp.subfield = 'c'
1604                         )
1605                 RANK
1606         } elsif (lc($sort) eq 'title') {
1607                 $rank = <<"             RANK";
1608                         (
1609                                 SELECT  FIRST(COALESCE(LTRIM(SUBSTR( frt.value, frt.ind2::text::int )),'zzzzzzzz'))
1610                                   FROM  $metabib_full_rec frt
1611                                   WHERE frt.record = f.source
1612                                         AND frt.tag = '245'
1613                                         AND frt.subfield = 'a'
1614                         )
1615                 RANK
1616         } elsif (lc($sort) eq 'author') {
1617                 $rank = <<"             RANK";
1618                         ( FIRST ((
1619                                 SELECT  COALESCE(LTRIM(fra.value),'zzzzzzzz')
1620                                   FROM  $metabib_full_rec fra
1621                                   WHERE fra.record = f.source
1622                                         AND fra.tag LIKE '1%'
1623                                         AND fra.subfield = 'a'
1624                                   ORDER BY fra.tag::text::int
1625                                   LIMIT 1
1626                         )) )
1627                 RANK
1628         } else {
1629                 $sort = undef;
1630         }
1631
1632
1633
1634         my $select = <<"        SQL";
1635                 SELECT  f.source,
1636                         $rank,
1637                         $relevance
1638                 FROM    $search_table f,
1639                         $br_table br,
1640                         $descendants
1641                         $metabib_record_descriptor rd
1642                 WHERE   $fts_where
1643                         AND rd.record = f.source
1644                         AND br.id = f.source
1645                         AND br.deleted IS FALSE
1646                         $t_filter
1647                         $f_filter
1648                 GROUP BY 1
1649                 ORDER BY 2 $sort_dir, 3, MIN(COALESCE(CHAR_LENGTH(f.value),1))
1650         SQL
1651
1652
1653         if ($self->api_name !~ /Zsearch/o) {
1654
1655                 my $descendants = defined($ou_type) ?
1656                                 "actor.org_unit_descendants($ou, $ou_type)" :
1657                                 "actor.org_unit_descendants($ou)";
1658
1659                 if ($self->api_name !~ /staff/o) {
1660                         $select = <<"                   SQL";
1661
1662                         SELECT  DISTINCT s.*
1663                           FROM  ($select) s
1664                           WHERE EXISTS (
1665                                 SELECT  1
1666                                   FROM  $asset_call_number_table cn,
1667                                         $asset_copy_table cp,
1668                                         $cs_table cs,
1669                                         $cl_table cl,
1670                                         $br_table br,
1671                                         $descendants d
1672                                   WHERE br.id = s.source
1673                                         AND cn.record = s.source
1674                                         AND cp.status = cs.id
1675                                         AND cp.location = cl.id
1676                                         AND cn.owning_lib = d.id
1677                                         AND cp.call_number = cn.id
1678                                         AND cp.opac_visible IS TRUE
1679                                         AND cs.holdable IS TRUE
1680                                         AND cl.opac_visible IS TRUE
1681                                         AND br.active IS TRUE
1682                                         AND br.deleted IS FALSE
1683                                   LIMIT 1
1684                                 )
1685                           ORDER BY 2 $sort_dir, 3
1686
1687                         SQL
1688                 } else {
1689                         $select = <<"                   SQL";
1690
1691                         SELECT  DISTINCT s.*
1692                           FROM  ($select) s
1693                           WHERE EXISTS (
1694                                 SELECT  1
1695                                   FROM  $asset_call_number_table cn,
1696                                         $descendants d,
1697                                         $br_table br
1698                                   WHERE br.id = s.source
1699                                         AND cn.record = s.source
1700                                         AND cn.owning_lib = d.id
1701                                         AND br.deleted IS FALSE
1702                                   LIMIT 1
1703                                 )
1704                                 OR NOT EXISTS (
1705                                 SELECT  1
1706                                   FROM  $asset_call_number_table cn
1707                                   WHERE cn.record = s.source
1708                                   LIMIT 1
1709                                 )
1710                           ORDER BY 2 $sort_dir, 3
1711
1712                         SQL
1713                 }
1714         }
1715
1716
1717         $log->debug("Z39.50 (Record) Search SQL :: [$select]",DEBUG);
1718
1719         my $SQLstring = join('%',$fts->words);
1720         my $REstring = join('\\s+',$fts->words);
1721         my $first_word = ($fts->words)[0].'%';
1722         my $recs =
1723                 $class->db_Main->selectall_arrayref(
1724                         $select, {},
1725                         '%'.lc($SQLstring).'%',                 # phrase order match
1726                         lc($first_word),                        # first word match
1727                         '^\\s*'.lc($REstring).'\\s*/?\s*$',     # full exact match
1728                         ( !$sort ?
1729                                 ( '%'.lc($SQLstring).'%',                       # phrase order match
1730                                   lc($first_word),                              # first word match
1731                                   '^\\s*'.lc($REstring).'\\s*/?\s*$' ) :        # full exact match
1732                                 ()
1733                         ),
1734                         @types, @forms
1735                 );
1736         
1737         $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
1738
1739         my $max = 0;
1740         $max = 1 if (!@$recs);
1741         for (@$recs) {
1742                 $max = $$_[2] if ($$_[2] > $max);
1743         }
1744
1745         my $count = scalar(@$recs);
1746         for my $rec (@$recs[$offset .. $offset + $limit - 1]) {
1747                 next unless ($rec);
1748                 my ($mrid,$junk,$rank) = @$rec;
1749                 $client->respond( [$mrid, sprintf('%0.3f',$rank/$max), $count] );
1750         }
1751         return undef;
1752 }
1753
1754 for my $class ( qw/title author subject keyword series/ ) {
1755         __PACKAGE__->register_method(
1756                 api_name        => "open-ils.storage.metabib.$class.Zsearch",
1757                 method          => 'postfilter_Z_search_class_fts',
1758                 api_level       => 1,
1759                 stream          => 1,
1760                 cdbi            => "metabib::${class}_field_entry",
1761                 cachable        => 1,
1762         );
1763         __PACKAGE__->register_method(
1764                 api_name        => "open-ils.storage.biblio.$class.search_fts.record",
1765                 method          => 'postfilter_Z_search_class_fts',
1766                 api_level       => 1,
1767                 stream          => 1,
1768                 cdbi            => "metabib::${class}_field_entry",
1769                 cachable        => 1,
1770         );
1771         __PACKAGE__->register_method(
1772                 api_name        => "open-ils.storage.biblio.$class.search_fts.record.staff",
1773                 method          => 'postfilter_Z_search_class_fts',
1774                 api_level       => 1,
1775                 stream          => 1,
1776                 cdbi            => "metabib::${class}_field_entry",
1777                 cachable        => 1,
1778         );
1779 }
1780
1781
1782 sub multi_Z_search_full_rec {
1783         my $self = shift;
1784         my $client = shift;
1785
1786         my %args = @_;  
1787         my $class_join = $args{class_join} || 'AND';
1788         my $limit = $args{limit} || 10;
1789         my $offset = $args{offset} || 0;
1790         my @binds;
1791         my @selects;
1792
1793         my $limiter_count = 0;
1794
1795         for my $arg (@{ $args{searches} }) {
1796                 my $term = $$arg{term};
1797                 my $limiters = $$arg{restrict};
1798
1799                 my ($index_col) = metabib::full_rec->columns('FTS');
1800                 $index_col ||= 'value';
1801                 my $search_table = metabib::full_rec->table;
1802
1803                 my $fts = OpenILS::Application::Storage::FTS->compile($term, 'value',"$index_col");
1804
1805                 my $fts_where = $fts->sql_where_clause();
1806                 my @fts_ranks = $fts->fts_rank;
1807
1808                 my $rank = join(' + ', @fts_ranks);
1809
1810                 my @wheres;
1811                 for my $limit (@$limiters) {
1812                         push @wheres, "( tag = ? AND subfield LIKE ? AND $fts_where )";
1813                         push @binds, $$limit{tag}, ($$limit{subfield} ? $$limit{subfield} : '_');
1814                         $log->debug("Limiting query using { tag => $$limit{tag}, subfield => $$limit{subfield} }", DEBUG);
1815                 }
1816                 $limiter_count++;
1817                 my $where = join(' OR ', @wheres);
1818
1819                 push @selects, "SELECT FIRST(id), record, SUM($rank) as sum FROM $search_table WHERE $where GROUP BY 2";
1820
1821         }
1822
1823         my $metabib_record_descriptor = metabib::record_descriptor->table;
1824
1825         my $cj = 'HAVING COUNT(DISTINCT x.id) = ' . $limiter_count if ($class_join eq 'AND');
1826         my $search_table =
1827                 '(SELECT x.record, sum(x.sum) FROM (('.
1828                         join(') UNION ALL (', @selects).
1829                         ")) x GROUP BY 1 $cj ORDER BY 2 DESC )";
1830
1831         my ($t_filter, $f_filter) = ('','');
1832
1833         if ($args{format}) {
1834                 my ($t, $f) = split '-', $args{format};
1835                 my @types = split '', $t;
1836                 my @forms = split '', $f;
1837                 if (@types) {
1838                         $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
1839                 }
1840
1841                 if (@forms) {
1842                         $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
1843                 }
1844                 push @binds, @types, @forms;
1845         }
1846
1847
1848         my $select = <<"        SQL";
1849                 SELECT  f.record, f.sum
1850                 FROM    $search_table f,
1851                         $metabib_record_descriptor rd
1852                 WHERE   rd.record = f.record
1853                         $t_filter
1854                         $f_filter
1855                 ORDER BY 2
1856         SQL
1857
1858
1859         $log->debug("Search SQL :: [$select]",DEBUG);
1860
1861         my $recs = metabib::full_rec->db_Main->selectall_arrayref("$select;", {}, @binds);
1862         $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
1863
1864         my $count = @$recs;
1865         for my $rec (@$recs[$offset .. $offset + $limit - 1]) {
1866                 next unless ($$rec[0]);
1867                 my ($rid,$rank) = @$rec;
1868                 $client->respond( [$rid, sprintf('%0.3f',$rank), $count] );
1869         }
1870         return undef;
1871 }
1872 __PACKAGE__->register_method(
1873         api_name        => 'open-ils.storage.metabib.full_rec.Zmulti_search',
1874         method          => 'multi_Z_search_full_rec',
1875         api_level       => 1,
1876         stream          => 1,
1877         cachable        => 1,
1878 );
1879
1880 __PACKAGE__->register_method(
1881         api_name        => 'open-ils.storage.biblio.multiclass.search_fts.record',
1882         method          => 'multi_Z_search_full_rec',
1883         api_level       => 1,
1884         stream          => 1,
1885         cachable        => 1,
1886 );
1887
1888
1889 1;