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.31 2001/02/26 14:32:36 adam
49 * Updated for YAZ 1.7. HTML output tidy up. Added LOC target.
51 * Revision 1.30 1996/02/12 10:04:54 adam
52 * The gateway doesn't try to reconnect if it is already known that
53 * it will fail (connect_fail flag introduced).
55 * Revision 1.29 1995/07/28 10:51:08 adam
56 * Bug fix: account from previous session had effect when new target command
59 * Revision 1.28 1995/07/03 08:20:15 adam
60 * More help information and better diagnostics.
62 * Revision 1.27 1995/05/19 13:25:59 adam
63 * Bug fixes. Better command line options.
65 * Revision 1.26 1995/05/18 12:03:08 adam
66 * Bug fixes and minor improvements.
68 * Revision 1.25 1995/05/16 09:40:42 adam
69 * LICENSE. Setting of CCL token names (and/or/not/set) in read_kernel_res.
71 * Revision 1.24 1995/05/04 10:40:07 adam
72 * More work on Def-settings.
74 * Revision 1.23 1995/05/03 16:34:18 adam
75 * CCL def command, i.e. user definitions - saved as resource files.
77 * Revision 1.22 1995/05/03 07:37:39 adam
78 * CCL commands stop/continue implemented. New functions gw_res_{int,bool}
79 * are used when possible.
81 * Revision 1.21 1995/05/01 16:26:56 adam
82 * More work on resource monitor.
84 * Revision 1.20 1995/05/01 12:43:32 adam
85 * First work on resource monitor program.
87 * Revision 1.19 1995/04/19 16:01:58 adam
88 * Some hacks to get the FIFO communication work!! Isn't reliable.
89 * Resource gw.account added - default account info.
91 * Revision 1.18 1995/04/19 13:19:09 adam
92 * New command: account - for authentication.
94 * Revision 1.17 1995/04/19 10:46:18 adam
95 * Persistency works much better now. New command: status - history-like
97 * Revision 1.16 1995/04/19 07:31:07 adam
98 * First work on Z39.50 persistence.
100 * Revision 1.15 1995/04/17 09:34:30 adam
101 * Timeout (idletime) adjustable. Minor changes in kernel.
103 * Revision 1.14 1995/03/28 11:42:34 adam
104 * First use of string-queue utility.
106 * Revision 1.13 1995/03/28 08:01:25 adam
107 * FIFO existence is used to test for a running kernel.
109 * Revision 1.12 1995/03/27 12:51:05 adam
110 * New log level in use: GW_LOG_ERRNO.
112 * Revision 1.11 1995/03/27 08:24:02 adam
113 * First use of gip interface and gw-db.
114 * First work on eti program.
116 * Revision 1.10 1995/03/01 14:32:25 adam
117 * Better diagnostics. Default is, that only one database selected when
120 * Revision 1.9 1995/02/23 08:32:17 adam
123 * Revision 1.7 1995/02/22 15:22:33 adam
124 * Much more checking of run-time state. Show command never retrieves
125 * more records than indicated by the previous search request. Help
126 * command available. The maximum number of records retrieved can be
129 * Revision 1.6 1995/02/22 08:51:34 adam
130 * Output function can be customized in fml, which is used to print
131 * the reply to reply_fd.
133 * Revision 1.5 1995/02/20 21:16:20 adam
134 * FML support. Bug fixes. Profile for drewdb.
136 * Revision 1.4 1995/02/17 17:06:16 adam
139 * Revision 1.3 1995/02/16 18:35:09 adam
140 * First use of Zdist library. Search requests are supported.
141 * Present requests are not supported yet.
143 * Revision 1.2 1995/02/16 13:21:00 adam
144 * Organization of resource files for targets and conversion
145 * language implemented.
147 * Revision 1.1 1995/02/15 17:45:29 adam
148 * First version of email gateway kernel. Email requests are read
149 * from stdin. The output is transferred to an MTA if 'From' is
150 * found in the header - or stdout if absent. No Z39.50 client is used.
159 #include <sys/types.h>
160 #include <sys/time.h>
164 #include <strqueue.h>
169 struct gw_kernel_info info;
171 static void kernel_events (struct str_queue *queue)
173 char fifo_client_name[1024];
174 char fifo_server_name[1024];
181 int continuation = 0;
188 persist_flag = gw_res_bool (info.kernel_res, "gw.persist", 0);
189 timeout = gw_res_int (info.kernel_res, "gw.timeout", 600);
190 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "event loop");
192 sprintf (fifo_client_name, "fifo.c.%d", info.userid);
193 sprintf (fifo_server_name, "fifo.s.%d", info.userid);
195 gip = gips_initialize (fifo_server_name);
196 gips_open (gip, fifo_client_name, 1);
197 gip_fd = gip_infileno (gip);
198 extra_fd = open (fifo_server_name, O_WRONLY);
203 FD_SET (gip_fd, &set_r);
210 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "IPC select");
211 r = select (gip_fd+1, &set_r, NULL, NULL, &tv);
214 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, KERNEL_LOG, "select");
220 gw_log (GW_LOG_STAT, KERNEL_LOG, "Stopping");
222 gw_log (GW_LOG_STAT, KERNEL_LOG, "Timeout after %d seconds",
224 if (info.zass && persist_flag)
225 save_p_state (info.userid);
228 if (FD_ISSET (gip_fd, &set_r))
230 char command[128], *cp;
232 if (!(lgets (command, 127, gip_fd)))
234 gw_log (GW_LOG_WARN, KERNEL_LOG, "Unexpected close");
237 if ((cp = strchr (command, '\n')))
239 gw_log (GW_LOG_STAT, KERNEL_LOG, "IPC: %s", command);
240 if (!strcmp (command, "mail"))
242 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Incoming mail");
243 while (lgets (line_buf, sizeof(line_buf)-1, gip_fd))
244 str_queue_enq (queue, line_buf);
245 urp_start (continuation, queue);
246 if (persist_flag && !continuation)
247 load_p_state (info.userid);
248 r = urp_command (queue);
249 if (r == 1) /* stop? */
251 info.zass = NULL; /* delete association */
252 *info.target = 0; /* indicate no target */
253 read_kernel_res(); /* reread resources */
255 del_p_state (info.userid); /* remove persist file */
258 while (str_queue_deq (queue, 0, 0))
261 else if (!strcmp (command, "stop"))
263 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "stop");
264 while (lgets (line_buf, sizeof(line_buf)-1, gip_fd))
269 gw_log (GW_LOG_WARN, KERNEL_LOG, "Unknown IPC: %s", command);
278 int main (int argc, char **argv)
280 struct str_queue *queue;
282 info.kernel_res = NULL;
283 info.default_res = "default.res";
284 info.override_res = NULL;
287 info.account_in_session = 1;
291 info.override_portno = NULL;
292 info.override_hostname = NULL;
293 info.databases = NULL;
294 info.database = NULL;
297 info.connect_failed = 0;
304 info.kernel_res = gw_res_init ();
312 fprintf (stderr, "kernel [options] [resourceFile]\n");
313 fprintf (stderr, "If no resource file is specified");
314 fprintf (stderr, " default.res is used\n");
315 fprintf (stderr, "Options:\n");
316 fprintf (stderr, " -d Enable debugging log\n");
317 fprintf (stderr, " -t target Open target immediately\n");
318 fprintf (stderr, " -g lang Set language\n");
319 fprintf (stderr, " -o resource Override with resource\n");
320 fprintf (stderr, " -h host Override host\n");
321 fprintf (stderr, " -p port Override port\n");
322 fprintf (stderr, " -l log Set Log file\n");
323 fprintf (stderr, " -i id Set IPC userid\n");
326 gw_log_level (GW_LOG_ALL & ~RES_DEBUG);
329 gw_log_level (GW_LOG_ALL);
333 strcpy (info.target, argv[0]+2);
337 strcpy (info.target, *++argv);
341 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing target name");
347 info.lang = argv[0]+2;
355 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing language name");
361 info.override_res = argv[0]+2;
365 info.override_res = *++argv;
369 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing override name");
375 info.override_portno = argv[0]+2;
379 info.override_portno = *++argv;
383 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing portno");
389 info.override_hostname = argv[0]+2;
393 info.override_hostname = *++argv;
397 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing hostname");
403 gw_log_file (GW_LOG_ALL, argv[0]+2);
407 gw_log_file (GW_LOG_ALL, *++argv);
411 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing log filename");
417 info.userid = atoi (argv[0]+2);
421 info.userid = atoi (*++argv);
425 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing user id");
428 gw_log_session (info.userid);
431 gw_log (GW_LOG_FATAL, KERNEL_LOG, "unknown option %s;"
432 " use -H for help", *argv);
437 info.default_res = *argv;
439 if (!(queue = str_queue_mk ()))
441 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, KERNEL_LOG, "str_queue_mk");
444 if (info.userid != -1)
447 kernel_events (queue);
453 while (lgets (line_buf, sizeof(line_buf)-1, 0))
454 str_queue_enq (queue, line_buf);
455 urp_start (0, queue);
462 struct gw_user_set *user_set_add (const char *name, int hits,
463 const char *database,
464 struct ccl_rpn_node *rpn,
466 const char *search_str)
468 struct gw_user_set *s;
470 s = malloc (sizeof (*s));
473 s->name = gw_strdup (name);
475 s->database = gw_strdup (database);
477 s->present_flag = present_flag;
478 s->search_str = gw_strdup (search_str);
484 void user_set_init (void)
486 struct gw_user_set *s, *s1;
488 for (s = info.sets; s; s = s1)
492 ccl_rpn_delete (s->rpn);
499 struct gw_user_set *user_set_search (const char *name)
501 struct gw_user_set *s;
505 for (s = info.sets; s; s = s->prev)
506 if (!strcmp (s->name, name))
512 static void fml_inf_write (int ch)
516 static FILE *fml_inf;
518 static int fml_inf_read (void)
520 return getc (fml_inf);
524 void read_kernel_res (void)
528 char resource_name[256];
533 ccl_qual_rm (&info.bibset);
534 info.bibset = ccl_qual_mk ();
537 gw_res_close (info.kernel_res);
538 info.kernel_res = gw_res_init ();
540 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading kernel resource, default %s",
543 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading kernel resource, target %s",
546 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading kernel resource, lang %s",
549 /* read default resources. These should exist */
550 if (gw_res_merge (info.kernel_res, info.default_res))
552 gw_log (GW_LOG_WARN, KERNEL_LOG, "Couldn't read resource file %s",
556 /* fetch target definitions (if defined at all) */
559 sprintf (resource_name, "gw.target.%s", info.target);
560 v = gw_res_get (info.kernel_res, resource_name, NULL);
562 gw_res_merge (info.kernel_res, v);
564 /* fetch user definitions (if user-id is specified) */
565 if (info.userid >= 0)
568 sprintf (fname, "user.%d.r", info.userid);
569 gw_res_merge (info.kernel_res, fname);
571 /* fetch language definitions (if specified at all) */
572 v = gw_res_get (info.kernel_res, "gw.language", info.lang);
575 sprintf (resource_name, "gw.lang.%s", v);
576 v = gw_res_get (info.kernel_res, resource_name, NULL);
579 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Reading language resources %s",
581 gw_res_merge (info.kernel_res, v);
584 /* fetch overriding resources from file (if specified) */
585 if (info.override_res)
586 gw_res_merge (info.kernel_res, info.override_res);
588 /* read bibset definition for ccl */
589 v = gw_res_get (info.kernel_res, "gw.bibset", NULL);
594 bib_inf = fopen (v, "r");
596 gw_log (GW_LOG_WARN, KERNEL_LOG, "cannot open %s", v);
599 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading bib file %s", v);
600 ccl_qual_file (info.bibset, bib_inf);
605 /* determine host name and port no */
606 sprintf (resource_name, "gw.target.%s", info.target);
607 if (*info.target && ! gw_res_get (info.kernel_res, resource_name, NULL))
609 /* target is specified, and there is no sub-resource for it... */
612 if ((split = strchr (info.target, ':')))
614 memcpy (info.hostname, info.target, split-info.target);
615 info.hostname[split-info.target] = '\0';
616 info.port = atoi (split+1);
620 strcpy (info.hostname, info.target);
621 info.port = gw_res_int (info.kernel_res, "gw.portno", 210);
625 { /* resources gw.hostname and gw.portno will be used */
626 strncpy (info.hostname, gw_res_get (info.kernel_res,
627 "gw.hostname", "localhost"),
628 sizeof(info.hostname)-1);
629 info.port = gw_res_int (info.kernel_res, "gw.portno", 210);
630 strcpy (info.account, gw_res_get (info.kernel_res, "gw.account", ""));
631 info.account_in_session = 0;
633 /* set info.databases (all available databases for target) */
634 /* set info.database (first database for target) */
636 free (info.databases);
638 free (info.database);
639 v = gw_res_get (info.kernel_res, "gw.databases", "");
640 info.databases = gw_strdup (v);
641 for (cp = info.databases; (cp = strchr (cp, ' ')); cp++)
643 v = gw_res_get (info.kernel_res, "gw.database", "");
644 if (*v == '\0' && *info.databases)
647 cp = strchr (info.databases, ',');
649 len = cp ? (cp-info.databases) : strlen (info.databases);
650 info.database = malloc (len+1);
651 assert (info.database);
652 memcpy (info.database, info.databases, len);
653 info.database[len] = '\0';
657 info.database = gw_strdup (v);
658 for (cp = info.database; (cp = strchr (cp, ' ')); cp++)
662 /* the port no can be explicitly overridden by a command line option */
663 if (info.override_portno)
664 info.port = atoi (info.override_portno);
666 /* the hostname can be explicitly overridden by a command line option */
667 if (info.override_hostname)
668 strncpy (info.hostname, info.override_hostname,
669 sizeof(info.hostname)-1);
671 ccl_token_and = gw_res_get (info.kernel_res, "ccl.token.and", "and");
672 ccl_token_or = gw_res_get (info.kernel_res, "ccl.token.or", "or");
673 ccl_token_not = gw_res_get (info.kernel_res, "ccl.token.not", "not");
674 ccl_token_set = gw_res_get (info.kernel_res, "ccl.token.set", "set");
676 /* determine if more than one result-set names is supported */
677 if (gw_res_bool (info.kernel_res, "gw.result.set", 1))
684 v = gw_res_get (info.kernel_res, "gw.fml", "default.fml");
685 fml_inf = fopen (v, "r");
687 gw_log (GW_LOG_WARN, KERNEL_LOG, "cannot open fml script %s", v);
690 info.fml = fml_open ();
691 info.fml->read_func = fml_inf_read;
692 info.fml->write_func = fml_inf_write;
693 fml_preprocess (info.fml);