stop function implemented.
[pazpar2-moved-to-github.git] / src / pazpar2.h
index 1f65270..0e69b2c 100644 (file)
@@ -1,4 +1,4 @@
-/* $Id: pazpar2.h,v 1.25 2007-04-17 21:25:26 quinn Exp $
+/* $Id: pazpar2.h,v 1.40 2007-06-13 08:04:03 adam Exp $
    Copyright (c) 2006-2007, Index Data.
 
 This file is part of Pazpar2.
@@ -22,7 +22,6 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 #ifndef PAZPAR2_H
 #define PAZPAR2_H
 
-struct record;
 
 #include <netdb.h>
 
@@ -39,48 +38,24 @@ struct record;
 #include "reclists.h"
 #include "eventl.h"
 #include "config.h"
+#include "parameters.h"
 
+struct record;
 struct client;
 
-union data_types {
-    char *text;
-    struct {
-        int min;
-        int max;
-    } number;
-};
 
-struct record_metadata {
-    union data_types data;
-    struct record_metadata *next; // next item of this name
-};
+enum pazpar2_error_code {
+    PAZPAR2_NO_ERROR = 0,
 
-struct record {
-    struct client *client;
-    struct record_metadata **metadata; // Array mirrors list of metadata fields in config
-    union data_types **sortkeys;       // Array mirrors list of sortkey fields in config
-    struct record *next;  // Next in cluster of merged records
-};
-
-struct record_cluster
-{
-    struct record_metadata **metadata; // Array mirrors list of metadata fields in config
-    union data_types **sortkeys;
-    char *merge_key;
-    int relevance;
-    int *term_frequency_vec;
-    int recid; // Set-specific ID for this record
-    struct record *records;
-};
-
-struct connection;
-
-// Represents a host (irrespective of databases)
-struct host {
-    char *hostport;
-    char *ipport;
-    struct connection *connections; // All connections to this
-    struct host *next;
+    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
 };
 
 // Represents a (virtual) database on a host
@@ -92,16 +67,6 @@ struct database {
     struct zr_explain *explain;
     struct setting **settings;
     struct database *next;
-    CCL_bibset ccl_map;
-    yaz_marc_t yaz_marc;
-    struct database_retrievalmap *map;
-};
-
-// Normalization filter. Turns incoming record into internal representation
-// Simple sequence of stylesheets run in series.
-struct database_retrievalmap {
-    xsltStylesheet *stylesheet;
-    struct database_retrievalmap *next;
 };
 
 struct database_criterion_value {
@@ -115,47 +80,23 @@ struct database_criterion {
     struct database_criterion *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;
+// 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 {
-    struct session_database *database;
-    struct connection *connection;
-    struct session *session;
-    char *pquery; // Current search
-    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;
+// Represents a database as viewed from one session, possibly with settings overriden
+// for that session
+struct session_database
+{
+    pp2_charset_t pct;
+    struct database *database;
+    struct setting **settings;
+    yaz_marc_t yaz_marc;
+    struct database_retrievalmap *map;
+    struct session_database *next;
 };
 
 #define SESSION_WATCH_RECORDS   0
@@ -171,21 +112,11 @@ struct named_termlist
     struct termlist *termlist;
 };
 
-// Represents a database as viewed from one session, possibly with settings overriden
-// for that session (to support authorization/authentication)
-struct session_database
-{
-    struct database *database;
-    struct setting **settings;
-    struct session_database *next;
-};
-
 // End-user session
 struct session {
     struct session_database *databases;  // All databases, settings overriden
     struct client *clients;              // Clients connected for current search
     int requestid; 
-    char query[1024];
     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)
@@ -223,36 +154,18 @@ struct hitsbytarget {
     int hits;
     int diagnostic;
     int records;
-    char* state;
+    const char *state;
     int connected;
 };
 
-struct parameters {
-    char proxy_override[128];
-    char listener_override[128];
-    char zproxy_override[128];
-    char settings_path_override[128];
-    struct conf_server *server;
-    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;
-    ODR odr_out;
-    ODR odr_in;
-};
-
 struct hitsbytarget *hitsbytarget(struct session *s, int *count);
 int select_targets(struct session *se, struct database_criterion *crit);
 struct session *new_session(NMEM nmem);
 void destroy_session(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, char *filter);
+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, int id);
@@ -264,10 +177,24 @@ char *session_setting_oneval(struct session_database *db, int offset);
 
 void start_http_listener(void);
 void start_proxy(void);
-void start_zproxy(void);
+//void start_zproxy(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, 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);
+
+int pazpar2_process(int debug,
+                    void (*work)(void *data), void *data,
+                    const char *pidfile, const char *uid);
 
-extern struct parameters global_parameters;
-extern IOCHAN channel_list;
 
 #endif