+/* 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 CONFIG_H
#define CONFIG_H
#include <libxslt/transform.h>
#include <libxslt/xsltutils.h>
-enum conf_sortkey_types
-{
- Metadata_sortkey_no, // This is not to be used as a sortkey
+#include <yaz/nmem.h>
+#include "charsets.h"
+
+enum conf_metadata_type {
+ Metadata_type_generic, // Generic text field
+ Metadata_type_number, // A number
+ Metadata_type_year, // A number
+ Metadata_type_date // A number
+};
+
+enum conf_metadata_merge {
+ Metadata_merge_no, // Don't merge
+ Metadata_merge_unique, // Include unique elements in merged block
+ Metadata_merge_longest, // Include the longest (strlen) value
+ Metadata_merge_range, // Store value as a range of lowest-highest
+ Metadata_merge_all // Just include all elements found
+};
+
+enum conf_sortkey_type {
+ Metadata_sortkey_relevance,
Metadata_sortkey_numeric, // Standard numerical sorting
- Metadata_sortkey_range, // Range sorting (pick lowest or highest)
Metadata_sortkey_skiparticle, // Skip leading article when sorting
- Metadata_sortkey_string
+ Metadata_sortkey_string // Flat string
+};
+
+// This controls the ability to insert 'static' values from settings into retrieval recs
+enum conf_setting_type {
+ Metadata_setting_no,
+ Metadata_setting_postproc, // Insert setting value into normalized record
+ Metadata_setting_parameter // Expose value to normalization stylesheets
};
// Describes known metadata elements and how they are to be manipulated
-// An array of these structure provides a 'map' against which discovered metadata
-// elements are matched. It also governs storage, to minimize number of cycles needed
-// at various tages of processing
+// An array of these structure provides a 'map' against which
+// discovered metadata elements are matched. It also governs storage,
+// to minimize number of cycles needed at various tages of processing
struct conf_metadata
{
- char *name; // The name of this element. Output by normalization stylesheet
+ char *name; // The field name. Output by normalization stylesheet
int brief; // Is this element to be returned in the brief format?
int termlist;// Is this field to be treated as a termlist for browsing?
- int rank; // Rank factor. 0 means don't use this field for ranking, 1 is default
+ int rank; // Rank factor. 0 means don't use this field for ranking,
+ // 1 is default
// values >1 give additional significance to a field
- enum
- {
- Metadata_type_generic, // Generic text field
- Metadata_type_integer, // Integer type
- Metadata_type_year // A year
- } type;
- enum conf_sortkey_types sortkey;
- enum
- {
- Metadata_merge_no, // Don't merge
- Metadata_merge_unique, // Include unique elements in merged block
- Metadata_merge_longest, // Include the longest (strlen) value
- Metadata_merge_range, // Store value as a range of lowest-highest
- Metadata_merge_all // Just include all elements found
- } merge;
+ int sortkey_offset; // -1 if it's not a sortkey, otherwise index
+ // into service/record_cluster->sortkey array
+ enum conf_metadata_type type;
+ enum conf_metadata_merge merge;
+ enum conf_setting_type setting; // Value is to be taken from session/db settings?
};
+
+
+struct conf_metadata * conf_metadata_assign(NMEM nmem,
+ struct conf_metadata * metadata,
+ const char *name,
+ enum conf_metadata_type type,
+ enum conf_metadata_merge merge,
+ enum conf_setting_type setting,
+ int brief,
+ int termlist,
+ int rank,
+ int sortkey_offset);
+
+
+
// Controls sorting
struct conf_sortkey
{
char *name;
- enum conf_sortkey_types type;
+ enum conf_sortkey_type type;
};
+struct conf_sortkey * conf_sortkey_assign(NMEM nmem,
+ struct conf_sortkey * sortkey,
+ const char *name,
+ enum conf_sortkey_type type);
+
+
+
+// It is conceivable that there will eventually be several 'services'
+// offered from one server, with separate configuration -- possibly
+// more than one services associated with the same port. For now,
+// however, only a single service is possible.
struct conf_service
{
int num_metadata;
struct conf_metadata *metadata;
int num_sortkeys;
struct conf_sortkey *sortkeys;
+
};
+struct conf_service * conf_service_create(NMEM nmem,
+ int num_metadata, int num_sortkeys);
+
+
+struct conf_metadata* conf_service_add_metadata(NMEM nmem,
+ struct conf_service *service,
+ int field_id,
+ const char *name,
+ enum conf_metadata_type type,
+ enum conf_metadata_merge merge,
+ enum conf_setting_type setting,
+ int brief,
+ int termlist,
+ int rank,
+ int sortkey_offset);
+
+struct conf_sortkey * conf_service_add_sortkey(NMEM nmem,
+ struct conf_service *service,
+ int field_id,
+ const char *name,
+ enum conf_sortkey_type type);
+
+
+int conf_service_metadata_field_id(struct conf_service *service, const char * name);
+
+int conf_service_sortkey_field_id(struct conf_service *service, const char * name);
+
+
struct conf_server
{
char *host;
int port;
char *proxy_host;
int proxy_port;
+ char *myurl;
+ char *settings;
+
+ pp2_charset_t relevance_pct;
+ pp2_charset_t sort_pct;
+ pp2_charset_t mergekey_pct;
+
struct conf_service *service;
struct conf_server *next;
};
-struct conf_queryprofile
-{
- int dummy;
-};
-
-struct conf_retrievalmap
+struct conf_targetprofiles
{
enum {
- Map_xslt
+ Targetprofiles_local
} type;
- char *charset;
- char *format;
- xsltStylesheet *stylesheet;
- struct conf_retrievalmap *next;
-};
-
-struct conf_retrievalprofile
-{
- char *requestsyntax;
- enum {
- Nativesyn_xml,
- Nativesyn_iso2709
- } native_syntax;
- enum {
- Nativeform_na,
- Nativeform_marc21,
- } native_format;
- char *native_encoding;
- enum {
- Nativemapto_na,
- Nativemapto_marcxml,
- Nativemapto_marcxchange
- } native_mapto;
- yaz_marc_t yaz_marc;
- struct conf_retrievalmap *maplist;
- struct conf_retrievalprofile *next;
+ char *src;
};
struct conf_config
{
struct conf_server *servers;
- struct conf_queryprofile *queryprofiles;
- struct conf_retrievalprofile *retrievalprofiles;
+ struct conf_targetprofiles *targetprofiles;
};
#ifndef CONFIG_NOEXTERNS
#endif
int read_config(const char *fname);
+xsltStylesheet *conf_load_stylesheet(const char *fname);
#endif
projects / pazpar2-moved-to-github.git / blobdiff