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     unsigned hash_size;
  36
  37     int num_records;
  38     struct reclist_bucket *sorted_list;
  39     struct reclist_bucket *sorted_ptr;
  40     struct reclist_bucket **last;
  41     NMEM nmem;
  42 };
  43
  44 static struct reclist_sortparms *qsort_sortparms = 0; /* thread pr */
  45
  46 struct reclist_bucket
  47 {
  48     struct record_cluster *record;
  49     struct reclist_bucket *hnext;
  50     struct reclist_bucket *snext;
  51 };
  52
  53 struct reclist_sortparms *reclist_parse_sortparms(NMEM nmem, const char *parms,
  54                                                   struct conf_service *service)
  55 {
  56     struct reclist_sortparms *res = 0;
  57     struct reclist_sortparms **rp = &res;
  58
  59     if (strlen(parms) > 256)
  60         return 0;
  61     while (*parms)
  62     {
  63         char parm[256];
  64         char *pp;
  65         const char *cpp;
  66         int increasing;
  67         int i;
  68         int offset = 0;
  69         enum conf_sortkey_type type;
  70         struct reclist_sortparms *new;
  71
  72         if (!(cpp = strchr(parms, ',')))
  73             cpp = parms + strlen(parms);
  74         strncpy(parm, parms, cpp - parms);
  75         parm[cpp-parms] = '\0';
  76
  77         if ((pp = strchr(parm, ':')))
  78         {
  79             increasing = pp[1] == '1' ? 1 : 0;
  80             *pp = '\0';
  81         }
  82         else
  83             increasing = 0;
  84         if (!strcmp(parm, "relevance"))
  85         {
  86             type = Metadata_sortkey_relevance;
  87         }
  88         else
  89         {
  90             for (i = 0; i < service->num_sortkeys; i++)
  91             {
  92                 struct conf_sortkey *sk = &service->sortkeys[i];
  93                 if (!strcmp(sk->name, parm))
  94                 {
  95                     type = sk->type;
  96                     if (type == Metadata_sortkey_skiparticle)
  97                         type = Metadata_sortkey_string;
  98                     break;
  99                 }
 100             }
 101             if (i >= service->num_sortkeys)
 102             {
 103                 yaz_log(YLOG_FATAL, "Bad sortkey: %s", parm);
 104                 return 0;
 105             }
 106             else
 107                 offset = i;
 108         }
 109         new = *rp = nmem_malloc(nmem, sizeof(struct reclist_sortparms));
 110         new->next = 0;
 111         new->offset = offset;
 112         new->type = type;
 113         new->increasing = increasing;
 114         rp = &new->next;
 115         if (*(parms = cpp))
 116             parms++;
 117     }
 118     return res;
 119 }
 120
 121 static int reclist_cmp(const void *p1, const void *p2)
 122 {
 123     struct record_cluster *r1 = (*(struct reclist_bucket**) p1)->record;
 124     struct record_cluster *r2 = (*(struct reclist_bucket**) p2)->record;
 125     struct reclist_sortparms *s;
 126     int res = 0;
 127
 128     for (s = qsort_sortparms; s && res == 0; s = s->next)
 129     {
 130         union data_types *ut1 = r1->sortkeys[s->offset];
 131         union data_types *ut2 = r2->sortkeys[s->offset];
 132         const char *s1, *s2;
 133         switch (s->type)
 134         {
 135         case Metadata_sortkey_relevance:
 136             res = r2->relevance - r1->relevance;
 137             break;
 138         case Metadata_sortkey_string:
 139             s1 = ut1 ? ut1->text.sort : "";
 140             s2 = ut2 ? ut2->text.sort : "";
 141             res = strcmp(s2, s1);
 142             if (res)
 143             {
 144                 if (s->increasing)
 145                     res *= -1;
 146             }
 147             break;
 148         case Metadata_sortkey_numeric:
 149             if (ut1 && ut2)
 150             {
 151                 if (s->increasing)
 152                     res = ut1->number.min  - ut2->number.min;
 153                 else
 154                     res = ut2->number.max  - ut1->number.max;
 155             }
 156             else if (ut1 && !ut2)
 157                 res = -1;
 158             else if (!ut1 && ut2)
 159                 res = 1;
 160             else
 161                 res = 0;
 162             break;
 163         default:
 164             yaz_log(YLOG_WARN, "Bad sort type: %d", s->type);
 165             res = 0;
 166         }
 167     }
 168     if (res == 0)
 169         res = strcmp(r1->recid, r2->recid);
 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)
 221 {
 222     struct reclist *res = nmem_malloc(nmem, sizeof(struct reclist));
 223     res->hash_size = 399;
 224     res->hashtable
 225         = nmem_malloc(nmem, res->hash_size * sizeof(struct reclist_bucket*));
 226     memset(res->hashtable, 0, res->hash_size * sizeof(struct reclist_bucket*));
 227     res->nmem = nmem;
 228
 229     res->sorted_ptr = 0;
 230     res->sorted_list = 0;
 231     res->last = &res->sorted_list;
 232
 233     res->num_records = 0;
 234     return res;
 235 }
 236
 237 int reclist_get_num_records(struct reclist *l)
 238 {
 239     if (l)
 240         return l->num_records;
 241     return 0;
 242 }
 243
 244 // Insert a record. Return record cluster (newly formed or pre-existing)
 245 struct record_cluster *reclist_insert( struct reclist *l,
 246                                        struct conf_service *service,
 247                                        struct record  *record,
 248                                        char *merge_key, int *total)
 249 {
 250     unsigned int bucket;
 251     struct reclist_bucket **p;
 252     struct record_cluster *cluster = 0;
 253
 254     assert(service);
 255     assert(l);
 256     assert(record);
 257     assert(merge_key);
 258     assert(total);
 259
 260     bucket = jenkins_hash((unsigned char*) merge_key) % l->hash_size;
 261
 262     for (p = &l->hashtable[bucket]; *p; p = &(*p)->hnext)
 263     {
 264         // We found a matching record. Merge them
 265         if (!strcmp(merge_key, (*p)->record->merge_key))
 266         {
 267             struct record_cluster *existing = (*p)->record;
 268             record->next = existing->records;
 269             existing->records = record;
 270             cluster = existing;
 271             break;
 272         }
 273     }
 274     if (!cluster)
 275     {
 276         struct reclist_bucket *new =
 277             nmem_malloc(l->nmem, sizeof(*new));
 278
 279         cluster = nmem_malloc(l->nmem, sizeof(*cluster));
 280
 281         record->next = 0;
 282         new->record = cluster;
 283         new->hnext = 0;
 284         cluster->records = record;
 285         cluster->merge_key = merge_key;
 286         cluster->relevance = 0;
 287         cluster->term_frequency_vec = 0;
 288         cluster->recid = merge_key;
 289         (*total)++;
 290         cluster->metadata =
 291             nmem_malloc(l->nmem,
 292                         sizeof(struct record_metadata*) * service->num_metadata);
 293         memset(cluster->metadata, 0,
 294                sizeof(struct record_metadata*) * service->num_metadata);
 295         cluster->sortkeys =
 296             nmem_malloc(l->nmem, sizeof(struct record_metadata*) * service->num_sortkeys);
 297         memset(cluster->sortkeys, 0,
 298                sizeof(union data_types*) * service->num_sortkeys);
 299
 300         /* attach to hash list */
 301         *p = new;
 302
 303         /* append to sorted_list */
 304         *l->last = new;
 305         l->last = &new->snext;
 306         l->sorted_ptr = l->sorted_list;
 307         new->snext = 0;
 308
 309         l->num_records++;
 310     }
 311     return cluster;
 312 }
 313
 314
 315 /*
 316  * Local variables:
 317  * c-basic-offset: 4
 318  * c-file-style: "Stroustrup"
 319  * indent-tabs-mode: nil
 320  * End:
 321  * vim: shiftwidth=4 tabstop=8 expandtab
 322  */
 323