7b6e78a974f9a9307151747296505b7138c0da41
[pazpar2-moved-to-github.git] / src / session.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 /** \file session.c
21     \brief high-level logic; mostly user sessions and settings
22 */
23
24 #if HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27
28 #include <time.h>
29 #include <stdlib.h>
30 #include <stdio.h>
31 #include <string.h>
32 #if HAVE_SYS_TIME_H
33 #include <sys/time.h>
34 #endif
35 #if HAVE_UNISTD_H
36 #include <unistd.h>
37 #endif
38 #ifdef WIN32
39 #include <windows.h>
40 #endif
41 #include <signal.h>
42 #include <ctype.h>
43 #include <assert.h>
44 #include <math.h>
45
46 #include <yaz/marcdisp.h>
47 #include <yaz/comstack.h>
48 #include <yaz/tcpip.h>
49 #include <yaz/proto.h>
50 #include <yaz/readconf.h>
51 #include <yaz/pquery.h>
52 #include <yaz/otherinfo.h>
53 #include <yaz/yaz-util.h>
54 #include <yaz/nmem.h>
55 #include <yaz/query-charset.h>
56 #include <yaz/querytowrbuf.h>
57 #include <yaz/oid_db.h>
58 #include <yaz/snprintf.h>
59 #include <yaz/gettimeofday.h>
60
61 #define USE_TIMING 0
62 #if USE_TIMING
63 #include <yaz/timing.h>
64 #endif
65
66 #include "ppmutex.h"
67 #include "parameters.h"
68 #include "session.h"
69 #include "eventl.h"
70 #include "http.h"
71 #include "termlists.h"
72 #include "reclists.h"
73 #include "relevance.h"
74 #include "database.h"
75 #include "client.h"
76 #include "settings.h"
77 #include "normalize7bit.h"
78
79 #define TERMLIST_HIGH_SCORE 25
80
81 #define MAX_CHUNK 15
82
83 #define MAX(a,b) ((a)>(b)?(a):(b))
84
85 // Note: Some things in this structure will eventually move to configuration
86 struct parameters global_parameters = 
87 {
88     0,   // dump_records
89     0,   // debug_mode
90     0,   // predictable sessions
91 };
92
93 struct client_list {
94     struct client *client;
95     struct client_list *next;
96 };
97
98 /* session counting (1) , disable client counting (0) */
99 static YAZ_MUTEX g_session_mutex = 0;
100 static int no_sessions = 0;
101
102 static int session_use(int delta)
103 {
104     int sessions;
105     if (!g_session_mutex)
106         yaz_mutex_create(&g_session_mutex);
107     yaz_mutex_enter(g_session_mutex);
108     no_sessions += delta;
109     sessions = no_sessions;
110     yaz_mutex_leave(g_session_mutex);
111     yaz_log(YLOG_DEBUG, "%s sesions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), no_sessions);
112     return sessions;
113 }
114
115 int sessions_count(void) {
116     return session_use(0);
117 }
118
119 static void log_xml_doc(xmlDoc *doc)
120 {
121     FILE *lf = yaz_log_file();
122     xmlChar *result = 0;
123     int len = 0;
124 #if LIBXML_VERSION >= 20600
125     xmlDocDumpFormatMemory(doc, &result, &len, 1);
126 #else
127     xmlDocDumpMemory(doc, &result, &len);
128 #endif
129     if (lf && len)
130     {
131         (void) fwrite(result, 1, len, lf);
132         fprintf(lf, "\n");
133     }
134     xmlFree(result);
135 }
136
137 static void session_enter(struct session *s)
138 {
139     yaz_mutex_enter(s->session_mutex);
140 }
141
142 static void session_leave(struct session *s)
143 {
144     yaz_mutex_leave(s->session_mutex);
145 }
146
147 // Recursively traverse query structure to extract terms.
148 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
149 {
150     char **words;
151     int numwords;
152     int i;
153
154     switch (n->kind)
155     {
156     case CCL_RPN_AND:
157     case CCL_RPN_OR:
158     case CCL_RPN_NOT:
159     case CCL_RPN_PROX:
160         pull_terms(nmem, n->u.p[0], termlist, num);
161         pull_terms(nmem, n->u.p[1], termlist, num);
162         break;
163     case CCL_RPN_TERM:
164         nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
165         for (i = 0; i < numwords; i++)
166             termlist[(*num)++] = words[i];
167         break;
168     default: // NOOP
169         break;
170     }
171 }
172
173
174 void add_facet(struct session *s, const char *type, const char *value, int count)
175 {
176     struct conf_service *service = s->service;
177     pp2_relevance_token_t prt;
178     const char *facet_component;
179     WRBUF facet_wrbuf = wrbuf_alloc();
180     prt = pp2_relevance_tokenize(service->facet_pct);
181     
182     pp2_relevance_first(prt, value, 0);
183     while ((facet_component = pp2_relevance_token_next(prt)))
184     {
185         if (*facet_component)
186         {
187             if (wrbuf_len(facet_wrbuf))
188                 wrbuf_puts(facet_wrbuf, " ");
189             wrbuf_puts(facet_wrbuf, facet_component);
190         }
191     }
192     pp2_relevance_token_destroy(prt);
193     
194     if (wrbuf_len(facet_wrbuf))
195     {
196         int i;
197         for (i = 0; i < s->num_termlists; i++)
198             if (!strcmp(s->termlists[i].name, type))
199                 break;
200         if (i == s->num_termlists)
201         {
202             if (i == SESSION_MAX_TERMLISTS)
203             {
204                 session_log(s, YLOG_FATAL, "Too many termlists");
205                 wrbuf_destroy(facet_wrbuf);
206                 return;
207             }
208             
209             s->termlists[i].name = nmem_strdup(s->nmem, type);
210             s->termlists[i].termlist 
211                 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
212             s->num_termlists = i + 1;
213         }
214         
215 #if 0
216         session_log(s, YLOG_DEBUG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
217 #endif
218         termlist_insert(s->termlists[i].termlist, wrbuf_cstr(facet_wrbuf),
219                         count);
220     }
221     wrbuf_destroy(facet_wrbuf);
222 }
223
224 static xmlDoc *record_to_xml(struct session *se,
225                              struct session_database *sdb, const char *rec)
226 {
227     struct database *db = sdb->database;
228     xmlDoc *rdoc = 0;
229
230     rdoc = xmlParseMemory(rec, strlen(rec));
231
232     if (!rdoc)
233     {
234         session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
235                     db->url);
236         return 0;
237     }
238
239     if (global_parameters.dump_records)
240     {
241         session_log(se, YLOG_LOG, "Un-normalized record from %s", db->url);
242         log_xml_doc(rdoc);
243     }
244
245     return rdoc;
246 }
247
248 #define MAX_XSLT_ARGS 16
249
250 // Add static values from session database settings if applicable
251 static void insert_settings_parameters(struct session_database *sdb,
252                                        struct conf_service *service,
253                                        char **parms,
254                                        NMEM nmem)
255 {
256     int i;
257     int nparms = 0;
258     int offset = 0;
259
260     for (i = 0; i < service->num_metadata; i++)
261     {
262         struct conf_metadata *md = &service->metadata[i];
263         int setting;
264
265         if (md->setting == Metadata_setting_parameter &&
266             (setting = settings_lookup_offset(service, md->name)) >= 0)
267         {
268             const char *val = session_setting_oneval(sdb, setting);
269             if (val && nparms < MAX_XSLT_ARGS)
270             {
271                 char *buf;
272                 int len = strlen(val);
273                 buf = nmem_malloc(nmem, len + 3);
274                 buf[0] = '\'';
275                 strcpy(buf + 1, val);
276                 buf[len+1] = '\'';
277                 buf[len+2] = '\0';
278                 parms[offset++] = md->name;
279                 parms[offset++] = buf;
280                 nparms++;
281             }
282         }
283     }
284     parms[offset] = 0;
285 }
286
287 // Add static values from session database settings if applicable
288 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
289     struct conf_service *service)
290 {
291     int i;
292
293     for (i = 0; i < service->num_metadata; i++)
294     {
295         struct conf_metadata *md = &service->metadata[i];
296         int offset;
297
298         if (md->setting == Metadata_setting_postproc &&
299             (offset = settings_lookup_offset(service, md->name)) >= 0)
300         {
301             const char *val = session_setting_oneval(sdb, offset);
302             if (val)
303             {
304                 xmlNode *r = xmlDocGetRootElement(doc);
305                 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
306                                              (xmlChar *) val);
307                 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
308             }
309         }
310     }
311 }
312
313 static xmlDoc *normalize_record(struct session *se,
314                                 struct session_database *sdb,
315                                 struct conf_service *service,
316                                 const char *rec, NMEM nmem)
317 {
318     xmlDoc *rdoc = record_to_xml(se, sdb, rec);
319
320     if (rdoc)
321     {
322         char *parms[MAX_XSLT_ARGS*2+1];
323         
324         insert_settings_parameters(sdb, service, parms, nmem);
325         
326         if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
327         {
328             session_log(se, YLOG_WARN, "Normalize failed from %s",
329                         sdb->database->url);
330         }
331         else
332         {
333             insert_settings_values(sdb, rdoc, service);
334             
335             if (global_parameters.dump_records)
336             {
337                 session_log(se, YLOG_LOG, "Normalized record from %s", 
338                             sdb->database->url);
339                 log_xml_doc(rdoc);
340             }
341         }
342     }
343     return rdoc;
344 }
345
346 void session_settings_dump(struct session *se,
347                            struct session_database *db,
348                            WRBUF w)
349 {
350     if (db->settings)
351     {
352         int i, num = db->num_settings;
353         for (i = 0; i < num; i++)
354         {
355             struct setting *s = db->settings[i];
356             for (;s ; s = s->next)
357             {
358                 wrbuf_puts(w, "<set name=\"");
359                 wrbuf_xmlputs(w, s->name);
360                 wrbuf_puts(w, "\" value=\"");
361                 wrbuf_xmlputs(w, s->value);
362                 wrbuf_puts(w, "\"/>");
363             }
364             if (db->settings[i])
365                 wrbuf_puts(w, "\n");
366         }
367     }
368 }
369
370 // Retrieve first defined value for 'name' for given database.
371 // Will be extended to take into account user associated with session
372 const char *session_setting_oneval(struct session_database *db, int offset)
373 {
374     if (offset >= db->num_settings || !db->settings[offset])
375         return "";
376     return db->settings[offset]->value;
377 }
378
379 // Prepare XSLT stylesheets for record normalization
380 // Structures are allocated on the session_wide nmem to avoid having
381 // to recompute this for every search. This would lead
382 // to leaking if a single session was to repeatedly change the PZ_XSLT
383 // setting. However, this is not a realistic use scenario.
384 static int prepare_map(struct session *se, struct session_database *sdb)
385 {
386     const char *s;
387
388     if (!sdb->settings)
389     {
390         session_log(se, YLOG_WARN, "No settings on %s", sdb->database->url);
391         return -1;
392     }
393     if ((s = session_setting_oneval(sdb, PZ_XSLT)))
394     {
395         char auto_stylesheet[256];
396
397         if (!strcmp(s, "auto"))
398         {
399             const char *request_syntax = session_setting_oneval(
400                 sdb, PZ_REQUESTSYNTAX);
401             if (request_syntax)
402             {
403                 char *cp;
404                 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
405                              "%s.xsl", request_syntax);
406                 for (cp = auto_stylesheet; *cp; cp++)
407                 {
408                     /* deliberately only consider ASCII */
409                     if (*cp > 32 && *cp < 127)
410                         *cp = tolower(*cp);
411                 }
412                 s = auto_stylesheet;
413             }
414             else
415             {
416                 session_log(se, YLOG_WARN,
417                             "No pz:requestsyntax for auto stylesheet");
418             }
419         }
420         sdb->map = normalize_cache_get(se->normalize_cache,
421                                        se->service->server->config, s);
422         if (!sdb->map)
423             return -1;
424     }
425     return 0;
426 }
427
428 // This analyzes settings and recomputes any supporting data structures
429 // if necessary.
430 static int prepare_session_database(struct session *se, 
431                                     struct session_database *sdb)
432 {
433     if (!sdb->settings)
434     {
435         session_log(se, YLOG_WARN, 
436                 "No settings associated with %s", sdb->database->url);
437         return -1;
438     }
439     if (sdb->settings[PZ_XSLT] && !sdb->map)
440     {
441         if (prepare_map(se, sdb) < 0)
442             return -1;
443     }
444     return 0;
445 }
446
447 // called if watch should be removed because http_channel is to be destroyed
448 static void session_watch_cancel(void *data, struct http_channel *c,
449                                  void *data2)
450 {
451     struct session_watchentry *ent = data;
452
453     ent->fun = 0;
454     ent->data = 0;
455     ent->obs = 0;
456 }
457
458 // set watch. Returns 0=OK, -1 if watch is already set
459 int session_set_watch(struct session *s, int what, 
460                       session_watchfun fun, void *data,
461                       struct http_channel *chan)
462 {
463     int ret;
464     session_enter(s);
465     if (s->watchlist[what].fun)
466         ret = -1;
467     else
468     {
469         
470         s->watchlist[what].fun = fun;
471         s->watchlist[what].data = data;
472         s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
473                                                    session_watch_cancel);
474         ret = 0;
475     }
476     session_leave(s);
477     return 0;
478 }
479
480 void session_alert_watch(struct session *s, int what)
481 {
482     assert(s);
483     session_enter(s);
484     if (s->watchlist[what].fun)
485     {
486         /* our watch is no longer associated with http_channel */
487         void *data;
488         session_watchfun fun;
489
490         http_remove_observer(s->watchlist[what].obs);
491         fun  = s->watchlist[what].fun;
492         data = s->watchlist[what].data;
493
494         /* reset watch before fun is invoked - in case fun wants to set
495            it again */
496         s->watchlist[what].fun = 0;
497         s->watchlist[what].data = 0;
498         s->watchlist[what].obs = 0;
499
500         session_leave(s);
501         session_log(s, YLOG_DEBUG,
502                     "Alert Watch: %d calling function: %p", what, fun);
503         fun(data);
504     }
505     else
506         session_leave(s);
507 }
508
509 //callback for grep_databases
510 static void select_targets_callback(void *context, struct session_database *db)
511 {
512     struct session *se = (struct session*) context;
513     struct client *cl = client_create();
514     struct client_list *l;
515     client_set_database(cl, db);
516
517     client_set_session(cl, se);
518
519     l = xmalloc(sizeof(*l));
520     l->client = cl;
521     l->next = se->clients;
522     se->clients = l;
523 }
524
525 static void session_remove_clients(struct session *se)
526 {
527     struct client_list *l;
528
529     session_enter(se);
530     l = se->clients;
531     se->clients = 0;
532     session_leave(se);
533
534     while (l)
535     {
536         struct client_list *l_next = l->next;
537         client_lock(l->client);
538         client_set_session(l->client, 0);
539         client_set_database(l->client, 0);
540         client_unlock(l->client);
541         client_destroy(l->client);
542         xfree(l);
543         l = l_next;
544     }
545 }
546
547 // Associates a set of clients with a session;
548 // Note: Session-databases represent databases with per-session 
549 // setting overrides
550 static int select_targets(struct session *se, const char *filter)
551 {
552     return session_grep_databases(se, filter, select_targets_callback);
553 }
554
555 int session_active_clients(struct session *s)
556 {
557     struct client_list *l;
558     int res = 0;
559
560     for (l = s->clients; l; l = l->next)
561         if (client_is_active(l->client))
562             res++;
563
564     return res;
565 }
566
567 int session_is_preferred_clients_ready(struct session *s)
568 {
569     struct client_list *l;
570     int res = 0;
571
572     for (l = s->clients; l; l = l->next)
573         if (client_is_active_preferred(l->client))
574             res++;
575     session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
576     return res == 0;
577 }
578
579
580
581 enum pazpar2_error_code search(struct session *se,
582                                const char *query,
583                                const char *startrecs, const char *maxrecs,
584                                const char *filter,
585                                const char **addinfo)
586 {
587     int live_channels = 0;
588     int no_working = 0;
589     int no_failed = 0;
590     struct client_list *l;
591     struct timeval tval;
592
593     session_log(se, YLOG_DEBUG, "Search");
594
595     *addinfo = 0;
596
597     session_remove_clients(se);
598     
599     session_enter(se);
600     reclist_destroy(se->reclist);
601     se->reclist = 0;
602     relevance_destroy(&se->relevance);
603     nmem_reset(se->nmem);
604     se->total_records = se->total_hits = se->total_merged = 0;
605     se->num_termlists = 0;
606     live_channels = select_targets(se, filter);
607     if (!live_channels)
608     {
609         session_leave(se);
610         return PAZPAR2_NO_TARGETS;
611     }
612     se->reclist = reclist_create(se->nmem);
613
614     yaz_gettimeofday(&tval);
615     
616     tval.tv_sec += 5;
617
618     for (l = se->clients; l; l = l->next)
619     {
620         struct client *cl = l->client;
621
622         if (maxrecs)
623             client_set_maxrecs(cl, atoi(maxrecs));
624         if (startrecs)
625             client_set_startrecs(cl, atoi(startrecs));
626         if (prepare_session_database(se, client_get_database(cl)) < 0)
627             ;
628         else if (client_parse_query(cl, query) < 0)
629             no_failed++;
630         else
631         {
632             no_working++;
633             if (client_prep_connection(cl, se->service->z3950_operation_timeout,
634                                        se->service->z3950_session_timeout,
635                                        se->service->server->iochan_man,
636                                        &tval))
637                 client_start_search(cl);
638         }
639     }
640     session_leave(se);
641     if (no_working == 0)
642     {
643         if (no_failed > 0)
644         {
645             *addinfo = "query";
646             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
647         }
648         else
649             return PAZPAR2_NO_TARGETS;
650     }
651     return PAZPAR2_NO_ERROR;
652 }
653
654 // Creates a new session_database object for a database
655 static void session_init_databases_fun(void *context, struct database *db)
656 {
657     struct session *se = (struct session *) context;
658     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
659     int i;
660
661     new->database = db;
662     
663     new->map = 0;
664     assert(db->settings);
665     new->settings = nmem_malloc(se->session_nmem,
666                                 sizeof(struct settings *) * db->num_settings);
667     new->num_settings = db->num_settings;
668     for (i = 0; i < db->num_settings; i++)
669     {
670         struct setting *setting = db->settings[i];
671         new->settings[i] = setting;
672     }
673     new->next = se->databases;
674     se->databases = new;
675 }
676
677 // Doesn't free memory associated with sdb -- nmem takes care of that
678 static void session_database_destroy(struct session_database *sdb)
679 {
680     sdb->map = 0;
681 }
682
683 // Initialize session_database list -- this represents this session's view
684 // of the database list -- subject to modification by the settings ws command
685 void session_init_databases(struct session *se)
686 {
687     se->databases = 0;
688     predef_grep_databases(se, se->service, session_init_databases_fun);
689 }
690
691 // Probably session_init_databases_fun should be refactored instead of
692 // called here.
693 static struct session_database *load_session_database(struct session *se, 
694                                                       char *id)
695 {
696     struct database *db = new_database(id, se->session_nmem);
697
698     resolve_database(se->service, db);
699
700     session_init_databases_fun((void*) se, db);
701
702     // New sdb is head of se->databases list
703     return se->databases;
704 }
705
706 // Find an existing session database. If not found, load it
707 static struct session_database *find_session_database(struct session *se, 
708                                                       char *id)
709 {
710     struct session_database *sdb;
711
712     for (sdb = se->databases; sdb; sdb = sdb->next)
713         if (!strcmp(sdb->database->url, id))
714             return sdb;
715     return load_session_database(se, id);
716 }
717
718 // Apply a session override to a database
719 void session_apply_setting(struct session *se, char *dbname, char *setting,
720                            char *value)
721 {
722     struct session_database *sdb = find_session_database(se, dbname);
723     struct conf_service *service = se->service;
724     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
725     int offset = settings_create_offset(service, setting);
726
727     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
728                           se->session_nmem);
729     new->precedence = 0;
730     new->target = dbname;
731     new->name = setting;
732     new->value = value;
733     new->next = sdb->settings[offset];
734     sdb->settings[offset] = new;
735
736     // Force later recompute of settings-driven data structures
737     // (happens when a search starts and client connections are prepared)
738     switch (offset)
739     {
740     case PZ_XSLT:
741         if (sdb->map)
742         {
743             sdb->map = 0;
744         }
745         break;
746     }
747 }
748
749 void destroy_session(struct session *se)
750 {
751     struct session_database *sdb;
752     session_log(se, YLOG_DEBUG, "Destroying");
753     session_use(-1);
754     session_remove_clients(se);
755
756     for (sdb = se->databases; sdb; sdb = sdb->next)
757         session_database_destroy(sdb);
758     normalize_cache_destroy(se->normalize_cache);
759     relevance_destroy(&se->relevance);
760     reclist_destroy(se->reclist);
761     nmem_destroy(se->nmem);
762     service_destroy(se->service);
763     yaz_mutex_destroy(&se->session_mutex);
764     wrbuf_destroy(se->wrbuf);
765 }
766
767 size_t session_get_memory_status(struct session *session) {
768     size_t session_nmem;
769     if (session == 0)
770         return 0;
771     session_enter(session);
772     session_nmem = nmem_total(session->nmem);
773     session_leave(session);
774     return session_nmem;
775 }
776
777
778 struct session *new_session(NMEM nmem, struct conf_service *service,
779                             unsigned session_id)
780 {
781     int i;
782     struct session *session = nmem_malloc(nmem, sizeof(*session));
783
784     char tmp_str[50];
785
786     sprintf(tmp_str, "session#%u", session_id);
787
788     session->session_id = session_id;
789     session_log(session, YLOG_DEBUG, "New");
790     session->service = service;
791     session->relevance = 0;
792     session->total_hits = 0;
793     session->total_records = 0;
794     session->number_of_warnings_unknown_elements = 0;
795     session->number_of_warnings_unknown_metadata = 0;
796     session->num_termlists = 0;
797     session->reclist = 0;
798     session->clients = 0;
799     session->session_nmem = nmem;
800     session->nmem = nmem_create();
801     session->wrbuf = wrbuf_alloc();
802     session->databases = 0;
803     for (i = 0; i <= SESSION_WATCH_MAX; i++)
804     {
805         session->watchlist[i].data = 0;
806         session->watchlist[i].fun = 0;
807     }
808     session->normalize_cache = normalize_cache_create();
809     session->session_mutex = 0;
810     pazpar2_mutex_create(&session->session_mutex, tmp_str);
811     session_use(1);
812     return session;
813 }
814
815 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
816 {
817     struct hitsbytarget *res = 0;
818     struct client_list *l;
819     size_t sz = 0;
820
821     session_enter(se);
822     for (l = se->clients; l; l = l->next)
823         sz++;
824
825     res = nmem_malloc(nmem, sizeof(*res) * sz);
826     *count = 0;
827     for (l = se->clients; l; l = l->next)
828     {
829         struct client *cl = l->client;
830         WRBUF w = wrbuf_alloc();
831         const char *name = session_setting_oneval(client_get_database(cl),
832                                                   PZ_NAME);
833
834         res[*count].id = client_get_database(cl)->database->url;
835         res[*count].name = *name ? name : "Unknown";
836         res[*count].hits = client_get_hits(cl);
837         res[*count].records = client_get_num_records(cl);
838         res[*count].diagnostic = client_get_diagnostic(cl);
839         res[*count].state = client_get_state_str(cl);
840         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
841         session_settings_dump(se, client_get_database(cl), w);
842         res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
843         wrbuf_destroy(w);
844         (*count)++;
845     }
846     session_leave(se);
847     return res;
848 }
849
850 struct termlist_score **termlist(struct session *se, const char *name, int *num)
851 {
852     int i;
853     struct termlist_score **tl = 0;
854
855     session_enter(se);
856     for (i = 0; i < se->num_termlists; i++)
857         if (!strcmp((const char *) se->termlists[i].name, name))
858         {
859             tl = termlist_highscore(se->termlists[i].termlist, num);
860             break;
861         }
862     session_leave(se);
863     return tl;
864 }
865
866 #ifdef MISSING_HEADERS
867 void report_nmem_stats(void)
868 {
869     size_t in_use, is_free;
870
871     nmem_get_memory_in_use(&in_use);
872     nmem_get_memory_free(&is_free);
873
874     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld", 
875             (long) in_use, (long) is_free);
876 }
877 #endif
878
879 struct record_cluster *show_single_start(struct session *se, const char *id,
880                                          struct record_cluster **prev_r,
881                                          struct record_cluster **next_r)
882 {
883     struct record_cluster *r = 0;
884
885     session_enter(se);
886     *prev_r = 0;
887     *next_r = 0;
888     if (se->reclist)
889     {
890         reclist_enter(se->reclist);
891         while ((r = reclist_read_record(se->reclist)))
892         {
893             if (!strcmp(r->recid, id))
894             {
895                 *next_r = reclist_read_record(se->reclist);
896                 break;
897             }
898             *prev_r = r;
899         }
900         reclist_leave(se->reclist);
901     }
902     if (!r)
903         session_leave(se);
904     return r;
905 }
906
907 void show_single_stop(struct session *se, struct record_cluster *rec)
908 {
909     session_leave(se);
910 }
911
912 struct record_cluster **show_range_start(struct session *se,
913                                          struct reclist_sortparms *sp, 
914                                          int start, int *num, int *total, Odr_int *sumhits)
915 {
916     struct record_cluster **recs;
917     struct reclist_sortparms *spp;
918     int i;
919 #if USE_TIMING    
920     yaz_timing_t t = yaz_timing_create();
921 #endif
922     session_enter(se);
923     recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
924     if (!se->relevance)
925     {
926         *num = 0;
927         *total = 0;
928         *sumhits = 0;
929         recs = 0;
930     }
931     else
932     {
933         for (spp = sp; spp; spp = spp->next)
934             if (spp->type == Metadata_sortkey_relevance)
935             {
936                 relevance_prepare_read(se->relevance, se->reclist);
937                 break;
938             }
939         reclist_sort(se->reclist, sp);
940         
941         reclist_enter(se->reclist);
942         *total = reclist_get_num_records(se->reclist);
943         *sumhits = se->total_hits;
944         
945         for (i = 0; i < start; i++)
946             if (!reclist_read_record(se->reclist))
947             {
948                 *num = 0;
949                 recs = 0;
950                 break;
951             }
952         
953         for (i = 0; i < *num; i++)
954         {
955             struct record_cluster *r = reclist_read_record(se->reclist);
956             if (!r)
957             {
958                 *num = i;
959                 break;
960             }
961             recs[i] = r;
962         }
963         reclist_leave(se->reclist);
964     }
965 #if USE_TIMING
966     yaz_timing_stop(t);
967     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f", 
968             yaz_timing_get_real(t), yaz_timing_get_user(t),
969             yaz_timing_get_sys(t));
970     yaz_timing_destroy(&t);
971 #endif
972     return recs;
973 }
974
975 void show_range_stop(struct session *se, struct record_cluster **recs)
976 {
977     session_leave(se);
978 }
979
980 void statistics(struct session *se, struct statistics *stat)
981 {
982     struct client_list *l;
983     int count = 0;
984
985     memset(stat, 0, sizeof(*stat));
986     for (l = se->clients; l; l = l->next)
987     {
988         struct client *cl = l->client;
989         if (!client_get_connection(cl))
990             stat->num_no_connection++;
991         switch (client_get_state(cl))
992         {
993         case Client_Connecting: stat->num_connecting++; break;
994         case Client_Working: stat->num_working++; break;
995         case Client_Idle: stat->num_idle++; break;
996         case Client_Failed: stat->num_failed++; break;
997         case Client_Error: stat->num_error++; break;
998         default: break;
999         }
1000         count++;
1001     }
1002     stat->num_hits = se->total_hits;
1003     stat->num_records = se->total_records;
1004
1005     stat->num_clients = count;
1006 }
1007
1008 static struct record_metadata *record_metadata_init(
1009     NMEM nmem, const char *value, enum conf_metadata_type type,
1010     struct _xmlAttr *attr)
1011 {
1012     struct record_metadata *rec_md = record_metadata_create(nmem);
1013     struct record_metadata_attr **attrp = &rec_md->attributes;
1014     
1015     for (; attr; attr = attr->next)
1016     {
1017         if (attr->children && attr->children->content)
1018         {
1019             if (strcmp((const char *) attr->name, "type"))
1020             {  /* skip the "type" attribute.. Its value is already part of
1021                   the element in output (md-%s) and so repeating it here
1022                   is redundant */
1023                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1024                 (*attrp)->name =
1025                     nmem_strdup(nmem, (const char *) attr->name);
1026                 (*attrp)->value =
1027                     nmem_strdup(nmem, (const char *) attr->children->content);
1028                 attrp = &(*attrp)->next;
1029             }
1030         }
1031     }
1032     *attrp = 0;
1033
1034     if (type == Metadata_type_generic)
1035     {
1036         char *p = nmem_strdup(nmem, value);
1037
1038         p = normalize7bit_generic(p, " ,/.:([");
1039         
1040         rec_md->data.text.disp = p;
1041         rec_md->data.text.sort = 0;
1042     }
1043     else if (type == Metadata_type_year || type == Metadata_type_date)
1044     {
1045         int first, last;
1046         int longdate = 0;
1047
1048         if (type == Metadata_type_date)
1049             longdate = 1;
1050         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1051             return 0;
1052
1053         rec_md->data.number.min = first;
1054         rec_md->data.number.max = last;
1055     }
1056     else
1057         return 0;
1058     return rec_md;
1059 }
1060
1061 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1062                                  struct conf_service *service, WRBUF norm_wr)
1063 {
1064     xmlNode *n;
1065     int no_found = 0;
1066     for (n = root->children; n; n = n->next)
1067     {
1068         if (n->type != XML_ELEMENT_NODE)
1069             continue;
1070         if (!strcmp((const char *) n->name, "metadata"))
1071         {
1072             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1073             if (type == NULL) {
1074                 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1075             }
1076             else if (!strcmp(name, (const char *) type))
1077             {
1078                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1079                 if (value)
1080                 {
1081                     const char *norm_str;
1082                     pp2_relevance_token_t prt =
1083                         pp2_relevance_tokenize(service->mergekey_pct);
1084                     
1085                     pp2_relevance_first(prt, (const char *) value, 0);
1086                     if (wrbuf_len(norm_wr) > 0)
1087                         wrbuf_puts(norm_wr, " ");
1088                     wrbuf_puts(norm_wr, name);
1089                     while ((norm_str =
1090                             pp2_relevance_token_next(prt)))
1091                     {
1092                         if (*norm_str)
1093                         {
1094                             wrbuf_puts(norm_wr, " ");
1095                             wrbuf_puts(norm_wr, norm_str);
1096                         }
1097                     }
1098                     xmlFree(value);
1099                     pp2_relevance_token_destroy(prt);
1100                     no_found++;
1101                 }
1102             }
1103             xmlFree(type);
1104         }
1105     }
1106     return no_found;
1107 }
1108
1109 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1110                                 struct conf_service *service, NMEM nmem)
1111 {
1112     char *mergekey_norm = 0;
1113     xmlNode *root = xmlDocGetRootElement(doc);
1114     WRBUF norm_wr = wrbuf_alloc();
1115
1116     /* consider mergekey from XSL first */
1117     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1118     if (mergekey)
1119     {
1120         const char *norm_str;
1121         pp2_relevance_token_t prt =
1122             pp2_relevance_tokenize(service->mergekey_pct);
1123
1124         pp2_relevance_first(prt, (const char *) mergekey, 0);
1125         while ((norm_str = pp2_relevance_token_next(prt)))
1126         {
1127             if (*norm_str)
1128             {
1129                 if (wrbuf_len(norm_wr))
1130                     wrbuf_puts(norm_wr, " ");
1131                 wrbuf_puts(norm_wr, norm_str);
1132             }
1133         }
1134         pp2_relevance_token_destroy(prt);
1135         xmlFree(mergekey);
1136     }
1137     else
1138     {
1139         /* no mergekey defined in XSL. Look for mergekey metadata instead */
1140         int field_id;
1141         for (field_id = 0; field_id < service->num_metadata; field_id++)
1142         {
1143             struct conf_metadata *ser_md = &service->metadata[field_id];
1144             if (ser_md->mergekey != Metadata_mergekey_no)
1145             {
1146                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1147                                               service, norm_wr);
1148                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1149                 {
1150                     /* no mergekey on this one and it is required.. 
1151                        Generate unique key instead */
1152                     wrbuf_rewind(norm_wr);
1153                     break;
1154                 }
1155             }
1156         }
1157     }
1158
1159     /* generate unique key if none is not generated already or is empty */
1160     if (wrbuf_len(norm_wr) == 0)
1161     {
1162         wrbuf_printf(norm_wr, "%s-%d",
1163                      client_get_database(cl)->database->url, record_no);
1164     }
1165     if (wrbuf_len(norm_wr) > 0)
1166         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1167     wrbuf_destroy(norm_wr);
1168     return mergekey_norm;
1169 }
1170
1171 /** \brief see if metadata for pz:recordfilter exists 
1172     \param root xml root element of normalized record
1173     \param sdb session database for client
1174     \retval 0 if there is no metadata for pz:recordfilter
1175     \retval 1 if there is metadata for pz:recordfilter
1176
1177     If there is no pz:recordfilter defined, this function returns 1
1178     as well.
1179 */
1180     
1181 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1182 {
1183     int match = 0;
1184     xmlNode *n;
1185     const char *s;
1186     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1187
1188     if (!s || !*s)
1189         return 1;
1190
1191     for (n = root->children; n; n = n->next)
1192     {
1193         if (n->type != XML_ELEMENT_NODE)
1194             continue;
1195         if (!strcmp((const char *) n->name, "metadata"))
1196         {
1197             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1198             if (type)
1199             {
1200                 size_t len;
1201                 int substring;
1202                 const char *eq;
1203
1204                 if ((eq = strchr(s, '=')))
1205                     substring = 0;
1206                 else if ((eq = strchr(s, '~')))
1207                     substring = 1;
1208                 if (eq)
1209                     len = eq - s;
1210                 else
1211                     len = strlen(s);
1212                 if (len == strlen((const char *)type) &&
1213                     !memcmp((const char *) type, s, len))
1214                 {
1215                     xmlChar *value = xmlNodeGetContent(n);
1216                     if (value && *value)
1217                     {
1218                         if (!eq ||
1219                             (substring && strstr((const char *) value, eq+1)) ||
1220                             (!substring && !strcmp((const char *) value, eq + 1)))
1221                             match = 1;
1222                     }
1223                     xmlFree(value);
1224                 }
1225                 xmlFree(type);
1226             }
1227         }
1228     }
1229     return match;
1230 }
1231
1232
1233 static int ingest_to_cluster(struct client *cl,
1234                              xmlDoc *xdoc,
1235                              xmlNode *root,
1236                              int record_no,
1237                              const char *mergekey_norm);
1238
1239 /** \brief ingest XML record
1240     \param cl client holds the result set for record
1241     \param rec record buffer (0 terminated)
1242     \param record_no record position (1, 2, ..)
1243     \param nmem working NMEM
1244     \retval 0 OK
1245     \retval -1 failure
1246 */
1247 int ingest_record(struct client *cl, const char *rec,
1248                   int record_no, NMEM nmem)
1249 {
1250     struct session *se = client_get_session(cl);
1251     int ret = 0;
1252     struct session_database *sdb = client_get_database(cl);
1253     struct conf_service *service = se->service;
1254     xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1255     xmlNode *root;
1256     const char *mergekey_norm;
1257     
1258     if (!xdoc)
1259         return -1;
1260     
1261     root = xmlDocGetRootElement(xdoc);
1262     
1263     if (!check_record_filter(root, sdb))
1264     {
1265         session_log(se, YLOG_WARN, "Filtered out record no %d from %s",
1266                     record_no, sdb->database->url);
1267         xmlFreeDoc(xdoc);
1268         return -1;
1269     }
1270     
1271     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1272     if (!mergekey_norm)
1273     {
1274         session_log(se, YLOG_WARN, "Got no mergekey");
1275         xmlFreeDoc(xdoc);
1276         return -1;
1277     }
1278     session_enter(se);
1279     if (client_get_session(cl) == se)
1280         ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1281     session_leave(se);
1282     
1283     xmlFreeDoc(xdoc);
1284     return ret;
1285 }
1286
1287 static int ingest_to_cluster(struct client *cl,
1288                              xmlDoc *xdoc,
1289                              xmlNode *root,
1290                              int record_no,
1291                              const char *mergekey_norm)
1292 {
1293     xmlNode *n;
1294     xmlChar *type = 0;
1295     xmlChar *value = 0;
1296     struct session_database *sdb = client_get_database(cl);
1297     struct session *se = client_get_session(cl);
1298     struct conf_service *service = se->service;
1299     struct record *record = record_create(se->nmem, 
1300                                           service->num_metadata,
1301                                           service->num_sortkeys, cl,
1302                                           record_no);
1303     struct record_cluster *cluster = reclist_insert(se->reclist,
1304                                                     service, 
1305                                                     record,
1306                                                     mergekey_norm,
1307                                                     &se->total_merged);
1308
1309     const char *use_term_factor_str = session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1310     int use_term_factor = 0;
1311     int term_factor = 1; 
1312     if (use_term_factor_str && use_term_factor_str[0] != 0)
1313        use_term_factor =  atoi(use_term_factor_str);
1314     if (use_term_factor) {
1315         int maxrecs = client_get_maxrecs(cl);
1316         int hits = (int) client_get_hits(cl);
1317         term_factor = MAX(hits, maxrecs) /  MAX(1, maxrecs);
1318         assert(term_factor >= 1);
1319         yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1320     }
1321
1322     if (!cluster)
1323         return -1;
1324     if (global_parameters.dump_records)
1325         session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1326                     sdb->database->url, record_no);
1327     relevance_newrec(se->relevance, cluster);
1328     
1329     // now parsing XML record and adding data to cluster or record metadata
1330     for (n = root->children; n; n = n->next)
1331     {
1332         pp2_relevance_token_t prt;
1333         if (type)
1334             xmlFree(type);
1335         if (value)
1336             xmlFree(value);
1337         type = value = 0;
1338         
1339         if (n->type != XML_ELEMENT_NODE)
1340             continue;
1341         if (!strcmp((const char *) n->name, "metadata"))
1342         {
1343             struct conf_metadata *ser_md = 0;
1344             struct conf_sortkey *ser_sk = 0;
1345             struct record_metadata **wheretoput = 0;
1346             struct record_metadata *rec_md = 0;
1347             int md_field_id = -1;
1348             int sk_field_id = -1;
1349             
1350             type = xmlGetProp(n, (xmlChar *) "type");
1351             value = xmlNodeListGetString(xdoc, n->children, 1);
1352             
1353             if (!type || !value || !*value)
1354                 continue;
1355             
1356             md_field_id 
1357                 = conf_service_metadata_field_id(service, (const char *) type);
1358             if (md_field_id < 0)
1359             {
1360                 if (se->number_of_warnings_unknown_metadata == 0)
1361                 {
1362                     session_log(se, YLOG_WARN, 
1363                             "Ignoring unknown metadata element: %s", type);
1364                 }
1365                 se->number_of_warnings_unknown_metadata++;
1366                 continue;
1367             }
1368             
1369             ser_md = &service->metadata[md_field_id];
1370             
1371             if (ser_md->sortkey_offset >= 0){
1372                 sk_field_id = ser_md->sortkey_offset;
1373                 ser_sk = &service->sortkeys[sk_field_id];
1374             }
1375
1376             // non-merged metadata
1377             rec_md = record_metadata_init(se->nmem, (const char *) value,
1378                                           ser_md->type, n->properties);
1379             if (!rec_md)
1380             {
1381                 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1382                             "for element '%s'", value, type);
1383                 continue;
1384             }
1385             wheretoput = &record->metadata[md_field_id];
1386             while (*wheretoput)
1387                 wheretoput = &(*wheretoput)->next;
1388             *wheretoput = rec_md;
1389
1390             // merged metadata
1391             rec_md = record_metadata_init(se->nmem, (const char *) value,
1392                                           ser_md->type, 0);
1393             wheretoput = &cluster->metadata[md_field_id];
1394
1395             // and polulate with data:
1396             // assign cluster or record based on merge action
1397             if (ser_md->merge == Metadata_merge_unique)
1398             {
1399                 struct record_metadata *mnode;
1400                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1401                     if (!strcmp((const char *) mnode->data.text.disp, 
1402                                 rec_md->data.text.disp))
1403                         break;
1404                 if (!mnode)
1405                 {
1406                     rec_md->next = *wheretoput;
1407                     *wheretoput = rec_md;
1408                 }
1409             }
1410             else if (ser_md->merge == Metadata_merge_longest)
1411             {
1412                 if (!*wheretoput 
1413                     || strlen(rec_md->data.text.disp) 
1414                     > strlen((*wheretoput)->data.text.disp))
1415                 {
1416                     *wheretoput = rec_md;
1417                     if (ser_sk)
1418                     {
1419                         const char *sort_str = 0;
1420                         int skip_article = 
1421                             ser_sk->type == Metadata_sortkey_skiparticle;
1422
1423                         if (!cluster->sortkeys[sk_field_id])
1424                             cluster->sortkeys[sk_field_id] = 
1425                                 nmem_malloc(se->nmem, 
1426                                             sizeof(union data_types));
1427                          
1428                         prt = pp2_relevance_tokenize(service->sort_pct);
1429
1430                         pp2_relevance_first(prt, rec_md->data.text.disp,
1431                                             skip_article);
1432
1433                         pp2_relevance_token_next(prt);
1434                          
1435                         sort_str = pp2_get_sort(prt);
1436                          
1437                         cluster->sortkeys[sk_field_id]->text.disp = 
1438                             rec_md->data.text.disp;
1439                         if (!sort_str)
1440                         {
1441                             sort_str = rec_md->data.text.disp;
1442                             session_log(se, YLOG_WARN, 
1443                                     "Could not make sortkey. Bug #1858");
1444                         }
1445                         cluster->sortkeys[sk_field_id]->text.sort = 
1446                             nmem_strdup(se->nmem, sort_str);
1447                         pp2_relevance_token_destroy(prt);
1448                     }
1449                 }
1450             }
1451             else if (ser_md->merge == Metadata_merge_all)
1452             {
1453                 rec_md->next = *wheretoput;
1454                 *wheretoput = rec_md;
1455             }
1456             else if (ser_md->merge == Metadata_merge_range)
1457             {
1458                 if (!*wheretoput)
1459                 {
1460                     *wheretoput = rec_md;
1461                     if (ser_sk)
1462                         cluster->sortkeys[sk_field_id] 
1463                             = &rec_md->data;
1464                 }
1465                 else
1466                 {
1467                     int this_min = rec_md->data.number.min;
1468                     int this_max = rec_md->data.number.max;
1469                     if (this_min < (*wheretoput)->data.number.min)
1470                         (*wheretoput)->data.number.min = this_min;
1471                     if (this_max > (*wheretoput)->data.number.max)
1472                         (*wheretoput)->data.number.max = this_max;
1473                 }
1474             }
1475
1476
1477             // ranking of _all_ fields enabled ... 
1478             if (ser_md->rank)
1479                 relevance_countwords(se->relevance, cluster, 
1480                                      (char *) value, ser_md->rank,
1481                                      ser_md->name);
1482
1483             // construct facets ... unless the client already has reported them
1484             if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1485             {
1486
1487                 if (ser_md->type == Metadata_type_year)
1488                 {
1489                     char year[64];
1490                     sprintf(year, "%d", rec_md->data.number.max);
1491
1492                     add_facet(se, (char *) type, year, term_factor);
1493                     if (rec_md->data.number.max != rec_md->data.number.min)
1494                     {
1495                         sprintf(year, "%d", rec_md->data.number.min);
1496                         add_facet(se, (char *) type, year, term_factor);
1497                     }
1498                 }
1499                 else
1500                     add_facet(se, (char *) type, (char *) value, term_factor);
1501             }
1502
1503             // cleaning up
1504             xmlFree(type);
1505             xmlFree(value);
1506             type = value = 0;
1507         }
1508         else
1509         {
1510             if (se->number_of_warnings_unknown_elements == 0)
1511                 session_log(se, YLOG_WARN,
1512                         "Unexpected element in internal record: %s", n->name);
1513             se->number_of_warnings_unknown_elements++;
1514         }
1515     }
1516     if (type)
1517         xmlFree(type);
1518     if (value)
1519         xmlFree(value);
1520
1521     relevance_donerecord(se->relevance, cluster);
1522     se->total_records++;
1523
1524     return 0;
1525 }
1526
1527 void session_log(struct session *s, int level, const char *fmt, ...)
1528 {
1529     char buf[1024];
1530     va_list ap;
1531     va_start(ap, fmt);
1532
1533     yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1534     yaz_log(level, "Session (%u): %s", s->session_id, buf);
1535
1536     va_end(ap);
1537 }
1538
1539 /*
1540  * Local variables:
1541  * c-basic-offset: 4
1542  * c-file-style: "Stroustrup"
1543  * indent-tabs-mode: nil
1544  * End:
1545  * vim: shiftwidth=4 tabstop=8 expandtab
1546  */
1547