1 /* Gateway kernel - User Request Processor
5 * Revision 1.29 1995/04/19 16:01:58 adam
6 * Some hacks to get the FIFO communication work!! Isn't reliable.
7 * Resource gw.account added - default account info.
9 * Revision 1.28 1995/04/19 13:19:09 adam
10 * New command: account - for authentication.
12 * Revision 1.27 1995/04/19 10:46:19 adam
13 * Persistency works much better now. New command: status - history-like
15 * Revision 1.26 1995/04/19 07:31:12 adam
16 * First work on Z39.50 persistence.
18 * Revision 1.25 1995/04/17 09:34:33 adam
19 * Timeout (idletime) adjustable. Minor changes in kernel.
21 * Revision 1.24 1995/03/28 11:42:35 adam
22 * First use of string-queue utility.
24 * Revision 1.23 1995/03/28 08:01:28 adam
25 * FIFO existence is used to test for a running kernel.
27 * Revision 1.22 1995/03/27 12:51:05 adam
28 * New log level in use: GW_LOG_ERRNO.
30 * Revision 1.21 1995/03/27 08:24:04 adam
31 * First use of gip interface and gw-db.
32 * First work on eti program.
34 * Revision 1.20 1995/03/03 17:19:17 adam
35 * Smarter presentation. Bug fix in email header interpretation.
37 * Revision 1.19 1995/03/02 09:32:11 adam
38 * New presentation formats. f0=full, f1=brief, f2=mid
40 * Revision 1.18 1995/03/01 14:32:26 adam
41 * Better diagnostics. Default is, that only one database selected when
44 * Revision 1.17 1995/02/28 13:16:26 adam
45 * Configurable From: added.
47 * Revision 1.16 1995/02/23 10:08:20 adam
48 * Added logging of all user commands.
50 * Revision 1.15 1995/02/23 08:32:17 adam
53 * Revision 1.13 1995/02/22 16:54:42 adam
54 * Qualifiers of LOC target updated. More logging messages.
56 * Revision 1.12 1995/02/22 15:51:51 adam
57 * Bug fix: swap of parameter number and offset in function present.
59 * Revision 1.11 1995/02/22 15:22:33 adam
60 * Much more checking of run-time state. Show command never retrieves
61 * more records than indicated by the previous search request. Help
62 * command available. The maximum number of records retrieved can be
65 * Revision 1.10 1995/02/22 08:51:35 adam
66 * Output function can be customized in fml, which is used to print
67 * the reply to reply_fd.
69 * Revision 1.9 1995/02/21 17:46:21 adam
72 * Revision 1.8 1995/02/21 12:12:00 adam
73 * Diagnostic record with error info. observed.
75 * Revision 1.7 1995/02/20 21:16:20 adam
76 * FML support. Bug fixes. Profile for drewdb.
78 * Revision 1.6 1995/02/17 14:41:14 quinn
79 * Added simple display of records.
81 * Revision 1.5 1995/02/17 14:22:13 adam
82 * First steps of CCL show command. Not finished yet.
84 * Revision 1.4 1995/02/17 09:08:36 adam
85 * Reply with subject. CCL base command implemented.
87 * Revision 1.3 1995/02/16 18:35:09 adam
88 * First use of Zdist library. Search requests are supported.
89 * Present requests are not supported yet.
91 * Revision 1.2 1995/02/16 13:21:00 adam
92 * Organization of resource files for targets and conversion
93 * language implemented.
95 * Revision 1.1 1995/02/15 17:45:30 adam
96 * First version of email gateway kernel. Email requests are read
97 * from stdin. The output is transferred to an MTA if 'From' is
98 * found in the header - or stdout if absent. No Z39.50 client is used.
111 #include <strqueue.h>
114 static char line_buf[LINE_MAX+1];
116 static void put_esc_str (const char *s)
122 int lgets (char *buf, int max, int fd)
129 if ((r=read (fd, buf+no, 1)) != 1)
132 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, KERNEL_LOG, "read fail");
134 gw_log (GW_LOG_WARN, KERNEL_LOG, "read eof");
140 if (buf[no++] == '\n')
147 int reopen_target (void)
151 gw_log (GW_LOG_WARN, KERNEL_LOG, "Zass free...");
152 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reopen_target");
153 info.zass = zass_open (info.hostname, info.port, *info.account ?
154 info.account : NULL);
157 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Cannot connect to target %s:%d",
158 info.hostname, info.port);
159 fprintf (reply_fd, "%s %s:%d\n",
160 gw_res_get (info.kernel_res, "gw.err.connect",
161 "Cannot connect to target"),
162 info.hostname, info.port);
165 v = gw_res_get (info.kernel_res, "gw.description", NULL);
169 fprintf (reply_fd, "\n");
171 fprintf (reply_fd, "%s %s:%d\n",
172 gw_res_get (info.kernel_res, "gw.msg.connect",
173 "Connection established to"),
174 info.hostname, info.port);
176 fprintf (reply_fd, "%s:\n%s\n",
177 gw_res_get (info.kernel_res, "gw.msg.databases",
178 "Available databases"),
181 fprintf (reply_fd, "%s:\n%s\n",
182 gw_res_get (info.kernel_res, "gw.msg.database",
183 "Selected databases"),
186 fprintf (reply_fd, "set=%d\n", info.setno);
188 fprintf (reply_fd, "set=Default\n");
193 static struct command_word {
195 char *resource_suffix;
203 { "continue", "continue" },
204 { "status", "status" },
205 { "cancel", "cancel" },
206 { "target", "target" },
208 { "account", "account" },
212 static int command_search (struct command_word *tab, struct ccl_token *cmd,
213 const char *resource_prefix)
217 assert (resource_prefix);
220 while (tab->default_value)
222 char *cp, command_names[60];
223 char resource_name[60];
226 sprintf (resource_name, "%s%s", resource_prefix,
227 tab->resource_suffix);
228 v = gw_res_get (info.kernel_res, resource_name, tab->default_value);
230 strcpy (command_names, v);
236 if ((split = strchr (cp, ' ')))
238 if (cmd->len == strlen(cp) &&
239 !memcmp (cmd->name, cp, cmd->len))
251 static struct error_no_struct {
254 } error_ccl_tab[] = {
256 { CCL_ERR_TERM_EXPECTED, "term.expected" },
257 { CCL_ERR_RP_EXPECTED, "rp.expected" },
258 { CCL_ERR_SETNAME_EXPECTED, "setname.expected" },
259 { CCL_ERR_OP_EXPECTED, "op.expected" },
260 { CCL_ERR_BAD_RP, "bad.rp" },
261 { CCL_ERR_UNKNOWN_QUAL, "unknown.qual" },
262 { CCL_ERR_DOUBLE_QUAL, "double.qual" },
263 { CCL_ERR_EQ_EXPECTED, "eq.expected" },
264 { CCL_ERR_BAD_RELATION, "bad.relation" },
265 { CCL_ERR_TRUNC_NOT_LEFT, "trunc.not.left" },
266 { CCL_ERR_TRUNC_NOT_BOTH, "trunc.not.both" },
267 { CCL_ERR_TRUNC_NOT_RIGHT, "trunc.not.right" },
271 static char *error_no_search (struct error_no_struct *tab, int no)
273 struct error_no_struct *p = tab;
274 while (p->resource_name)
277 return p->resource_name;
283 static int email_header (struct str_queue *sq,
284 char *from_str, char *subject_str)
288 while (str_queue_deq (sq, line_buf, LINE_MAX))
290 if (line_buf[0] == '\n')
292 if (memcmp (line_buf, "From ", 5) == 0)
293 sscanf (line_buf+4, "%s", from_str);
294 if (memcmp (line_buf, "Subject: ", 9) == 0 &&
295 sscanf (line_buf+9, "%s", subject_str+1) == 1)
296 strcpy (subject_str, line_buf+9);
301 static void help_general (void)
303 put_esc_str (gw_res_get (info.kernel_res, "gw.help.general",
304 "Commands available in this service:\n"));
307 static int exec_help (struct ccl_token *list)
309 static char *sep = "-------------------------------\\n";
314 put_esc_str (gw_res_get (info.kernel_res, "gw.help.target",
315 "target <name> - selects a given target\n"));
318 put_esc_str (gw_res_get (info.kernel_res, "gw.help.base",
319 "base <base>.. - selects databases\n"));
322 put_esc_str (gw_res_get (info.kernel_res, "gw.help.find",
323 "find <query> - performs a search request\n"));
326 put_esc_str (gw_res_get (info.kernel_res, "gw.help.show",
327 "show <spec> - retrieves and displays "
333 static void display_diag_error (int code, const char *addinfo)
337 sprintf (str, "gw.bib1.diag.%d", code);
338 fprintf (reply_fd, "%s %d:\n %s: '%s'\n",
339 gw_res_get (info.kernel_res, "gw.msg.z39errcode",
342 gw_res_get (info.kernel_res, str, ""), addinfo);
345 static int exec_find (struct ccl_token *list, const char *search_str)
347 const struct zass_searchent *p;
348 struct gw_user_set *us;
351 struct ccl_rpn_node *rpn;
355 if (info.setno == -1)
356 strcpy (setname, "Default");
358 sprintf (setname, "%d", info.setno);
359 rpn = ccl_find (info.bibset, list, &error, &pos);
362 const char *v = NULL, *n;
365 fprintf (reply_fd, " %*s^ - ", pos - line_buf, " ");
367 n = error_no_search (error_ccl_tab, error);
370 sprintf (name, "gw.err.%s", n);
371 v = gw_res_get (info.kernel_res, name, NULL);
374 v = ccl_err_msg (error);
375 fprintf (reply_fd, "%s\n", v);
378 ccl_pr_tree (rpn, reply_fd);
379 fprintf (reply_fd, "\n");
381 if (!*info.database )
383 fprintf (reply_fd, "%s\n",
384 gw_res_get (info.kernel_res, "gw.err.no.database",
385 "You must select database"));
388 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Searching in database %s",
391 fprintf (reply_fd, "Searching in database %s\n", info.database);
392 p = zass_p_search (info.zass, rpn, setname, info.database, info.sets);
395 fprintf (reply_fd, "Search fail\n");
398 if (p->errcode != -1)
400 display_diag_error (p->errcode, p->errstring);
403 fprintf (reply_fd, "%d %s\n", p->num,
404 gw_res_get (info.kernel_res, "gw.msg.hits", "hit(s)"));
405 us = user_set_add (setname, p->num, info.database, rpn, 1, search_str);
406 fprintf (reply_fd, "Result-set %s created\n", setname);
412 static int exec_account (struct ccl_token *list)
414 if (list->kind != CCL_TOK_EOL)
417 memcpy (info.account, list->name, len);
418 info.target[len] = '\0';
421 *info.account = '\0';
425 static int exec_target (struct ccl_token *list)
428 if (list->kind == CCL_TOK_EOL)
431 memcpy (info.target, list->name, len);
432 info.target [len] = '\0';
435 return reopen_target ();
438 static void exec_status_r (struct gw_user_set *sp)
442 exec_status_r (sp->prev);
443 fprintf (reply_fd, "%6s %7d %12.12s %.50s\n", sp->name, sp->hits,
444 sp->database, sp->search_str);
447 static int exec_status (struct ccl_token *list)
449 fprintf (reply_fd, " Name Hits Database Find\n");
450 exec_status_r (info.sets);
454 static int exec_base (struct ccl_token *list)
456 struct ccl_token *li = list;
460 if (list->kind == CCL_TOK_EOL)
462 free (info.database);
463 while (li->kind != CCL_TOK_EOL)
467 if (li->kind == CCL_TOK_COMMA)
470 info.database = malloc (len);
471 assert (info.database );
474 while (li->kind != CCL_TOK_EOL)
476 memcpy (info.database+len, li->name, li->len);
478 info.database[len++] = ',';
480 if (li->kind == CCL_TOK_COMMA)
483 info.database[len-1] = '\0';
487 struct command_word show_tab [] =
494 static void present (const char *set, int offset, int number,
495 struct ccl_token *format_token)
497 const struct zass_presentent *zp;
502 max_number = atoi (gw_res_get (info.kernel_res, "gw.max.show",
504 if (number > max_number)
506 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "present in set %s", set);
507 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "present of %d records from offset %d",
509 zp = zass_p_present(info.zass, (char *) set, offset, number);
515 int record_log_fd = -1;
516 const char *record_log_name;
518 record_log_name = gw_res_get (info.kernel_res, "gw.marc.log",
522 sprintf (path, "%s/%s", gw_res_get (info.kernel_res,
525 record_log_fd = open (path, O_WRONLY|O_CREAT|O_APPEND, 0666);
526 if (record_log_fd == -1)
527 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, "Cannot open %s", path);
529 fprintf (reply_fd, gw_res_get (info.kernel_res,
531 "Got %d records from set %s"),
533 fprintf (reply_fd, "\n");
534 for (i = 0, pp = zp->records; pp; pp = pp->next, i++)
538 const char *arg_ar[5];
540 fprintf (reply_fd, "--- %d/%d ---\n",
541 i+offset, offset+zp->num-1);
542 if (!gw_res_get (info.kernel_res, "gw.ignore.which", NULL))
544 if (pp->which == ZASS_REC_DIAG)
546 display_diag_error (pp->errcode, pp->errstring);
549 else if (pp->which != ZASS_REC_USMARC)
551 fprintf (reply_fd, "Unknown record kind %d\n",
556 if (record_log_fd != -1)
557 write (record_log_fd, pp->record, strlen(pp->record));
558 rec = iso2709_cvt (pp->record);
564 len = format_token->len;
565 if (len >= sizeof(format_str))
566 len = sizeof(format_str)-1;
567 memcpy (format_str, format_token->name, len);
568 format_str[len] = '\0';
570 if (info.fml && format_token &&
571 (!strcmp (format_str, "0") || !strcmp (format_str, "1")
572 || !strcmp(format_str, "2")))
575 arg_ar[1] = format_str;
576 arg_ar[2] = " \\list";
577 arg_ar[3] = marc_to_str (info.fml, rec);
579 fml_exec_call_argv (info.fml, arg_ar);
582 iso2709_display (rec, reply_fd);
584 iso2709_display (rec, reply_fd);
589 fprintf (reply_fd, "Not a MARC record\n");
591 if (record_log_fd != -1)
592 close (record_log_fd);
596 static int exec_show (struct ccl_token *list)
599 struct ccl_token *set_token = NULL;
600 struct ccl_token *format_token = NULL;
601 struct ccl_token *li = list;
602 int no_of_present = 0;
605 while (li->kind != CCL_TOK_EOL)
608 if (li->next->kind == CCL_TOK_EQ)
610 if (li->kind == CCL_TOK_SET) /* set = <name> ? */
617 modifier_no = command_search (show_tab, li, "ccl.token.");
620 fprintf (reply_fd, "Unknown modifier in show\n");
624 if (modifier_no == 1) /* f = <name> ? */
626 else if (modifier_no == 2) /* p = <name> ? */
628 if (li->kind != CCL_TOK_EOL /* p = <name> - <name> ? */
629 && li->next->kind == CCL_TOK_MINUS
630 && li->next->next != CCL_TOK_EOL)
636 fprintf (reply_fd, "%s\n", "Missing token after '='");
645 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Got set=%.*s", set_token->len,
648 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Got format=%.*s", format_token->len,
652 while (li->kind != CCL_TOK_EOL)
658 if (li->next->kind == CCL_TOK_EQ && li->kind != CCL_TOK_SET)
660 modifier_no = command_search (show_tab, li, "ccl.token.");
662 if (modifier_no == 2) /* p = <name> ? */
664 if (li->kind != CCL_TOK_EOL /* p = <name> - <name> ? */
665 && li->next->kind == CCL_TOK_MINUS
666 && li->next->next != CCL_TOK_EOL)
669 memcpy (tmp_str, li->name, len);
670 tmp_str [len] = '\0';
671 offset = atoi (tmp_str);
675 memcpy (tmp_str, li->name, len);
676 tmp_str [len] = '\0';
677 number = atoi (tmp_str) - offset + 1;
682 memcpy (tmp_str, li->name, len);
683 tmp_str [len] = '\0';
684 offset = atoi (tmp_str);
693 memcpy (tmp_str, li->name, len);
695 number = atoi (tmp_str);
699 if (offset > 0 && number > 0)
701 struct gw_user_set *us;
705 len = set_token->len;
706 memcpy (tmp_str, set_token->name, len);
708 us = user_set_search (tmp_str);
711 us = user_set_search (NULL);
712 if (us && us->hits != -1) /* proper result-set? */
714 if (offset <= us->hits)
716 if (offset+number-1 > us->hits)
717 number = us->hits - offset+1;
718 present (us->name, offset, number, format_token);
721 else if (!no_of_present) /* display error message once! */
723 fprintf (reply_fd, "%s\n",
724 gw_res_get (info.kernel_res, "gw.err.no.set",
725 "No result-set generated"));
730 if (!no_of_present) /* no records shown so far? */
732 struct gw_user_set *us;
735 us = user_set_search (NULL);
736 if (us && us->hits != -1) /* proper result-set? */
738 default_show = atoi (gw_res_get (info.kernel_res,
739 "gw.default.show", "20"));
740 if (us->hits > default_show)
741 present (us->name, 1, default_show, format_token);
742 else if (us->hits > 0)
743 present (us->name, 1, us->hits, format_token);
745 else /* display error message */
747 fprintf (reply_fd, "%s\n",
748 gw_res_get (info.kernel_res, "gw.err.no.set",
749 "No result-set generated"));
756 static int exec_command (const char *str)
758 struct ccl_token *cmd = ccl_tokenize (str);
761 if (cmd->kind != CCL_TOK_EOL &&
762 (no = command_search (command_tab, cmd, "ccl.command.")))
764 if (!info.zass && no != 9 && no != 4 && no != 11 && no != 7)
766 fprintf (reply_fd, "\n> %s\n", str);
767 if (!info.zass && (no == 1 || no == 2 || no == 3))
769 fprintf (reply_fd, "%s\n",
770 gw_res_get (info.kernel_res, "gw.err.no.target",
771 "No connection established - "
776 ccl_token_and = gw_res_get (info.kernel_res, "ccl.token.and", "and");
777 ccl_token_or = gw_res_get (info.kernel_res, "ccl.token.or", "or");
778 ccl_token_not = gw_res_get (info.kernel_res, "ccl.token.not", "not");
779 ccl_token_set = gw_res_get (info.kernel_res, "ccl.token.set", "set");
784 return exec_find (cmd->next, str);
786 return exec_show (cmd->next);
788 return exec_base (cmd->next);
790 return exec_help (cmd->next);
792 return exec_status (cmd->next);
794 return exec_target (cmd->next);
796 return exec_account (cmd->next);
798 fprintf (reply_fd, "%s\n",
799 gw_res_get (info.kernel_res, "gw.err.unimplemented",
800 "Not implemented yet"));
805 fprintf (reply_fd, "\n> %s\n", str);
806 fprintf (reply_fd, " ^ %s\n",
807 gw_res_get (info.kernel_res, "gw.err.unknown.command",
809 "Use help to see list of commands"));
814 int urp_start (int continuation, struct str_queue *queue)
816 char subject_str[128];
819 info.reply_fname = NULL;
821 if (email_header (queue, info.from_str, subject_str))
823 gw_log (GW_LOG_WARN, KERNEL_LOG, "No message body");
826 tty_init (stdout, 40, 70);
829 info.reply_fname = tempnam (gw_res_get (info.kernel_res,
830 "gw.reply.tmp.dir", NULL),
831 gw_res_get (info.kernel_res,
832 "gw.reply.tmp.prefix", "gwr"));
834 reply_fd = fopen (info.reply_fname, "w");
837 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, KERNEL_LOG, "Cannot create %s",
841 tty_init (reply_fd, 0, 0);
842 fprintf (reply_fd, "From: %s\n",
843 gw_res_get (info.kernel_res, "gw.msg.from","Email-gateway"));
844 fprintf (reply_fd, "Subject: ");
846 fprintf (reply_fd, "Z39.50 Re: %s", subject_str);
848 fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res,
851 fprintf (reply_fd, "\n");
852 gw_log (GW_LOG_ACCT, KERNEL_LOG, "User start %s", info.from_str);
855 gw_log (GW_LOG_WARN, KERNEL_LOG, "No From in email header");
856 fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res, "gw.msg.greeting",
857 "Email->Z39.50 gateway"));
859 fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res,
865 int urp_command (struct str_queue *queue)
869 while (str_queue_deq (queue, line_buf, LINE_MAX))
871 if (line_buf[0] == '\n')
874 while (str_queue_deq (queue, 0, 0))
880 if ((cp = strchr (line_buf, '\n')))
882 gw_log (GW_LOG_ACCT, KERNEL_LOG, "cmd: %s", line_buf);
883 if (isalpha (line_buf[0]))
884 exec_command (line_buf);
892 if (!info.command_no)
894 fprintf (reply_fd, "%s\n",
895 gw_res_get (info.kernel_res, "gw.err.nullbody", "No body"));
904 assert (info.reply_fname);
908 mta = gw_res_get (info.kernel_res, "gw.reply.mta",
909 "/usr/lib/sendmail");
910 sprintf (cmd, "%s %s < %s", mta, info.from_str, info.reply_fname);
912 mta_code = system (cmd);
914 gw_log (GW_LOG_FATAL, KERNEL_LOG,
915 "Reply '%s' got exit code %d", cmd, mta_code);
917 unlink (info.reply_fname);
918 gw_log (GW_LOG_ACCT, KERNEL_LOG, "User end %s", info.from_str);