2 * Copyright (C) 2007-2008 Equinox Software, Inc.
3 * Mike Rylander <miker@esilibrary.com>
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
18 DROP SCHEMA search CASCADE;
24 CREATE TABLE search.relevance_adjustment (
25 id SERIAL PRIMARY KEY,
26 active BOOL NOT NULL DEFAULT TRUE,
27 field INT NOT NULL REFERENCES config.metabib_field (id) DEFERRABLE INITIALLY DEFERRED,
28 bump_type TEXT NOT NULL CHECK (bump_type IN ('word_order','first_word','full_match')),
29 multiplier NUMERIC NOT NULL DEFAULT 1.0
31 CREATE UNIQUE INDEX bump_once_per_field_idx ON search.relevance_adjustment ( field, bump_type );
33 CREATE OR REPLACE FUNCTION search.pick_table (TEXT) RETURNS TEXT AS $$
35 WHEN $1 = 'author' THEN 'metabib.author_field_entry'
36 WHEN $1 = 'title' THEN 'metabib.title_field_entry'
37 WHEN $1 = 'subject' THEN 'metabib.subject_field_entry'
38 WHEN $1 = 'keyword' THEN 'metabib.keyword_field_entry'
39 WHEN $1 = 'series' THEN 'metabib.series_field_entry'
43 CREATE TYPE search.search_result AS ( id BIGINT, rel NUMERIC, record INT, total INT, checked INT, visible INT, deleted INT, excluded INT );
44 CREATE TYPE search.search_args AS ( id INT, field_class TEXT, field_name TEXT, table_alias TEXT, term TEXT, term_type TEXT );
46 CREATE OR REPLACE FUNCTION search.staged_fts (
50 param_searches TEXT, -- JSON hash, to be turned into a resultset via search.parse_search_args
52 param_locations INT[],
53 param_audience TEXT[],
54 param_language TEXT[],
55 param_lit_form TEXT[],
58 param_vformats TEXT[],
59 param_bib_level TEXT[],
61 param_pref_lang_multiplier REAL,
70 ) RETURNS SETOF search.search_result AS $func$
73 current_res search.search_result%ROWTYPE;
74 query_part search.search_args%ROWTYPE;
75 phrase_query_part search.search_args%ROWTYPE;
80 rank_adjust search.relevance_adjustment%ROWTYPE;
86 query_table_alias TEXT;
87 from_alias_array TEXT[] := '{}';
88 used_ranks TEXT[] := '{}';
91 search_org_list INT[];
92 select_clause TEXT := 'SELECT';
93 from_clause TEXT := ' FROM metabib.metarecord_source_map m JOIN metabib.rec_descriptor mrd ON (m.source = mrd.record) ';
94 where_clause TEXT := ' WHERE 1=1 ';
95 mrd_used BOOL := FALSE;
96 sort_desc BOOL := FALSE;
99 core_cursor REFCURSOR;
101 vis_limit_query TEXT;
102 inner_where_clause TEXT;
104 total_count INT := 0;
105 check_count INT := 0;
106 deleted_count INT := 0;
107 visible_count INT := 0;
108 excluded_count INT := 0;
112 core_rel_limit := COALESCE( param_rel_limit, 25000 );
113 core_chk_limit := COALESCE( param_chk_limit, 1000 );
114 core_skip_chk := COALESCE( param_skip_chk, 1 );
117 select_clause := select_clause || ' m.metarecord as id, array_accum(distinct m.source) as records,';
119 select_clause := select_clause || ' m.source as id, array_accum(distinct m.source) as records,';
122 -- first we need to construct the base query
123 FOR query_part IN SELECT * FROM search.parse_search_args(param_searches) WHERE term_type = 'fts_query' LOOP
125 inner_where_clause := 'index_vector @@ ' || query_part.term;
127 IF query_part.field_name IS NOT NULL THEN
129 SELECT id INTO mb_field
130 FROM config.metabib_field
131 WHERE field_class = query_part.field_class
132 AND name = query_part.field_name;
135 inner_where_clause := inner_where_clause ||
136 ' AND ' || 'field = ' || mb_field;
141 -- moving on to the rank ...
142 SELECT * INTO query_part
143 FROM search.parse_search_args(param_searches)
144 WHERE term_type = 'fts_rank'
145 AND table_alias = query_part.table_alias;
147 current_rank := query_part.term || ' * ' || query_part.table_alias || '_weight.weight';
149 IF query_part.field_name IS NOT NULL THEN
151 SELECT array_accum(distinct id) INTO mb_field_list
152 FROM config.metabib_field
153 WHERE field_class = query_part.field_class
154 AND name = query_part.field_name;
158 SELECT array_accum(distinct id) INTO mb_field_list
159 FROM config.metabib_field
160 WHERE field_class = query_part.field_class;
164 FOR rank_adjust IN SELECT * FROM search.relevance_adjustment WHERE active AND field IN ( SELECT * FROM search.explode_array( mb_field_list ) ) LOOP
166 IF NOT rank_adjust.bump_type = ANY (used_ranks) THEN
168 IF rank_adjust.bump_type = 'first_word' THEN
169 SELECT term INTO tmp_text
170 FROM search.parse_search_args(param_searches)
171 WHERE table_alias = query_part.table_alias AND term_type = 'word'
175 tmp_text := query_part.table_alias || '.value ILIKE ' || quote_literal( tmp_text || '%' );
177 ELSIF rank_adjust.bump_type = 'word_order' THEN
178 SELECT array_to_string( array_accum( term ), '%' ) INTO tmp_text
179 FROM search.parse_search_args(param_searches)
180 WHERE table_alias = query_part.table_alias AND term_type = 'word';
182 tmp_text := query_part.table_alias || '.value ILIKE ' || quote_literal( '%' || tmp_text || '%' );
184 ELSIF rank_adjust.bump_type = 'full_match' THEN
185 SELECT array_to_string( array_accum( term ), E'\\s+' ) INTO tmp_text
186 FROM search.parse_search_args(param_searches)
187 WHERE table_alias = query_part.table_alias AND term_type = 'word';
189 tmp_text := query_part.table_alias || '.value ~ ' || quote_literal( '^' || tmp_text || E'\\W*$' );
194 IF tmp_text IS NOT NULL THEN
195 current_rank := current_rank || ' * ( CASE WHEN ' || tmp_text ||
196 ' THEN ' || rank_adjust.multiplier || '::REAL ELSE 1.0 END )';
199 used_ranks := array_append( used_ranks, rank_adjust.bump_type );
205 ranks := array_append( ranks, current_rank );
208 FOR phrase_query_part IN
210 FROM search.parse_search_args(param_searches)
211 WHERE term_type = 'phrase'
212 AND table_alias = query_part.table_alias LOOP
214 tmp_text := replace( phrase_query_part.term, '*', E'\\*' );
215 tmp_text := replace( tmp_text, '?', E'\\?' );
216 tmp_text := replace( tmp_text, '+', E'\\+' );
217 tmp_text := replace( tmp_text, '|', E'\\|' );
218 tmp_text := replace( tmp_text, '(', E'\\(' );
219 tmp_text := replace( tmp_text, ')', E'\\)' );
220 tmp_text := replace( tmp_text, '[', E'\\[' );
221 tmp_text := replace( tmp_text, ']', E'\\]' );
223 inner_where_clause := inner_where_clause || ' AND ' || 'value ~* ' || quote_literal( E'(^|\\W+)' || regexp_replace(tmp_text, E'\\s+',E'\\\\s+','g') || E'(\\W+|\$)' );
227 query_table := search.pick_table(query_part.field_class);
229 from_clause := from_clause ||
230 ' JOIN ( SELECT * FROM ' || query_table || ' WHERE ' || inner_where_clause ||
231 CASE WHEN core_rel_limit > 0 THEN ' LIMIT ' || core_rel_limit::TEXT ELSE '' END || ' ) AS ' || query_part.table_alias ||
232 ' ON ( m.source = ' || query_part.table_alias || '.source )' ||
233 ' JOIN config.metabib_field AS ' || query_part.table_alias || '_weight' ||
234 ' ON ( ' || query_part.table_alias || '.field = ' || query_part.table_alias || '_weight.id AND ' || query_part.table_alias || '_weight.search_field)';
236 from_alias_array := array_append(from_alias_array, query_part.table_alias);
240 IF param_pref_lang IS NOT NULL AND param_pref_lang_multiplier IS NOT NULL THEN
241 current_rank := ' CASE WHEN mrd.item_lang = ' || quote_literal( param_pref_lang ) ||
242 ' THEN ' || param_pref_lang_multiplier || '::REAL ELSE 1.0 END ';
244 --ranks := array_append( ranks, current_rank );
247 current_rank := ' AVG( ( (' || array_to_string( ranks, ') + (' ) || ') ) * ' || current_rank || ' ) ';
248 select_clause := select_clause || current_rank || ' AS rel,';
250 sort_desc = param_sort_desc;
252 IF param_sort = 'pubdate' THEN
254 tmp_text := '999999';
255 IF param_sort_desc THEN tmp_text := '0'; END IF;
259 SELECT SUBSTRING(frp.value FROM E'\\d{4}')
260 FROM metabib.full_rec frp
261 WHERE frp.record = m.source
263 AND frp.subfield = 'c'
265 )), $$ || quote_literal(tmp_text) || $$ )::INT )
268 ELSIF param_sort = 'title' THEN
270 tmp_text := 'zzzzzz';
271 IF param_sort_desc THEN tmp_text := ' '; END IF;
275 SELECT LTRIM(SUBSTR( frt.value, COALESCE(SUBSTRING(frt.ind2 FROM E'\\d+'),'0')::INT + 1 ))
276 FROM metabib.full_rec frt
277 WHERE frt.record = m.source
279 AND frt.subfield = 'a'
281 )),$$ || quote_literal(tmp_text) || $$))
284 ELSIF param_sort = 'author' THEN
286 tmp_text := 'zzzzzz';
287 IF param_sort_desc THEN tmp_text := ' '; END IF;
291 SELECT LTRIM(fra.value)
292 FROM metabib.full_rec fra
293 WHERE fra.record = m.source
294 AND fra.tag LIKE '1%'
295 AND fra.subfield = 'a'
296 ORDER BY fra.tag::text::int
298 )),$$ || quote_literal(tmp_text) || $$))
301 ELSIF param_sort = 'create_date' THEN
302 current_rank := $$( FIRST (( SELECT create_date FROM biblio.record_entry rbr WHERE rbr.id = m.source)) )$$;
303 ELSIF param_sort = 'edit_date' THEN
304 current_rank := $$( FIRST (( SELECT edit_date FROM biblio.record_entry rbr WHERE rbr.id = m.source)) )$$;
306 sort_desc := NOT COALESCE(param_sort_desc, FALSE);
309 select_clause := select_clause || current_rank || ' AS rank';
311 -- now add the other qualifiers
312 IF param_audience IS NOT NULL AND array_upper(param_audience, 1) > 0 THEN
313 where_clause = where_clause || $$ AND mrd.audience IN ('$$ || array_to_string(param_audience, $$','$$) || $$') $$;
316 IF param_language IS NOT NULL AND array_upper(param_language, 1) > 0 THEN
317 where_clause = where_clause || $$ AND mrd.item_lang IN ('$$ || array_to_string(param_language, $$','$$) || $$') $$;
320 IF param_lit_form IS NOT NULL AND array_upper(param_lit_form, 1) > 0 THEN
321 where_clause = where_clause || $$ AND mrd.lit_form IN ('$$ || array_to_string(param_lit_form, $$','$$) || $$') $$;
324 IF param_types IS NOT NULL AND array_upper(param_types, 1) > 0 THEN
325 where_clause = where_clause || $$ AND mrd.item_type IN ('$$ || array_to_string(param_types, $$','$$) || $$') $$;
328 IF param_forms IS NOT NULL AND array_upper(param_forms, 1) > 0 THEN
329 where_clause = where_clause || $$ AND mrd.item_form IN ('$$ || array_to_string(param_forms, $$','$$) || $$') $$;
332 IF param_vformats IS NOT NULL AND array_upper(param_vformats, 1) > 0 THEN
333 where_clause = where_clause || $$ AND mrd.vr_format IN ('$$ || array_to_string(param_vformats, $$','$$) || $$') $$;
336 IF param_bib_level IS NOT NULL AND array_upper(param_bib_level, 1) > 0 THEN
337 where_clause = where_clause || $$ AND mrd.bib_level IN ('$$ || array_to_string(param_bib_level, $$','$$) || $$') $$;
340 core_rel_query := select_clause || from_clause || where_clause ||
341 ' GROUP BY 1 ORDER BY 4' || CASE WHEN sort_desc THEN ' DESC' ELSE ' ASC' END || ';';
342 --RAISE NOTICE 'Base Query: %', core_rel_query;
344 IF param_search_ou > 0 THEN
345 IF param_depth IS NOT NULL THEN
346 SELECT array_accum(distinct id) INTO search_org_list FROM actor.org_unit_descendants( param_search_ou, param_depth );
348 SELECT array_accum(distinct id) INTO search_org_list FROM actor.org_unit_descendants( param_search_ou );
350 ELSIF param_search_ou < 0 THEN
351 SELECT array_accum(distinct org_unit) INTO search_org_list FROM actor.org_lasso_map WHERE lasso = -param_search_ou;
352 ELSIF param_search_ou = 0 THEN
353 -- reserved for user lassos (ou_buckets/type='lasso') with ID passed in depth ... hack? sure.
356 OPEN core_cursor FOR EXECUTE core_rel_query;
360 FETCH core_cursor INTO core_result;
364 IF total_count % 1000 = 0 THEN
365 -- RAISE NOTICE ' % total, % checked so far ... ', total_count, check_count;
368 IF core_chk_limit > 0 AND total_count - core_skip_chk + 1 >= core_chk_limit THEN
369 total_count := total_count + 1;
373 total_count := total_count + 1;
375 CONTINUE WHEN param_skip_chk IS NOT NULL and total_count < param_skip_chk;
377 check_count := check_count + 1;
379 PERFORM 1 FROM biblio.record_entry b WHERE NOT b.deleted AND b.id IN ( SELECT * FROM search.explode_array( core_result.records ) );
381 -- RAISE NOTICE ' % were all deleted ... ', core_result.records;
382 deleted_count := deleted_count + 1;
387 FROM biblio.record_entry b
388 JOIN config.bib_source s ON (b.source = s.id)
390 AND b.id IN ( SELECT * FROM search.explode_array( core_result.records ) );
393 -- RAISE NOTICE ' % were all transcendant ... ', core_result.records;
394 visible_count := visible_count + 1;
396 current_res.id = core_result.id;
397 current_res.rel = core_result.rel;
401 SELECT COUNT(DISTINCT s.source) INTO tmp_int FROM metabib.metarecord_source_map s WHERE s.metarecord = core_result.id;
405 current_res.record = core_result.records[1];
407 current_res.record = NULL;
410 RETURN NEXT current_res;
415 IF param_statuses IS NOT NULL AND array_upper(param_statuses, 1) > 0 THEN
418 FROM asset.call_number cn
419 JOIN asset.copy cp ON (cp.call_number = cn.id)
422 AND cp.status IN ( SELECT * FROM search.explode_array( param_statuses ) )
423 AND cn.record IN ( SELECT * FROM search.explode_array( core_result.records ) )
424 AND cp.circ_lib IN ( SELECT * FROM search.explode_array( search_org_list ) )
428 -- RAISE NOTICE ' % were all status-excluded ... ', core_result.records;
429 excluded_count := excluded_count + 1;
435 IF param_locations IS NOT NULL AND array_upper(param_locations, 1) > 0 THEN
438 FROM asset.call_number cn
439 JOIN asset.copy cp ON (cp.call_number = cn.id)
442 AND cp.location IN ( SELECT * FROM search.explode_array( param_locations ) )
443 AND cn.record IN ( SELECT * FROM search.explode_array( core_result.records ) )
444 AND cp.circ_lib IN ( SELECT * FROM search.explode_array( search_org_list ) )
448 -- RAISE NOTICE ' % were all copy_location-excluded ... ', core_result.records;
449 excluded_count := excluded_count + 1;
455 IF staff IS NULL OR NOT staff THEN
458 FROM asset.call_number cn
459 JOIN asset.copy cp ON (cp.call_number = cn.id)
460 JOIN actor.org_unit a ON (cp.circ_lib = a.id)
461 JOIN asset.copy_location cl ON (cp.location = cl.id)
462 JOIN config.copy_status cs ON (cp.status = cs.id)
469 AND cp.circ_lib IN ( SELECT * FROM search.explode_array( search_org_list ) )
470 AND cn.record IN ( SELECT * FROM search.explode_array( core_result.records ) )
474 -- RAISE NOTICE ' % were all visibility-excluded ... ', core_result.records;
475 excluded_count := excluded_count + 1;
482 FROM asset.call_number cn
483 JOIN asset.copy cp ON (cp.call_number = cn.id)
484 JOIN actor.org_unit a ON (cp.circ_lib = a.id)
485 JOIN asset.copy_location cl ON (cp.location = cl.id)
488 AND cp.circ_lib IN ( SELECT * FROM search.explode_array( search_org_list ) )
489 AND cn.record IN ( SELECT * FROM search.explode_array( core_result.records ) )
495 FROM asset.call_number cn
496 WHERE cn.record IN ( SELECT * FROM search.explode_array( core_result.records ) )
500 -- RAISE NOTICE ' % were all visibility-excluded ... ', core_result.records;
501 excluded_count := excluded_count + 1;
509 visible_count := visible_count + 1;
511 current_res.id = core_result.id;
512 current_res.rel = core_result.rel;
516 SELECT COUNT(DISTINCT s.source) INTO tmp_int FROM metabib.metarecord_source_map s WHERE s.metarecord = core_result.id;
520 current_res.record = core_result.records[1];
522 current_res.record = NULL;
525 RETURN NEXT current_res;
527 IF visible_count % 1000 = 0 THEN
528 -- RAISE NOTICE ' % visible so far ... ', visible_count;
533 current_res.id = NULL;
534 current_res.rel = NULL;
535 current_res.record = NULL;
536 current_res.total = total_count;
537 current_res.checked = check_count;
538 current_res.deleted = deleted_count;
539 current_res.visible = visible_count;
540 current_res.excluded = excluded_count;
544 RETURN NEXT current_res;
547 $func$ LANGUAGE PLPGSQL;
550 param_statuses INT[],
551 param_audience TEXT[], x
552 param_language TEXT[], x
553 param_lit_form TEXT[], x
554 param_types TEXT[], x
555 param_forms TEXT[], x
556 param_vformats TEXT[], x
559 CREATE OR REPLACE FUNCTION search.explode_array(anyarray) RETURNS SETOF anyelement AS $BODY$
560 SELECT ($1)[s] FROM generate_series(1, array_upper($1, 1)) AS s;
562 LANGUAGE 'sql' IMMUTABLE;
564 CREATE OR REPLACE FUNCTION search.parse_search_args (TEXT) RETURNS SETOF search.search_args AS $perlcode$
568 my $args = decode_json( $json );
572 for my $k ( keys %$args ) {
573 (my $alias = $k) =~ s/\|/_/gso;
574 my ($class, $field) = split /\|/, $k;
575 my $part = $args->{$k};
576 for my $p ( keys %$part ) {
577 my $data = $part->{$p};
578 $data = [$data] if (!ref($data));
579 for my $datum ( @$data ) {
581 { field_class => $class,
582 field_name => $field,
584 table_alias => $alias,
596 $perlcode$ LANGUAGE PLPERLU;