src/reclists.c

   1 /* $Id: reclists.c,v 1.18 2007-07-02 20:55:50 adam Exp $
   2    Copyright (c) 2006-2007, Index Data.
   3
   4 This file is part of Pazpar2.
   5
   6 Pazpar2 is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 2, or (at your option) any later
   9 version.
  10
  11 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with Pazpar2; see the file LICENSE.  If not, write to the
  18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.
  20  */
  21
  22 #include <assert.h>
  23
  24 #if HAVE_CONFIG_H
  25 #include <cconfig.h>
  26 #endif
  27
  28 #include <yaz/yaz-util.h>
  29
  30 #include "pazpar2.h"
  31 #include "reclists.h"
  32
  33 extern struct parameters global_parameters;
  34
  35 // Not threadsafe
  36 static struct reclist_sortparms *sortparms = 0;
  37
  38 struct reclist_bucket
  39 {
  40     struct record_cluster *record;
  41     struct reclist_bucket *next;
  42 };
  43
  44 #if 0
  45 struct reclist_sortparms *
  46 reclist_sortparms_insert_field_id(NMEM nmem,
  47                          struct reclist_sortparms **sortparms,
  48                          int field_id,
  49                          enum conf_sortkey_type type,
  50                          int increasing)
  51 {
  52     struct reclist_sortparms * tmp_rlsp = 0;
  53     // assert(nmem);
  54
  55     if(!sortparms || field_id < 0)
  56         return 0;
  57
  58     // construct new reclist_sortparms
  59     tmp_rlsp  = nmem_malloc(nmem, sizeof(struct reclist_sortparms));
  60     tmp_rlsp->offset = field_id;
  61     tmp_rlsp->type = type;
  62     tmp_rlsp->increasing = increasing;
  63
  64
  65     // insert in *sortparms place, moving *sortparms one down the list
  66     tmp_rlsp->next = *sortparms;
  67     *sortparms = tmp_rlsp;
  68
  69     return *sortparms;
  70 };
  71 #endif
  72
  73 #if 0
  74 struct reclist_sortparms *
  75 reclist_sortparms_insert(NMEM nmem,
  76                          struct reclist_sortparms **sortparms,
  77                          struct conf_service * service,
  78                          const char * name,
  79                          int increasing)
  80 {
  81     int field_id = 0;
  82
  83     if (!sortparms || !service || !name)
  84         return 0;
  85
  86     field_id = conf_service_sortkey_field_id(service, name);
  87
  88     if (-1 == field_id)
  89         return 0;
  90
  91     return reclist_sortparms_insert_field_id(nmem, sortparms, field_id,
  92                                              service->sortkeys[field_id].type,
  93                                              increasing);
  94 };
  95 #endif
  96
  97
  98 struct reclist_sortparms *reclist_parse_sortparms(NMEM nmem, const char *parms)
  99 {
 100     struct reclist_sortparms *res = 0;
 101     struct reclist_sortparms **rp = &res;
 102     struct conf_service *service = config->servers->service;
 103
 104     if (strlen(parms) > 256)
 105         return 0;
 106     while (*parms)
 107     {
 108         char parm[256];
 109         char *pp;
 110         const char *cpp;
 111         int increasing;
 112         int i;
 113         int offset;
 114         enum conf_sortkey_type type;
 115         struct reclist_sortparms *new;
 116
 117         if (!(cpp = strchr(parms, ',')))
 118             cpp = parms + strlen(parms);
 119         strncpy(parm, parms, cpp - parms);
 120         parm[cpp-parms] = '\0';
 121
 122         if ((pp = strchr(parm, ':')))
 123         {
 124             increasing = pp[1] == '1' ? 1 : 0;
 125             *pp = '\0';
 126         }
 127         else
 128             increasing = 0;
 129         if (!strcmp(parm, "relevance"))
 130         {
 131             type = Metadata_sortkey_relevance;
 132             offset = -1;
 133         }
 134         else
 135         {
 136             for (i = 0; i < service->num_sortkeys; i++)
 137             {
 138                 struct conf_sortkey *sk = &service->sortkeys[i];
 139                 if (!strcmp(sk->name, parm))
 140                 {
 141                     type = sk->type;
 142                     if (type == Metadata_sortkey_skiparticle)
 143                         type = Metadata_sortkey_string;
 144                     break;
 145                 }
 146             }
 147             if (i >= service->num_sortkeys)
 148             {
 149                 yaz_log(YLOG_FATAL, "Bad sortkey: %s", parm);
 150                 return 0;
 151             }
 152             else
 153                 offset = i;
 154         }
 155         new = *rp = nmem_malloc(nmem, sizeof(struct reclist_sortparms));
 156         new->next = 0;
 157         new->offset = offset;
 158         new->type = type;
 159         new->increasing = increasing;
 160         rp = &new->next;
 161         if (*(parms = cpp))
 162             parms++;
 163     }
 164     return res;
 165 }
 166
 167 static int reclist_cmp(const void *p1, const void *p2)
 168 {
 169     struct record_cluster *r1 = (*(struct record_cluster**) p1);
 170     struct record_cluster *r2 = (*(struct record_cluster**) p2);
 171     struct reclist_sortparms *s;
 172
 173     for (s = sortparms; s; s = s->next)
 174     {
 175         int res;
 176         switch (s->type)
 177         {
 178             char *s1, *s2;
 179
 180             case Metadata_sortkey_relevance:
 181                 res = r2->relevance - r1->relevance;
 182                 break;
 183             case Metadata_sortkey_string:
 184                 s1 = r1->sortkeys[s->offset] ? r1->sortkeys[s->offset]->text : "";
 185                 s2 = r2->sortkeys[s->offset] ? r2->sortkeys[s->offset]->text : "";
 186                 res = strcmp(s2, s1);
 187                 break;
 188             case Metadata_sortkey_numeric:
 189                 res = 0;
 190                 break;
 191             default:
 192                 yaz_log(YLOG_FATAL, "Bad sort type: %d", s->type);
 193                 exit(1);
 194         }
 195         if (res)
 196         {
 197             if (s->increasing)
 198                 res *= -1;
 199             return res;
 200         }
 201     }
 202     return 0;
 203 }
 204
 205 void reclist_sort(struct reclist *l, struct reclist_sortparms *parms)
 206 {
 207     sortparms = parms;
 208     qsort(l->flatlist, l->num_records,
 209           sizeof(struct record_cluster*), reclist_cmp);
 210     reclist_rewind(l);
 211 }
 212
 213 struct record_cluster *reclist_read_record(struct reclist *l)
 214 {
 215     if (l && l->pointer < l->num_records)
 216         return l->flatlist[l->pointer++];
 217     else
 218         return 0;
 219 }
 220
 221 void reclist_rewind(struct reclist *l)
 222 {
 223     if (l)
 224         l->pointer = 0;
 225 }
 226
 227 // Jenkins one-at-a-time hash (from wikipedia)
 228 static unsigned int hash(const unsigned char *key)
 229 {
 230     unsigned int hash = 0;
 231
 232     while (*key)
 233     {
 234         hash += *(key++);
 235         hash += (hash << 10);
 236         hash ^= (hash >> 6);
 237     }
 238     hash += (hash << 3);
 239     hash ^= (hash >> 11);
 240     hash += (hash << 15);
 241     return hash;
 242 }
 243
 244 struct reclist *reclist_create(NMEM nmem, int numrecs)
 245 {
 246     int hashsize = 1;
 247     struct reclist *res;
 248
 249     assert(numrecs);
 250     while (hashsize < numrecs)
 251         hashsize <<= 1;
 252     res = nmem_malloc(nmem, sizeof(struct reclist));
 253     res->hashtable
 254         = nmem_malloc(nmem, hashsize * sizeof(struct reclist_bucket*));
 255     memset(res->hashtable, 0, hashsize * sizeof(struct reclist_bucket*));
 256     res->hashtable_size = hashsize;
 257     res->nmem = nmem;
 258     res->hashmask = hashsize - 1; // Creates a bitmask
 259
 260     res->num_records = 0;
 261     res->flatlist = nmem_malloc(nmem, numrecs * sizeof(struct record_cluster*));
 262     res->flatlist_size = numrecs;
 263
 264     return res;
 265 }
 266
 267 // Insert a record. Return record cluster (newly formed or pre-existing)
 268 struct record_cluster *reclist_insert( struct reclist *l,
 269                                        struct conf_service *service,
 270                                        struct record  *record,
 271                                        const char *merge_key, int *total)
 272 {
 273     unsigned int bucket;
 274     struct reclist_bucket **p;
 275     struct record_cluster *cluster = 0;
 276
 277     assert(service);
 278     assert(l);
 279     assert(record);
 280     assert(merge_key);
 281     assert(total);
 282
 283     bucket = hash((unsigned char*) merge_key) & l->hashmask;
 284
 285     for (p = &l->hashtable[bucket]; *p; p = &(*p)->next)
 286     {
 287         // We found a matching record. Merge them
 288         if (!strcmp(merge_key, (*p)->record->merge_key))
 289         {
 290             struct record_cluster *existing = (*p)->record;
 291             record->next = existing->records;
 292             existing->records = record;
 293             cluster = existing;
 294             break;
 295         }
 296     }
 297     if (!cluster && l->num_records < l->flatlist_size)
 298     {
 299         struct reclist_bucket *new =
 300             nmem_malloc(l->nmem, sizeof(struct reclist_bucket));
 301         struct record_cluster *newc =
 302             nmem_malloc(l->nmem, sizeof(struct record_cluster));
 303
 304         record->next = 0;
 305         new->record = newc;
 306         new->next = 0;
 307         newc->records = record;
 308         newc->merge_key = (char *) merge_key;
 309         newc->relevance = 0;
 310         newc->term_frequency_vec = 0;
 311         newc->recid = (*total)++;
 312         newc->metadata = nmem_malloc(l->nmem,
 313                 sizeof(struct record_metadata*) * service->num_metadata);
 314         memset(newc->metadata, 0,
 315                sizeof(struct record_metadata*) * service->num_metadata);
 316         newc->sortkeys = nmem_malloc(l->nmem,
 317                 sizeof(struct record_metadata*) * service->num_sortkeys);
 318         memset(newc->sortkeys, 0,
 319                sizeof(union data_types*) * service->num_sortkeys);
 320
 321         *p = new;
 322         l->flatlist[l->num_records++] = newc;
 323         cluster = newc;
 324     }
 325     return cluster;
 326 }
 327
 328
 329 /*
 330  * Local variables:
 331  * c-basic-offset: 4
 332  * indent-tabs-mode: nil
 333  * End:
 334  * vim: shiftwidth=4 tabstop=8 expandtab
 335  */