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