1 /* Gateway kernel - User Request Processor
5 * Revision 1.30 1995/04/20 16:10:47 adam
6 * Modified to work with non-blocking zass-api. Not using non-blocking
9 * Revision 1.29 1995/04/19 16:01:58 adam
10 * Some hacks to get the FIFO communication work!! Isn't reliable.
11 * Resource gw.account added - default account info.
13 * Revision 1.28 1995/04/19 13:19:09 adam
14 * New command: account - for authentication.
16 * Revision 1.27 1995/04/19 10:46:19 adam
17 * Persistency works much better now. New command: status - history-like
19 * Revision 1.26 1995/04/19 07:31:12 adam
20 * First work on Z39.50 persistence.
22 * Revision 1.25 1995/04/17 09:34:33 adam
23 * Timeout (idletime) adjustable. Minor changes in kernel.
25 * Revision 1.24 1995/03/28 11:42:35 adam
26 * First use of string-queue utility.
28 * Revision 1.23 1995/03/28 08:01:28 adam
29 * FIFO existence is used to test for a running kernel.
31 * Revision 1.22 1995/03/27 12:51:05 adam
32 * New log level in use: GW_LOG_ERRNO.
34 * Revision 1.21 1995/03/27 08:24:04 adam
35 * First use of gip interface and gw-db.
36 * First work on eti program.
38 * Revision 1.20 1995/03/03 17:19:17 adam
39 * Smarter presentation. Bug fix in email header interpretation.
41 * Revision 1.19 1995/03/02 09:32:11 adam
42 * New presentation formats. f0=full, f1=brief, f2=mid
44 * Revision 1.18 1995/03/01 14:32:26 adam
45 * Better diagnostics. Default is, that only one database selected when
48 * Revision 1.17 1995/02/28 13:16:26 adam
49 * Configurable From: added.
51 * Revision 1.16 1995/02/23 10:08:20 adam
52 * Added logging of all user commands.
54 * Revision 1.15 1995/02/23 08:32:17 adam
57 * Revision 1.13 1995/02/22 16:54:42 adam
58 * Qualifiers of LOC target updated. More logging messages.
60 * Revision 1.12 1995/02/22 15:51:51 adam
61 * Bug fix: swap of parameter number and offset in function present.
63 * Revision 1.11 1995/02/22 15:22:33 adam
64 * Much more checking of run-time state. Show command never retrieves
65 * more records than indicated by the previous search request. Help
66 * command available. The maximum number of records retrieved can be
69 * Revision 1.10 1995/02/22 08:51:35 adam
70 * Output function can be customized in fml, which is used to print
71 * the reply to reply_fd.
73 * Revision 1.9 1995/02/21 17:46:21 adam
76 * Revision 1.8 1995/02/21 12:12:00 adam
77 * Diagnostic record with error info. observed.
79 * Revision 1.7 1995/02/20 21:16:20 adam
80 * FML support. Bug fixes. Profile for drewdb.
82 * Revision 1.6 1995/02/17 14:41:14 quinn
83 * Added simple display of records.
85 * Revision 1.5 1995/02/17 14:22:13 adam
86 * First steps of CCL show command. Not finished yet.
88 * Revision 1.4 1995/02/17 09:08:36 adam
89 * Reply with subject. CCL base command implemented.
91 * Revision 1.3 1995/02/16 18:35:09 adam
92 * First use of Zdist library. Search requests are supported.
93 * Present requests are not supported yet.
95 * Revision 1.2 1995/02/16 13:21:00 adam
96 * Organization of resource files for targets and conversion
97 * language implemented.
99 * Revision 1.1 1995/02/15 17:45:30 adam
100 * First version of email gateway kernel. Email requests are read
101 * from stdin. The output is transferred to an MTA if 'From' is
102 * found in the header - or stdout if absent. No Z39.50 client is used.
115 #include <strqueue.h>
118 static char line_buf[LINE_MAX+1];
120 static void put_esc_str (const char *s)
126 int lgets (char *buf, int max, int fd)
133 if ((r=read (fd, buf+no, 1)) != 1)
136 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, KERNEL_LOG, "read fail");
138 gw_log (GW_LOG_WARN, KERNEL_LOG, "read eof");
144 if (buf[no++] == '\n')
151 int reopen_target (void)
155 gw_log (GW_LOG_WARN, KERNEL_LOG, "Zass free...");
156 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reopen_target");
157 info.zass = zass_open (info.hostname, info.port, NULL, /* complete */
158 *info.account ? info.account : NULL);
161 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Cannot connect to target %s:%d",
162 info.hostname, info.port);
163 fprintf (reply_fd, "%s %s:%d\n",
164 gw_res_get (info.kernel_res, "gw.err.connect",
165 "Cannot connect to target"),
166 info.hostname, info.port);
169 v = gw_res_get (info.kernel_res, "gw.description", NULL);
173 fprintf (reply_fd, "\n");
175 fprintf (reply_fd, "%s %s:%d\n",
176 gw_res_get (info.kernel_res, "gw.msg.connect",
177 "Connection established to"),
178 info.hostname, info.port);
180 fprintf (reply_fd, "%s:\n%s\n",
181 gw_res_get (info.kernel_res, "gw.msg.databases",
182 "Available databases"),
185 fprintf (reply_fd, "%s:\n%s\n",
186 gw_res_get (info.kernel_res, "gw.msg.database",
187 "Selected databases"),
190 fprintf (reply_fd, "set=%d\n", info.setno);
192 fprintf (reply_fd, "set=Default\n");
197 static struct command_word {
199 char *resource_suffix;
207 { "continue", "continue" },
208 { "status", "status" },
209 { "cancel", "cancel" },
210 { "target", "target" },
212 { "account", "account" },
216 static int command_search (struct command_word *tab, struct ccl_token *cmd,
217 const char *resource_prefix)
221 assert (resource_prefix);
224 while (tab->default_value)
226 char *cp, command_names[60];
227 char resource_name[60];
230 sprintf (resource_name, "%s%s", resource_prefix,
231 tab->resource_suffix);
232 v = gw_res_get (info.kernel_res, resource_name, tab->default_value);
234 strcpy (command_names, v);
240 if ((split = strchr (cp, ' ')))
242 if (cmd->len == strlen(cp) &&
243 !memcmp (cmd->name, cp, cmd->len))
255 static struct error_no_struct {
258 } error_ccl_tab[] = {
260 { CCL_ERR_TERM_EXPECTED, "term.expected" },
261 { CCL_ERR_RP_EXPECTED, "rp.expected" },
262 { CCL_ERR_SETNAME_EXPECTED, "setname.expected" },
263 { CCL_ERR_OP_EXPECTED, "op.expected" },
264 { CCL_ERR_BAD_RP, "bad.rp" },
265 { CCL_ERR_UNKNOWN_QUAL, "unknown.qual" },
266 { CCL_ERR_DOUBLE_QUAL, "double.qual" },
267 { CCL_ERR_EQ_EXPECTED, "eq.expected" },
268 { CCL_ERR_BAD_RELATION, "bad.relation" },
269 { CCL_ERR_TRUNC_NOT_LEFT, "trunc.not.left" },
270 { CCL_ERR_TRUNC_NOT_BOTH, "trunc.not.both" },
271 { CCL_ERR_TRUNC_NOT_RIGHT, "trunc.not.right" },
275 static char *error_no_search (struct error_no_struct *tab, int no)
277 struct error_no_struct *p = tab;
278 while (p->resource_name)
281 return p->resource_name;
287 static int email_header (struct str_queue *sq,
288 char *from_str, char *subject_str)
292 while (str_queue_deq (sq, line_buf, LINE_MAX))
294 if (line_buf[0] == '\n')
296 if (memcmp (line_buf, "From ", 5) == 0)
297 sscanf (line_buf+4, "%s", from_str);
298 if (memcmp (line_buf, "Subject: ", 9) == 0 &&
299 sscanf (line_buf+9, "%s", subject_str+1) == 1)
300 strcpy (subject_str, line_buf+9);
305 static void help_general (void)
307 put_esc_str (gw_res_get (info.kernel_res, "gw.help.general",
308 "Commands available in this service:\n"));
311 static int exec_help (struct ccl_token *list)
313 static char *sep = "-------------------------------\\n";
318 put_esc_str (gw_res_get (info.kernel_res, "gw.help.target",
319 "target <name> - selects a given target\n"));
322 put_esc_str (gw_res_get (info.kernel_res, "gw.help.base",
323 "base <base>.. - selects databases\n"));
326 put_esc_str (gw_res_get (info.kernel_res, "gw.help.find",
327 "find <query> - performs a search request\n"));
330 put_esc_str (gw_res_get (info.kernel_res, "gw.help.show",
331 "show <spec> - retrieves and displays "
337 static void display_diag_error (int code, const char *addinfo)
341 sprintf (str, "gw.bib1.diag.%d", code);
342 fprintf (reply_fd, "%s %d:\n %s: '%s'\n",
343 gw_res_get (info.kernel_res, "gw.msg.z39errcode",
346 gw_res_get (info.kernel_res, str, ""), addinfo);
349 static int exec_find (struct ccl_token *list, const char *search_str)
351 const struct zass_searchent *p;
352 struct gw_user_set *us;
355 struct ccl_rpn_node *rpn;
359 if (info.setno == -1)
360 strcpy (setname, "Default");
362 sprintf (setname, "%d", info.setno);
363 rpn = ccl_find (info.bibset, list, &error, &pos);
366 const char *v = NULL, *n;
369 fprintf (reply_fd, " %*s^ - ", pos - line_buf, " ");
371 n = error_no_search (error_ccl_tab, error);
374 sprintf (name, "gw.err.%s", n);
375 v = gw_res_get (info.kernel_res, name, NULL);
378 v = ccl_err_msg (error);
379 fprintf (reply_fd, "%s\n", v);
382 ccl_pr_tree (rpn, reply_fd);
383 fprintf (reply_fd, "\n");
385 if (!*info.database )
387 fprintf (reply_fd, "%s\n",
388 gw_res_get (info.kernel_res, "gw.err.no.database",
389 "You must select database"));
392 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Searching in database %s",
395 fprintf (reply_fd, "Searching in database %s\n", info.database);
396 p = zass_p_search (info.zass, rpn, setname, info.database, info.sets);
399 fprintf (reply_fd, "Search fail\n");
402 if (p->errcode != -1)
404 display_diag_error (p->errcode, p->errstring);
407 fprintf (reply_fd, "%d %s\n", p->num,
408 gw_res_get (info.kernel_res, "gw.msg.hits", "hit(s)"));
409 us = user_set_add (setname, p->num, info.database, rpn, 1, search_str);
410 fprintf (reply_fd, "Result-set %s created\n", setname);
416 static int exec_account (struct ccl_token *list)
418 if (list->kind != CCL_TOK_EOL)
421 memcpy (info.account, list->name, len);
422 info.target[len] = '\0';
425 *info.account = '\0';
429 static int exec_target (struct ccl_token *list)
432 if (list->kind == CCL_TOK_EOL)
435 memcpy (info.target, list->name, len);
436 info.target [len] = '\0';
439 return reopen_target ();
442 static void exec_status_r (struct gw_user_set *sp)
446 exec_status_r (sp->prev);
447 fprintf (reply_fd, "%6s %7d %12.12s %.50s\n", sp->name, sp->hits,
448 sp->database, sp->search_str);
451 static int exec_status (struct ccl_token *list)
453 fprintf (reply_fd, " Name Hits Database Find\n");
454 exec_status_r (info.sets);
458 static int exec_base (struct ccl_token *list)
460 struct ccl_token *li = list;
464 if (list->kind == CCL_TOK_EOL)
466 free (info.database);
467 while (li->kind != CCL_TOK_EOL)
471 if (li->kind == CCL_TOK_COMMA)
474 info.database = malloc (len);
475 assert (info.database );
478 while (li->kind != CCL_TOK_EOL)
480 memcpy (info.database+len, li->name, li->len);
482 info.database[len++] = ',';
484 if (li->kind == CCL_TOK_COMMA)
487 info.database[len-1] = '\0';
491 struct command_word show_tab [] =
498 static void present (const char *set, int offset, int number,
499 struct ccl_token *format_token)
501 const struct zass_presentent *zp;
506 max_number = atoi (gw_res_get (info.kernel_res, "gw.max.show",
508 if (number > max_number)
510 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "present in set %s", set);
511 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "present of %d records from offset %d",
513 zp = zass_p_present(info.zass, (char *) set, offset, number);
519 int record_log_fd = -1;
520 const char *record_log_name;
522 record_log_name = gw_res_get (info.kernel_res, "gw.marc.log",
526 sprintf (path, "%s/%s", gw_res_get (info.kernel_res,
529 record_log_fd = open (path, O_WRONLY|O_CREAT|O_APPEND, 0666);
530 if (record_log_fd == -1)
531 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, "Cannot open %s", path);
533 fprintf (reply_fd, gw_res_get (info.kernel_res,
535 "Got %d records from set %s"),
537 fprintf (reply_fd, "\n");
538 for (i = 0, pp = zp->records; pp; pp = pp->next, i++)
542 const char *arg_ar[5];
544 fprintf (reply_fd, "--- %d/%d ---\n",
545 i+offset, offset+zp->num-1);
546 if (!gw_res_get (info.kernel_res, "gw.ignore.which", NULL))
548 if (pp->which == ZASS_REC_DIAG)
550 display_diag_error (pp->errcode, pp->errstring);
553 else if (pp->which != ZASS_REC_USMARC)
555 fprintf (reply_fd, "Unknown record kind %d\n",
560 if (record_log_fd != -1)
561 write (record_log_fd, pp->record, strlen(pp->record));
562 rec = iso2709_cvt (pp->record);
568 len = format_token->len;
569 if (len >= sizeof(format_str))
570 len = sizeof(format_str)-1;
571 memcpy (format_str, format_token->name, len);
572 format_str[len] = '\0';
574 if (info.fml && format_token &&
575 (!strcmp (format_str, "0") || !strcmp (format_str, "1")
576 || !strcmp(format_str, "2")))
579 arg_ar[1] = format_str;
580 arg_ar[2] = " \\list";
581 arg_ar[3] = marc_to_str (info.fml, rec);
583 fml_exec_call_argv (info.fml, arg_ar);
586 iso2709_display (rec, reply_fd);
588 iso2709_display (rec, reply_fd);
593 fprintf (reply_fd, "Not a MARC record\n");
595 if (record_log_fd != -1)
596 close (record_log_fd);
600 static int exec_show (struct ccl_token *list)
603 struct ccl_token *set_token = NULL;
604 struct ccl_token *format_token = NULL;
605 struct ccl_token *li = list;
606 int no_of_present = 0;
609 while (li->kind != CCL_TOK_EOL)
612 if (li->next->kind == CCL_TOK_EQ)
614 if (li->kind == CCL_TOK_SET) /* set = <name> ? */
621 modifier_no = command_search (show_tab, li, "ccl.token.");
624 fprintf (reply_fd, "Unknown modifier in show\n");
628 if (modifier_no == 1) /* f = <name> ? */
630 else if (modifier_no == 2) /* p = <name> ? */
632 if (li->kind != CCL_TOK_EOL /* p = <name> - <name> ? */
633 && li->next->kind == CCL_TOK_MINUS
634 && li->next->next != CCL_TOK_EOL)
640 fprintf (reply_fd, "%s\n", "Missing token after '='");
649 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Got set=%.*s", set_token->len,
652 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Got format=%.*s", format_token->len,
656 while (li->kind != CCL_TOK_EOL)
662 if (li->next->kind == CCL_TOK_EQ && li->kind != CCL_TOK_SET)
664 modifier_no = command_search (show_tab, li, "ccl.token.");
666 if (modifier_no == 2) /* p = <name> ? */
668 if (li->kind != CCL_TOK_EOL /* p = <name> - <name> ? */
669 && li->next->kind == CCL_TOK_MINUS
670 && li->next->next != CCL_TOK_EOL)
673 memcpy (tmp_str, li->name, len);
674 tmp_str [len] = '\0';
675 offset = atoi (tmp_str);
679 memcpy (tmp_str, li->name, len);
680 tmp_str [len] = '\0';
681 number = atoi (tmp_str) - offset + 1;
686 memcpy (tmp_str, li->name, len);
687 tmp_str [len] = '\0';
688 offset = atoi (tmp_str);
697 memcpy (tmp_str, li->name, len);
699 number = atoi (tmp_str);
703 if (offset > 0 && number > 0)
705 struct gw_user_set *us;
709 len = set_token->len;
710 memcpy (tmp_str, set_token->name, len);
712 us = user_set_search (tmp_str);
715 us = user_set_search (NULL);
716 if (us && us->hits != -1) /* proper result-set? */
718 if (offset <= us->hits)
720 if (offset+number-1 > us->hits)
721 number = us->hits - offset+1;
722 present (us->name, offset, number, format_token);
725 else if (!no_of_present) /* display error message once! */
727 fprintf (reply_fd, "%s\n",
728 gw_res_get (info.kernel_res, "gw.err.no.set",
729 "No result-set generated"));
734 if (!no_of_present) /* no records shown so far? */
736 struct gw_user_set *us;
739 us = user_set_search (NULL);
740 if (us && us->hits != -1) /* proper result-set? */
742 default_show = atoi (gw_res_get (info.kernel_res,
743 "gw.default.show", "20"));
744 if (us->hits > default_show)
745 present (us->name, 1, default_show, format_token);
746 else if (us->hits > 0)
747 present (us->name, 1, us->hits, format_token);
749 else /* display error message */
751 fprintf (reply_fd, "%s\n",
752 gw_res_get (info.kernel_res, "gw.err.no.set",
753 "No result-set generated"));
760 static int exec_command (const char *str)
762 struct ccl_token *cmd = ccl_tokenize (str);
765 if (cmd->kind != CCL_TOK_EOL &&
766 (no = command_search (command_tab, cmd, "ccl.command.")))
768 if (!info.zass && no != 9 && no != 4 && no != 11 && no != 7)
770 fprintf (reply_fd, "\n> %s\n", str);
771 if (!info.zass && (no == 1 || no == 2 || no == 3))
773 fprintf (reply_fd, "%s\n",
774 gw_res_get (info.kernel_res, "gw.err.no.target",
775 "No connection established - "
780 ccl_token_and = gw_res_get (info.kernel_res, "ccl.token.and", "and");
781 ccl_token_or = gw_res_get (info.kernel_res, "ccl.token.or", "or");
782 ccl_token_not = gw_res_get (info.kernel_res, "ccl.token.not", "not");
783 ccl_token_set = gw_res_get (info.kernel_res, "ccl.token.set", "set");
788 return exec_find (cmd->next, str);
790 return exec_show (cmd->next);
792 return exec_base (cmd->next);
794 return exec_help (cmd->next);
796 return exec_status (cmd->next);
798 return exec_target (cmd->next);
800 return exec_account (cmd->next);
802 fprintf (reply_fd, "%s\n",
803 gw_res_get (info.kernel_res, "gw.err.unimplemented",
804 "Not implemented yet"));
809 fprintf (reply_fd, "\n> %s\n", str);
810 fprintf (reply_fd, " ^ %s\n",
811 gw_res_get (info.kernel_res, "gw.err.unknown.command",
813 "Use help to see list of commands"));
818 int urp_start (int continuation, struct str_queue *queue)
820 char subject_str[128];
823 info.reply_fname = NULL;
825 if (email_header (queue, info.from_str, subject_str))
827 gw_log (GW_LOG_WARN, KERNEL_LOG, "No message body");
830 tty_init (stdout, 40, 70);
833 info.reply_fname = tempnam (gw_res_get (info.kernel_res,
834 "gw.reply.tmp.dir", NULL),
835 gw_res_get (info.kernel_res,
836 "gw.reply.tmp.prefix", "gwr"));
838 reply_fd = fopen (info.reply_fname, "w");
841 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, KERNEL_LOG, "Cannot create %s",
845 tty_init (reply_fd, 0, 0);
846 fprintf (reply_fd, "From: %s\n",
847 gw_res_get (info.kernel_res, "gw.msg.from","Email-gateway"));
848 fprintf (reply_fd, "Subject: ");
850 fprintf (reply_fd, "Z39.50 Re: %s", subject_str);
852 fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res,
855 fprintf (reply_fd, "\n");
856 gw_log (GW_LOG_ACCT, KERNEL_LOG, "User start %s", info.from_str);
859 gw_log (GW_LOG_WARN, KERNEL_LOG, "No From in email header");
860 fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res, "gw.msg.greeting",
861 "Email->Z39.50 gateway"));
863 fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res,
869 int urp_command (struct str_queue *queue)
873 while (str_queue_deq (queue, line_buf, LINE_MAX))
875 if (line_buf[0] == '\n')
878 while (str_queue_deq (queue, 0, 0))
884 if ((cp = strchr (line_buf, '\n')))
886 gw_log (GW_LOG_ACCT, KERNEL_LOG, "cmd: %s", line_buf);
887 if (isalpha (line_buf[0]))
888 exec_command (line_buf);
896 if (!info.command_no)
898 fprintf (reply_fd, "%s\n",
899 gw_res_get (info.kernel_res, "gw.err.nullbody", "No body"));
908 assert (info.reply_fname);
912 mta = gw_res_get (info.kernel_res, "gw.reply.mta",
913 "/usr/lib/sendmail");
914 sprintf (cmd, "%s %s < %s", mta, info.from_str, info.reply_fname);
916 mta_code = system (cmd);
918 gw_log (GW_LOG_FATAL, KERNEL_LOG,
919 "Reply '%s' got exit code %d", cmd, mta_code);
921 unlink (info.reply_fname);
922 gw_log (GW_LOG_ACCT, KERNEL_LOG, "User end %s", info.from_str);