*** empty log message ***
[idzebra-moved-to-github.git] / index / index.h
index 1894cb5..6064462 100644 (file)
 /*
- * Copyright (C) 1994-1995, Index Data I/S 
+ * Copyright (C) 1995-2002, Index Data
  * All rights reserved.
- * Sebastian Hammer, Adam Dickmeiss
- *
- * $Log: index.h,v $
- * Revision 1.28  1995-11-27 13:58:53  adam
- * New option -t. storeStore data implemented in server.
- *
- * Revision 1.27  1995/11/25  10:24:06  adam
- * More record fields - they are enumerated now.
- * New options: flagStoreData flagStoreKey.
- *
- * Revision 1.26  1995/11/22  17:19:17  adam
- * Record management uses the bfile system.
- *
- * Revision 1.25  1995/11/21  15:29:12  adam
- * Config file 'base' read by default by both indexer and server.
- *
- * Revision 1.24  1995/11/21  15:01:15  adam
- * New general match criteria implemented.
- * New feature: document groups.
- *
- * Revision 1.23  1995/11/20  16:59:45  adam
- * New update method: the 'old' keys are saved for each records.
- *
- * Revision 1.22  1995/11/20  11:56:26  adam
- * Work on new traversal.
- *
- * Revision 1.21  1995/11/16  15:34:55  adam
- * Uses new record management system in both indexer and server.
- *
- * Revision 1.20  1995/11/15  14:46:18  adam
- * Started work on better record management system.
- *
- * Revision 1.19  1995/10/27  14:00:11  adam
- * Implemented detection of database availability.
- *
- * Revision 1.18  1995/10/17  18:02:08  adam
- * New feature: databases. Implemented as prefix to words in dictionary.
- *
- * Revision 1.17  1995/10/13  16:01:49  adam
- * Work on relations.
- *
- * Revision 1.16  1995/10/10  12:24:38  adam
- * Temporary sort files are compressed.
- *
- * Revision 1.15  1995/10/04  16:57:19  adam
- * Key input and merge sort in one pass.
- *
- * Revision 1.14  1995/09/29  14:01:40  adam
- * Bug fixes.
- *
- * Revision 1.13  1995/09/28  14:22:56  adam
- * Sort uses smaller temporary files.
- *
- * Revision 1.12  1995/09/28  12:10:32  adam
- * Bug fixes. Field prefix used in queries.
- *
- * Revision 1.11  1995/09/27  12:22:28  adam
- * More work on extract in record control.
- * Field name is not in isam keys but in prefix in dictionary words.
- *
- * Revision 1.10  1995/09/14  07:48:23  adam
- * Record control management.
- *
- * Revision 1.9  1995/09/11  13:09:33  adam
- * More work on relevance feedback.
- *
- * Revision 1.8  1995/09/08  14:52:27  adam
- * Minor changes. Dictionary is lower case now.
- *
- * Revision 1.7  1995/09/06  16:11:16  adam
- * Option: only one word key per file.
- *
- * Revision 1.6  1995/09/05  15:28:39  adam
- * More work on search engine.
- *
- * Revision 1.5  1995/09/04  12:33:42  adam
- * Various cleanup. YAZ util used instead.
- *
- * Revision 1.4  1995/09/04  09:10:35  adam
- * More work on index add/del/update.
- * Merge sort implemented.
- * Initial work on z39 server.
- *
- * Revision 1.3  1995/09/01  14:06:35  adam
- * Split of work into more files.
- *
- * Revision 1.2  1995/09/01  10:30:24  adam
- * More work on indexing. Not working yet.
- *
- * Revision 1.1  1995/08/31  14:50:24  adam
- * New simple file index tool.
- *
+ * Sebastian Hammer, Adam Dickmeiss, Heikki Levanto
+ * $Id: index.h,v 1.73 2002-02-20 17:30:01 adam Exp $
  */
 
-#include <alexutil.h>
+#ifndef INDEX_H
+#define INDEX_H
+
+#include <time.h>
+#include <zebraver.h>
+#include <zebrautl.h>
+#include <zebramap.h>
+
 #include <dict.h>
+#include <isams.h>
+#if ZMBOL
 #include <isam.h>
+#include <isamc.h>
+#include <isamd.h>
+#define ISAM_DEFAULT "c"
+#else
+#define ISAM_DEFAULT "s"
+#endif
+#include <yaz/data1.h>
+#include <recctrl.h>
+#include "zebraapi.h"
+
+YAZ_BEGIN_CDECL
+
+#define SU_SCHEME 1
 
 #define IT_MAX_WORD 256
 #define IT_KEY_HAVE_SEQNO 1
 #define IT_KEY_HAVE_FIELD 0
 
+typedef int SYSNO;
+
 struct it_key {
     int  sysno;
-    int   seqno;
+    int  seqno;
 };
 
 enum dirsKind { dirs_dir, dirs_file };
@@ -113,32 +47,39 @@ enum dirsKind { dirs_dir, dirs_file };
 struct dir_entry {
     enum dirsKind kind;
     char *name;
-    int ctime;
+    time_t mtime;
 };
 
 struct dirs_entry {
     enum dirsKind kind;
     char path[256];
     SYSNO sysno;
-    int ctime;
+    time_t mtime;
 };
 
 struct recordGroup {
-    char *groupName;
-    char *databaseName;
-    char *path;
-    char *fileMatch;
-    char *fileType;
-    int  flagStoreData;
-    int  flagStoreKeys;
+    char         *groupName;
+    char         *databaseName;
+    char         *path;
+    char         *recordId;
+    char         *recordType;
+    int          flagStoreData;
+    int          flagStoreKeys;
+    int          flagRw;
+    int          fileVerboseLimit;
+    int          databaseNamePath;
+    int          explainDatabase;
 };
 
-struct dirs_info *dirs_open (Dict dict, const char *rep);
+void getFnameTmp (Res res, char *fname, int no);
+        
+struct dirs_info *dirs_open (Dict dict, const char *rep, int rw);
+struct dirs_info *dirs_fopen (Dict dict, const char *path);
 struct dirs_entry *dirs_read (struct dirs_info *p);
 struct dirs_entry *dirs_last (struct dirs_info *p);
-void dirs_mkdir (struct dirs_info *p, const char *src, int ctime);
+void dirs_mkdir (struct dirs_info *p, const char *src, time_t mtime);
 void dirs_rmdir (struct dirs_info *p, const char *src);
-void dirs_add (struct dirs_info *p, const char *src, int sysno, int ctime);
+void dirs_add (struct dirs_info *p, const char *src, int sysno, time_t mtime);
 void dirs_del (struct dirs_info *p, const char *src);
 void dirs_free (struct dirs_info **pp);
 
@@ -146,23 +87,39 @@ struct dir_entry *dir_open (const char *rep);
 void dir_sort (struct dir_entry *e);
 void dir_free (struct dir_entry **e_p);
 
-void repositoryUpdate (struct recordGroup *rGroup);
-void repositoryAdd (struct recordGroup *rGroup);
-void repositoryDelete (struct recordGroup *rGroup);
+void repositoryUpdate (ZebraHandle zh);
+void repositoryAdd (ZebraHandle zh);
+void repositoryDelete (ZebraHandle zh);
+void repositoryShow (ZebraHandle zh);
 
-void key_open (int mem);
-int key_close (void);
-void key_write (int cmd, struct it_key *k, const char *str);
+int key_open (ZebraHandle zh, int mem);
+int key_close (ZebraHandle zh);
 int key_compare (const void *p1, const void *p2);
+int key_get_pos (const void *p);
+int key_compare_it (const void *p1, const void *p2);
 int key_qsort_compare (const void *p1, const void *p2);
 void key_logdump (int mask, const void *p);
-void key_input (const char *dict_fname, const char *isam_fname,
-                 int nkeys, int cache);
+void inv_prstat (ZebraHandle zh);
+void inv_compact (BFiles bfs);
+void key_input (ZebraHandle zh, int nkeys, int cache, Res res);
+ISAMS_M key_isams_m (Res res, ISAMS_M me);
+#if ZMBOL
+ISAMC_M key_isamc_m (Res res, ISAMC_M me);
+ISAMD_M key_isamd_m (Res res, ISAMD_M me);
+#endif
 int merge_sort (char **buf, int from, int to);
+int key_SU_code (int ch, char *out);
 
-#define TEMP_FNAME  "keys%d.tmp"
-#define FNAME_WORD_DICT "worddict"
-#define FNAME_WORD_ISAM "wordisam"
+#define FNAME_DICT "dict"
+#define FNAME_ISAM "isam"
+#define FNAME_ISAMC "isamc"
+#define FNAME_ISAMS "isams"
+#define FNAME_ISAMH "isamh"
+#define FNAME_ISAMD "isamd"
+#define FNAME_CONFIG "zebra.cfg"
+
+#define GMATCH_DICT "gmatch"
+#define FMATCH_DICT "fmatch"
 
 struct strtab *strtab_mk (void);
 int strtab_src (struct strtab *t, const char *name, void ***infop);
@@ -173,5 +130,50 @@ int index_char_cvt (int c);
 int index_word_prefix (char *string, int attset_ordinal,
                        int local_attribute, const char *databaseName);
 
-int fileExtract (SYSNO *sysno, const char *fname,
-                 struct recordGroup *rGroup, int deleteFlag);
+int fileExtract (ZebraHandle zh, SYSNO *sysno, const char *fname,
+                 const struct recordGroup *rGroup, int deleteFlag);
+
+void zebraIndexLockMsg (ZebraHandle zh, const char *str);
+void zebraIndexUnlock (ZebraHandle zh);
+int zebraIndexLock (BFiles bfs, ZebraHandle zh, int commitNow, const char *rval);
+int zebraIndexWait (ZebraHandle zh, int commitPhase);
+
+#define FNAME_MAIN_LOCK   "zebraidx.LCK"
+#define FNAME_COMMIT_LOCK "zebracmt.LCK"
+#define FNAME_ORG_LOCK    "zebraorg.LCK"
+#define FNAME_TOUCH_TIME  "zebraidx.time"
+
+typedef struct zebra_lock_info *ZebraLockHandle;
+ZebraLockHandle zebra_lock_create(const char *file, int excl_flag);
+void zebra_lock_destroy (ZebraLockHandle h);
+int zebra_lock (ZebraLockHandle h);
+int zebra_lock_nb (ZebraLockHandle h);
+int zebra_unlock (ZebraLockHandle h);
+int zebra_lock_fd (ZebraLockHandle h);
+void zebra_lock_prefix (Res res, char *dst);
+
+int zebra_lock_w (ZebraLockHandle h);
+int zebra_lock_r (ZebraLockHandle h);
+
+void zebra_load_atts (data1_handle dh, Res res);
+
+int key_SU_decode (int *ch, const unsigned char *out);
+int key_SU_encode (int ch, char *out);
+
+// extern Res common_resource;
+
+struct encode_info {
+    int  sysno;
+    int  seqno;
+    int  cmd;
+    char buf[768];
+};
+
+void encode_key_init (struct encode_info *i);
+char *encode_key_int (int d, char *bp);
+void encode_key_write (char *k, struct encode_info *i, FILE *outf);
+
+
+YAZ_END_CDECL
+
+#endif