+/* This file is part of Pazpar2.
+ Copyright (C) 2006-2008 Index Data
+
+Pazpar2 is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+*/
+
#ifndef PAZPAR2_H
#define PAZPAR2_H
-struct record;
#include <netdb.h>
#include "termlists.h"
#include "relevance.h"
+#include "reclists.h"
#include "eventl.h"
#include "config.h"
+#include "parameters.h"
+#include "http.h"
+struct record;
struct client;
-struct record_metadata
-{
- union
- {
- char *text;
- struct {
- int first;
- int last;
- } year_range;
- int year;
- } interpretation;
-};
-struct record {
- struct client *client;
- char *title;
- int target_offset;
- char *merge_key;
- struct record_metadata *md;
- int relevance;
- int *term_frequency_vec;
- struct record *next_cluster;
-};
+enum pazpar2_error_code {
+ PAZPAR2_NO_ERROR = 0,
-struct connection;
+ PAZPAR2_NO_SESSION,
+ PAZPAR2_MISSING_PARAMETER,
+ PAZPAR2_MALFORMED_PARAMETER_VALUE,
+ PAZPAR2_MALFORMED_PARAMETER_ENCODING,
+ PAZPAR2_MALFORMED_SETTING,
+ PAZPAR2_HITCOUNTS_FAILED,
+ PAZPAR2_RECORD_MISSING,
+ PAZPAR2_NO_TARGETS,
+ PAZPAR2_CONFIG_TARGET,
+ PAZPAR2_RECORD_FAIL,
+ PAZPAR2_NOT_IMPLEMENTED,
-// Represents a host (irrespective of databases)
-struct host {
- char *hostport;
- char *ipport;
- struct connection *connections; // All connections to this
- struct host *next;
+ PAZPAR2_LAST_ERROR
};
// Represents a (virtual) database on a host
char *url;
char **databases;
int errors;
- struct conf_queryprofile *qprofile;
- struct conf_retrievalprofile *rprofile;
+ struct zr_explain *explain;
+ struct setting **settings;
struct database *next;
};
+struct database_criterion_value {
+ char *value;
+ struct database_criterion_value *next;
+};
-// Represents a physical, reusable connection to a remote Z39.50 host
-struct connection {
- IOCHAN iochan;
- COMSTACK link;
- struct host *host;
- struct client *client;
- char *ibuf;
- int ibufsize;
- enum {
- Conn_Connecting,
- Conn_Open,
- Conn_Waiting,
- } state;
- struct connection *next;
+struct database_criterion {
+ char *name;
+ struct database_criterion_value *values;
+ struct database_criterion *next;
+};
+
+// Normalization filter. Turns incoming record into internal representation
+// Simple sequence of stylesheets run in series.
+struct database_retrievalmap {
+ xsltStylesheet *stylesheet;
+ struct database_retrievalmap *next;
};
-// Represents client state for a connection to one search target
-struct client {
+// Represents a database as viewed from one session, possibly with settings overriden
+// for that session
+struct session_database
+{
struct database *database;
- struct connection *connection;
- struct session *session;
- int hits;
- int records;
- int setno;
- int requestid; // ID of current outstanding request
- int diagnostic;
- enum client_state
- {
- Client_Connecting,
- Client_Connected,
- Client_Idle,
- Client_Initializing,
- Client_Searching,
- Client_Presenting,
- Client_Error,
- Client_Failed,
- Client_Disconnected,
- Client_Stopped
- } state;
- struct client *next;
+ struct setting **settings;
+ yaz_marc_t yaz_marc;
+ struct database_retrievalmap *map;
+ struct session_database *next;
};
-#define SESSION_WATCH_RECORDS 0
-#define SESSION_WATCH_MAX 0
+
+
+#define SESSION_WATCH_SHOW 0
+#define SESSION_WATCH_RECORD 1
+#define SESSION_WATCH_MAX 1
#define SESSION_MAX_TERMLISTS 10
struct termlist *termlist;
};
+struct session_watchentry {
+ void *data;
+ http_channel_observer_t obs;
+ session_watchfun fun;
+};
+
// End-user session
struct session {
- struct client *clients;
+ struct session_database *databases; // All databases, settings overriden
+ struct client *clients; // Clients connected for current search
int requestid;
- char query[1024];
- NMEM nmem; // Nmem for each operation (i.e. search)
+ NMEM session_nmem; // Nmem for session-permanent storage
+ NMEM nmem; // Nmem for each operation (i.e. search, result set, etc)
WRBUF wrbuf; // Wrbuf for scratch(i.e. search)
int num_termlists;
struct named_termlist termlists[SESSION_MAX_TERMLISTS];
struct relevance *relevance;
struct reclist *reclist;
- struct {
- void *data;
- session_watchfun fun;
- } watchlist[SESSION_WATCH_MAX + 1];
+ struct session_watchentry watchlist[SESSION_WATCH_MAX + 1];
int expected_maxrecs;
int total_hits;
int total_records;
+ int total_merged;
};
struct statistics {
};
struct hitsbytarget {
- char id[256];
+ char *id;
+ const char *name;
int hits;
int diagnostic;
int records;
- char* state;
+ const char *state;
int connected;
};
-struct parameters {
- int dump_records;
- int timeout; /* operations timeout, in seconds */
- char implementationId[128];
- char implementationName[128];
- char implementationVersion[128];
- int target_timeout; // seconds
- int session_timeout;
- int toget;
- int chunk;
- CCL_bibset ccl_filter;
- yaz_marc_t yaz_marc;
- ODR odr_out;
- ODR odr_in;
-};
-
-struct hitsbytarget *hitsbytarget(struct session *s, int *count);
-int select_targets(struct session *se);
-struct session *new_session();
+struct hitsbytarget *hitsbytarget(struct session *s, int *count, NMEM nmem);
+int select_targets(struct session *se, struct database_criterion *crit);
+struct session *new_session(NMEM nmem);
void destroy_session(struct session *s);
+void session_init_databases(struct session *s);
int load_targets(struct session *s, const char *fn);
void statistics(struct session *s, struct statistics *stat);
-char *search(struct session *s, char *query);
-struct record **show(struct session *s, int start, int *num, int *total,
- int *sumhits, NMEM nmem_show);
+enum pazpar2_error_code search(struct session *s, char *query,
+ char *filter, const char **addinfo);
+struct record_cluster **show(struct session *s, struct reclist_sortparms *sp, int start,
+ int *num, int *total, int *sumhits, NMEM nmem_show);
+struct record_cluster *show_single(struct session *s, const char *id);
struct termlist_score **termlist(struct session *s, const char *name, int *num);
-void session_set_watch(struct session *s, int what, session_watchfun fun, void *data);
+int session_set_watch(struct session *s, int what, session_watchfun fun, void *data, struct http_channel *c);
int session_active_clients(struct session *s);
+void session_apply_setting(struct session *se, char *dbname, char *setting, char *value);
+const char *session_setting_oneval(struct session_database *db, int offset);
+
+void start_http_listener(void);
+void start_proxy(void);
+
+void pazpar2_add_channel(IOCHAN c);
+void pazpar2_event_loop(void);
+
+int host_getaddrinfo(struct host *host);
+
+xmlDoc *normalize_record(struct session_database *sdb, struct session *se,
+ Z_External *rec);
+xmlDoc *record_to_xml(struct session_database *sdb, Z_External *rec);
+
+struct record *ingest_record(struct client *cl, Z_External *rec,
+ int record_no);
+void session_alert_watch(struct session *s, int what);
+void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num);
#endif
projects / pazpar2-moved-to-github.git / blobdiff