index/index.h

   1 /*
   2  * Copyright (C) 1994-1995, Index Data I/S
   3  * All rights reserved.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: index.h,v $
   7  * Revision 1.35  1996-02-12 18:45:36  adam
   8  * New fileVerboseFlag in record group control.
   9  *
  10  * Revision 1.34  1995/12/11  11:43:29  adam
  11  * Locking based on fcntl instead of flock.
  12  * Setting commitEnable removed. Command line option -n can be used to
  13  * prevent commit if commit setting is defined in the configuration file.
  14  *
  15  * Revision 1.33  1995/12/08  16:22:53  adam
  16  * Work on update while servers are running. Three lock files introduced.
  17  * The servers reload their registers when necessary, but they don't
  18  * reestablish result sets yet.
  19  *
  20  * Revision 1.32  1995/12/07  17:38:46  adam
  21  * Work locking mechanisms for concurrent updates/commit.
  22  *
  23  * Revision 1.31  1995/12/06  12:41:22  adam
  24  * New command 'stat' for the index program.
  25  * Filenames can be read from stdin by specifying '-'.
  26  * Bug fix/enhancement of the transformation from terms to regular
  27  * expressons in the search engine.
  28  *
  29  * Revision 1.30  1995/12/05  11:25:02  adam
  30  * Include of zebraver.h.
  31  *
  32  * Revision 1.29  1995/11/28  09:09:40  adam
  33  * Zebra config renamed.
  34  * Use setting 'recordId' to identify record now.
  35  * Bug fix in recindex.c: rec_release_blocks was invokeded even
  36  * though the blocks were already released.
  37  * File traversal properly deletes records when needed.
  38  *
  39  * Revision 1.28  1995/11/27  13:58:53  adam
  40  * New option -t. storeStore data implemented in server.
  41  *
  42  * Revision 1.27  1995/11/25  10:24:06  adam
  43  * More record fields - they are enumerated now.
  44  * New options: flagStoreData flagStoreKey.
  45  *
  46  * Revision 1.26  1995/11/22  17:19:17  adam
  47  * Record management uses the bfile system.
  48  *
  49  * Revision 1.25  1995/11/21  15:29:12  adam
  50  * Config file 'base' read by default by both indexer and server.
  51  *
  52  * Revision 1.24  1995/11/21  15:01:15  adam
  53  * New general match criteria implemented.
  54  * New feature: document groups.
  55  *
  56  * Revision 1.23  1995/11/20  16:59:45  adam
  57  * New update method: the 'old' keys are saved for each records.
  58  *
  59  * Revision 1.22  1995/11/20  11:56:26  adam
  60  * Work on new traversal.
  61  *
  62  * Revision 1.21  1995/11/16  15:34:55  adam
  63  * Uses new record management system in both indexer and server.
  64  *
  65  * Revision 1.20  1995/11/15  14:46:18  adam
  66  * Started work on better record management system.
  67  *
  68  * Revision 1.19  1995/10/27  14:00:11  adam
  69  * Implemented detection of database availability.
  70  *
  71  * Revision 1.18  1995/10/17  18:02:08  adam
  72  * New feature: databases. Implemented as prefix to words in dictionary.
  73  *
  74  * Revision 1.17  1995/10/13  16:01:49  adam
  75  * Work on relations.
  76  *
  77  * Revision 1.16  1995/10/10  12:24:38  adam
  78  * Temporary sort files are compressed.
  79  *
  80  * Revision 1.15  1995/10/04  16:57:19  adam
  81  * Key input and merge sort in one pass.
  82  *
  83  * Revision 1.14  1995/09/29  14:01:40  adam
  84  * Bug fixes.
  85  *
  86  * Revision 1.13  1995/09/28  14:22:56  adam
  87  * Sort uses smaller temporary files.
  88  *
  89  * Revision 1.12  1995/09/28  12:10:32  adam
  90  * Bug fixes. Field prefix used in queries.
  91  *
  92  * Revision 1.11  1995/09/27  12:22:28  adam
  93  * More work on extract in record control.
  94  * Field name is not in isam keys but in prefix in dictionary words.
  95  *
  96  * Revision 1.10  1995/09/14  07:48:23  adam
  97  * Record control management.
  98  *
  99  * Revision 1.9  1995/09/11  13:09:33  adam
 100  * More work on relevance feedback.
 101  *
 102  * Revision 1.8  1995/09/08  14:52:27  adam
 103  * Minor changes. Dictionary is lower case now.
 104  *
 105  * Revision 1.7  1995/09/06  16:11:16  adam
 106  * Option: only one word key per file.
 107  *
 108  * Revision 1.6  1995/09/05  15:28:39  adam
 109  * More work on search engine.
 110  *
 111  * Revision 1.5  1995/09/04  12:33:42  adam
 112  * Various cleanup. YAZ util used instead.
 113  *
 114  * Revision 1.4  1995/09/04  09:10:35  adam
 115  * More work on index add/del/update.
 116  * Merge sort implemented.
 117  * Initial work on z39 server.
 118  *
 119  * Revision 1.3  1995/09/01  14:06:35  adam
 120  * Split of work into more files.
 121  *
 122  * Revision 1.2  1995/09/01  10:30:24  adam
 123  * More work on indexing. Not working yet.
 124  *
 125  * Revision 1.1  1995/08/31  14:50:24  adam
 126  * New simple file index tool.
 127  *
 128  */
 129
 130 #include <zebraver.h>
 131 #include <alexutil.h>
 132 #include <dict.h>
 133 #include <isam.h>
 134
 135 #define IT_MAX_WORD 256
 136 #define IT_KEY_HAVE_SEQNO 1
 137 #define IT_KEY_HAVE_FIELD 0
 138
 139 struct it_key {
 140     int  sysno;
 141     int   seqno;
 142 };
 143
 144 enum dirsKind { dirs_dir, dirs_file };
 145
 146 struct dir_entry {
 147     enum dirsKind kind;
 148     char *name;
 149     int ctime;
 150 };
 151
 152 struct dirs_entry {
 153     enum dirsKind kind;
 154     char path[256];
 155     SYSNO sysno;
 156     int ctime;
 157 };
 158
 159 struct recordGroup {
 160     char *groupName;
 161     char *databaseName;
 162     char *path;
 163     char *recordId;
 164     char *recordType;
 165     int  flagStoreData;
 166     int  flagStoreKeys;
 167     int  fileVerboseFlag;
 168 };
 169
 170
 171 struct dirs_info *dirs_open (Dict dict, const char *rep);
 172 struct dirs_entry *dirs_read (struct dirs_info *p);
 173 struct dirs_entry *dirs_last (struct dirs_info *p);
 174 void dirs_mkdir (struct dirs_info *p, const char *src, int ctime);
 175 void dirs_rmdir (struct dirs_info *p, const char *src);
 176 void dirs_add (struct dirs_info *p, const char *src, int sysno, int ctime);
 177 void dirs_del (struct dirs_info *p, const char *src);
 178 void dirs_free (struct dirs_info **pp);
 179
 180 struct dir_entry *dir_open (const char *rep);
 181 void dir_sort (struct dir_entry *e);
 182 void dir_free (struct dir_entry **e_p);
 183
 184 void repositoryUpdate (struct recordGroup *rGroup);
 185 void repositoryAdd (struct recordGroup *rGroup);
 186 void repositoryDelete (struct recordGroup *rGroup);
 187
 188 void key_open (int mem);
 189 int key_close (void);
 190 void key_write (int cmd, struct it_key *k, const char *str);
 191 int key_compare (const void *p1, const void *p2);
 192 int key_qsort_compare (const void *p1, const void *p2);
 193 void key_logdump (int mask, const void *p);
 194 void key_input (const char *dict_fname, const char *isam_fname,
 195                  int nkeys, int cache);
 196 int merge_sort (char **buf, int from, int to);
 197
 198 #define TEMP_FNAME  "keys%d.tmp"
 199 #define FNAME_WORD_DICT "worddict"
 200 #define FNAME_WORD_ISAM "wordisam"
 201 #define FNAME_CONFIG "zebra.cfg"
 202
 203 #define GMATCH_DICT "gmatch"
 204 #define FMATCH_DICT "fmatch"
 205
 206 struct strtab *strtab_mk (void);
 207 int strtab_src (struct strtab *t, const char *name, void ***infop);
 208 void strtab_del (struct strtab *t,
 209                  void (*func)(const char *name, void *info, void *data),
 210                  void *data);
 211 int index_char_cvt (int c);
 212 int index_word_prefix (char *string, int attset_ordinal,
 213                        int local_attribute, const char *databaseName);
 214
 215 int fileExtract (SYSNO *sysno, const char *fname,
 216                  const struct recordGroup *rGroup, int deleteFlag);
 217
 218 void rec_prstat (void);
 219
 220 void zebraLockPrefix (char *pathPrefix);
 221
 222 void zebraIndexLockMsg (const char *str);
 223 void zebraIndexUnlock (void);
 224 void zebraIndexLock (int commitNow);
 225 int zebraIndexWait (int commitPhase);
 226
 227 #define FNAME_MAIN_LOCK   "zebraidx.LCK"
 228 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
 229 #define FNAME_ORG_LOCK    "zebraorg.LCK"
 230 #define FNAME_TOUCH_TIME  "zebraidx.time"
 231
 232 int zebraLock (int fd, int wr);
 233 int zebraLockNB (int fd, int wr);
 234 int zebraUnlock (int fd);