2 * Copyright (c) 1995, the EUROPAGATE consortium (see below).
4 * The EUROPAGATE consortium members are:
6 * University College Dublin
7 * Danmarks Teknologiske Videnscenter
8 * An Chomhairle Leabharlanna
9 * Consejo Superior de Investigaciones Cientificas
11 * Permission to use, copy, modify, distribute, and sell this software and
12 * its documentation, in whole or in part, for any purpose, is hereby granted,
15 * 1. This copyright and permission notice appear in all copies of the
16 * software and its documentation. Notices of copyright or attribution
17 * which appear at the beginning of any file must remain unchanged.
19 * 2. The names of EUROPAGATE or the project partners may not be used to
20 * endorse or promote products derived from this software without specific
21 * prior written permission.
23 * 3. Users of this software (implementors and gateway operators) agree to
24 * inform the EUROPAGATE consortium of their use of the software. This
25 * information will be used to evaluate the EUROPAGATE project and the
26 * software, and to plan further developments. The consortium may use
27 * the information in later publications.
29 * 4. Users of this software agree to make their best efforts, when
30 * documenting their use of the software, to acknowledge the EUROPAGATE
31 * consortium, and the role played by the software in their work.
33 * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
34 * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
35 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
36 * IN NO EVENT SHALL THE EUROPAGATE CONSORTIUM OR ITS MEMBERS BE LIABLE
37 * FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF
38 * ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
39 * OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND
40 * ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
41 * USE OR PERFORMANCE OF THIS SOFTWARE.
44 /* Gateway kernel - Main
48 * Revision 1.27 1995/05/19 13:25:59 adam
49 * Bug fixes. Better command line options.
51 * Revision 1.26 1995/05/18 12:03:08 adam
52 * Bug fixes and minor improvements.
54 * Revision 1.25 1995/05/16 09:40:42 adam
55 * LICENSE. Setting of CCL token names (and/or/not/set) in read_kernel_res.
57 * Revision 1.24 1995/05/04 10:40:07 adam
58 * More work on Def-settings.
60 * Revision 1.23 1995/05/03 16:34:18 adam
61 * CCL def command, i.e. user definitions - saved as resource files.
63 * Revision 1.22 1995/05/03 07:37:39 adam
64 * CCL commands stop/continue implemented. New functions gw_res_{int,bool}
65 * are used when possible.
67 * Revision 1.21 1995/05/01 16:26:56 adam
68 * More work on resource monitor.
70 * Revision 1.20 1995/05/01 12:43:32 adam
71 * First work on resource monitor program.
73 * Revision 1.19 1995/04/19 16:01:58 adam
74 * Some hacks to get the FIFO communication work!! Isn't reliable.
75 * Resource gw.account added - default account info.
77 * Revision 1.18 1995/04/19 13:19:09 adam
78 * New command: account - for authentication.
80 * Revision 1.17 1995/04/19 10:46:18 adam
81 * Persistency works much better now. New command: status - history-like
83 * Revision 1.16 1995/04/19 07:31:07 adam
84 * First work on Z39.50 persistence.
86 * Revision 1.15 1995/04/17 09:34:30 adam
87 * Timeout (idletime) adjustable. Minor changes in kernel.
89 * Revision 1.14 1995/03/28 11:42:34 adam
90 * First use of string-queue utility.
92 * Revision 1.13 1995/03/28 08:01:25 adam
93 * FIFO existence is used to test for a running kernel.
95 * Revision 1.12 1995/03/27 12:51:05 adam
96 * New log level in use: GW_LOG_ERRNO.
98 * Revision 1.11 1995/03/27 08:24:02 adam
99 * First use of gip interface and gw-db.
100 * First work on eti program.
102 * Revision 1.10 1995/03/01 14:32:25 adam
103 * Better diagnostics. Default is, that only one database selected when
106 * Revision 1.9 1995/02/23 08:32:17 adam
109 * Revision 1.7 1995/02/22 15:22:33 adam
110 * Much more checking of run-time state. Show command never retrieves
111 * more records than indicated by the previous search request. Help
112 * command available. The maximum number of records retrieved can be
115 * Revision 1.6 1995/02/22 08:51:34 adam
116 * Output function can be customized in fml, which is used to print
117 * the reply to reply_fd.
119 * Revision 1.5 1995/02/20 21:16:20 adam
120 * FML support. Bug fixes. Profile for drewdb.
122 * Revision 1.4 1995/02/17 17:06:16 adam
125 * Revision 1.3 1995/02/16 18:35:09 adam
126 * First use of Zdist library. Search requests are supported.
127 * Present requests are not supported yet.
129 * Revision 1.2 1995/02/16 13:21:00 adam
130 * Organization of resource files for targets and conversion
131 * language implemented.
133 * Revision 1.1 1995/02/15 17:45:29 adam
134 * First version of email gateway kernel. Email requests are read
135 * from stdin. The output is transferred to an MTA if 'From' is
136 * found in the header - or stdout if absent. No Z39.50 client is used.
145 #include <sys/types.h>
146 #include <sys/time.h>
150 #include <strqueue.h>
153 FILE *reply_fd = stdout;
155 struct gw_kernel_info info;
157 static void kernel_events (struct str_queue *queue)
159 char fifo_client_name[1024];
160 char fifo_server_name[1024];
167 int continuation = 0;
172 persist_flag = gw_res_bool (info.kernel_res, "gw.persist", 0);
173 timeout = gw_res_int (info.kernel_res, "gw.timeout", 600);
174 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "event loop");
176 sprintf (fifo_client_name, "fifo.c.%d", info.userid);
177 sprintf (fifo_server_name, "fifo.s.%d", info.userid);
179 gip = gips_initialize (fifo_server_name);
180 gips_open (gip, fifo_client_name, 1);
181 gip_fd = gip_infileno (gip);
182 extra_fd = open (fifo_server_name, O_WRONLY);
187 FD_SET (gip_fd, &set_r);
194 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "IPC select");
195 r = select (gip_fd+1, &set_r, NULL, NULL, &tv);
198 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, KERNEL_LOG, "select");
204 gw_log (GW_LOG_STAT, KERNEL_LOG, "Stopping");
206 gw_log (GW_LOG_STAT, KERNEL_LOG, "Timeout after %d seconds",
208 if (info.zass && persist_flag)
209 save_p_state (info.userid);
212 if (FD_ISSET (gip_fd, &set_r))
214 char command[128], *cp;
216 if (!(lgets (command, 127, gip_fd)))
218 gw_log (GW_LOG_WARN, KERNEL_LOG, "Unexpected close");
221 if ((cp = strchr (command, '\n')))
223 gw_log (GW_LOG_STAT, KERNEL_LOG, "IPC: %s", command);
224 if (!strcmp (command, "mail"))
226 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Incoming mail");
227 while (lgets (line_buf, sizeof(line_buf)-1, gip_fd))
228 str_queue_enq (queue, line_buf);
229 urp_start (continuation, queue);
230 if (persist_flag && !continuation)
231 load_p_state (info.userid);
232 r = urp_command (queue);
233 if (r == 1) /* stop? */
235 info.zass = NULL; /* delete association */
236 *info.target = 0; /* indicate no target */
237 read_kernel_res(); /* reread resources */
239 del_p_state (info.userid); /* remove persist file */
242 while (str_queue_deq (queue, 0, 0))
245 else if (!strcmp (command, "stop"))
247 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "stop");
248 while (lgets (line_buf, sizeof(line_buf)-1, gip_fd))
253 gw_log (GW_LOG_WARN, KERNEL_LOG, "Unknown IPC: %s", command);
262 int main (int argc, char **argv)
264 struct str_queue *queue;
266 info.kernel_res = NULL;
267 info.default_res = "default.res";
268 info.override_res = NULL;
274 info.override_portno = NULL;
275 info.override_hostname = NULL;
276 info.databases = NULL;
277 info.database = NULL;
286 info.kernel_res = gw_res_init ();
294 fprintf (stderr, "kernel [options] [resourceFile]\n");
295 fprintf (stderr, "If no resource file is specified");
296 fprintf (stderr, " default.res is used\n");
297 fprintf (stderr, "Options:\n");
298 fprintf (stderr, " -d Enable debugging log\n");
299 fprintf (stderr, " -t target Open target immediately\n");
300 fprintf (stderr, " -g lang Set language\n");
301 fprintf (stderr, " -o resource Override with resource\n");
302 fprintf (stderr, " -h host Override host\n");
303 fprintf (stderr, " -p port Override port\n");
304 fprintf (stderr, " -l log Set Log file\n");
305 fprintf (stderr, " -i id Set IPC userid\n");
308 gw_log_level (GW_LOG_ALL & ~RES_DEBUG);
311 gw_log_level (GW_LOG_ALL);
315 strcpy (info.target, argv[0]+2);
319 strcpy (info.target, *++argv);
323 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing target name");
329 info.lang = argv[0]+2;
337 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing language name");
343 info.override_res = argv[0]+2;
347 info.override_res = *++argv;
351 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing override name");
357 info.override_portno = argv[0]+2;
361 info.override_portno = *++argv;
365 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing portno");
371 info.override_hostname = argv[0]+2;
375 info.override_hostname = *++argv;
379 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing hostname");
385 gw_log_file (GW_LOG_ALL, argv[0]+2);
389 gw_log_file (GW_LOG_ALL, *++argv);
393 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing log filename");
399 info.userid = atoi (argv[0]+2);
403 info.userid = atoi (*++argv);
407 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing user id");
410 gw_log_session (info.userid);
413 gw_log (GW_LOG_FATAL, KERNEL_LOG, "unknown option %s;"
414 " use -H for help", *argv);
419 info.default_res = *argv;
421 if (!(queue = str_queue_mk ()))
423 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, KERNEL_LOG, "str_queue_mk");
426 if (info.userid != -1)
429 kernel_events (queue);
435 while (lgets (line_buf, sizeof(line_buf)-1, 0))
436 str_queue_enq (queue, line_buf);
437 urp_start (0, queue);
444 struct gw_user_set *user_set_add (const char *name, int hits,
445 const char *database,
446 struct ccl_rpn_node *rpn,
448 const char *search_str)
450 struct gw_user_set *s;
452 s = malloc (sizeof (*s));
455 s->name = gw_strdup (name);
457 s->database = gw_strdup (database);
459 s->present_flag = present_flag;
460 s->search_str = gw_strdup (search_str);
466 void user_set_init (void)
468 struct gw_user_set *s, *s1;
470 for (s = info.sets; s; s = s1)
474 ccl_rpn_delete (s->rpn);
481 struct gw_user_set *user_set_search (const char *name)
483 struct gw_user_set *s;
487 for (s = info.sets; s; s = s->prev)
488 if (!strcmp (s->name, name))
494 static void fml_inf_write (int ch)
498 static FILE *fml_inf;
500 static int fml_inf_read (void)
502 return getc (fml_inf);
506 void read_kernel_res (void)
508 char path_prefix[128];
512 char resource_name[256];
517 ccl_qual_rm (&info.bibset);
518 info.bibset = ccl_qual_mk ();
521 gw_res_close (info.kernel_res);
522 info.kernel_res = gw_res_init ();
524 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading kernel resource, default %s",
527 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading kernel resource, target %s",
530 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading kernel resource, lang %s",
533 /* read default resources. These should exist */
534 if (gw_res_merge (info.kernel_res, info.default_res))
536 gw_log (GW_LOG_WARN, KERNEL_LOG, "Couldn't read resource file %s",
540 strcpy (path_prefix, gw_res_get (info.kernel_res, "gw.path", "."));
542 /* fetch target definitions (if defined at all) */
545 sprintf (resource_name, "gw.target.%s", info.target);
546 v = gw_res_get (info.kernel_res, resource_name, NULL);
549 sprintf (fname, "%s/%s", path_prefix, v);
550 gw_res_merge (info.kernel_res, fname);
553 /* fetch user definitions (if user-id is specified) */
554 if (info.userid >= 0)
556 sprintf (fname, "%s/user.%d.r", path_prefix, info.userid);
557 gw_res_merge (info.kernel_res, fname);
559 /* fetch language definitions (if specified at all) */
560 v = gw_res_get (info.kernel_res, "gw.language", info.lang);
563 sprintf (resource_name, "gw.lang.%s", v);
564 v = gw_res_get (info.kernel_res, resource_name, NULL);
567 sprintf (fname, "%s/%s", path_prefix, v);
568 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Reading language resources %s",
570 gw_res_merge (info.kernel_res, fname);
573 /* fetch overriding resources from file (if specified) */
574 if (info.override_res)
576 sprintf (fname, "%s/%s", path_prefix, info.override_res);
577 gw_res_merge (info.kernel_res, fname);
580 /* read bibset definition for ccl */
581 v = gw_res_get (info.kernel_res, "gw.bibset", NULL);
586 sprintf (fname, "%s/%s", path_prefix, v);
587 bib_inf = fopen (fname, "r");
589 gw_log (GW_LOG_WARN, KERNEL_LOG, "cannot open %s", fname);
592 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading bib file %s", fname);
593 ccl_qual_file (info.bibset, bib_inf);
598 /* determine host name and port no */
599 sprintf (resource_name, "gw.target.%s", info.target);
600 if (*info.target && ! gw_res_get (info.kernel_res, resource_name, NULL))
602 /* target is specified, and there is no sub-resource for it... */
605 if ((split = strchr (info.target, ':')))
607 memcpy (info.hostname, info.target, split-info.target);
608 info.hostname[split-info.target] = '\0';
609 info.port = atoi (split+1);
613 strcpy (info.hostname, info.target);
614 info.port = gw_res_int (info.kernel_res, "gw.portno", 210);
618 { /* resources gw.hostname and gw.portno will be used */
619 strncpy (info.hostname, gw_res_get (info.kernel_res,
620 "gw.hostname", "localhost"),
621 sizeof(info.hostname)-1);
622 info.port = gw_res_int (info.kernel_res, "gw.portno", 210);
623 strcpy (info.account, gw_res_get (info.kernel_res, "gw.account", ""));
625 /* set info.databases (all available databases for target) */
626 /* set info.database (first database for target) */
628 free (info.databases);
630 free (info.database);
631 v = gw_res_get (info.kernel_res, "gw.databases", "");
632 info.databases = gw_strdup (v);
633 for (cp = info.databases; (cp = strchr (cp, ' ')); cp++)
635 v = gw_res_get (info.kernel_res, "gw.database", "");
636 if (*v == '\0' && *info.databases)
639 cp = strchr (info.databases, ',');
641 len = cp ? (cp-info.databases) : strlen (info.databases);
642 info.database = malloc (len+1);
643 assert (info.database);
644 memcpy (info.database, info.databases, len);
645 info.database[len] = '\0';
649 info.database = gw_strdup (v);
650 for (cp = info.database; (cp = strchr (cp, ' ')); cp++)
654 /* the port no can be explicitly overridden by a command line option */
655 if (info.override_portno)
656 info.port = atoi (info.override_portno);
658 /* the hostname can be explicitly overridden by a command line option */
659 if (info.override_hostname)
660 strncpy (info.hostname, info.override_hostname,
661 sizeof(info.hostname)-1);
663 ccl_token_and = gw_res_get (info.kernel_res, "ccl.token.and", "and");
664 ccl_token_or = gw_res_get (info.kernel_res, "ccl.token.or", "or");
665 ccl_token_not = gw_res_get (info.kernel_res, "ccl.token.not", "not");
666 ccl_token_set = gw_res_get (info.kernel_res, "ccl.token.set", "set");
668 /* determine if more than one result-set names is supported */
669 if (gw_res_bool (info.kernel_res, "gw.result.set", 1))
676 v = gw_res_get (info.kernel_res, "gw.fml", "default.fml");
677 sprintf (fname, "%s/%s", path_prefix, v);
678 fml_inf = fopen (fname, "r");
680 gw_log (GW_LOG_WARN, KERNEL_LOG,
681 "cannot open fml script %s", fname);
684 info.fml = fml_open ();
685 info.fml->read_func = fml_inf_read;
686 info.fml->write_func = fml_inf_write;
687 fml_preprocess (info.fml);