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 "session.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 struct reclist_bucket
  46 {
  47     struct record_cluster *record;
  48     struct reclist_bucket *hnext;
  49     struct reclist_bucket *snext;
  50     struct reclist_sortparms *sort_parms;
  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 reclist_sortparms *sortparms =
 124         (*(struct reclist_bucket **) p1)->sort_parms;
 125     struct record_cluster *r1 = (*(struct reclist_bucket**) p1)->record;
 126     struct record_cluster *r2 = (*(struct reclist_bucket**) p2)->record;
 127     struct reclist_sortparms *s;
 128     int res = 0;
 129
 130     for (s = sortparms; s && res == 0; s = s->next)
 131     {
 132         union data_types *ut1 = r1->sortkeys[s->offset];
 133         union data_types *ut2 = r2->sortkeys[s->offset];
 134         const char *s1, *s2;
 135         switch (s->type)
 136         {
 137         case Metadata_sortkey_relevance:
 138             res = r2->relevance_score - r1->relevance_score;
 139             break;
 140         case Metadata_sortkey_string:
 141             s1 = ut1 ? ut1->text.sort : "";
 142             s2 = ut2 ? ut2->text.sort : "";
 143             res = strcmp(s2, s1);
 144             if (res)
 145             {
 146                 if (s->increasing)
 147                     res *= -1;
 148             }
 149             break;
 150         case Metadata_sortkey_numeric:
 151             if (ut1 && ut2)
 152             {
 153                 if (s->increasing)
 154                     res = ut1->number.min  - ut2->number.min;
 155                 else
 156                     res = ut2->number.max  - ut1->number.max;
 157             }
 158             else if (ut1 && !ut2)
 159                 res = -1;
 160             else if (!ut1 && ut2)
 161                 res = 1;
 162             else
 163                 res = 0;
 164             break;
 165         default:
 166             yaz_log(YLOG_WARN, "Bad sort type: %d", s->type);
 167             res = 0;
 168         }
 169     }
 170     if (res == 0)
 171         res = strcmp(r1->recid, r2->recid);
 172     return res;
 173 }
 174
 175 void reclist_sort(struct reclist *l, struct reclist_sortparms *parms)
 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         ptr->sort_parms = parms;
 189         flatlist[i] = ptr;
 190         ptr = ptr->snext;
 191         i++;
 192     }
 193     assert(i == l->num_records);
 194
 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     if (l)
 259         yaz_mutex_destroy(&l->mutex);
 260 }
 261
 262 int reclist_get_num_records(struct reclist *l)
 263 {
 264     if (l)
 265         return l->num_records;
 266     return 0;
 267 }
 268
 269 // Insert a record. Return record cluster (newly formed or pre-existing)
 270 struct record_cluster *reclist_insert(struct reclist *l,
 271                                       struct conf_service *service,
 272                                       struct record *record,
 273                                       const char *merge_key, int *total)
 274 {
 275     unsigned int bucket;
 276     struct reclist_bucket **p;
 277     struct record_cluster *cluster = 0;
 278
 279     assert(service);
 280     assert(l);
 281     assert(record);
 282     assert(merge_key);
 283     assert(total);
 284
 285     bucket = jenkins_hash((unsigned char*) merge_key) % l->hash_size;
 286
 287     yaz_mutex_enter(l->mutex);
 288     for (p = &l->hashtable[bucket]; *p; p = &(*p)->hnext)
 289     {
 290         // We found a matching record. Merge them
 291         if (!strcmp(merge_key, (*p)->record->merge_key))
 292         {
 293             struct record_cluster *existing = (*p)->record;
 294             record->next = existing->records;
 295             existing->records = record;
 296             cluster = existing;
 297             break;
 298         }
 299     }
 300     if (!cluster)
 301     {
 302         struct reclist_bucket *new =
 303             nmem_malloc(l->nmem, sizeof(*new));
 304
 305         cluster = nmem_malloc(l->nmem, sizeof(*cluster));
 306
 307         record->next = 0;
 308         new->record = cluster;
 309         new->hnext = 0;
 310         cluster->records = record;
 311         cluster->merge_key = nmem_strdup(l->nmem, merge_key);
 312         cluster->relevance_score = 0;
 313         cluster->term_frequency_vec = 0;
 314         cluster->recid = nmem_strdup(l->nmem, merge_key);
 315         (*total)++;
 316         cluster->metadata =
 317             nmem_malloc(l->nmem,
 318                         sizeof(struct record_metadata*) * service->num_metadata);
 319         memset(cluster->metadata, 0,
 320                sizeof(struct record_metadata*) * service->num_metadata);
 321         cluster->sortkeys =
 322             nmem_malloc(l->nmem, sizeof(struct record_metadata*) * service->num_sortkeys);
 323         memset(cluster->sortkeys, 0,
 324                sizeof(union data_types*) * service->num_sortkeys);
 325
 326         /* attach to hash list */
 327         *p = new;
 328
 329         /* append to sorted_list */
 330         *l->last = new;
 331         l->last = &new->snext;
 332         l->sorted_ptr = l->sorted_list;
 333         new->snext = 0;
 334
 335         l->num_records++;
 336     }
 337     yaz_mutex_leave(l->mutex);
 338     return cluster;
 339 }
 340
 341 /*
 342  * Local variables:
 343  * c-basic-offset: 4
 344  * c-file-style: "Stroustrup"
 345  * indent-tabs-mode: nil
 346  * End:
 347  * vim: shiftwidth=4 tabstop=8 expandtab
 348  */
 349