1 package OpenILS::Application::Storage::Publisher::metabib;
2 use base qw/OpenILS::Application::Storage::Publisher/;
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;
10 use Digest::MD5 qw/md5_hex/;
13 my $log = 'OpenSRF::Utils::Logger';
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...
21 sub ordered_records_from_metarecord {
30 my ($t, $f) = split '-', $formats;
31 @types = split '', $t;
32 @forms = split '', $f;
35 my $copies_visible = 'AND cp.opac_visible IS TRUE AND cs.holdable IS TRUE';
36 $copies_visible = '' if ($self->api_name =~ /staff/o);
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 $cp_table = asset::copy->table;
42 my $cs_table = config::copy_status->table;
43 my $out_table = actor::org_unit_type->table;
53 if ($copies_visible) {
55 sum((SELECT count(cp.id)
57 JOIN $cs_table cs ON (cp.status = cs.id)
58 WHERE cn.id = cp.call_number
66 if ($copies_visible) {
71 WHERE rd.record = sm.source
72 AND cn.record = rd.record
79 WHERE rd.record = sm.source
85 GROUP BY rd.record, rd.item_type, rd.item_form
88 WHEN rd.item_type IS NULL -- default
90 WHEN rd.item_type = '' -- default
92 WHEN rd.item_type IN ('a','t') -- books
94 WHEN rd.item_type = 'g' -- movies
96 WHEN rd.item_type IN ('i','j') -- sound recordings
98 WHEN rd.item_type = 'm' -- software
100 WHEN rd.item_type = 'k' -- images
102 WHEN rd.item_type IN ('e','f') -- maps
104 WHEN rd.item_type IN ('o','p') -- mixed
106 WHEN rd.item_type IN ('c','d') -- music
108 WHEN rd.item_type = 'r' -- 3d
115 if ($copies_visible) {
116 $sql .= ' WHERE x.count > 0'
120 $sql .= ' AND x.item_type IN ('.join(',',map{'?'}@types).')';
124 $sql .= ' AND x.item_form IN ('.join(',',map{'?'}@forms).')';
127 my $sth = metabib::metarecord_source_map->db_Main->prepare_cached($sql);
128 $sth->execute("$mr", @types, @forms);
129 while ( my $row = $sth->fetchrow_arrayref ) {
130 $client->respond( $$row[0] );
135 __PACKAGE__->register_method(
136 api_name => 'open-ils.storage.ordered.metabib.metarecord.records',
137 method => 'ordered_records_from_metarecord',
142 __PACKAGE__->register_method(
143 api_name => 'open-ils.storage.ordered.metabib.metarecord.records.staff',
144 method => 'ordered_records_from_metarecord',
151 sub metarecord_copy_count {
157 my $sm_table = metabib::metarecord_source_map->table;
158 my $cn_table = asset::call_number->table;
159 my $cp_table = asset::copy->table;
160 my $cs_table = config::copy_status->table;
161 my $out_table = actor::org_unit_type->table;
162 my $descendants = "actor.org_unit_descendants(u.id)";
163 my $ancestors = "actor.org_unit_ancestors(?)";
165 my $copies_visible = 'AND cp.opac_visible IS TRUE AND cs.holdable IS TRUE';
166 $copies_visible = '' if ($self->api_name =~ /staff/o);
174 JOIN $cn_table cn ON (cn.record = r.source)
175 JOIN $cp_table cp ON (cn.id = cp.call_number)
176 JOIN $cs_table cs ON (cp.status = cs.id)
177 JOIN $descendants a ON (cp.circ_lib = a.id)
178 WHERE r.metarecord = ?
185 JOIN $cn_table cn ON (cn.record = r.source)
186 JOIN $cp_table cp ON (cn.id = cp.call_number)
187 JOIN $cs_table cs ON (cp.status = cs.id)
188 JOIN $descendants a ON (cp.circ_lib = a.id)
189 WHERE r.metarecord = ?
196 JOIN $out_table t ON (u.ou_type = t.id)
200 my $sth = metabib::metarecord_source_map->db_Main->prepare_cached($sql);
201 $sth->execute(''.$args{metarecord}, ''.$args{metarecord}, ''.$args{org_unit});
202 while ( my $row = $sth->fetchrow_hashref ) {
203 $client->respond( $row );
207 __PACKAGE__->register_method(
208 api_name => 'open-ils.storage.metabib.metarecord.copy_count',
209 method => 'metarecord_copy_count',
214 __PACKAGE__->register_method(
215 api_name => 'open-ils.storage.metabib.metarecord.copy_count.staff',
216 method => 'metarecord_copy_count',
222 sub search_full_rec {
228 my $term = $args{term};
229 my $limiters = $args{restrict};
231 my ($index_col) = metabib::full_rec->columns('FTS');
232 $index_col ||= 'value';
233 my $search_table = metabib::full_rec->table;
235 my $fts = OpenILS::Application::Storage::FTS->compile($term, 'value',"$index_col");
237 my $fts_where = $fts->sql_where_clause();
238 my @fts_ranks = $fts->fts_rank;
240 my $rank = join(' + ', @fts_ranks);
244 for my $limit (@$limiters) {
245 push @wheres, "( tag = ? AND subfield LIKE ? AND $fts_where )";
246 push @binds, $$limit{tag}, $$limit{subfield};
247 $log->debug("Limiting query using { tag => $$limit{tag}, subfield => $$limit{subfield} }", DEBUG);
249 my $where = join(' OR ', @wheres);
251 my $select = "SELECT record, sum($rank) FROM $search_table WHERE $where GROUP BY 1 ORDER BY 2 DESC;";
253 $log->debug("Search SQL :: [$select]",DEBUG);
255 my $recs = metabib::full_rec->db_Main->selectall_arrayref($select, {}, @binds);
256 $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
258 $client->respond($_) for (@$recs);
261 __PACKAGE__->register_method(
262 api_name => 'open-ils.storage.direct.metabib.full_rec.search_fts.value',
263 method => 'search_full_rec',
268 __PACKAGE__->register_method(
269 api_name => 'open-ils.storage.direct.metabib.full_rec.search_fts.index_vector',
270 method => 'search_full_rec',
277 # XXX factored most of the PG dependant stuff out of here... need to find a way to do "dependants".
278 sub search_class_fts {
283 my $term = $args{term};
284 my $ou = $args{org_unit};
285 my $ou_type = $args{depth};
286 my $limit = $args{limit};
287 my $offset = $args{offset};
289 my $limit_clause = '';
290 my $offset_clause = '';
292 $limit_clause = "LIMIT $limit" if (defined $limit and int($limit) > 0);
293 $offset_clause = "OFFSET $offset" if (defined $offset and int($offset) > 0);
296 my ($t_filter, $f_filter) = ('','');
299 my ($t, $f) = split '-', $args{format};
300 @types = split '', $t;
301 @forms = split '', $f;
303 $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
307 $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
313 my $descendants = defined($ou_type) ?
314 "actor.org_unit_descendants($ou, $ou_type)" :
315 "actor.org_unit_descendants($ou)";
317 my $class = $self->{cdbi};
318 my $search_table = $class->table;
320 my $metabib_record_descriptor = metabib::record_descriptor->table;
321 my $metabib_metarecord = metabib::metarecord->table;
322 my $metabib_full_rec = metabib::full_rec->table;
323 my $metabib_metarecord_source_map_table = metabib::metarecord_source_map->table;
324 my $asset_call_number_table = asset::call_number->table;
325 my $asset_copy_table = asset::copy->table;
326 my $cs_table = config::copy_status->table;
328 my ($index_col) = $class->columns('FTS');
329 $index_col ||= 'value';
331 my $fts = OpenILS::Application::Storage::FTS->compile($term, 'f.value', "f.$index_col");
333 my $fts_where = $fts->sql_where_clause;
334 my @fts_ranks = $fts->fts_rank;
336 my $rank = join(' + ', @fts_ranks);
338 my $has_vols = 'AND cn.owning_lib = d.id';
339 my $has_copies = 'AND cp.call_number = cn.id';
340 my $copies_visible = 'AND cp.opac_visible IS TRUE AND cs.holdable IS TRUE';
342 my $visible_count = ', count(DISTINCT cp.id)';
343 my $visible_count_test = 'HAVING count(DISTINCT cp.id) > 0';
345 if ($self->api_name =~ /staff/o) {
346 $copies_visible = '';
347 $visible_count_test = '';
348 $has_copies = '' if ($ou_type == 0);
349 $has_vols = '' if ($ou_type == 0);
352 my $rank_calc = <<" RANK";
354 * CASE WHEN f.value ILIKE ? THEN 1.2 ELSE 1 END -- phrase order
355 * CASE WHEN f.value ILIKE ? THEN 1.5 ELSE 1 END -- first word match
356 * CASE WHEN f.value ~* ? THEN 2 ELSE 1 END -- only word match
357 )/COUNT(m.source)), MIN(COALESCE(CHAR_LENGTH(f.value),1))
360 $rank_calc = ',1 , 1' if ($self->api_name =~ /unordered/o);
362 if ($copies_visible) {
364 SELECT m.metarecord $rank_calc $visible_count
365 FROM $search_table f,
366 $metabib_metarecord_source_map_table m,
367 $asset_call_number_table cn,
368 $asset_copy_table cp,
370 $metabib_record_descriptor rd,
373 AND m.source = f.source
374 AND cn.record = m.source
375 AND rd.record = m.source
376 AND cp.status = cs.id
382 GROUP BY m.metarecord $visible_count_test
384 $limit_clause $offset_clause
388 SELECT m.metarecord $rank_calc, 0
389 FROM $search_table f,
390 $metabib_metarecord_source_map_table m,
391 $metabib_record_descriptor rd
393 AND m.source = f.source
394 AND rd.record = m.source
399 $limit_clause $offset_clause
403 $log->debug("Field Search SQL :: [$select]",DEBUG);
405 my $SQLstring = join('%',$fts->words);
406 my $REstring = join('\\s+',$fts->words);
407 my $first_word = ($fts->words)[0].'%';
408 my $recs = ($self->api_name =~ /unordered/o) ?
409 $class->db_Main->selectall_arrayref($select, {}, @types, @forms) :
410 $class->db_Main->selectall_arrayref($select, {},
411 '%'.lc($SQLstring).'%', # phrase order match
412 lc($first_word), # first word match
413 '^\\s*'.lc($REstring).'\\s*/?\s*$', # full exact match
417 $log->debug("Search yielded ".scalar(@$recs)." results.",DEBUG);
419 $client->respond($_) for (map { [@$_[0,1,3]] } @$recs);
423 for my $class ( qw/title author subject keyword series/ ) {
424 __PACKAGE__->register_method(
425 api_name => "open-ils.storage.metabib.$class.search_fts.metarecord",
426 method => 'search_class_fts',
429 cdbi => "metabib::${class}_field_entry",
432 __PACKAGE__->register_method(
433 api_name => "open-ils.storage.metabib.$class.search_fts.metarecord.unordered",
434 method => 'search_class_fts',
437 cdbi => "metabib::${class}_field_entry",
440 __PACKAGE__->register_method(
441 api_name => "open-ils.storage.metabib.$class.search_fts.metarecord.staff",
442 method => 'search_class_fts',
445 cdbi => "metabib::${class}_field_entry",
448 __PACKAGE__->register_method(
449 api_name => "open-ils.storage.metabib.$class.search_fts.metarecord.staff.unordered",
450 method => 'search_class_fts',
453 cdbi => "metabib::${class}_field_entry",
458 # XXX factored most of the PG dependant stuff out of here... need to find a way to do "dependants".
459 sub search_class_fts_count {
464 my $term = $args{term};
465 my $ou = $args{org_unit};
466 my $ou_type = $args{depth};
467 my $limit = $args{limit} || 100;
468 my $offset = $args{offset} || 0;
470 my $descendants = defined($ou_type) ?
471 "actor.org_unit_descendants($ou, $ou_type)" :
472 "actor.org_unit_descendants($ou)";
475 my ($t_filter, $f_filter) = ('','');
478 my ($t, $f) = split '-', $args{format};
479 @types = split '', $t;
480 @forms = split '', $f;
482 $t_filter = ' AND rd.item_type IN ('.join(',',map{'?'}@types).')';
486 $f_filter .= ' AND rd.item_form IN ('.join(',',map{'?'}@forms).')';
491 (my $search_class = $self->api_name) =~ s/.*metabib.(\w+).search_fts.*/$1/o;
493 my $class = $self->{cdbi};
494 my $search_table = $class->table;
496 my $metabib_record_descriptor = metabib::record_descriptor->table;
497 my $metabib_metarecord_source_map_table = metabib::metarecord_source_map->table;
498 my $asset_call_number_table = asset::call_number->table;
499 my $asset_copy_table = asset::copy->table;
500 my $cs_table = config::copy_status->table;
502 my ($index_col) = $class->columns('FTS');
503 $index_col ||= 'value';
505 my $fts = OpenILS::Application::Storage::FTS->compile($term, 'value',"$index_col");
507 my $fts_where = $fts->sql_where_clause;
509 my $has_vols = 'AND cn.owning_lib = d.id';
510 my $has_copies = 'AND cp.call_number = cn.id';
511 my $copies_visible = 'AND cp.opac_visible IS TRUE AND cs.holdable IS TRUE';
512 if ($self->api_name =~ /staff/o) {
513 $copies_visible = '';
514 $has_vols = '' if ($ou_type == 0);
515 $has_copies = '' if ($ou_type == 0);
518 # XXX test an "EXISTS version of descendant checking...
520 if ($copies_visible) {
522 SELECT count(distinct m.metarecord)
523 FROM $search_table f,
524 $metabib_metarecord_source_map_table m,
525 $asset_call_number_table cn,
526 $asset_copy_table cp,
528 $metabib_record_descriptor rd,
531 AND m.source = f.source
532 AND cn.record = m.source
533 AND rd.record = m.source
534 AND cp.status = cs.id
543 SELECT count(distinct m.metarecord)
544 FROM $search_table f,
545 $metabib_metarecord_source_map_table m,
546 $metabib_record_descriptor rd
548 AND m.source = f.source
549 AND rd.record = m.source
555 $log->debug("Field Search Count SQL :: [$select]",DEBUG);
557 my $recs = $class->db_Main->selectrow_arrayref($select, {}, @types, @forms)->[0];
559 $log->debug("Count Search yielded $recs results.",DEBUG);
564 for my $class ( qw/title author subject keyword series/ ) {
565 __PACKAGE__->register_method(
566 api_name => "open-ils.storage.metabib.$class.search_fts.metarecord_count",
567 method => 'search_class_fts_count',
570 cdbi => "metabib::${class}_field_entry",
573 __PACKAGE__->register_method(
574 api_name => "open-ils.storage.metabib.$class.search_fts.metarecord_count.staff",
575 method => 'search_class_fts_count',
578 cdbi => "metabib::${class}_field_entry",