lib/index.h

   1 /*
   2  *      Sherlock: Data structures used in indices
   3  *
   4  *      (c) 2001--2003 Martin Mares <mj@ucw.cz>
   5  */
   6
   7 #ifndef _SHERLOCK_INDEX_H
   8 #define _SHERLOCK_INDEX_H
   9
  10 #include SHERLOCK_CUSTOM
  11
  12 #define INDEX_VERSION (0x32250100+sizeof(struct card_attr))     /* Increase with each incompatible change in index format */
  13
  14 /*
  15  *  Words
  16  *
  17  *  MAX_WORD_LEN is the maximum length (measured in UTF-8 characters, excluding
  18  *  the terminating zero byte if there's any) of any word which may appear in the
  19  *  indices or in the bucket file. Naturally, the same constant also bounds
  20  *  the number of UCS-2 characters in a word.
  21  *
  22  *  Caveat: If you are upcasing/downcasing the word, the UTF-8 encoding can
  23  *  expand, although at most twice, so you need to reserve 2*MAX_WORD_LEN bytes.
  24  */
  25
  26 #define MAX_WORD_LEN            64      /* a multiple of 4 */
  27
  28 /* Word and string types are defined in lib/custom.h */
  29
  30 /* Types used for storing contexts */
  31
  32 #ifdef CONFIG_CONTEXTS
  33 #if CONFIG_MAX_CONTEXTS == 32768
  34 typedef u16 context_t;
  35 #define bget_context bgetw
  36 #define bput_context bputw
  37 #define GET_CONTEXT GET_U16
  38 #define PUT_CONTEXT PUT_U16
  39 #elif CONFIG_MAX_CONTEXTS == 256
  40 typedef byte context_t;
  41 #define bget_context bgetc
  42 #define bput_context bputc
  43 #define GET_CONTEXT GET_U8
  44 #define PUT_CONTEXT PUT_U8
  45 #else
  46 #error CONFIG_MAX_CONTEXTS set to an invalid value.
  47 #endif
  48 #else
  49 struct fastbuf;
  50 typedef struct { } context_t;
  51 static inline uns bget_context(struct fastbuf *b UNUSED) { return 0; }
  52 static inline void bput_context(struct fastbuf *b UNUSED, uns context UNUSED) { }
  53 #define GET_CONTEXT(p) 0
  54 #define PUT_CONTEXT(p,x) do {} while(0)
  55 #endif
  56
  57 /* Index card attributes */
  58
  59 struct card_attr {
  60   u32 card;                             /* Reference to card description (either oid or filepos) */
  61 #ifdef CONFIG_SITES
  62   u32 site_id;
  63 #endif
  64   CUSTOM_CARD_ATTRS                     /* Include all custom attributes */
  65   byte weight;
  66   byte flags;
  67 #ifdef CONFIG_LASTMOD
  68   byte age;                             /* Document age in pseudo-logarithmic units wrt. reference time */
  69 #endif
  70 #ifdef CONFIG_FILETYPE
  71   byte type_flags;                      /* File type flags (see below) */
  72 #endif
  73 };
  74
  75 enum card_flag {
  76   CARD_FLAG_EMPTY = 1,                  /* Empty document (redirect, robot file etc.) [scanner] */
  77   CARD_FLAG_ACCENTED = 2,               /* Document contains accented characters [scanner] */
  78   CARD_FLAG_DUP = 4,                    /* Removed as a duplicate [merger] */
  79   CARD_FLAG_MERGED = 8,                 /* Destination of a merge [merger] */
  80   CARD_FLAG_IMAGE = 16,                 /* Is an image object [scanner] */
  81   CARD_FLAG_FRAMESET = 32,              /* Contains a frameset to be ignored [scanner] */
  82   CARD_FLAG_GIANT_CLASS = 64,           /* Belongs to a very large class, subject to penalties [merger] */
  83 };
  84
  85 #define CARD_POS_SHIFT 5                /* Card positions are shifted this # of bits to the right */
  86
  87 /*
  88  *  We store document type and several other properties in card_attr->type_flags.
  89  *  Here we define only the basic structure, the details are defined in custom.h
  90  *  (the list of type names custom_file_type_names[] and also setting of the file
  91  *  types in custom_create_attrs()).
  92  *
  93  *  bits 7--5   file type: (0-3: text types, 4-7: other types, defined by custom.h)
  94  *  bits 4--0   type-dependent information, for text types it's document language code
  95  */
  96
  97 #ifdef CONFIG_FILETYPE
  98 #define CA_GET_FILE_TYPE(a) ((a)->type_flags >> 5)
  99 #define CA_GET_FILE_INFO(a) ((a)->type_flags & 0x1f)
 100 #define CA_GET_FILE_LANG(a) ((a)->type_flags & 0x80 ? 0 : CA_GET_FILE_INFO(a))
 101 #define FILETYPE_ATTRS SMALL_SET_ATTR(ftype, FILETYPE, CA_GET_FILE_TYPE, ext_ft_parse)
 102 #define MAX_FILE_TYPES 8
 103 byte *ext_ft_parse(u32 *dest, byte *value, uns intval);
 104 extern byte *custom_file_type_names[MAX_FILE_TYPES];
 105 #else
 106 #define FILETYPE_ATTRS
 107 #endif
 108
 109 #ifdef CONFIG_LANG
 110 /* You can use language matching without CONFIG_FILETYPE, but you have to define CA_GET_FILE_LANG yourself. */
 111 #define LANG_ATTRS SMALL_SET_ATTR(lang, LANG, CA_GET_FILE_LANG, ext_lang_parse)
 112 byte *ext_lang_parse(u32 *dest, byte *value, uns intval);
 113 #else
 114 #define LANG_ATTRS
 115 #endif
 116
 117 #define EXTENDED_ATTRS CUSTOM_ATTRS LANG_ATTRS          /* Beware, FILETYPE_ATTRS are handled separately */
 118
 119 /* String fingerprints */
 120
 121 struct fingerprint {
 122   byte hash[12];
 123 };
 124
 125 void fingerprint(byte *string, struct fingerprint *fp);
 126
 127 static inline u32
 128 fp_hash(struct fingerprint *fp)
 129 {
 130   /* This hash is expected to be monotonic wrt. fpsort's order by fprecog */
 131   return (fp->hash[0] << 24) | (fp->hash[1] << 16) | (fp->hash[2] << 8) | fp->hash[3];
 132 }
 133
 134 /* URL keys */
 135
 136 #define URL_KEY_BUF_SIZE (3*MAX_URL_SIZE)
 137 byte *url_key(byte *url, byte *buf);
 138 void url_fingerprint(byte *url, struct fingerprint *fp);
 139 void url_key_init(void);
 140
 141 /* Conversion of document age from seconds to our internal units */
 142
 143 static inline int
 144 convert_age(sh_time_t lastmod, sh_time_t reftime)
 145 {
 146   sh_time_t age;
 147   if (reftime < lastmod)                /* past times */
 148     return -1;
 149   age = (reftime - lastmod) / 3600;
 150   if (age < 48)                         /* last 2 days: 1 hour resolution */
 151     return age;
 152   age = (age-48) / 24;
 153   if (age < 64)                         /* next 64 days: 1 day resolution */
 154     return 48 + age;
 155   age = (age-64) / 7;
 156   if (age < 135)                        /* next 135 weeks: 1 week resolution */
 157     return 112 + age;
 158   age = (age-135) / 52;
 159   if (age < 8)                          /* next 8 years: 1 year resolution */
 160     return 247 + age;
 161   return 255;                           /* then just "infinite future" */
 162 }
 163
 164 #endif