1 /* Gateway kernel - User Request Processor
5 * Revision 1.26 1995/04/19 07:31:12 adam
6 * First work on Z39.50 persistence.
8 * Revision 1.25 1995/04/17 09:34:33 adam
9 * Timeout (idletime) adjustable. Minor changes in kernel.
11 * Revision 1.24 1995/03/28 11:42:35 adam
12 * First use of string-queue utility.
14 * Revision 1.23 1995/03/28 08:01:28 adam
15 * FIFO existence is used to test for a running kernel.
17 * Revision 1.22 1995/03/27 12:51:05 adam
18 * New log level in use: GW_LOG_ERRNO.
20 * Revision 1.21 1995/03/27 08:24:04 adam
21 * First use of gip interface and gw-db.
22 * First work on eti program.
24 * Revision 1.20 1995/03/03 17:19:17 adam
25 * Smarter presentation. Bug fix in email header interpretation.
27 * Revision 1.19 1995/03/02 09:32:11 adam
28 * New presentation formats. f0=full, f1=brief, f2=mid
30 * Revision 1.18 1995/03/01 14:32:26 adam
31 * Better diagnostics. Default is, that only one database selected when
34 * Revision 1.17 1995/02/28 13:16:26 adam
35 * Configurable From: added.
37 * Revision 1.16 1995/02/23 10:08:20 adam
38 * Added logging of all user commands.
40 * Revision 1.15 1995/02/23 08:32:17 adam
43 * Revision 1.13 1995/02/22 16:54:42 adam
44 * Qualifiers of LOC target updated. More logging messages.
46 * Revision 1.12 1995/02/22 15:51:51 adam
47 * Bug fix: swap of parameter number and offset in function present.
49 * Revision 1.11 1995/02/22 15:22:33 adam
50 * Much more checking of run-time state. Show command never retrieves
51 * more records than indicated by the previous search request. Help
52 * command available. The maximum number of records retrieved can be
55 * Revision 1.10 1995/02/22 08:51:35 adam
56 * Output function can be customized in fml, which is used to print
57 * the reply to reply_fd.
59 * Revision 1.9 1995/02/21 17:46:21 adam
62 * Revision 1.8 1995/02/21 12:12:00 adam
63 * Diagnostic record with error info. observed.
65 * Revision 1.7 1995/02/20 21:16:20 adam
66 * FML support. Bug fixes. Profile for drewdb.
68 * Revision 1.6 1995/02/17 14:41:14 quinn
69 * Added simple display of records.
71 * Revision 1.5 1995/02/17 14:22:13 adam
72 * First steps of CCL show command. Not finished yet.
74 * Revision 1.4 1995/02/17 09:08:36 adam
75 * Reply with subject. CCL base command implemented.
77 * Revision 1.3 1995/02/16 18:35:09 adam
78 * First use of Zdist library. Search requests are supported.
79 * Present requests are not supported yet.
81 * Revision 1.2 1995/02/16 13:21:00 adam
82 * Organization of resource files for targets and conversion
83 * language implemented.
85 * Revision 1.1 1995/02/15 17:45:30 adam
86 * First version of email gateway kernel. Email requests are read
87 * from stdin. The output is transferred to an MTA if 'From' is
88 * found in the header - or stdout if absent. No Z39.50 client is used.
101 #include <strqueue.h>
104 static char line_buf[LINE_MAX+1];
106 static void put_esc_str (const char *s)
112 int lgets (char *buf, int max, int fd)
119 if ((r=read (fd, buf+no, 1)) != 1)
122 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, KERNEL_LOG, "read fail");
128 if (buf[no++] == '\n')
135 int reopen_target (void)
139 gw_log (GW_LOG_WARN, KERNEL_LOG, "Zass free...");
140 info.zass = zass_open (info.hostname, info.port);
143 fprintf (reply_fd, "%s %s:%d\n",
144 gw_res_get (info.kernel_res, "gw.err.connect",
145 "Cannot connect to target"),
146 info.hostname, info.port);
149 v = gw_res_get (info.kernel_res, "gw.description", NULL);
153 fprintf (reply_fd, "\n");
155 fprintf (reply_fd, "%s %s:%d\n",
156 gw_res_get (info.kernel_res, "gw.msg.connect",
157 "Connection established to"),
158 info.hostname, info.port);
160 fprintf (reply_fd, "%s:\n%s\n",
161 gw_res_get (info.kernel_res, "gw.msg.databases",
162 "Available databases"),
165 fprintf (reply_fd, "%s:\n%s\n",
166 gw_res_get (info.kernel_res, "gw.msg.database",
167 "Selected databases"),
173 static struct command_word {
175 char *resource_suffix;
183 { "continue", "continue" },
184 { "status", "status" },
185 { "cancel", "cancel" },
186 { "target", "target" },
191 static int command_search (struct command_word *tab, struct ccl_token *cmd,
192 const char *resource_prefix)
196 assert (resource_prefix);
199 while (tab->default_value)
201 char *cp, command_names[60];
202 char resource_name[60];
205 sprintf (resource_name, "%s%s", resource_prefix,
206 tab->resource_suffix);
207 v = gw_res_get (info.kernel_res, resource_name, tab->default_value);
209 strcpy (command_names, v);
215 if ((split = strchr (cp, ' ')))
217 if (cmd->len == strlen(cp) &&
218 !memcmp (cmd->name, cp, cmd->len))
230 static struct error_no_struct {
233 } error_ccl_tab[] = {
235 { CCL_ERR_TERM_EXPECTED, "term.expected" },
236 { CCL_ERR_RP_EXPECTED, "rp.expected" },
237 { CCL_ERR_SETNAME_EXPECTED, "setname.expected" },
238 { CCL_ERR_OP_EXPECTED, "op.expected" },
239 { CCL_ERR_BAD_RP, "bad.rp" },
240 { CCL_ERR_UNKNOWN_QUAL, "unknown.qual" },
241 { CCL_ERR_DOUBLE_QUAL, "double.qual" },
242 { CCL_ERR_EQ_EXPECTED, "eq.expected" },
243 { CCL_ERR_BAD_RELATION, "bad.relation" },
244 { CCL_ERR_TRUNC_NOT_LEFT, "trunc.not.left" },
245 { CCL_ERR_TRUNC_NOT_BOTH, "trunc.not.both" },
246 { CCL_ERR_TRUNC_NOT_RIGHT, "trunc.not.right" },
250 static char *error_no_search (struct error_no_struct *tab, int no)
252 struct error_no_struct *p = tab;
253 while (p->resource_name)
256 return p->resource_name;
262 static int email_header (struct str_queue *sq,
263 char *from_str, char *subject_str)
267 while (str_queue_deq (sq, line_buf, LINE_MAX))
269 if (line_buf[0] == '\n')
271 if (memcmp (line_buf, "From ", 5) == 0)
272 sscanf (line_buf+4, "%s", from_str);
273 if (memcmp (line_buf, "Subject: ", 9) == 0 &&
274 sscanf (line_buf+9, "%s", subject_str+1) == 1)
275 strcpy (subject_str, line_buf+9);
280 static void help_general (void)
282 put_esc_str (gw_res_get (info.kernel_res, "gw.help.general",
283 "Commands available in this service:\n"));
286 static int exec_help (struct ccl_token *list)
288 static char *sep = "-------------------------------\\n";
293 put_esc_str (gw_res_get (info.kernel_res, "gw.help.target",
294 "target <name> - selects a given target\n"));
297 put_esc_str (gw_res_get (info.kernel_res, "gw.help.base",
298 "base <base>.. - selects databases\n"));
301 put_esc_str (gw_res_get (info.kernel_res, "gw.help.find",
302 "find <query> - performs a search request\n"));
305 put_esc_str (gw_res_get (info.kernel_res, "gw.help.show",
306 "show <spec> - retrieves and displays "
312 static void display_diag_error (int code, const char *addinfo)
316 sprintf (str, "gw.bib1.diag.%d", code);
317 fprintf (reply_fd, "%s %d:\n %s: '%s'\n",
318 gw_res_get (info.kernel_res, "gw.msg.z39errcode",
321 gw_res_get (info.kernel_res, str, ""), addinfo);
324 static int exec_find (struct ccl_token *list)
326 const struct zass_searchent *p;
327 struct gw_user_set *us;
330 struct ccl_rpn_node *rpn;
334 if (info.setno == -1)
335 strcpy (setname, "Default");
337 sprintf (setname, "%d", info.setno);
338 rpn = ccl_find (info.bibset, list, &error, &pos);
341 const char *v = NULL, *n;
344 fprintf (reply_fd, " %*s^ - ", pos - line_buf, " ");
346 n = error_no_search (error_ccl_tab, error);
349 sprintf (name, "gw.err.%s", n);
350 v = gw_res_get (info.kernel_res, name, NULL);
353 v = ccl_err_msg (error);
354 fprintf (reply_fd, "%s\n", v);
357 ccl_pr_tree (rpn, reply_fd);
358 fprintf (reply_fd, "\n");
360 if (!*info.database )
362 fprintf (reply_fd, "%s\n",
363 gw_res_get (info.kernel_res, "gw.err.no.database",
364 "You must select database"));
367 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Searching in database %s",
370 fprintf (reply_fd, "Searching in database %s\n", info.database);
371 p = zass_p_search (info.zass, rpn, setname, info.database, info.sets);
374 fprintf (reply_fd, "Search fail\n");
377 if (p->errcode != -1)
379 display_diag_error (p->errcode, p->errstring);
382 fprintf (reply_fd, "%d %s\n", p->num,
383 gw_res_get (info.kernel_res, "gw.msg.hits", "hit(s)"));
384 us = user_set_add (setname, p->num, info.database, rpn, 1);
385 fprintf (reply_fd, "Result-set %s created\n", setname);
391 static int exec_target (struct ccl_token *list)
394 if (list->kind == CCL_TOK_EOL)
397 memcpy (info.target, list->name, len);
398 info.target [len] = '\0';
401 return reopen_target ();
404 static int exec_base (struct ccl_token *list)
406 struct ccl_token *li = list;
410 if (list->kind == CCL_TOK_EOL)
412 free (info.database);
413 while (li->kind != CCL_TOK_EOL)
417 if (li->kind == CCL_TOK_COMMA)
420 info.database = malloc (len);
421 assert (info.database );
424 while (li->kind != CCL_TOK_EOL)
426 memcpy (info.database+len, li->name, li->len);
428 info.database[len++] = ',';
430 if (li->kind == CCL_TOK_COMMA)
433 info.database[len-1] = '\0';
437 struct command_word show_tab [] =
444 static void present (const char *set, int offset, int number,
445 struct ccl_token *format_token)
447 const struct zass_presentent *zp;
452 max_number = atoi (gw_res_get (info.kernel_res, "gw.max.show",
454 if (number > max_number)
456 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "present in set %s", set);
457 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "present of %d records from offset %d",
459 zp = zass_p_present(info.zass, (char *) set, offset, number);
465 int record_log_fd = -1;
466 const char *record_log_name;
468 record_log_name = gw_res_get (info.kernel_res, "gw.marc.log",
472 sprintf (path, "%s/%s", gw_res_get (info.kernel_res,
475 record_log_fd = open (path, O_WRONLY|O_CREAT|O_APPEND, 0666);
476 if (record_log_fd == -1)
477 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, "Cannot open %s", path);
479 fprintf (reply_fd, gw_res_get (info.kernel_res,
483 fprintf (reply_fd, "\n");
484 for (i = 0, pp = zp->records; pp; pp = pp->next, i++)
488 const char *arg_ar[5];
490 fprintf (reply_fd, "--- %d/%d ---\n",
491 i+offset, offset+zp->num-1);
492 if (!gw_res_get (info.kernel_res, "gw.ignore.which", NULL))
494 if (pp->which == ZASS_REC_DIAG)
496 display_diag_error (pp->errcode, pp->errstring);
499 else if (pp->which != ZASS_REC_USMARC)
501 fprintf (reply_fd, "Unknown record kind %d\n",
506 if (record_log_fd != -1)
507 write (record_log_fd, pp->record, strlen(pp->record));
508 rec = iso2709_cvt (pp->record);
514 len = format_token->len;
515 if (len >= sizeof(format_str))
516 len = sizeof(format_str)-1;
517 memcpy (format_str, format_token->name, len);
518 format_str[len] = '\0';
520 if (info.fml && format_token &&
521 (!strcmp (format_str, "0") || !strcmp (format_str, "1")
522 || !strcmp(format_str, "2")))
525 arg_ar[1] = format_str;
526 arg_ar[2] = " \\list";
527 arg_ar[3] = marc_to_str (info.fml, rec);
529 fml_exec_call_argv (info.fml, arg_ar);
532 iso2709_display (rec, reply_fd);
534 iso2709_display (rec, reply_fd);
539 fprintf (reply_fd, "Not a MARC record\n");
541 if (record_log_fd != -1)
542 close (record_log_fd);
546 static int exec_show (struct ccl_token *list)
549 struct ccl_token *set_token = NULL;
550 struct ccl_token *format_token = NULL;
551 struct ccl_token *li = list;
552 int no_of_present = 0;
555 while (li->kind != CCL_TOK_EOL)
558 if (li->next->kind == CCL_TOK_EQ)
560 if (li->kind == CCL_TOK_SET) /* set = <name> ? */
567 modifier_no = command_search (show_tab, li, "ccl.token.");
570 fprintf (reply_fd, "Unknown modifier in show\n");
574 if (modifier_no == 1) /* f = <name> ? */
576 else if (modifier_no == 2) /* p = <name> ? */
578 if (li->kind != CCL_TOK_EOL /* p = <name> - <name> ? */
579 && li->next->kind == CCL_TOK_MINUS
580 && li->next->next != CCL_TOK_EOL)
586 fprintf (reply_fd, "%s\n", "Missing token after '='");
595 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Got set=%.*s", set_token->len,
598 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Got format=%.*s", format_token->len,
602 while (li->kind != CCL_TOK_EOL)
608 if (li->next->kind == CCL_TOK_EQ && li->kind != CCL_TOK_SET)
610 modifier_no = command_search (show_tab, li, "ccl.token.");
612 if (modifier_no == 2) /* p = <name> ? */
614 if (li->kind != CCL_TOK_EOL /* p = <name> - <name> ? */
615 && li->next->kind == CCL_TOK_MINUS
616 && li->next->next != CCL_TOK_EOL)
619 memcpy (tmp_str, li->name, len);
620 tmp_str [len] = '\0';
621 offset = atoi (tmp_str);
625 memcpy (tmp_str, li->name, len);
626 tmp_str [len] = '\0';
627 number = atoi (tmp_str) - offset + 1;
632 memcpy (tmp_str, li->name, len);
633 tmp_str [len] = '\0';
634 offset = atoi (tmp_str);
643 memcpy (tmp_str, li->name, len);
645 number = atoi (tmp_str);
649 if (offset > 0 && number > 0)
651 struct gw_user_set *us;
655 len = set_token->len;
656 memcpy (tmp_str, set_token->name, len);
658 us = user_set_search (tmp_str);
661 us = user_set_search (NULL);
662 if (us && us->hits != -1) /* proper result-set? */
664 if (offset <= us->hits)
666 if (offset+number-1 > us->hits)
667 number = us->hits - offset+1;
668 present (us->name, offset, number, format_token);
671 else if (!no_of_present) /* display error message once! */
673 fprintf (reply_fd, "%s\n",
674 gw_res_get (info.kernel_res, "gw.err.no.set",
675 "No result-set generated"));
680 if (!no_of_present) /* no records shown so far? */
682 struct gw_user_set *us;
685 us = user_set_search (NULL);
686 if (us && us->hits != -1) /* proper result-set? */
688 default_show = atoi (gw_res_get (info.kernel_res,
689 "gw.default.show", "20"));
690 if (us->hits > default_show)
691 present (us->name, 1, default_show, format_token);
692 else if (us->hits > 0)
693 present (us->name, 1, us->hits, format_token);
695 else /* display error message */
697 fprintf (reply_fd, "%s\n",
698 gw_res_get (info.kernel_res, "gw.err.no.set",
699 "No result-set generated"));
706 static int exec_command (const char *str)
708 struct ccl_token *cmd = ccl_tokenize (str);
711 if (cmd->kind != CCL_TOK_EOL &&
712 (no = command_search (command_tab, cmd, "ccl.command.")))
714 if (!info.zass && no != 9 && no != 4)
716 fprintf (reply_fd, "\n> %s\n", str);
717 if (!info.zass && (no == 1 || no == 2 || no == 3))
719 fprintf (reply_fd, "%s\n",
720 gw_res_get (info.kernel_res, "gw.err.no.target",
721 "No connection established - "
728 return exec_find (cmd->next);
730 return exec_show (cmd->next);
732 return exec_base (cmd->next);
734 return exec_help (cmd->next);
736 return exec_target (cmd->next);
738 fprintf (reply_fd, "%s\n",
739 gw_res_get (info.kernel_res, "gw.err.unimplemented",
740 "Not implemented yet"));
745 fprintf (reply_fd, "\n> %s\n", str);
746 fprintf (reply_fd, " ^ %s\n",
747 gw_res_get (info.kernel_res, "gw.err.unknown.command",
749 "Use help to see list of commands"));
754 int urp_start (int continuation, struct str_queue *queue)
756 char subject_str[128];
759 info.reply_fname = NULL;
761 if (email_header (queue, info.from_str, subject_str))
763 gw_log (GW_LOG_WARN, KERNEL_LOG, "No message body");
766 tty_init (stdout, 40, 70);
769 info.reply_fname = tempnam (gw_res_get (info.kernel_res,
770 "gw.reply.tmp.dir", NULL),
771 gw_res_get (info.kernel_res,
772 "gw.reply.tmp.prefix", "gwr"));
774 reply_fd = fopen (info.reply_fname, "w");
777 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, KERNEL_LOG, "Cannot create %s",
781 tty_init (reply_fd, 0, 0);
782 fprintf (reply_fd, "From: %s\n",
783 gw_res_get (info.kernel_res, "gw.msg.from","Email-gateway"));
784 fprintf (reply_fd, "Subject: ");
786 fprintf (reply_fd, "Z39.50 Re: %s", subject_str);
788 fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res,
791 fprintf (reply_fd, "\n");
792 gw_log (GW_LOG_ACCT, KERNEL_LOG, "User start %s", info.from_str);
795 gw_log (GW_LOG_WARN, KERNEL_LOG, "No From in email header");
796 fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res, "gw.msg.greeting",
797 "Email->Z39.50 gateway"));
799 fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res,
802 ccl_token_and = gw_res_get (info.kernel_res, "ccl.token.and", "and");
803 ccl_token_or = gw_res_get (info.kernel_res, "ccl.token.or", "or");
804 ccl_token_not = gw_res_get (info.kernel_res, "ccl.token.not", "not");
805 ccl_token_set = gw_res_get (info.kernel_res, "ccl.token.set", "set");
809 int urp_command (struct str_queue *queue)
813 while (str_queue_deq (queue, line_buf, LINE_MAX))
815 if (line_buf[0] == '\n')
818 while (str_queue_deq (queue, 0, 0))
824 if ((cp = strchr (line_buf, '\n')))
826 gw_log (GW_LOG_ACCT, KERNEL_LOG, "cmd: %s", line_buf);
827 if (isalpha (line_buf[0]))
828 exec_command (line_buf);
836 if (!info.command_no)
838 fprintf (reply_fd, "%s\n",
839 gw_res_get (info.kernel_res, "gw.err.nullbody", "No body"));
848 assert (info.reply_fname);
852 mta = gw_res_get (info.kernel_res, "gw.reply.mta",
853 "/usr/lib/sendmail");
854 sprintf (cmd, "%s %s < %s", mta, info.from_str, info.reply_fname);
856 mta_code = system (cmd);
858 gw_log (GW_LOG_FATAL, KERNEL_LOG,
859 "Reply '%s' got exit code %d", cmd, mta_code);
861 unlink (info.reply_fname);
862 gw_log (GW_LOG_ACCT, KERNEL_LOG, "User end %s", info.from_str);