1 /* This file is part of Pazpar2.
2 Copyright (C) Index Data
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
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
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
26 #include <yaz/yaz-util.h>
31 #include "jenkins_hash.h"
35 struct reclist_bucket **hashtable;
39 struct record_cluster *sorted_list;
40 struct record_cluster *sorted_ptr;
47 struct record_cluster *record;
48 struct reclist_bucket *hash_next;
51 static void append_merge_keys(struct record_metadata_attr **p,
52 const struct record_metadata_attr *a,
55 for (; a; a = a->next)
57 struct record_metadata_attr **pi = p;
58 for (; *pi; pi = &(*pi)->next)
59 if (!strcmp((*pi)->value, a->value))
63 *pi = (struct record_metadata_attr *) nmem_malloc(nmem, sizeof(**p));
64 (*pi)->name = nmem_strdup_null(nmem, a->name);
65 (*pi)->value = nmem_strdup_null(nmem, a->value);
71 struct reclist_sortparms *reclist_parse_sortparms(NMEM nmem, const char *parms,
72 struct conf_service *service)
74 struct reclist_sortparms *res = 0;
75 struct reclist_sortparms **rp = &res;
77 if (strlen(parms) > 256)
87 enum conf_metadata_type type = Metadata_type_generic;
88 struct reclist_sortparms *new;
90 if (!(cpp = strchr(parms, ',')))
91 cpp = parms + strlen(parms);
92 strncpy(parm, parms, cpp - parms);
93 parm[cpp-parms] = '\0';
95 if ((pp = strchr(parm, ':')))
99 else if (pp[1] == '0')
103 yaz_log(YLOG_FATAL, "Bad sortkey modifier: %s", parm);
110 type = Metadata_type_position;
112 yaz_log(YLOG_FATAL, "Bad sortkey modifier: %s", parm);
116 if (type != Metadata_type_position)
118 if (!strcmp(parm, "relevance"))
120 type = Metadata_type_relevance;
122 else if (!strcmp(parm, "position"))
124 type = Metadata_type_position;
126 else if (!strcmp(parm, "retrieval"))
128 type = Metadata_type_retrieval;
132 for (i = 0; i < service->num_sortkeys; i++)
134 struct conf_sortkey *sk = &service->sortkeys[i];
135 if (!strcmp(sk->name, parm))
141 if (i >= service->num_sortkeys)
143 yaz_log(YLOG_FATAL, "Sortkey not defined in service: %s",
151 yaz_log(YLOG_FATAL, "Sortkey not defined in service: %s",
156 new = *rp = nmem_malloc(nmem, sizeof(struct reclist_sortparms));
158 new->offset = offset;
160 new->increasing = increasing;
161 new->name = nmem_strdup(nmem, parm);
169 static int reclist_cmp(const void *p1, const void *p2)
171 struct record_cluster *r1 = (*(struct record_cluster**) p1);
172 struct record_cluster *r2 = (*(struct record_cluster**) p2);
173 struct reclist_sortparms *sortparms = r1->sort_parms;
174 struct reclist_sortparms *s;
177 for (s = sortparms; s && res == 0; s = s->next)
179 union data_types *ut1 = r1->sortkeys[s->offset];
180 union data_types *ut2 = r2->sortkeys[s->offset];
184 case Metadata_type_relevance:
185 res = r1->relevance_score - r2->relevance_score;
187 case Metadata_type_generic:
188 case Metadata_type_skiparticle:
189 s1 = ut1 ? ut1->text.sort : "";
190 s2 = ut2 ? ut2->text.sort : "";
191 res = strcmp(s1, s2);
193 case Metadata_type_year:
194 case Metadata_type_date:
198 res = ut1->number.min - ut2->number.min;
200 res = ut1->number.max - ut2->number.max;
202 else if (ut1 && !ut2)
204 res = -1; /* without date/year: last! */
207 else if (!ut1 && ut2)
209 res = 1; /* without date/year: last! */
215 case Metadata_type_position:
216 if (r1->records && r2->records)
218 int pos1 = 0, pos2 = 0;
220 for (rec = r1->records; rec; rec = rec->next)
221 if (pos1 == 0 || rec->position < pos1)
222 pos1 = rec->position;
223 for (rec = r2->records; rec; rec = rec->next)
224 if (pos2 == 0 || rec->position < pos2)
225 pos2 = rec->position;
230 case Metadata_type_float:
233 if (ut1->fnumber == ut2->fnumber)
235 else if (ut1->fnumber > ut2->fnumber)
247 case Metadata_type_retrieval:
248 res = r1->retrieval_position - r2->retrieval_position;
251 if (res && !s->increasing)
255 res = strcmp(r1->recid, r2->recid);
259 void reclist_limit(struct reclist *l, struct session *se, int lazy)
263 struct record_cluster **pp = &l->sorted_list;
269 for (i = 0; i < l->hash_size; i++)
271 struct reclist_bucket *p;
272 for (p = l->hashtable[i]; p; p = p->hash_next)
273 p->record->sorted_next = 0;
275 for (i = 0; i < l->hash_size; i++)
277 struct reclist_bucket *p;
278 for (p = l->hashtable[i]; p; p = p->hash_next)
280 if (session_check_cluster_limit(se, p->record))
282 if (!p->record->sorted_next)
285 pp = &p->record->sorted_next;
286 *pp = p->record; /* signal already in use */
294 l->num_records = num;
298 void reclist_sort(struct reclist *l, struct reclist_sortparms *parms)
300 struct record_cluster **flatlist = xmalloc(sizeof(*flatlist) * l->num_records);
301 struct record_cluster *ptr;
302 struct record_cluster **prev;
307 ptr = l->sorted_list;
308 prev = &l->sorted_list;
311 ptr->sort_parms = parms;
313 ptr = ptr->sorted_next;
316 assert(i == l->num_records);
318 qsort(flatlist, l->num_records, sizeof(*flatlist), reclist_cmp);
319 for (i = 0; i < l->num_records; i++)
322 prev = &flatlist[i]->sorted_next;
331 struct record_cluster *reclist_read_record(struct reclist *l)
333 if (l && l->sorted_ptr)
335 struct record_cluster *t = l->sorted_ptr;
336 l->sorted_ptr = l->sorted_ptr->sorted_next;
343 void reclist_enter(struct reclist *l)
345 yaz_mutex_enter(l->mutex);
346 l->sorted_ptr = l->sorted_list;
350 void reclist_leave(struct reclist *l)
352 yaz_mutex_leave(l->mutex);
353 l->sorted_ptr = l->sorted_list;
356 void reclist_rewind(struct reclist *l)
358 l->sorted_ptr = l->sorted_list;
362 struct reclist *reclist_create(NMEM nmem)
364 struct reclist *res = nmem_malloc(nmem, sizeof(struct reclist));
365 res->hash_size = 399;
367 = nmem_malloc(nmem, res->hash_size * sizeof(struct reclist_bucket*));
368 memset(res->hashtable, 0, res->hash_size * sizeof(struct reclist_bucket*));
372 res->sorted_list = 0;
374 res->num_records = 0;
376 pazpar2_mutex_create(&res->mutex, "reclist");
380 void reclist_destroy(struct reclist *l)
385 for (i = 0; i < l->hash_size; i++)
387 struct reclist_bucket *p;
388 for (p = l->hashtable[i]; p; p = p->hash_next)
390 wrbuf_destroy(p->record->relevance_explain1);
391 wrbuf_destroy(p->record->relevance_explain2);
392 p->record->relevance_explain1 = 0;
393 p->record->relevance_explain2 = 0;
396 yaz_mutex_destroy(&l->mutex);
400 int reclist_get_num_records(struct reclist *l)
403 return l->num_records;
407 static void merge_cluster(struct reclist *l,
409 struct record_cluster *dst,
410 struct record_cluster *src)
412 struct record_metadata_attr *mkl;
413 struct record **rp = &dst->records;
414 for (; *rp; rp = &(*rp)->next)
418 for (mkl = src->merge_keys; mkl; mkl = mkl->next)
420 const char *merge_key = mkl->value;
421 unsigned int bucket =
422 jenkins_hash((unsigned char*) merge_key) % l->hash_size;
423 struct reclist_bucket *p;
425 for (p = l->hashtable[bucket]; p; p = p->hash_next)
426 if (p->record == src)
430 /* not merging metadata and sortkeys yet */
432 relevance_mergerec(r, dst, src);
434 wrbuf_puts(dst->relevance_explain1, wrbuf_cstr(src->relevance_explain1));
435 wrbuf_puts(dst->relevance_explain2, wrbuf_cstr(src->relevance_explain2));
437 wrbuf_destroy(src->relevance_explain1);
438 src->relevance_explain1 = 0;
439 wrbuf_destroy(src->relevance_explain2);
440 src->relevance_explain2 = 0;
442 append_merge_keys(&dst->merge_keys, src->merge_keys, l->nmem);
445 static struct record_cluster *new_cluster(
448 struct conf_service *service,
449 struct record *record,
450 struct record_metadata_attr *merge_keys
453 struct record_cluster *cluster;
454 cluster = nmem_malloc(l->nmem, sizeof(*cluster));
457 cluster->retrieval_position = l->num_records;
458 cluster->records = record;
459 cluster->merge_keys = 0;
460 append_merge_keys(&cluster->merge_keys, merge_keys, l->nmem);
461 cluster->relevance_score = 0;
462 cluster->recid = cluster->merge_keys->value;
465 sizeof(struct record_metadata*) * service->num_metadata);
466 memset(cluster->metadata, 0,
467 sizeof(struct record_metadata*) * service->num_metadata);
469 nmem_malloc(l->nmem, sizeof(struct record_metadata*) * service->num_sortkeys);
470 memset(cluster->sortkeys, 0,
471 sizeof(union data_types*) * service->num_sortkeys);
472 relevance_newrec(r, cluster);
473 cluster->relevance_explain1 = wrbuf_alloc();
474 cluster->relevance_explain2 = wrbuf_alloc();
475 /* attach to hash list */
477 l->sorted_list = l->sorted_ptr = 0;
481 // Insert a record. Return record cluster (newly formed or pre-existing)
482 struct record_cluster *reclist_insert(struct reclist *l,
484 struct conf_service *service,
485 struct record *record,
486 struct record_metadata_attr *merge_keys,
489 struct record_cluster *cluster = 0;
490 struct record_metadata_attr *mkl = merge_keys;
498 yaz_mutex_enter(l->mutex);
500 for (; mkl; mkl = mkl->next)
502 const char *merge_key = mkl->value;
503 unsigned int bucket =
504 jenkins_hash((unsigned char*) merge_key) % l->hash_size;
505 struct reclist_bucket **p;
506 struct reclist_bucket *rb = 0;
508 for (p = &l->hashtable[bucket]; *p; p = &(*p)->hash_next)
510 struct record_metadata_attr *mkr = (*p)->record->merge_keys;
511 for (; mkr; mkr = mkr->next)
513 // We found a matching record. Merge them
514 if (!strcmp(merge_key, mkr->value))
520 for (re = &rb->record->records; *re; re = &(*re)->next)
522 if ((*re)->client == record->client &&
523 record_compare(record, *re, service))
525 yaz_mutex_leave(l->mutex);
529 cluster = rb->record;
535 if (cluster != rb->record)
537 assert(rb->record->relevance_explain1);
538 merge_cluster(l, r, cluster, rb->record);
548 cluster = new_cluster(l, r, service, record, merge_keys);
553 rb = nmem_malloc(l->nmem, sizeof(*rb));
554 rb->record = cluster;
560 yaz_mutex_leave(l->mutex);
564 int reclist_sortparms_cmp(struct reclist_sortparms *sort1, struct reclist_sortparms *sort2)
569 if (sort1 == 0 || sort2 == 0)
571 rc = strcmp(sort1->name, sort2->name) || sort1->increasing != sort2->increasing || sort1->type != sort2->type;
577 * c-file-style: "Stroustrup"
578 * indent-tabs-mode: nil
580 * vim: shiftwidth=4 tabstop=8 expandtab