src/reclists.c

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