1 /* $Id: logic.c,v 1.29 2007-05-16 17:16:21 quinn Exp $
2 Copyright (c) 2006-2007, Index Data.
4 This file is part of Pazpar2.
6 Pazpar2 is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 2, or (at your option) any later
11 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with Pazpar2; see the file LICENSE. If not, write to the
18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
23 \brief high-level logic; mostly user sessions and settings
31 #include <sys/socket.h>
37 #include <yaz/marcdisp.h>
38 #include <yaz/comstack.h>
39 #include <yaz/tcpip.h>
40 #include <yaz/proto.h>
41 #include <yaz/readconf.h>
42 #include <yaz/pquery.h>
43 #include <yaz/otherinfo.h>
44 #include <yaz/yaz-util.h>
46 #include <yaz/query-charset.h>
47 #include <yaz/querytowrbuf.h>
48 #if YAZ_VERSIONL >= 0x020163
49 #include <yaz/oid_db.h>
58 #include <yaz/timing.h>
61 #include <netinet/in.h>
66 #include "termlists.h"
68 #include "relevance.h"
73 #include "normalize7bit.h"
77 // Note: Some things in this structure will eventually move to configuration
78 struct parameters global_parameters =
99 // Recursively traverse query structure to extract terms.
100 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
112 pull_terms(nmem, n->u.p[0], termlist, num);
113 pull_terms(nmem, n->u.p[1], termlist, num);
116 nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
117 for (i = 0; i < numwords; i++)
118 termlist[(*num)++] = words[i];
127 static void add_facet(struct session *s, const char *type, const char *value)
133 for (i = 0; i < s->num_termlists; i++)
134 if (!strcmp(s->termlists[i].name, type))
136 if (i == s->num_termlists)
138 if (i == SESSION_MAX_TERMLISTS)
140 yaz_log(YLOG_FATAL, "Too many termlists");
144 s->termlists[i].name = nmem_strdup(s->nmem, type);
145 s->termlists[i].termlist
146 = termlist_create(s->nmem, s->expected_maxrecs, 15);
147 s->num_termlists = i + 1;
149 termlist_insert(s->termlists[i].termlist, value);
152 xmlDoc *normalize_record(struct session_database *sdb, Z_External *rec)
154 struct database_retrievalmap *m;
155 struct database *db = sdb->database;
159 // First normalize to XML
164 if (rec->which != Z_External_octet)
166 yaz_log(YLOG_WARN, "Unexpected external branch, probably BER %s",
170 buf = (char*) rec->u.octet_aligned->buf;
171 len = rec->u.octet_aligned->len;
172 if (yaz_marc_read_iso2709(sdb->yaz_marc, buf, len) < 0)
174 yaz_log(YLOG_WARN, "Failed to decode MARC %s", db->url);
178 yaz_marc_write_using_libxml2(sdb->yaz_marc, 1);
179 if (yaz_marc_write_xml(sdb->yaz_marc, &res,
180 "http://www.loc.gov/MARC21/slim", 0, 0) < 0)
182 yaz_log(YLOG_WARN, "Failed to encode as XML %s",
186 rdoc = xmlNewDoc((xmlChar *) "1.0");
187 xmlDocSetRootElement(rdoc, res);
193 "Unknown native_syntax in normalize_record from %s",
198 if (global_parameters.dump_records){
200 "Input Record (normalized) from %s\n----------------\n",
202 #if LIBXML_VERSION >= 20600
203 xmlDocFormatDump(stderr, rdoc, 1);
205 xmlDocDump(stderr, rdoc);
209 for (m = sdb->map; m; m = m->next){
214 new = xsltApplyStylesheet(m->stylesheet, rdoc, 0);
215 root= xmlDocGetRootElement(new);
216 if (!new || !root || !(root->children))
218 yaz_log(YLOG_WARN, "XSLT transformation failed from %s",
229 if (global_parameters.dump_records)
231 fprintf(stderr, "Record from %s\n----------------\n",
233 #if LIBXML_VERSION >= 20600
234 xmlDocFormatDump(stderr, rdoc, 1);
236 xmlDocDump(stderr, rdoc);
242 // Retrieve first defined value for 'name' for given database.
243 // Will be extended to take into account user associated with session
244 char *session_setting_oneval(struct session_database *db, int offset)
246 if (!db->settings[offset])
248 return db->settings[offset]->value;
253 // Initialize YAZ Map structures for MARC-based targets
254 static int prepare_yazmarc(struct session_database *sdb)
260 yaz_log(YLOG_WARN, "No settings for %s", sdb->database->url);
263 if ((s = session_setting_oneval(sdb, PZ_NATIVESYNTAX))
264 && !strncmp(s, "iso2709", 7))
266 char *encoding = "marc-8s", *e;
269 // See if a native encoding is specified
270 if ((e = strchr(s, ';')))
273 sdb->yaz_marc = yaz_marc_create();
274 yaz_marc_subfield_str(sdb->yaz_marc, "\t");
276 cm = yaz_iconv_open("utf-8", encoding);
280 "Unable to map from %s to UTF-8 for target %s",
281 encoding, sdb->database->url);
284 yaz_marc_iconv(sdb->yaz_marc, cm);
289 // Prepare XSLT stylesheets for record normalization
290 // Structures are allocated on the session_wide nmem to avoid having
291 // to recompute this for every search. This would lead
292 // to leaking if a single session was to repeatedly change the PZ_XSLT
293 // setting. However, this is not a realistic use scenario.
294 static int prepare_map(struct session *se, struct session_database *sdb)
300 yaz_log(YLOG_WARN, "No settings on %s", sdb->database->url);
303 if ((s = session_setting_oneval(sdb, PZ_XSLT)))
306 struct database_retrievalmap **m = &sdb->map;
309 nmem_strsplit(se->session_nmem, ",", s, &stylesheets, &num);
310 for (i = 0; i < num; i++)
312 (*m) = nmem_malloc(se->session_nmem, sizeof(**m));
314 if (!((*m)->stylesheet = conf_load_stylesheet(stylesheets[i])))
316 yaz_log(YLOG_FATAL, "Unable to load stylesheet: %s",
324 yaz_log(YLOG_WARN, "No Normalization stylesheet for target %s",
329 // This analyzes settings and recomputes any supporting data structures
331 static int prepare_session_database(struct session *se,
332 struct session_database *sdb)
337 "No settings associated with %s", sdb->database->url);
340 if (sdb->settings[PZ_NATIVESYNTAX] && !sdb->yaz_marc)
342 if (prepare_yazmarc(sdb) < 0)
345 if (sdb->settings[PZ_XSLT] && !sdb->map)
347 if (prepare_map(se, sdb) < 0)
354 void session_set_watch(struct session *s, int what,
355 session_watchfun fun, void *data)
357 s->watchlist[what].fun = fun;
358 s->watchlist[what].data = data;
361 void session_alert_watch(struct session *s, int what)
363 if (!s->watchlist[what].fun)
365 (*s->watchlist[what].fun)(s->watchlist[what].data);
366 s->watchlist[what].fun = 0;
367 s->watchlist[what].data = 0;
370 //callback for grep_databases
371 static void select_targets_callback(void *context, struct session_database *db)
373 struct session *se = (struct session*) context;
374 struct client *cl = client_create();
375 client_set_database(cl, db);
376 client_set_session(cl, se);
379 // Associates a set of clients with a session;
380 // Note: Session-databases represent databases with per-session
382 int select_targets(struct session *se, struct database_criterion *crit)
385 client_destroy(se->clients);
387 return session_grep_databases(se, crit, select_targets_callback);
390 int session_active_clients(struct session *s)
395 for (c = s->clients; c; c = client_next_in_session(c))
396 if (client_is_active(c))
402 // parses crit1=val1,crit2=val2|val3,...
403 static struct database_criterion *parse_filter(NMEM m, const char *buf)
405 struct database_criterion *res = 0;
412 nmem_strsplit(m, ",", buf, &values, &num);
413 for (i = 0; i < num; i++)
418 struct database_criterion *new = nmem_malloc(m, sizeof(*new));
419 char *eq = strchr(values[i], '=');
422 yaz_log(YLOG_WARN, "Missing equal-sign in filter");
426 new->name = values[i];
427 nmem_strsplit(m, "|", eq, &subvalues, &subnum);
429 for (subi = 0; subi < subnum; subi++)
431 struct database_criterion_value *newv
432 = nmem_malloc(m, sizeof(*newv));
433 newv->value = subvalues[subi];
434 newv->next = new->values;
443 char *search(struct session *se, char *query, char *filter)
445 int live_channels = 0;
447 struct database_criterion *criteria;
449 yaz_log(YLOG_DEBUG, "Search");
451 nmem_reset(se->nmem);
452 criteria = parse_filter(se->nmem, filter);
454 live_channels = select_targets(se, criteria);
457 int maxrecs = live_channels * global_parameters.toget;
458 se->num_termlists = 0;
459 se->reclist = reclist_create(se->nmem, maxrecs);
460 // This will be initialized in send_search()
461 se->total_records = se->total_hits = se->total_merged = 0;
462 se->expected_maxrecs = maxrecs;
469 for (cl = se->clients; cl; cl = client_next_in_session(cl))
471 if (prepare_session_database(se, client_get_database(cl)) < 0)
472 return "CONFIG_ERROR";
473 // Query must parse for all targets
474 if (client_parse_query(cl, query) < 0)
478 for (cl = se->clients; cl; cl = client_next_in_session(cl))
480 client_prep_connection(cl);
486 // Creates a new session_database object for a database
487 static void session_init_databases_fun(void *context, struct database *db)
489 struct session *se = (struct session *) context;
490 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
491 int num = settings_num();
496 new->pct = pp2_charset_create();
499 = nmem_malloc(se->session_nmem, sizeof(struct settings *) * num);
500 memset(new->settings, 0, sizeof(struct settings*) * num);
504 for (i = 0; i < num; i++)
505 new->settings[i] = db->settings[i];
507 new->next = se->databases;
511 // Doesn't free memory associated with sdb -- nmem takes care of that
512 static void session_database_destroy(struct session_database *sdb)
514 struct database_retrievalmap *m;
516 for (m = sdb->map; m; m = m->next)
517 xsltFreeStylesheet(m->stylesheet);
519 yaz_marc_destroy(sdb->yaz_marc);
521 pp2_charset_destroy(sdb->pct);
524 // Initialize session_database list -- this represents this session's view
525 // of the database list -- subject to modification by the settings ws command
526 void session_init_databases(struct session *se)
529 grep_databases(se, 0, session_init_databases_fun);
532 // Probably session_init_databases_fun should be refactored instead of
534 static struct session_database *load_session_database(struct session *se,
537 struct database *db = find_database(id, 0);
539 session_init_databases_fun((void*) se, db);
540 // New sdb is head of se->databases list
541 return se->databases;
544 // Find an existing session database. If not found, load it
545 static struct session_database *find_session_database(struct session *se,
548 struct session_database *sdb;
550 for (sdb = se->databases; sdb; sdb = sdb->next)
551 if (!strcmp(sdb->database->url, id))
553 return load_session_database(se, id);
556 // Apply a session override to a database
557 void session_apply_setting(struct session *se, char *dbname, char *setting,
560 struct session_database *sdb = find_session_database(se, dbname);
561 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
562 int offset = settings_offset_cprefix(setting);
566 yaz_log(YLOG_WARN, "Unknown setting %s", setting);
571 yaz_log(YLOG_WARN, "No need to set pz:id setting. Ignoring");
575 new->target = dbname;
578 new->next = sdb->settings[offset];
579 sdb->settings[offset] = new;
581 // Force later recompute of settings-driven data structures
582 // (happens when a search starts and client connections are prepared)
585 case PZ_NATIVESYNTAX:
588 yaz_marc_destroy(sdb->yaz_marc);
595 struct database_retrievalmap *m;
596 // We don't worry about the map structure -- it's in nmem
597 for (m = sdb->map; m; m = m->next)
598 xsltFreeStylesheet(m->stylesheet);
605 void destroy_session(struct session *s)
607 struct session_database *sdb;
609 yaz_log(YLOG_LOG, "Destroying session");
611 client_destroy(s->clients);
612 for (sdb = s->databases; sdb; sdb = sdb->next)
613 session_database_destroy(sdb);
614 nmem_destroy(s->nmem);
615 wrbuf_destroy(s->wrbuf);
618 struct session *new_session(NMEM nmem)
621 struct session *session = nmem_malloc(nmem, sizeof(*session));
623 yaz_log(YLOG_DEBUG, "New Pazpar2 session");
625 session->total_hits = 0;
626 session->total_records = 0;
627 session->num_termlists = 0;
628 session->reclist = 0;
629 session->requestid = -1;
630 session->clients = 0;
631 session->expected_maxrecs = 0;
632 session->session_nmem = nmem;
633 session->nmem = nmem_create();
634 session->wrbuf = wrbuf_alloc();
635 session_init_databases(session);
636 for (i = 0; i <= SESSION_WATCH_MAX; i++)
638 session->watchlist[i].data = 0;
639 session->watchlist[i].fun = 0;
645 struct hitsbytarget *hitsbytarget(struct session *se, int *count)
647 static struct hitsbytarget res[1000]; // FIXME MM
651 for (cl = se->clients; cl; cl = client_next_in_session(cl))
653 char *name = session_setting_oneval(client_get_database(cl), PZ_NAME);
655 res[*count].id = client_get_database(cl)->database->url;
656 res[*count].name = *name ? name : "Unknown";
657 res[*count].hits = client_get_hits(cl);
658 res[*count].records = client_get_num_records(cl);
659 res[*count].diagnostic = client_get_diagnostic(cl);
660 res[*count].state = client_get_state_str(cl);
661 res[*count].connected = client_get_connection(cl) ? 1 : 0;
668 struct termlist_score **termlist(struct session *s, const char *name, int *num)
672 for (i = 0; i < s->num_termlists; i++)
673 if (!strcmp((const char *) s->termlists[i].name, name))
674 return termlist_highscore(s->termlists[i].termlist, num);
678 #ifdef MISSING_HEADERS
679 void report_nmem_stats(void)
681 size_t in_use, is_free;
683 nmem_get_memory_in_use(&in_use);
684 nmem_get_memory_free(&is_free);
686 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
687 (long) in_use, (long) is_free);
691 struct record_cluster *show_single(struct session *s, int id)
693 struct record_cluster *r;
695 reclist_rewind(s->reclist);
696 while ((r = reclist_read_record(s->reclist)))
702 struct record_cluster **show(struct session *s, struct reclist_sortparms *sp,
703 int start, int *num, int *total, int *sumhits,
706 struct record_cluster **recs = nmem_malloc(nmem_show, *num
707 * sizeof(struct record_cluster *));
708 struct reclist_sortparms *spp;
711 yaz_timing_t t = yaz_timing_create();
714 for (spp = sp; spp; spp = spp->next)
715 if (spp->type == Metadata_sortkey_relevance)
717 relevance_prepare_read(s->relevance, s->reclist);
720 reclist_sort(s->reclist, sp);
722 *total = s->reclist->num_records;
723 *sumhits = s->total_hits;
725 for (i = 0; i < start; i++)
726 if (!reclist_read_record(s->reclist))
733 for (i = 0; i < *num; i++)
735 struct record_cluster *r = reclist_read_record(s->reclist);
745 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
746 yaz_timing_get_real(t), yaz_timing_get_user(t),
747 yaz_timing_get_sys(t));
748 yaz_timing_destroy(&t);
753 void statistics(struct session *se, struct statistics *stat)
758 memset(stat, 0, sizeof(*stat));
759 for (cl = se->clients; cl; cl = client_next_in_session(cl))
761 if (!client_get_connection(cl))
762 stat->num_no_connection++;
763 switch (client_get_state(cl))
765 case Client_Connecting: stat->num_connecting++; break;
766 case Client_Initializing: stat->num_initializing++; break;
767 case Client_Searching: stat->num_searching++; break;
768 case Client_Presenting: stat->num_presenting++; break;
769 case Client_Idle: stat->num_idle++; break;
770 case Client_Failed: stat->num_failed++; break;
771 case Client_Error: stat->num_error++; break;
776 stat->num_hits = se->total_hits;
777 stat->num_records = se->total_records;
779 stat->num_clients = count;
782 void start_http_listener(void)
785 struct conf_server *ser = global_parameters.server;
787 if (*global_parameters.listener_override)
788 strcpy(hp, global_parameters.listener_override);
791 strcpy(hp, ser->host ? ser->host : "");
796 sprintf(hp + strlen(hp), "%d", ser->port);
802 void start_proxy(void)
805 struct conf_server *ser = global_parameters.server;
807 if (*global_parameters.proxy_override)
808 strcpy(hp, global_parameters.proxy_override);
809 else if (ser->proxy_host || ser->proxy_port)
811 strcpy(hp, ser->proxy_host ? ser->proxy_host : "");
816 sprintf(hp + strlen(hp), "%d", ser->proxy_port);
822 http_set_proxyaddr(hp, ser->myurl ? ser->myurl : "");
825 void start_zproxy(void)
827 struct conf_server *ser = global_parameters.server;
829 if (*global_parameters.zproxy_override){
830 yaz_log(YLOG_LOG, "Z39.50 proxy %s",
831 global_parameters.zproxy_override);
835 else if (ser->zproxy_host || ser->zproxy_port)
839 strcpy(hp, ser->zproxy_host ? ser->zproxy_host : "");
840 if (ser->zproxy_port)
847 sprintf(hp + strlen(hp), "%d", ser->zproxy_port);
849 strcpy(global_parameters.zproxy_override, hp);
850 yaz_log(YLOG_LOG, "Z39.50 proxy %s",
851 global_parameters.zproxy_override);
858 // Master list of connections we're handling events to
859 static IOCHAN channel_list = 0;
860 void pazpar2_add_channel(IOCHAN chan)
862 chan->next = channel_list;
866 void pazpar2_event_loop()
868 event_loop(&channel_list);
871 struct record *ingest_record(struct client *cl, Z_External *rec,
874 xmlDoc *xdoc = normalize_record(client_get_database(cl), rec);
876 struct record *record;
877 struct record_cluster *cluster;
878 struct session *se = client_get_session(cl);
879 xmlChar *mergekey, *mergekey_norm;
882 struct conf_service *service = global_parameters.server->service;
887 root = xmlDocGetRootElement(xdoc);
888 if (!(mergekey = xmlGetProp(root, (xmlChar *) "mergekey")))
890 yaz_log(YLOG_WARN, "No mergekey found in record");
895 record = record_create(se->nmem,
896 service->num_metadata, service->num_sortkeys);
897 record_assign_client(record, cl);
899 mergekey_norm = (xmlChar *) nmem_strdup(se->nmem, (char*) mergekey);
901 normalize7bit_mergekey((char *) mergekey_norm, 0);
903 cluster = reclist_insert(se->reclist,
904 global_parameters.server->service,
905 record, (char *) mergekey_norm,
907 if (global_parameters.dump_records)
908 yaz_log(YLOG_LOG, "Cluster id %d from %s (#%d)", cluster->recid,
909 client_get_database(cl)->database->url, record_no);
912 /* no room for record */
916 relevance_newrec(se->relevance, cluster);
919 // now parsing XML record and adding data to cluster or record metadata
920 for (n = root->children; n; n = n->next)
928 if (n->type != XML_ELEMENT_NODE)
930 if (!strcmp((const char *) n->name, "metadata"))
932 struct conf_metadata *ser_md = 0;
933 struct conf_sortkey *ser_sk = 0;
934 struct record_metadata **wheretoput = 0;
935 struct record_metadata *rec_md = 0;
936 int md_field_id = -1;
937 int sk_field_id = -1;
940 type = xmlGetProp(n, (xmlChar *) "type");
941 value = xmlNodeListGetString(xdoc, n->children, 0);
947 = conf_service_metadata_field_id(service, (const char *) type);
951 "Ignoring unknown metadata element: %s", type);
955 ser_md = &service->metadata[md_field_id];
957 if (ser_md->sortkey_offset >= 0){
958 sk_field_id = ser_md->sortkey_offset;
959 ser_sk = &service->sortkeys[sk_field_id];
962 // Find out where we are putting it - based on merge or not
963 if (ser_md->merge == Metadata_merge_no)
964 wheretoput = &record->metadata[md_field_id];
966 wheretoput = &cluster->metadata[md_field_id];
968 // create new record_metadata
969 rec_md = record_metadata_create(se->nmem);
971 // and polulate with data:
972 // type based charmapping decisions follow here
973 if (ser_md->type == Metadata_type_generic)
976 char * p = (char *) value;
977 p = normalize7bit_generic(p, " ,/.:([");
979 rec_md->data.text = nmem_strdup(se->nmem, p);
982 else if (ser_md->type == Metadata_type_year)
984 if (extract7bit_years((char *) value, &first, &last) < 0)
990 "Unknown type in metadata element %s", type);
994 // and polulate with data:
995 // assign cluster or record based on merge action
996 if (ser_md->merge == Metadata_merge_unique)
998 struct record_metadata *mnode;
999 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1000 if (!strcmp((const char *) mnode->data.text,
1005 rec_md->next = *wheretoput;
1006 *wheretoput = rec_md;
1009 else if (ser_md->merge == Metadata_merge_longest)
1012 || strlen(rec_md->data.text)
1013 > strlen((*wheretoput)->data.text))
1015 *wheretoput = rec_md;
1018 char *s = nmem_strdup(se->nmem, rec_md->data.text);
1019 if (!cluster->sortkeys[sk_field_id])
1020 cluster->sortkeys[sk_field_id] =
1021 nmem_malloc(se->nmem,
1022 sizeof(union data_types));
1023 normalize7bit_mergekey(s,
1024 (ser_sk->type == Metadata_sortkey_skiparticle));
1025 cluster->sortkeys[sk_field_id]->text = s;
1029 else if (ser_md->merge == Metadata_merge_all
1030 || ser_md->merge == Metadata_merge_no)
1032 rec_md->next = *wheretoput;
1033 *wheretoput = rec_md;
1035 else if (ser_md->merge == Metadata_merge_range)
1039 *wheretoput = rec_md;
1040 (*wheretoput)->data.number.min = first;
1041 (*wheretoput)->data.number.max = last;
1043 cluster->sortkeys[sk_field_id]
1048 if (first < (*wheretoput)->data.number.min)
1049 (*wheretoput)->data.number.min = first;
1050 if (last > (*wheretoput)->data.number.max)
1051 (*wheretoput)->data.number.max = last;
1056 union data_types *sdata
1057 = cluster->sortkeys[sk_field_id];
1058 yaz_log(YLOG_LOG, "SK range: %d-%d",
1059 sdata->number.min, sdata->number.max);
1065 // ranking of _all_ fields enabled ...
1067 relevance_countwords(se->relevance, cluster,
1068 (char *) value, ser_md->rank);
1070 // construct facets ...
1071 if (ser_md->termlist)
1073 if (ser_md->type == Metadata_type_year)
1076 sprintf(year, "%d", last);
1077 add_facet(se, (char *) type, year);
1080 sprintf(year, "%d", first);
1081 add_facet(se, (char *) type, year);
1085 add_facet(se, (char *) type, (char *) value);
1095 "Unexpected element %s in internal record", n->name);
1104 relevance_donerecord(se->relevance, cluster);
1105 se->total_records++;
1115 * indent-tabs-mode: nil
1117 * vim: shiftwidth=4 tabstop=8 expandtab