src/reclists.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2010 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     YAZ_MUTEX mutex;
  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         const char *s1, *s2;
 134         switch (s->type)
 135         {
 136         case Metadata_sortkey_relevance:
 137             res = r2->relevance_score - r1->relevance_score;
 138             break;
 139         case Metadata_sortkey_string:
 140             s1 = ut1 ? ut1->text.sort : "";
 141             s2 = ut2 ? ut2->text.sort : "";
 142             res = strcmp(s2, s1);
 143             if (res)
 144             {
 145                 if (s->increasing)
 146                     res *= -1;
 147             }
 148             break;
 149         case Metadata_sortkey_numeric:
 150             if (ut1 && ut2)
 151             {
 152                 if (s->increasing)
 153                     res = ut1->number.min  - ut2->number.min;
 154                 else
 155                     res = ut2->number.max  - ut1->number.max;
 156             }
 157             else if (ut1 && !ut2)
 158                 res = -1;
 159             else if (!ut1 && ut2)
 160                 res = 1;
 161             else
 162                 res = 0;
 163             break;
 164         default:
 165             yaz_log(YLOG_WARN, "Bad sort type: %d", s->type);
 166             res = 0;
 167         }
 168     }
 169     if (res == 0)
 170         res = strcmp(r1->recid, r2->recid);
 171     return res;
 172 }
 173
 174 void reclist_sort(struct reclist *l, struct reclist_sortparms *parms)
 175 {
 176
 177     struct reclist_bucket **flatlist = xmalloc(sizeof(*flatlist) * l->num_records);
 178     struct reclist_bucket *ptr;
 179     struct reclist_bucket **prev;
 180     int i = 0;
 181
 182     reclist_enter(l);
 183
 184     ptr = l->sorted_list;
 185     prev = &l->sorted_list;
 186     while (ptr)
 187     {
 188         flatlist[i] = ptr;
 189         ptr = ptr->snext;
 190         i++;
 191     }
 192     assert(i == l->num_records);
 193
 194     qsort_sortparms = parms;
 195     qsort(flatlist, l->num_records, sizeof(*flatlist), reclist_cmp);
 196     for (i = 0; i < l->num_records; i++)
 197     {
 198         *prev = flatlist[i];
 199         prev = &flatlist[i]->snext;
 200     }
 201     *prev = 0;
 202     l->last = prev;
 203
 204     xfree(flatlist);
 205
 206     reclist_leave(l);
 207 }
 208
 209 struct record_cluster *reclist_read_record(struct reclist *l)
 210 {
 211     if (l && l->sorted_ptr)
 212     {
 213         struct record_cluster *t = l->sorted_ptr->record;
 214         l->sorted_ptr = l->sorted_ptr->snext;
 215         return t;
 216     }
 217     else
 218         return 0;
 219 }
 220
 221 void reclist_enter(struct reclist *l)
 222 {
 223     yaz_mutex_enter(l->mutex);
 224     if (l)
 225         l->sorted_ptr = l->sorted_list;
 226 }
 227
 228
 229 void reclist_leave(struct reclist *l)
 230 {
 231     yaz_mutex_leave(l->mutex);
 232     if (l)
 233         l->sorted_ptr = l->sorted_list;
 234 }
 235
 236
 237 struct reclist *reclist_create(NMEM nmem)
 238 {
 239     struct reclist *res = nmem_malloc(nmem, sizeof(struct reclist));
 240     res->hash_size = 399;
 241     res->hashtable
 242         = nmem_malloc(nmem, res->hash_size * sizeof(struct reclist_bucket*));
 243     memset(res->hashtable, 0, res->hash_size * sizeof(struct reclist_bucket*));
 244     res->nmem = nmem;
 245
 246     res->sorted_ptr = 0;
 247     res->sorted_list = 0;
 248     res->last = &res->sorted_list;
 249
 250     res->num_records = 0;
 251     res->mutex = 0;
 252     yaz_mutex_create(&res->mutex);
 253     return res;
 254 }
 255
 256 void reclist_destroy(struct reclist *l)
 257 {
 258     yaz_mutex_destroy(&l->mutex);
 259 }
 260
 261 int reclist_get_num_records(struct reclist *l)
 262 {
 263     if (l)
 264         return l->num_records;
 265     return 0;
 266 }
 267
 268 // Insert a record. Return record cluster (newly formed or pre-existing)
 269 struct record_cluster *reclist_insert( struct reclist *l,
 270                                        struct conf_service *service,
 271                                        struct record  *record,
 272                                        char *merge_key, int *total)
 273 {
 274     unsigned int bucket;
 275     struct reclist_bucket **p;
 276     struct record_cluster *cluster = 0;
 277
 278     assert(service);
 279     assert(l);
 280     assert(record);
 281     assert(merge_key);
 282     assert(total);
 283
 284     bucket = jenkins_hash((unsigned char*) merge_key) % l->hash_size;
 285
 286     yaz_mutex_enter(l->mutex);
 287     for (p = &l->hashtable[bucket]; *p; p = &(*p)->hnext)
 288     {
 289         // We found a matching record. Merge them
 290         if (!strcmp(merge_key, (*p)->record->merge_key))
 291         {
 292             struct record_cluster *existing = (*p)->record;
 293             record->next = existing->records;
 294             existing->records = record;
 295             cluster = existing;
 296             break;
 297         }
 298     }
 299     if (!cluster)
 300     {
 301         struct reclist_bucket *new =
 302             nmem_malloc(l->nmem, sizeof(*new));
 303
 304         cluster = nmem_malloc(l->nmem, sizeof(*cluster));
 305
 306         record->next = 0;
 307         new->record = cluster;
 308         new->hnext = 0;
 309         cluster->records = record;
 310         cluster->merge_key = merge_key;
 311         cluster->relevance_score = 0;
 312         cluster->term_frequency_vec = 0;
 313         cluster->recid = merge_key;
 314         (*total)++;
 315         cluster->metadata =
 316             nmem_malloc(l->nmem,
 317                         sizeof(struct record_metadata*) * service->num_metadata);
 318         memset(cluster->metadata, 0,
 319                sizeof(struct record_metadata*) * service->num_metadata);
 320         cluster->sortkeys =
 321             nmem_malloc(l->nmem, sizeof(struct record_metadata*) * service->num_sortkeys);
 322         memset(cluster->sortkeys, 0,
 323                sizeof(union data_types*) * service->num_sortkeys);
 324
 325         /* attach to hash list */
 326         *p = new;
 327
 328         /* append to sorted_list */
 329         *l->last = new;
 330         l->last = &new->snext;
 331         l->sorted_ptr = l->sorted_list;
 332         new->snext = 0;
 333
 334         l->num_records++;
 335     }
 336     yaz_mutex_leave(l->mutex);
 337     return cluster;
 338 }
 339
 340 /*
 341  * Local variables:
 342  * c-basic-offset: 4
 343  * c-file-style: "Stroustrup"
 344  * indent-tabs-mode: nil
 345  * End:
 346  * vim: shiftwidth=4 tabstop=8 expandtab
 347  */
 348