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.29 1995/07/28 10:51:08 adam
49 * Bug fix: account from previous session had effect when new target command
52 * Revision 1.28 1995/07/03 08:20:15 adam
53 * More help information and better diagnostics.
55 * Revision 1.27 1995/05/19 13:25:59 adam
56 * Bug fixes. Better command line options.
58 * Revision 1.26 1995/05/18 12:03:08 adam
59 * Bug fixes and minor improvements.
61 * Revision 1.25 1995/05/16 09:40:42 adam
62 * LICENSE. Setting of CCL token names (and/or/not/set) in read_kernel_res.
64 * Revision 1.24 1995/05/04 10:40:07 adam
65 * More work on Def-settings.
67 * Revision 1.23 1995/05/03 16:34:18 adam
68 * CCL def command, i.e. user definitions - saved as resource files.
70 * Revision 1.22 1995/05/03 07:37:39 adam
71 * CCL commands stop/continue implemented. New functions gw_res_{int,bool}
72 * are used when possible.
74 * Revision 1.21 1995/05/01 16:26:56 adam
75 * More work on resource monitor.
77 * Revision 1.20 1995/05/01 12:43:32 adam
78 * First work on resource monitor program.
80 * Revision 1.19 1995/04/19 16:01:58 adam
81 * Some hacks to get the FIFO communication work!! Isn't reliable.
82 * Resource gw.account added - default account info.
84 * Revision 1.18 1995/04/19 13:19:09 adam
85 * New command: account - for authentication.
87 * Revision 1.17 1995/04/19 10:46:18 adam
88 * Persistency works much better now. New command: status - history-like
90 * Revision 1.16 1995/04/19 07:31:07 adam
91 * First work on Z39.50 persistence.
93 * Revision 1.15 1995/04/17 09:34:30 adam
94 * Timeout (idletime) adjustable. Minor changes in kernel.
96 * Revision 1.14 1995/03/28 11:42:34 adam
97 * First use of string-queue utility.
99 * Revision 1.13 1995/03/28 08:01:25 adam
100 * FIFO existence is used to test for a running kernel.
102 * Revision 1.12 1995/03/27 12:51:05 adam
103 * New log level in use: GW_LOG_ERRNO.
105 * Revision 1.11 1995/03/27 08:24:02 adam
106 * First use of gip interface and gw-db.
107 * First work on eti program.
109 * Revision 1.10 1995/03/01 14:32:25 adam
110 * Better diagnostics. Default is, that only one database selected when
113 * Revision 1.9 1995/02/23 08:32:17 adam
116 * Revision 1.7 1995/02/22 15:22:33 adam
117 * Much more checking of run-time state. Show command never retrieves
118 * more records than indicated by the previous search request. Help
119 * command available. The maximum number of records retrieved can be
122 * Revision 1.6 1995/02/22 08:51:34 adam
123 * Output function can be customized in fml, which is used to print
124 * the reply to reply_fd.
126 * Revision 1.5 1995/02/20 21:16:20 adam
127 * FML support. Bug fixes. Profile for drewdb.
129 * Revision 1.4 1995/02/17 17:06:16 adam
132 * Revision 1.3 1995/02/16 18:35:09 adam
133 * First use of Zdist library. Search requests are supported.
134 * Present requests are not supported yet.
136 * Revision 1.2 1995/02/16 13:21:00 adam
137 * Organization of resource files for targets and conversion
138 * language implemented.
140 * Revision 1.1 1995/02/15 17:45:29 adam
141 * First version of email gateway kernel. Email requests are read
142 * from stdin. The output is transferred to an MTA if 'From' is
143 * found in the header - or stdout if absent. No Z39.50 client is used.
152 #include <sys/types.h>
153 #include <sys/time.h>
157 #include <strqueue.h>
160 FILE *reply_fd = stdout;
162 struct gw_kernel_info info;
164 static void kernel_events (struct str_queue *queue)
166 char fifo_client_name[1024];
167 char fifo_server_name[1024];
174 int continuation = 0;
179 persist_flag = gw_res_bool (info.kernel_res, "gw.persist", 0);
180 timeout = gw_res_int (info.kernel_res, "gw.timeout", 600);
181 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "event loop");
183 sprintf (fifo_client_name, "fifo.c.%d", info.userid);
184 sprintf (fifo_server_name, "fifo.s.%d", info.userid);
186 gip = gips_initialize (fifo_server_name);
187 gips_open (gip, fifo_client_name, 1);
188 gip_fd = gip_infileno (gip);
189 extra_fd = open (fifo_server_name, O_WRONLY);
194 FD_SET (gip_fd, &set_r);
201 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "IPC select");
202 r = select (gip_fd+1, &set_r, NULL, NULL, &tv);
205 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, KERNEL_LOG, "select");
211 gw_log (GW_LOG_STAT, KERNEL_LOG, "Stopping");
213 gw_log (GW_LOG_STAT, KERNEL_LOG, "Timeout after %d seconds",
215 if (info.zass && persist_flag)
216 save_p_state (info.userid);
219 if (FD_ISSET (gip_fd, &set_r))
221 char command[128], *cp;
223 if (!(lgets (command, 127, gip_fd)))
225 gw_log (GW_LOG_WARN, KERNEL_LOG, "Unexpected close");
228 if ((cp = strchr (command, '\n')))
230 gw_log (GW_LOG_STAT, KERNEL_LOG, "IPC: %s", command);
231 if (!strcmp (command, "mail"))
233 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Incoming mail");
234 while (lgets (line_buf, sizeof(line_buf)-1, gip_fd))
235 str_queue_enq (queue, line_buf);
236 urp_start (continuation, queue);
237 if (persist_flag && !continuation)
238 load_p_state (info.userid);
239 r = urp_command (queue);
240 if (r == 1) /* stop? */
242 info.zass = NULL; /* delete association */
243 *info.target = 0; /* indicate no target */
244 read_kernel_res(); /* reread resources */
246 del_p_state (info.userid); /* remove persist file */
249 while (str_queue_deq (queue, 0, 0))
252 else if (!strcmp (command, "stop"))
254 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "stop");
255 while (lgets (line_buf, sizeof(line_buf)-1, gip_fd))
260 gw_log (GW_LOG_WARN, KERNEL_LOG, "Unknown IPC: %s", command);
269 int main (int argc, char **argv)
271 struct str_queue *queue;
273 info.kernel_res = NULL;
274 info.default_res = "default.res";
275 info.override_res = NULL;
278 info.account_in_session = 1;
282 info.override_portno = NULL;
283 info.override_hostname = NULL;
284 info.databases = NULL;
285 info.database = NULL;
294 info.kernel_res = gw_res_init ();
302 fprintf (stderr, "kernel [options] [resourceFile]\n");
303 fprintf (stderr, "If no resource file is specified");
304 fprintf (stderr, " default.res is used\n");
305 fprintf (stderr, "Options:\n");
306 fprintf (stderr, " -d Enable debugging log\n");
307 fprintf (stderr, " -t target Open target immediately\n");
308 fprintf (stderr, " -g lang Set language\n");
309 fprintf (stderr, " -o resource Override with resource\n");
310 fprintf (stderr, " -h host Override host\n");
311 fprintf (stderr, " -p port Override port\n");
312 fprintf (stderr, " -l log Set Log file\n");
313 fprintf (stderr, " -i id Set IPC userid\n");
316 gw_log_level (GW_LOG_ALL & ~RES_DEBUG);
319 gw_log_level (GW_LOG_ALL);
323 strcpy (info.target, argv[0]+2);
327 strcpy (info.target, *++argv);
331 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing target name");
337 info.lang = argv[0]+2;
345 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing language name");
351 info.override_res = argv[0]+2;
355 info.override_res = *++argv;
359 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing override name");
365 info.override_portno = argv[0]+2;
369 info.override_portno = *++argv;
373 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing portno");
379 info.override_hostname = argv[0]+2;
383 info.override_hostname = *++argv;
387 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing hostname");
393 gw_log_file (GW_LOG_ALL, argv[0]+2);
397 gw_log_file (GW_LOG_ALL, *++argv);
401 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing log filename");
407 info.userid = atoi (argv[0]+2);
411 info.userid = atoi (*++argv);
415 gw_log (GW_LOG_FATAL, KERNEL_LOG, "missing user id");
418 gw_log_session (info.userid);
421 gw_log (GW_LOG_FATAL, KERNEL_LOG, "unknown option %s;"
422 " use -H for help", *argv);
427 info.default_res = *argv;
429 if (!(queue = str_queue_mk ()))
431 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, KERNEL_LOG, "str_queue_mk");
434 if (info.userid != -1)
437 kernel_events (queue);
443 while (lgets (line_buf, sizeof(line_buf)-1, 0))
444 str_queue_enq (queue, line_buf);
445 urp_start (0, queue);
452 struct gw_user_set *user_set_add (const char *name, int hits,
453 const char *database,
454 struct ccl_rpn_node *rpn,
456 const char *search_str)
458 struct gw_user_set *s;
460 s = malloc (sizeof (*s));
463 s->name = gw_strdup (name);
465 s->database = gw_strdup (database);
467 s->present_flag = present_flag;
468 s->search_str = gw_strdup (search_str);
474 void user_set_init (void)
476 struct gw_user_set *s, *s1;
478 for (s = info.sets; s; s = s1)
482 ccl_rpn_delete (s->rpn);
489 struct gw_user_set *user_set_search (const char *name)
491 struct gw_user_set *s;
495 for (s = info.sets; s; s = s->prev)
496 if (!strcmp (s->name, name))
502 static void fml_inf_write (int ch)
506 static FILE *fml_inf;
508 static int fml_inf_read (void)
510 return getc (fml_inf);
514 void read_kernel_res (void)
518 char resource_name[256];
523 ccl_qual_rm (&info.bibset);
524 info.bibset = ccl_qual_mk ();
527 gw_res_close (info.kernel_res);
528 info.kernel_res = gw_res_init ();
530 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading kernel resource, default %s",
533 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading kernel resource, target %s",
536 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading kernel resource, lang %s",
539 /* read default resources. These should exist */
540 if (gw_res_merge (info.kernel_res, info.default_res))
542 gw_log (GW_LOG_WARN, KERNEL_LOG, "Couldn't read resource file %s",
546 /* fetch target definitions (if defined at all) */
549 sprintf (resource_name, "gw.target.%s", info.target);
550 v = gw_res_get (info.kernel_res, resource_name, NULL);
552 gw_res_merge (info.kernel_res, v);
554 /* fetch user definitions (if user-id is specified) */
555 if (info.userid >= 0)
558 sprintf (fname, "user.%d.r", info.userid);
559 gw_res_merge (info.kernel_res, fname);
561 /* fetch language definitions (if specified at all) */
562 v = gw_res_get (info.kernel_res, "gw.language", info.lang);
565 sprintf (resource_name, "gw.lang.%s", v);
566 v = gw_res_get (info.kernel_res, resource_name, NULL);
569 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Reading language resources %s",
571 gw_res_merge (info.kernel_res, v);
574 /* fetch overriding resources from file (if specified) */
575 if (info.override_res)
576 gw_res_merge (info.kernel_res, info.override_res);
578 /* read bibset definition for ccl */
579 v = gw_res_get (info.kernel_res, "gw.bibset", NULL);
584 bib_inf = fopen (v, "r");
586 gw_log (GW_LOG_WARN, KERNEL_LOG, "cannot open %s", v);
589 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reading bib file %s", v);
590 ccl_qual_file (info.bibset, bib_inf);
595 /* determine host name and port no */
596 sprintf (resource_name, "gw.target.%s", info.target);
597 if (*info.target && ! gw_res_get (info.kernel_res, resource_name, NULL))
599 /* target is specified, and there is no sub-resource for it... */
602 if ((split = strchr (info.target, ':')))
604 memcpy (info.hostname, info.target, split-info.target);
605 info.hostname[split-info.target] = '\0';
606 info.port = atoi (split+1);
610 strcpy (info.hostname, info.target);
611 info.port = gw_res_int (info.kernel_res, "gw.portno", 210);
615 { /* resources gw.hostname and gw.portno will be used */
616 strncpy (info.hostname, gw_res_get (info.kernel_res,
617 "gw.hostname", "localhost"),
618 sizeof(info.hostname)-1);
619 info.port = gw_res_int (info.kernel_res, "gw.portno", 210);
620 strcpy (info.account, gw_res_get (info.kernel_res, "gw.account", ""));
621 info.account_in_session = 0;
623 /* set info.databases (all available databases for target) */
624 /* set info.database (first database for target) */
626 free (info.databases);
628 free (info.database);
629 v = gw_res_get (info.kernel_res, "gw.databases", "");
630 info.databases = gw_strdup (v);
631 for (cp = info.databases; (cp = strchr (cp, ' ')); cp++)
633 v = gw_res_get (info.kernel_res, "gw.database", "");
634 if (*v == '\0' && *info.databases)
637 cp = strchr (info.databases, ',');
639 len = cp ? (cp-info.databases) : strlen (info.databases);
640 info.database = malloc (len+1);
641 assert (info.database);
642 memcpy (info.database, info.databases, len);
643 info.database[len] = '\0';
647 info.database = gw_strdup (v);
648 for (cp = info.database; (cp = strchr (cp, ' ')); cp++)
652 /* the port no can be explicitly overridden by a command line option */
653 if (info.override_portno)
654 info.port = atoi (info.override_portno);
656 /* the hostname can be explicitly overridden by a command line option */
657 if (info.override_hostname)
658 strncpy (info.hostname, info.override_hostname,
659 sizeof(info.hostname)-1);
661 ccl_token_and = gw_res_get (info.kernel_res, "ccl.token.and", "and");
662 ccl_token_or = gw_res_get (info.kernel_res, "ccl.token.or", "or");
663 ccl_token_not = gw_res_get (info.kernel_res, "ccl.token.not", "not");
664 ccl_token_set = gw_res_get (info.kernel_res, "ccl.token.set", "set");
666 /* determine if more than one result-set names is supported */
667 if (gw_res_bool (info.kernel_res, "gw.result.set", 1))
674 v = gw_res_get (info.kernel_res, "gw.fml", "default.fml");
675 fml_inf = fopen (v, "r");
677 gw_log (GW_LOG_WARN, KERNEL_LOG, "cannot open fml script %s", v);
680 info.fml = fml_open ();
681 info.fml->read_func = fml_inf_read;
682 info.fml->write_func = fml_inf_write;
683 fml_preprocess (info.fml);