src/reclists.c

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