src/reclists.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2011 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 "ppmutex.h"
  29 #include "session.h"
  30 #include "reclists.h"
  31 #include "jenkins_hash.h"
  32
  33 struct reclist
  34 {
  35     struct reclist_bucket **hashtable;
  36     unsigned hash_size;
  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     YAZ_MUTEX mutex;
  44 };
  45
  46 struct reclist_bucket
  47 {
  48     struct record_cluster *record;
  49     struct reclist_bucket *hnext;
  50     struct reclist_bucket *snext;
  51     struct reclist_sortparms *sort_parms;
  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 if (!strcmp(parm, "position"))
  90         {
  91             type = Metadata_sortkey_position;
  92         }
  93         else
  94         {
  95             for (i = 0; i < service->num_sortkeys; i++)
  96             {
  97                 struct conf_sortkey *sk = &service->sortkeys[i];
  98                 if (!strcmp(sk->name, parm))
  99                 {
 100                     type = sk->type;
 101                     if (type == Metadata_sortkey_skiparticle)
 102                         type = Metadata_sortkey_string;
 103                     break;
 104                 }
 105             }
 106             if (i >= service->num_sortkeys)
 107             {
 108                 yaz_log(YLOG_FATAL, "Bad sortkey: %s", parm);
 109                 return 0;
 110             }
 111             else
 112                 offset = i;
 113         }
 114         new = *rp = nmem_malloc(nmem, sizeof(struct reclist_sortparms));
 115         new->next = 0;
 116         new->offset = offset;
 117         new->type = type;
 118         new->increasing = increasing;
 119         new->name = nmem_strdup(nmem, parm);
 120         rp = &new->next;
 121         if (*(parms = cpp))
 122             parms++;
 123     }
 124     return res;
 125 }
 126
 127 static int reclist_cmp(const void *p1, const void *p2)
 128 {
 129     struct reclist_sortparms *sortparms =
 130         (*(struct reclist_bucket **) p1)->sort_parms;
 131     struct record_cluster *r1 = (*(struct reclist_bucket**) p1)->record;
 132     struct record_cluster *r2 = (*(struct reclist_bucket**) p2)->record;
 133     struct reclist_sortparms *s;
 134     int res = 0;
 135
 136     for (s = sortparms; s && res == 0; s = s->next)
 137     {
 138         union data_types *ut1 = r1->sortkeys[s->offset];
 139         union data_types *ut2 = r2->sortkeys[s->offset];
 140         const char *s1, *s2;
 141         switch (s->type)
 142         {
 143         case Metadata_sortkey_relevance:
 144             res = r2->relevance_score - r1->relevance_score;
 145             break;
 146         case Metadata_sortkey_string:
 147             s1 = ut1 ? ut1->text.sort : "";
 148             s2 = ut2 ? ut2->text.sort : "";
 149             res = strcmp(s2, s1);
 150             if (res)
 151             {
 152                 if (s->increasing)
 153                     res *= -1;
 154             }
 155             break;
 156         case Metadata_sortkey_numeric:
 157             if (ut1 && ut2)
 158             {
 159                 if (s->increasing)
 160                     res = ut1->number.min  - ut2->number.min;
 161                 else
 162                     res = ut2->number.max  - ut1->number.max;
 163             }
 164             else if (ut1 && !ut2)
 165                 res = -1;
 166             else if (!ut1 && ut2)
 167                 res = 1;
 168             else
 169                 res = 0;
 170             break;
 171         case Metadata_sortkey_position:
 172             if (r1->records && r2->records)
 173             {
 174                 int pos1 = 0, pos2 = 0;
 175                 struct record *rec;
 176                 for (rec = r1->records; rec; rec = rec->next)
 177                     if (pos1 == 0 || rec->position < pos1)
 178                         pos1 = rec->position;
 179                 for (rec = r2->records; rec; rec = rec->next)
 180                     if (pos2 == 0 || rec->position < pos2)
 181                         pos2 = rec->position;
 182                 if (s->increasing)
 183                     res = pos1 - pos2;
 184                 else
 185                     res = pos2 - pos1;
 186             }
 187             break;
 188         default:
 189             yaz_log(YLOG_WARN, "Bad sort type: %d", s->type);
 190             res = 0;
 191         }
 192     }
 193     if (res == 0)
 194         res = strcmp(r1->recid, r2->recid);
 195     return res;
 196 }
 197
 198 void reclist_sort(struct reclist *l, struct reclist_sortparms *parms)
 199 {
 200     struct reclist_bucket **flatlist = xmalloc(sizeof(*flatlist) * l->num_records);
 201     struct reclist_bucket *ptr;
 202     struct reclist_bucket **prev;
 203     int i = 0;
 204
 205     reclist_enter(l);
 206
 207     ptr = l->sorted_list;
 208     prev = &l->sorted_list;
 209     while (ptr)
 210     {
 211         ptr->sort_parms = parms;
 212         flatlist[i] = ptr;
 213         ptr = ptr->snext;
 214         i++;
 215     }
 216     assert(i == l->num_records);
 217
 218     qsort(flatlist, l->num_records, sizeof(*flatlist), reclist_cmp);
 219     for (i = 0; i < l->num_records; i++)
 220     {
 221         *prev = flatlist[i];
 222         prev = &flatlist[i]->snext;
 223     }
 224     *prev = 0;
 225     l->last = prev;
 226
 227     xfree(flatlist);
 228
 229     reclist_leave(l);
 230 }
 231
 232 struct record_cluster *reclist_read_record(struct reclist *l)
 233 {
 234     if (l && l->sorted_ptr)
 235     {
 236         struct record_cluster *t = l->sorted_ptr->record;
 237         l->sorted_ptr = l->sorted_ptr->snext;
 238         return t;
 239     }
 240     else
 241         return 0;
 242 }
 243
 244 void reclist_enter(struct reclist *l)
 245 {
 246     yaz_mutex_enter(l->mutex);
 247     if (l)
 248         l->sorted_ptr = l->sorted_list;
 249 }
 250
 251
 252 void reclist_leave(struct reclist *l)
 253 {
 254     yaz_mutex_leave(l->mutex);
 255     if (l)
 256         l->sorted_ptr = l->sorted_list;
 257 }
 258
 259
 260 struct reclist *reclist_create(NMEM nmem)
 261 {
 262     struct reclist *res = nmem_malloc(nmem, sizeof(struct reclist));
 263     res->hash_size = 399;
 264     res->hashtable
 265         = nmem_malloc(nmem, res->hash_size * sizeof(struct reclist_bucket*));
 266     memset(res->hashtable, 0, res->hash_size * sizeof(struct reclist_bucket*));
 267     res->nmem = nmem;
 268
 269     res->sorted_ptr = 0;
 270     res->sorted_list = 0;
 271     res->last = &res->sorted_list;
 272
 273     res->num_records = 0;
 274     res->mutex = 0;
 275     pazpar2_mutex_create(&res->mutex, "reclist");
 276     return res;
 277 }
 278
 279 void reclist_destroy(struct reclist *l)
 280 {
 281     if (l)
 282         yaz_mutex_destroy(&l->mutex);
 283 }
 284
 285 int reclist_get_num_records(struct reclist *l)
 286 {
 287     if (l)
 288         return l->num_records;
 289     return 0;
 290 }
 291
 292 // Insert a record. Return record cluster (newly formed or pre-existing)
 293 struct record_cluster *reclist_insert(struct reclist *l,
 294                                       struct conf_service *service,
 295                                       struct record *record,
 296                                       const char *merge_key, int *total)
 297 {
 298     unsigned int bucket;
 299     struct reclist_bucket **p;
 300     struct record_cluster *cluster = 0;
 301
 302     assert(service);
 303     assert(l);
 304     assert(record);
 305     assert(merge_key);
 306     assert(total);
 307
 308     bucket = jenkins_hash((unsigned char*) merge_key) % l->hash_size;
 309
 310     yaz_mutex_enter(l->mutex);
 311     for (p = &l->hashtable[bucket]; *p; p = &(*p)->hnext)
 312     {
 313         // We found a matching record. Merge them
 314         if (!strcmp(merge_key, (*p)->record->merge_key))
 315         {
 316             struct record_cluster *existing = (*p)->record;
 317             struct record *re = existing->records;
 318
 319             for (; re; re = re->next)
 320             {
 321                 if (re->client == record->client &&
 322                     record_compare(record, re, service))
 323                 {
 324                     yaz_mutex_leave(l->mutex);
 325                     return 0;
 326                 }
 327             }
 328             record->next = existing->records;
 329             existing->records = record;
 330             cluster = existing;
 331             break;
 332         }
 333     }
 334     if (!cluster)
 335     {
 336         struct reclist_bucket *new =
 337             nmem_malloc(l->nmem, sizeof(*new));
 338
 339         cluster = nmem_malloc(l->nmem, sizeof(*cluster));
 340
 341         record->next = 0;
 342         new->record = cluster;
 343         new->hnext = 0;
 344         cluster->records = record;
 345         cluster->merge_key = nmem_strdup(l->nmem, merge_key);
 346         cluster->relevance_score = 0;
 347         cluster->term_frequency_vec = 0;
 348         cluster->recid = nmem_strdup(l->nmem, merge_key);
 349         (*total)++;
 350         cluster->metadata =
 351             nmem_malloc(l->nmem,
 352                         sizeof(struct record_metadata*) * service->num_metadata);
 353         memset(cluster->metadata, 0,
 354                sizeof(struct record_metadata*) * service->num_metadata);
 355         cluster->sortkeys =
 356             nmem_malloc(l->nmem, sizeof(struct record_metadata*) * service->num_sortkeys);
 357         memset(cluster->sortkeys, 0,
 358                sizeof(union data_types*) * service->num_sortkeys);
 359
 360         /* attach to hash list */
 361         *p = new;
 362
 363         /* append to sorted_list */
 364         *l->last = new;
 365         l->last = &new->snext;
 366         l->sorted_ptr = l->sorted_list;
 367         new->snext = 0;
 368
 369         l->num_records++;
 370     }
 371     yaz_mutex_leave(l->mutex);
 372     return cluster;
 373 }
 374
 375 /*
 376  * Local variables:
 377  * c-basic-offset: 4
 378  * c-file-style: "Stroustrup"
 379  * indent-tabs-mode: nil
 380  * End:
 381  * vim: shiftwidth=4 tabstop=8 expandtab
 382  */
 383