Generic sort mechanism. Sort supported by relevance, string, or string w/o lead.
[pazpar2-moved-to-github.git] / src / reclists.c
1 /*
2  * $Id: reclists.c,v 1.7 2007-01-15 04:34:28 quinn Exp $
3  */
4
5 #include <assert.h>
6
7 #if HAVE_CONFIG_H
8 #include <cconfig.h>
9 #endif
10
11 #include <yaz/yaz-util.h>
12
13 #include "pazpar2.h"
14 #include "reclists.h"
15
16 extern struct parameters global_parameters;
17
18 // Not threadsafe
19 static struct reclist_sortparms *sortparms = 0;
20
21 struct reclist_bucket
22 {
23     struct record_cluster *record;
24     struct reclist_bucket *next;
25 };
26
27 struct reclist_sortparms *reclist_parse_sortparms(NMEM nmem, const char *parms)
28 {
29     struct reclist_sortparms *res = 0;
30     struct reclist_sortparms **rp = &res;
31     struct conf_service *service = config->servers->service;
32
33     if (strlen(parms) > 256)
34         return 0;
35     while (*parms)
36     {
37         char parm[256];
38         char *pp;
39         const char *cpp;
40         int increasing;
41         int i;
42         int offset;
43         enum conf_sortkey_type type;
44         struct reclist_sortparms *new;
45
46         if (!(cpp = strchr(parms, ',')))
47             cpp = parms + strlen(parms);
48         strncpy(parm, parms, cpp - parms); 
49         parm[cpp-parms] = '\0';
50
51         if ((pp = strchr(parm, ':')))
52         {
53             increasing = pp[1] == '1' ? 1 : 0;
54             *pp = '\0';
55         }
56         else
57             increasing = 0;
58         if (!strcmp(parm, "relevance"))
59         {
60             type = Metadata_sortkey_relevance;
61             offset = -1;
62         }
63         else
64         {
65             for (i = 0; i < service->num_sortkeys; i++)
66             {
67                 struct conf_sortkey *sk = &service->sortkeys[i];
68                 if (!strcmp(sk->name, parm))
69                 {
70                     type = sk->type;
71                     if (type == Metadata_sortkey_skiparticle)
72                         type = Metadata_sortkey_string;
73                     break;
74                 }
75             }
76             if (i >= service->num_sortkeys)
77             {
78                 yaz_log(YLOG_FATAL, "Bad sortkey: %s", parm);
79                 return 0;
80             }
81             else
82                 offset = i;
83         }
84         new = *rp = nmem_malloc(nmem, sizeof(struct reclist_sortparms));
85         new->next = 0;
86         new->offset = offset;
87         new->type = type;
88         new->increasing = increasing;
89         rp = &new->next;
90         if (*(parms = cpp))
91             parms++;
92     }
93     return res;
94 }
95
96 static int reclist_cmp(const void *p1, const void *p2)
97 {
98     struct record_cluster *r1 = (*(struct record_cluster**) p1);
99     struct record_cluster *r2 = (*(struct record_cluster**) p2);
100     struct reclist_sortparms *s;
101
102     for (s = sortparms; s; s = s->next)
103     {
104         int res;
105         switch (s->type)
106         {
107             case Metadata_sortkey_relevance:
108                 res = r2->relevance - r1->relevance;
109                 break;
110             case Metadata_sortkey_string:
111                 res = strcmp(r2->sortkeys[s->offset]->text, r1->sortkeys[s->offset]->text);
112                 break;
113             case Metadata_sortkey_numeric:
114                 res = 0;
115                 break;
116             default:
117                 yaz_log(YLOG_FATAL, "Bad sort type: %d", s->type);
118                 exit(1);
119         }
120         if (res)
121         {
122             if (s->increasing)
123                 res *= -1;
124             return res;
125         }
126     }
127     return 0;
128 }
129
130 void reclist_sort(struct reclist *l, struct reclist_sortparms *parms)
131 {
132     sortparms = parms;
133     qsort(l->flatlist, l->num_records, sizeof(struct record_cluster*), reclist_cmp);
134     reclist_rewind(l);
135 }
136
137 struct record_cluster *reclist_read_record(struct reclist *l)
138 {
139     if (l->pointer < l->num_records)
140         return l->flatlist[l->pointer++];
141     else
142         return 0;
143 }
144
145 void reclist_rewind(struct reclist *l)
146 {
147     l->pointer = 0;
148 }
149
150 // Jenkins one-at-a-time hash (from wikipedia)
151 static unsigned int hash(const unsigned char *key)
152 {
153     unsigned int hash = 0;
154
155     while (*key)
156     {
157         hash += *(key++);
158         hash += (hash << 10);
159         hash ^= (hash >> 6);
160     }
161     hash += (hash << 3);
162     hash ^= (hash >> 11);
163     hash += (hash << 15);
164     return hash;
165 }
166
167 struct reclist *reclist_create(NMEM nmem, int numrecs)
168 {
169     int hashsize = 1;
170     struct reclist *res;
171
172     assert(numrecs);
173     while (hashsize < numrecs)
174         hashsize <<= 1;
175     res = nmem_malloc(nmem, sizeof(struct reclist));
176     res->hashtable = nmem_malloc(nmem, hashsize * sizeof(struct reclist_bucket*));
177     memset(res->hashtable, 0, hashsize * sizeof(struct reclist_bucket*));
178     res->hashtable_size = hashsize;
179     res->nmem = nmem;
180     res->hashmask = hashsize - 1; // Creates a bitmask
181
182     res->num_records = 0;
183     res->flatlist = nmem_malloc(nmem, numrecs * sizeof(struct record_cluster*));
184     res->flatlist_size = numrecs;
185
186     return res;
187 }
188
189 // Insert a record. Return record cluster (newly formed or pre-existing)
190 struct record_cluster *reclist_insert(struct reclist *l, struct record  *record,
191         char *merge_key, int *total)
192 {
193     unsigned int bucket;
194     struct reclist_bucket **p;
195     struct record_cluster *cluster = 0;
196     struct conf_service *service = global_parameters.server->service;
197
198     bucket = hash((unsigned char*) merge_key) & l->hashmask;
199     for (p = &l->hashtable[bucket]; *p; p = &(*p)->next)
200     {
201         // We found a matching record. Merge them
202         if (!strcmp(merge_key, (*p)->record->merge_key))
203         {
204             struct record_cluster *existing = (*p)->record;
205             record->next = existing->records;
206             existing->records = record;
207             cluster = existing;
208             break;
209         }
210     }
211     if (!cluster && l->num_records < l->flatlist_size)
212     {
213         struct reclist_bucket *new =
214             nmem_malloc(l->nmem, sizeof(struct reclist_bucket));
215         struct record_cluster *newc =
216             nmem_malloc(l->nmem, sizeof(struct record_cluster));
217         
218         record->next = 0;
219         new->record = newc;
220         new->next = 0;
221         newc->records = record;
222         newc->merge_key = merge_key;
223         newc->relevance = 0;
224         newc->term_frequency_vec = 0;
225         newc->recid = (*total)++;
226         newc->metadata = nmem_malloc(l->nmem,
227                 sizeof(struct record_metadata*) * service->num_metadata);
228         memset(newc->metadata, 0, sizeof(struct record_metadata*) * service->num_metadata);
229         newc->sortkeys = nmem_malloc(l->nmem,
230                 sizeof(struct record_metadata*) * service->num_sortkeys);
231         memset(newc->sortkeys, 0, sizeof(union data_types*) * service->num_sortkeys);
232
233         *p = new;
234         l->flatlist[l->num_records++] = newc;
235         cluster = newc;
236     }
237     return cluster;
238 }
239
240
241 /*
242  * Local variables:
243  * c-basic-offset: 4
244  * indent-tabs-mode: nil
245  * End:
246  * vim: shiftwidth=4 tabstop=8 expandtab
247  */