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.30 1996/02/12 10:04:54 adam
49 * The gateway doesn't try to reconnect if it is already known that
50 * it will fail (connect_fail flag introduced).
52 * Revision 1.29 1995/07/28 10:51:08 adam
53 * Bug fix: account from previous session had effect when new target command
56 * Revision 1.28 1995/07/03 08:20:15 adam
57 * More help information and better diagnostics.
59 * Revision 1.27 1995/05/19 13:25:59 adam
60 * Bug fixes. Better command line options.
62 * Revision 1.26 1995/05/18 12:03:08 adam
63 * Bug fixes and minor improvements.
65 * Revision 1.25 1995/05/16 09:40:42 adam
66 * LICENSE. Setting of CCL token names (and/or/not/set) in read_kernel_res.
68 * Revision 1.24 1995/05/04 10:40:07 adam
69 * More work on Def-settings.
71 * Revision 1.23 1995/05/03 16:34:18 adam
72 * CCL def command, i.e. user definitions - saved as resource files.
74 * Revision 1.22 1995/05/03 07:37:39 adam
75 * CCL commands stop/continue implemented. New functions gw_res_{int,bool}
76 * are used when possible.
78 * Revision 1.21 1995/05/01 16:26:56 adam
79 * More work on resource monitor.
81 * Revision 1.20 1995/05/01 12:43:32 adam
82 * First work on resource monitor program.
84 * Revision 1.19 1995/04/19 16:01:58 adam
85 * Some hacks to get the FIFO communication work!! Isn't reliable.
86 * Resource gw.account added - default account info.
88 * Revision 1.18 1995/04/19 13:19:09 adam
89 * New command: account - for authentication.
91 * Revision 1.17 1995/04/19 10:46:18 adam
92 * Persistency works much better now. New command: status - history-like
94 * Revision 1.16 1995/04/19 07:31:07 adam
95 * First work on Z39.50 persistence.
97 * Revision 1.15 1995/04/17 09:34:30 adam
98 * Timeout (idletime) adjustable. Minor changes in kernel.
100 * Revision 1.14 1995/03/28 11:42:34 adam
101 * First use of string-queue utility.
103 * Revision 1.13 1995/03/28 08:01:25 adam
104 * FIFO existence is used to test for a running kernel.
106 * Revision 1.12 1995/03/27 12:51:05 adam
107 * New log level in use: GW_LOG_ERRNO.
109 * Revision 1.11 1995/03/27 08:24:02 adam
110 * First use of gip interface and gw-db.
111 * First work on eti program.
113 * Revision 1.10 1995/03/01 14:32:25 adam
114 * Better diagnostics. Default is, that only one database selected when
117 * Revision 1.9 1995/02/23 08:32:17 adam
120 * Revision 1.7 1995/02/22 15:22:33 adam
121 * Much more checking of run-time state. Show command never retrieves
122 * more records than indicated by the previous search request. Help
123 * command available. The maximum number of records retrieved can be
126 * Revision 1.6 1995/02/22 08:51:34 adam
127 * Output function can be customized in fml, which is used to print
128 * the reply to reply_fd.
130 * Revision 1.5 1995/02/20 21:16:20 adam
131 * FML support. Bug fixes. Profile for drewdb.
133 * Revision 1.4 1995/02/17 17:06:16 adam
136 * Revision 1.3 1995/02/16 18:35:09 adam
137 * First use of Zdist library. Search requests are supported.
138 * Present requests are not supported yet.
140 * Revision 1.2 1995/02/16 13:21:00 adam
141 * Organization of resource files for targets and conversion
142 * language implemented.
144 * Revision 1.1 1995/02/15 17:45:29 adam
145 * First version of email gateway kernel. Email requests are read
146 * from stdin. The output is transferred to an MTA if 'From' is
147 * found in the header - or stdout if absent. No Z39.50 client is used.
156 #include <sys/types.h>
157 #include <sys/time.h>
161 #include <strqueue.h>
164 FILE *reply_fd = stdout;
166 struct gw_kernel_info info;
168 static void kernel_events (struct str_queue *queue)
170 char fifo_client_name[1024];
171 char fifo_server_name[1024];
178 int continuation = 0;
183 persist_flag = gw_res_bool (info.kernel_res, "gw.persist", 0);
184 timeout = gw_res_int (info.kernel_res, "gw.timeout", 600);
185 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "event loop");
187 sprintf (fifo_client_name, "fifo.c.%d", info.userid);
188 sprintf (fifo_server_name, "fifo.s.%d", info.userid);
190 gip = gips_initialize (fifo_server_name);
191 gips_open (gip, fifo_client_name, 1);
192 gip_fd = gip_infileno (gip);
193 extra_fd = open (fifo_server_name, O_WRONLY);
198 FD_SET (gip_fd, &set_r);
205 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "IPC select");
206 r = select (gip_fd+1, &set_r, NULL, NULL, &tv);
209 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, KERNEL_LOG, "select");
215 gw_log (GW_LOG_STAT, KERNEL_LOG, "Stopping");
217 gw_log (GW_LOG_STAT, KERNEL_LOG, "Timeout after %d seconds",
219 if (info.zass && persist_flag)
220 save_p_state (info.userid);
223 if (FD_ISSET (gip_fd, &set_r))
225 char command[128], *cp;
227 if (!(lgets (command, 127, gip_fd)))
229 gw_log (GW_LOG_WARN, KERNEL_LOG, "Unexpected close");
232 if ((cp = strchr (command, '\n')))
234 gw_log (GW_LOG_STAT, KERNEL_LOG, "IPC: %s", command);
235 if (!strcmp (command, "mail"))
237 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Incoming mail");
238 while (lgets (line_buf, sizeof(line_buf)-1, gip_fd))
239 str_queue_enq (queue, line_buf);
240 urp_start (continuation, queue);
241 if (persist_flag && !continuation)
242 load_p_state (info.userid);
243 r = urp_command (queue);
244 if (r == 1) /* stop? */
246 info.zass = NULL; /* delete association */
247 *info.target = 0; /* indicate no target */
248 read_kernel_res(); /* reread resources */
250 del_p_state (info.userid); /* remove persist file */
253 while (str_queue_deq (queue, 0, 0))
256 else if (!strcmp (command, "stop"))
258 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "stop");
259 while (lgets (line_buf, sizeof(line_buf)-1, gip_fd))
264 gw_log (GW_LOG_WARN, KERNEL_LOG, "Unknown IPC: %s", command);
273 int main (int argc, char **argv)
275 struct str_queue *queue;
277 info.kernel_res = NULL;
278 info.default_res = "default.res";
279 info.override_res = NULL;
282 info.account_in_session = 1;
286 info.override_portno = NULL;
287 info.override_hostname = NULL;
288 info.databases = NULL;
289 info.database = NULL;
292 info.connect_failed = 0;
299 info.kernel_res = gw_res_init ();
307 fprintf (stderr, "kernel [options] [resourceFile]\n");
308 fprintf (stderr, "If no resource file is specified");
309 fprintf (stderr, " default.res is used\n");
310 fprintf (stderr, "Options:\n");
311 fprintf (stderr, " -d Enable debugging log\n");
312 fprintf (stderr, " -t target Open target immediately\n");
313 fprintf (stderr, " -g lang Set language\n");
314 fprintf (stderr, " -o resource Override with resource\n");
315 fprintf (stderr, " -h host Override host\n");
316 fprintf (stderr, " -p port Override port\n");
317 fprintf (stderr, " -l log Set Log file\n");
318 fprintf (stderr, " -i id Set IPC userid\n");
321 gw_log_level (GW_LOG_ALL & ~RES_DEBUG);
324 gw_log_level (GW_LOG_ALL);
328 strcpy (info.target, argv[0]+2);
332 strcpy (info.target, *++argv);
336 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing target name");
342 info.lang = argv[0]+2;
350 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing language name");
356 info.override_res = argv[0]+2;
360 info.override_res = *++argv;
364 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing override name");
370 info.override_portno = argv[0]+2;
374 info.override_portno = *++argv;
378 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing portno");
384 info.override_hostname = argv[0]+2;
388 info.override_hostname = *++argv;
392 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing hostname");
398 gw_log_file (GW_LOG_ALL, argv[0]+2);
402 gw_log_file (GW_LOG_ALL, *++argv);
406 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing log filename");
412 info.userid = atoi (argv[0]+2);
416 info.userid = atoi (*++argv);
420 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing user id");
423 gw_log_session (info.userid);
426 gw_log (GW_LOG_FATAL, KERNEL_LOG, "unknown option %s;"
427 " use -H for help", *argv);
432 info.default_res = *argv;
434 if (!(queue = str_queue_mk ()))
436 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, KERNEL_LOG, "str_queue_mk");
439 if (info.userid != -1)
442 kernel_events (queue);
448 while (lgets (line_buf, sizeof(line_buf)-1, 0))
449 str_queue_enq (queue, line_buf);
450 urp_start (0, queue);
457 struct gw_user_set *user_set_add (const char *name, int hits,
458 const char *database,
459 struct ccl_rpn_node *rpn,
461 const char *search_str)
463 struct gw_user_set *s;
465 s = malloc (sizeof (*s));
468 s->name = gw_strdup (name);
470 s->database = gw_strdup (database);
472 s->present_flag = present_flag;
473 s->search_str = gw_strdup (search_str);
479 void user_set_init (void)
481 struct gw_user_set *s, *s1;
483 for (s = info.sets; s; s = s1)
487 ccl_rpn_delete (s->rpn);
494 struct gw_user_set *user_set_search (const char *name)
496 struct gw_user_set *s;
500 for (s = info.sets; s; s = s->prev)
501 if (!strcmp (s->name, name))
507 static void fml_inf_write (int ch)
511 static FILE *fml_inf;
513 static int fml_inf_read (void)
515 return getc (fml_inf);
519 void read_kernel_res (void)
523 char resource_name[256];
528 ccl_qual_rm (&info.bibset);
529 info.bibset = ccl_qual_mk ();
532 gw_res_close (info.kernel_res);
533 info.kernel_res = gw_res_init ();
535 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading kernel resource, default %s",
538 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading kernel resource, target %s",
541 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading kernel resource, lang %s",
544 /* read default resources. These should exist */
545 if (gw_res_merge (info.kernel_res, info.default_res))
547 gw_log (GW_LOG_WARN, KERNEL_LOG, "Couldn't read resource file %s",
551 /* fetch target definitions (if defined at all) */
554 sprintf (resource_name, "gw.target.%s", info.target);
555 v = gw_res_get (info.kernel_res, resource_name, NULL);
557 gw_res_merge (info.kernel_res, v);
559 /* fetch user definitions (if user-id is specified) */
560 if (info.userid >= 0)
563 sprintf (fname, "user.%d.r", info.userid);
564 gw_res_merge (info.kernel_res, fname);
566 /* fetch language definitions (if specified at all) */
567 v = gw_res_get (info.kernel_res, "gw.language", info.lang);
570 sprintf (resource_name, "gw.lang.%s", v);
571 v = gw_res_get (info.kernel_res, resource_name, NULL);
574 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Reading language resources %s",
576 gw_res_merge (info.kernel_res, v);
579 /* fetch overriding resources from file (if specified) */
580 if (info.override_res)
581 gw_res_merge (info.kernel_res, info.override_res);
583 /* read bibset definition for ccl */
584 v = gw_res_get (info.kernel_res, "gw.bibset", NULL);
589 bib_inf = fopen (v, "r");
591 gw_log (GW_LOG_WARN, KERNEL_LOG, "cannot open %s", v);
594 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading bib file %s", v);
595 ccl_qual_file (info.bibset, bib_inf);
600 /* determine host name and port no */
601 sprintf (resource_name, "gw.target.%s", info.target);
602 if (*info.target && ! gw_res_get (info.kernel_res, resource_name, NULL))
604 /* target is specified, and there is no sub-resource for it... */
607 if ((split = strchr (info.target, ':')))
609 memcpy (info.hostname, info.target, split-info.target);
610 info.hostname[split-info.target] = '\0';
611 info.port = atoi (split+1);
615 strcpy (info.hostname, info.target);
616 info.port = gw_res_int (info.kernel_res, "gw.portno", 210);
620 { /* resources gw.hostname and gw.portno will be used */
621 strncpy (info.hostname, gw_res_get (info.kernel_res,
622 "gw.hostname", "localhost"),
623 sizeof(info.hostname)-1);
624 info.port = gw_res_int (info.kernel_res, "gw.portno", 210);
625 strcpy (info.account, gw_res_get (info.kernel_res, "gw.account", ""));
626 info.account_in_session = 0;
628 /* set info.databases (all available databases for target) */
629 /* set info.database (first database for target) */
631 free (info.databases);
633 free (info.database);
634 v = gw_res_get (info.kernel_res, "gw.databases", "");
635 info.databases = gw_strdup (v);
636 for (cp = info.databases; (cp = strchr (cp, ' ')); cp++)
638 v = gw_res_get (info.kernel_res, "gw.database", "");
639 if (*v == '\0' && *info.databases)
642 cp = strchr (info.databases, ',');
644 len = cp ? (cp-info.databases) : strlen (info.databases);
645 info.database = malloc (len+1);
646 assert (info.database);
647 memcpy (info.database, info.databases, len);
648 info.database[len] = '\0';
652 info.database = gw_strdup (v);
653 for (cp = info.database; (cp = strchr (cp, ' ')); cp++)
657 /* the port no can be explicitly overridden by a command line option */
658 if (info.override_portno)
659 info.port = atoi (info.override_portno);
661 /* the hostname can be explicitly overridden by a command line option */
662 if (info.override_hostname)
663 strncpy (info.hostname, info.override_hostname,
664 sizeof(info.hostname)-1);
666 ccl_token_and = gw_res_get (info.kernel_res, "ccl.token.and", "and");
667 ccl_token_or = gw_res_get (info.kernel_res, "ccl.token.or", "or");
668 ccl_token_not = gw_res_get (info.kernel_res, "ccl.token.not", "not");
669 ccl_token_set = gw_res_get (info.kernel_res, "ccl.token.set", "set");
671 /* determine if more than one result-set names is supported */
672 if (gw_res_bool (info.kernel_res, "gw.result.set", 1))
679 v = gw_res_get (info.kernel_res, "gw.fml", "default.fml");
680 fml_inf = fopen (v, "r");
682 gw_log (GW_LOG_WARN, KERNEL_LOG, "cannot open fml script %s", v);
685 info.fml = fml_open ();
686 info.fml->read_func = fml_inf_read;
687 info.fml->write_func = fml_inf_write;
688 fml_preprocess (info.fml);