src/pazpar2.h

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2009 Index Data
   3
   4 Pazpar2 is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 */
  19
  20 #ifndef PAZPAR2_H
  21 #define PAZPAR2_H
  22
  23 #include <yaz/comstack.h>
  24 #include <yaz/pquery.h>
  25 #include <yaz/ccl.h>
  26 #include <yaz/yaz-ccl.h>
  27
  28 #include "termlists.h"
  29 #include "reclists.h"
  30 #include "pazpar2_config.h"
  31 #include "http.h"
  32
  33 struct record;
  34 struct client;
  35
  36
  37 enum pazpar2_error_code {
  38     PAZPAR2_NO_ERROR = 0,
  39
  40     PAZPAR2_NO_SESSION,
  41     PAZPAR2_MISSING_PARAMETER,
  42     PAZPAR2_MALFORMED_PARAMETER_VALUE,
  43     PAZPAR2_MALFORMED_PARAMETER_ENCODING,
  44     PAZPAR2_MALFORMED_SETTING,
  45     PAZPAR2_HITCOUNTS_FAILED,
  46     PAZPAR2_RECORD_MISSING,
  47     PAZPAR2_NO_TARGETS,
  48     PAZPAR2_CONFIG_TARGET,
  49     PAZPAR2_RECORD_FAIL,
  50     PAZPAR2_NOT_IMPLEMENTED,
  51
  52     PAZPAR2_LAST_ERROR
  53 };
  54
  55 enum pazpar2_database_criterion_type {
  56     PAZPAR2_STRING_MATCH,
  57     PAZPAR2_SUBSTRING_MATCH
  58 };
  59
  60 // Represents a (virtual) database on a host
  61 struct database {
  62     struct host *host;
  63     char *url;
  64     char **databases;
  65     int errors;
  66     struct zr_explain *explain;
  67     int num_settings;
  68     struct setting **settings;
  69     struct database *next;
  70 };
  71
  72 struct database_criterion_value {
  73     char *value;
  74     struct database_criterion_value *next;
  75 };
  76
  77 struct database_criterion {
  78     char *name;
  79     enum pazpar2_database_criterion_type type;
  80     struct database_criterion_value *values;
  81     struct database_criterion *next;
  82 };
  83
  84 // Represents a database as viewed from one session, possibly with settings overriden
  85 // for that session
  86 struct session_database
  87 {
  88     struct database *database;
  89     struct setting **settings;
  90     normalize_record_t map;
  91     struct session_database *next;
  92 };
  93
  94
  95
  96 #define SESSION_WATCH_SHOW      0
  97 #define SESSION_WATCH_RECORD    1
  98 #define SESSION_WATCH_MAX       1
  99
 100 #define SESSION_MAX_TERMLISTS 10
 101
 102 typedef void (*session_watchfun)(void *data);
 103
 104 struct named_termlist
 105 {
 106     char *name;
 107     struct termlist *termlist;
 108 };
 109
 110 struct session_watchentry {
 111     void *data;
 112     http_channel_observer_t obs;
 113     session_watchfun fun;
 114 };
 115
 116 // End-user session
 117 struct session {
 118     struct conf_service *service; /* service in use for this session */
 119     struct session_database *databases;  // All databases, settings overriden
 120     struct client *clients;              // Clients connected for current search
 121     NMEM session_nmem;  // Nmem for session-permanent storage
 122     NMEM nmem;          // Nmem for each operation (i.e. search, result set, etc)
 123     WRBUF wrbuf;        // Wrbuf for scratch(i.e. search)
 124     int num_termlists;
 125     struct named_termlist termlists[SESSION_MAX_TERMLISTS];
 126     struct relevance *relevance;
 127     struct reclist *reclist;
 128     struct session_watchentry watchlist[SESSION_WATCH_MAX + 1];
 129     int total_hits;
 130     int total_records;
 131     int total_merged;
 132     int number_of_warnings_unknown_elements;
 133     int number_of_warnings_unknown_metadata;
 134     normalize_cache_t normalize_cache;
 135 };
 136
 137 struct statistics {
 138     int num_clients;
 139     int num_no_connection;
 140     int num_connecting;
 141     int num_working;
 142     int num_idle;
 143     int num_failed;
 144     int num_error;
 145     int num_hits;
 146     int num_records;
 147 };
 148
 149 struct hitsbytarget {
 150     char *id;
 151     const char *name;
 152     int hits;
 153     int diagnostic;
 154     int records;
 155     const char *state;
 156     int connected;
 157     WRBUF settings_xml;
 158 };
 159
 160 struct hitsbytarget *hitsbytarget(struct session *s, int *count, NMEM nmem);
 161 int select_targets(struct session *se, struct database_criterion *crit);
 162 struct session *new_session(NMEM nmem, struct conf_service *service);
 163 void destroy_session(struct session *s);
 164 void session_init_databases(struct session *s);
 165 int load_targets(struct session *s, const char *fn);
 166 void statistics(struct session *s, struct statistics *stat);
 167 enum pazpar2_error_code search(struct session *s, const char *query,
 168                                const char *startrecs, const char *maxrecs,
 169                                const char *filter, const char **addinfo);
 170 struct record_cluster **show(struct session *s, struct reclist_sortparms *sp, int start,
 171         int *num, int *total, int *sumhits, NMEM nmem_show);
 172 struct record_cluster *show_single(struct session *s, const char *id,
 173                                    struct record_cluster **prev_r,
 174                                    struct record_cluster **next_r);
 175 struct termlist_score **termlist(struct session *s, const char *name, int *num);
 176 int session_set_watch(struct session *s, int what, session_watchfun fun, void *data, struct http_channel *c);
 177 int session_active_clients(struct session *s);
 178 void session_apply_setting(struct session *se, char *dbname, char *setting, char *value);
 179 const char *session_setting_oneval(struct session_database *db, int offset);
 180
 181 void pazpar2_add_channel(IOCHAN c);
 182 void pazpar2_event_loop(void);
 183
 184 int host_getaddrinfo(struct host *host);
 185
 186 struct record *ingest_record(struct client *cl, const char *rec,
 187                              int record_no);
 188 void session_alert_watch(struct session *s, int what);
 189 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num);
 190
 191 #endif
 192
 193 /*
 194  * Local variables:
 195  * c-basic-offset: 4
 196  * c-file-style: "Stroustrup"
 197  * indent-tabs-mode: nil
 198  * End:
 199  * vim: shiftwidth=4 tabstop=8 expandtab
 200  */
 201