1 /* Gateway kernel - User Request Processor
5 * Revision 1.28 1995/04/19 13:19:09 adam
6 * New command: account - for authentication.
8 * Revision 1.27 1995/04/19 10:46:19 adam
9 * Persistency works much better now. New command: status - history-like
11 * Revision 1.26 1995/04/19 07:31:12 adam
12 * First work on Z39.50 persistence.
14 * Revision 1.25 1995/04/17 09:34:33 adam
15 * Timeout (idletime) adjustable. Minor changes in kernel.
17 * Revision 1.24 1995/03/28 11:42:35 adam
18 * First use of string-queue utility.
20 * Revision 1.23 1995/03/28 08:01:28 adam
21 * FIFO existence is used to test for a running kernel.
23 * Revision 1.22 1995/03/27 12:51:05 adam
24 * New log level in use: GW_LOG_ERRNO.
26 * Revision 1.21 1995/03/27 08:24:04 adam
27 * First use of gip interface and gw-db.
28 * First work on eti program.
30 * Revision 1.20 1995/03/03 17:19:17 adam
31 * Smarter presentation. Bug fix in email header interpretation.
33 * Revision 1.19 1995/03/02 09:32:11 adam
34 * New presentation formats. f0=full, f1=brief, f2=mid
36 * Revision 1.18 1995/03/01 14:32:26 adam
37 * Better diagnostics. Default is, that only one database selected when
40 * Revision 1.17 1995/02/28 13:16:26 adam
41 * Configurable From: added.
43 * Revision 1.16 1995/02/23 10:08:20 adam
44 * Added logging of all user commands.
46 * Revision 1.15 1995/02/23 08:32:17 adam
49 * Revision 1.13 1995/02/22 16:54:42 adam
50 * Qualifiers of LOC target updated. More logging messages.
52 * Revision 1.12 1995/02/22 15:51:51 adam
53 * Bug fix: swap of parameter number and offset in function present.
55 * Revision 1.11 1995/02/22 15:22:33 adam
56 * Much more checking of run-time state. Show command never retrieves
57 * more records than indicated by the previous search request. Help
58 * command available. The maximum number of records retrieved can be
61 * Revision 1.10 1995/02/22 08:51:35 adam
62 * Output function can be customized in fml, which is used to print
63 * the reply to reply_fd.
65 * Revision 1.9 1995/02/21 17:46:21 adam
68 * Revision 1.8 1995/02/21 12:12:00 adam
69 * Diagnostic record with error info. observed.
71 * Revision 1.7 1995/02/20 21:16:20 adam
72 * FML support. Bug fixes. Profile for drewdb.
74 * Revision 1.6 1995/02/17 14:41:14 quinn
75 * Added simple display of records.
77 * Revision 1.5 1995/02/17 14:22:13 adam
78 * First steps of CCL show command. Not finished yet.
80 * Revision 1.4 1995/02/17 09:08:36 adam
81 * Reply with subject. CCL base command implemented.
83 * Revision 1.3 1995/02/16 18:35:09 adam
84 * First use of Zdist library. Search requests are supported.
85 * Present requests are not supported yet.
87 * Revision 1.2 1995/02/16 13:21:00 adam
88 * Organization of resource files for targets and conversion
89 * language implemented.
91 * Revision 1.1 1995/02/15 17:45:30 adam
92 * First version of email gateway kernel. Email requests are read
93 * from stdin. The output is transferred to an MTA if 'From' is
94 * found in the header - or stdout if absent. No Z39.50 client is used.
107 #include <strqueue.h>
110 static char line_buf[LINE_MAX+1];
112 static void put_esc_str (const char *s)
118 int lgets (char *buf, int max, int fd)
125 if ((r=read (fd, buf+no, 1)) != 1)
128 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, KERNEL_LOG, "read fail");
134 if (buf[no++] == '\n')
141 int reopen_target (void)
145 gw_log (GW_LOG_WARN, KERNEL_LOG, "Zass free...");
146 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "reopen_target");
147 info.zass = zass_open (info.hostname, info.port, *info.account ?
148 info.account : NULL);
151 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Cannot connect to target %s:%d",
152 info.hostname, info.port);
153 fprintf (reply_fd, "%s %s:%d\n",
154 gw_res_get (info.kernel_res, "gw.err.connect",
155 "Cannot connect to target"),
156 info.hostname, info.port);
159 v = gw_res_get (info.kernel_res, "gw.description", NULL);
163 fprintf (reply_fd, "\n");
165 fprintf (reply_fd, "%s %s:%d\n",
166 gw_res_get (info.kernel_res, "gw.msg.connect",
167 "Connection established to"),
168 info.hostname, info.port);
170 fprintf (reply_fd, "%s:\n%s\n",
171 gw_res_get (info.kernel_res, "gw.msg.databases",
172 "Available databases"),
175 fprintf (reply_fd, "%s:\n%s\n",
176 gw_res_get (info.kernel_res, "gw.msg.database",
177 "Selected databases"),
180 fprintf (reply_fd, "set=%d\n", info.setno);
182 fprintf (reply_fd, "set=Default\n");
187 static struct command_word {
189 char *resource_suffix;
197 { "continue", "continue" },
198 { "status", "status" },
199 { "cancel", "cancel" },
200 { "target", "target" },
202 { "account", "account" },
206 static int command_search (struct command_word *tab, struct ccl_token *cmd,
207 const char *resource_prefix)
211 assert (resource_prefix);
214 while (tab->default_value)
216 char *cp, command_names[60];
217 char resource_name[60];
220 sprintf (resource_name, "%s%s", resource_prefix,
221 tab->resource_suffix);
222 v = gw_res_get (info.kernel_res, resource_name, tab->default_value);
224 strcpy (command_names, v);
230 if ((split = strchr (cp, ' ')))
232 if (cmd->len == strlen(cp) &&
233 !memcmp (cmd->name, cp, cmd->len))
245 static struct error_no_struct {
248 } error_ccl_tab[] = {
250 { CCL_ERR_TERM_EXPECTED, "term.expected" },
251 { CCL_ERR_RP_EXPECTED, "rp.expected" },
252 { CCL_ERR_SETNAME_EXPECTED, "setname.expected" },
253 { CCL_ERR_OP_EXPECTED, "op.expected" },
254 { CCL_ERR_BAD_RP, "bad.rp" },
255 { CCL_ERR_UNKNOWN_QUAL, "unknown.qual" },
256 { CCL_ERR_DOUBLE_QUAL, "double.qual" },
257 { CCL_ERR_EQ_EXPECTED, "eq.expected" },
258 { CCL_ERR_BAD_RELATION, "bad.relation" },
259 { CCL_ERR_TRUNC_NOT_LEFT, "trunc.not.left" },
260 { CCL_ERR_TRUNC_NOT_BOTH, "trunc.not.both" },
261 { CCL_ERR_TRUNC_NOT_RIGHT, "trunc.not.right" },
265 static char *error_no_search (struct error_no_struct *tab, int no)
267 struct error_no_struct *p = tab;
268 while (p->resource_name)
271 return p->resource_name;
277 static int email_header (struct str_queue *sq,
278 char *from_str, char *subject_str)
282 while (str_queue_deq (sq, line_buf, LINE_MAX))
284 if (line_buf[0] == '\n')
286 if (memcmp (line_buf, "From ", 5) == 0)
287 sscanf (line_buf+4, "%s", from_str);
288 if (memcmp (line_buf, "Subject: ", 9) == 0 &&
289 sscanf (line_buf+9, "%s", subject_str+1) == 1)
290 strcpy (subject_str, line_buf+9);
295 static void help_general (void)
297 put_esc_str (gw_res_get (info.kernel_res, "gw.help.general",
298 "Commands available in this service:\n"));
301 static int exec_help (struct ccl_token *list)
303 static char *sep = "-------------------------------\\n";
308 put_esc_str (gw_res_get (info.kernel_res, "gw.help.target",
309 "target <name> - selects a given target\n"));
312 put_esc_str (gw_res_get (info.kernel_res, "gw.help.base",
313 "base <base>.. - selects databases\n"));
316 put_esc_str (gw_res_get (info.kernel_res, "gw.help.find",
317 "find <query> - performs a search request\n"));
320 put_esc_str (gw_res_get (info.kernel_res, "gw.help.show",
321 "show <spec> - retrieves and displays "
327 static void display_diag_error (int code, const char *addinfo)
331 sprintf (str, "gw.bib1.diag.%d", code);
332 fprintf (reply_fd, "%s %d:\n %s: '%s'\n",
333 gw_res_get (info.kernel_res, "gw.msg.z39errcode",
336 gw_res_get (info.kernel_res, str, ""), addinfo);
339 static int exec_find (struct ccl_token *list, const char *search_str)
341 const struct zass_searchent *p;
342 struct gw_user_set *us;
345 struct ccl_rpn_node *rpn;
349 if (info.setno == -1)
350 strcpy (setname, "Default");
352 sprintf (setname, "%d", info.setno);
353 rpn = ccl_find (info.bibset, list, &error, &pos);
356 const char *v = NULL, *n;
359 fprintf (reply_fd, " %*s^ - ", pos - line_buf, " ");
361 n = error_no_search (error_ccl_tab, error);
364 sprintf (name, "gw.err.%s", n);
365 v = gw_res_get (info.kernel_res, name, NULL);
368 v = ccl_err_msg (error);
369 fprintf (reply_fd, "%s\n", v);
372 ccl_pr_tree (rpn, reply_fd);
373 fprintf (reply_fd, "\n");
375 if (!*info.database )
377 fprintf (reply_fd, "%s\n",
378 gw_res_get (info.kernel_res, "gw.err.no.database",
379 "You must select database"));
382 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Searching in database %s",
385 fprintf (reply_fd, "Searching in database %s\n", info.database);
386 p = zass_p_search (info.zass, rpn, setname, info.database, info.sets);
389 fprintf (reply_fd, "Search fail\n");
392 if (p->errcode != -1)
394 display_diag_error (p->errcode, p->errstring);
397 fprintf (reply_fd, "%d %s\n", p->num,
398 gw_res_get (info.kernel_res, "gw.msg.hits", "hit(s)"));
399 us = user_set_add (setname, p->num, info.database, rpn, 1, search_str);
400 fprintf (reply_fd, "Result-set %s created\n", setname);
406 static int exec_account (struct ccl_token *list)
408 if (list->kind != CCL_TOK_EOL)
411 memcpy (info.account, list->name, len);
412 info.target[len] = '\0';
415 *info.account = '\0';
419 static int exec_target (struct ccl_token *list)
422 if (list->kind == CCL_TOK_EOL)
425 memcpy (info.target, list->name, len);
426 info.target [len] = '\0';
429 return reopen_target ();
432 static void exec_status_r (struct gw_user_set *sp)
436 exec_status_r (sp->prev);
437 fprintf (reply_fd, "%6s %7d %12.12s %.50s\n", sp->name, sp->hits,
438 sp->database, sp->search_str);
441 static int exec_status (struct ccl_token *list)
443 fprintf (reply_fd, " Name Hits Database Find\n");
444 exec_status_r (info.sets);
448 static int exec_base (struct ccl_token *list)
450 struct ccl_token *li = list;
454 if (list->kind == CCL_TOK_EOL)
456 free (info.database);
457 while (li->kind != CCL_TOK_EOL)
461 if (li->kind == CCL_TOK_COMMA)
464 info.database = malloc (len);
465 assert (info.database );
468 while (li->kind != CCL_TOK_EOL)
470 memcpy (info.database+len, li->name, li->len);
472 info.database[len++] = ',';
474 if (li->kind == CCL_TOK_COMMA)
477 info.database[len-1] = '\0';
481 struct command_word show_tab [] =
488 static void present (const char *set, int offset, int number,
489 struct ccl_token *format_token)
491 const struct zass_presentent *zp;
496 max_number = atoi (gw_res_get (info.kernel_res, "gw.max.show",
498 if (number > max_number)
500 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "present in set %s", set);
501 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "present of %d records from offset %d",
503 zp = zass_p_present(info.zass, (char *) set, offset, number);
509 int record_log_fd = -1;
510 const char *record_log_name;
512 record_log_name = gw_res_get (info.kernel_res, "gw.marc.log",
516 sprintf (path, "%s/%s", gw_res_get (info.kernel_res,
519 record_log_fd = open (path, O_WRONLY|O_CREAT|O_APPEND, 0666);
520 if (record_log_fd == -1)
521 gw_log (GW_LOG_WARN|GW_LOG_ERRNO, "Cannot open %s", path);
523 fprintf (reply_fd, gw_res_get (info.kernel_res,
525 "Got %d records from set %s"),
527 fprintf (reply_fd, "\n");
528 for (i = 0, pp = zp->records; pp; pp = pp->next, i++)
532 const char *arg_ar[5];
534 fprintf (reply_fd, "--- %d/%d ---\n",
535 i+offset, offset+zp->num-1);
536 if (!gw_res_get (info.kernel_res, "gw.ignore.which", NULL))
538 if (pp->which == ZASS_REC_DIAG)
540 display_diag_error (pp->errcode, pp->errstring);
543 else if (pp->which != ZASS_REC_USMARC)
545 fprintf (reply_fd, "Unknown record kind %d\n",
550 if (record_log_fd != -1)
551 write (record_log_fd, pp->record, strlen(pp->record));
552 rec = iso2709_cvt (pp->record);
558 len = format_token->len;
559 if (len >= sizeof(format_str))
560 len = sizeof(format_str)-1;
561 memcpy (format_str, format_token->name, len);
562 format_str[len] = '\0';
564 if (info.fml && format_token &&
565 (!strcmp (format_str, "0") || !strcmp (format_str, "1")
566 || !strcmp(format_str, "2")))
569 arg_ar[1] = format_str;
570 arg_ar[2] = " \\list";
571 arg_ar[3] = marc_to_str (info.fml, rec);
573 fml_exec_call_argv (info.fml, arg_ar);
576 iso2709_display (rec, reply_fd);
578 iso2709_display (rec, reply_fd);
583 fprintf (reply_fd, "Not a MARC record\n");
585 if (record_log_fd != -1)
586 close (record_log_fd);
590 static int exec_show (struct ccl_token *list)
593 struct ccl_token *set_token = NULL;
594 struct ccl_token *format_token = NULL;
595 struct ccl_token *li = list;
596 int no_of_present = 0;
599 while (li->kind != CCL_TOK_EOL)
602 if (li->next->kind == CCL_TOK_EQ)
604 if (li->kind == CCL_TOK_SET) /* set = <name> ? */
611 modifier_no = command_search (show_tab, li, "ccl.token.");
614 fprintf (reply_fd, "Unknown modifier in show\n");
618 if (modifier_no == 1) /* f = <name> ? */
620 else if (modifier_no == 2) /* p = <name> ? */
622 if (li->kind != CCL_TOK_EOL /* p = <name> - <name> ? */
623 && li->next->kind == CCL_TOK_MINUS
624 && li->next->next != CCL_TOK_EOL)
630 fprintf (reply_fd, "%s\n", "Missing token after '='");
639 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Got set=%.*s", set_token->len,
642 gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Got format=%.*s", format_token->len,
646 while (li->kind != CCL_TOK_EOL)
652 if (li->next->kind == CCL_TOK_EQ && li->kind != CCL_TOK_SET)
654 modifier_no = command_search (show_tab, li, "ccl.token.");
656 if (modifier_no == 2) /* p = <name> ? */
658 if (li->kind != CCL_TOK_EOL /* p = <name> - <name> ? */
659 && li->next->kind == CCL_TOK_MINUS
660 && li->next->next != CCL_TOK_EOL)
663 memcpy (tmp_str, li->name, len);
664 tmp_str [len] = '\0';
665 offset = atoi (tmp_str);
669 memcpy (tmp_str, li->name, len);
670 tmp_str [len] = '\0';
671 number = atoi (tmp_str) - offset + 1;
676 memcpy (tmp_str, li->name, len);
677 tmp_str [len] = '\0';
678 offset = atoi (tmp_str);
687 memcpy (tmp_str, li->name, len);
689 number = atoi (tmp_str);
693 if (offset > 0 && number > 0)
695 struct gw_user_set *us;
699 len = set_token->len;
700 memcpy (tmp_str, set_token->name, len);
702 us = user_set_search (tmp_str);
705 us = user_set_search (NULL);
706 if (us && us->hits != -1) /* proper result-set? */
708 if (offset <= us->hits)
710 if (offset+number-1 > us->hits)
711 number = us->hits - offset+1;
712 present (us->name, offset, number, format_token);
715 else if (!no_of_present) /* display error message once! */
717 fprintf (reply_fd, "%s\n",
718 gw_res_get (info.kernel_res, "gw.err.no.set",
719 "No result-set generated"));
724 if (!no_of_present) /* no records shown so far? */
726 struct gw_user_set *us;
729 us = user_set_search (NULL);
730 if (us && us->hits != -1) /* proper result-set? */
732 default_show = atoi (gw_res_get (info.kernel_res,
733 "gw.default.show", "20"));
734 if (us->hits > default_show)
735 present (us->name, 1, default_show, format_token);
736 else if (us->hits > 0)
737 present (us->name, 1, us->hits, format_token);
739 else /* display error message */
741 fprintf (reply_fd, "%s\n",
742 gw_res_get (info.kernel_res, "gw.err.no.set",
743 "No result-set generated"));
750 static int exec_command (const char *str)
752 struct ccl_token *cmd = ccl_tokenize (str);
755 if (cmd->kind != CCL_TOK_EOL &&
756 (no = command_search (command_tab, cmd, "ccl.command.")))
758 if (!info.zass && no != 9 && no != 4 && no != 11 && no != 7)
760 fprintf (reply_fd, "\n> %s\n", str);
761 if (!info.zass && (no == 1 || no == 2 || no == 3))
763 fprintf (reply_fd, "%s\n",
764 gw_res_get (info.kernel_res, "gw.err.no.target",
765 "No connection established - "
770 ccl_token_and = gw_res_get (info.kernel_res, "ccl.token.and", "and");
771 ccl_token_or = gw_res_get (info.kernel_res, "ccl.token.or", "or");
772 ccl_token_not = gw_res_get (info.kernel_res, "ccl.token.not", "not");
773 ccl_token_set = gw_res_get (info.kernel_res, "ccl.token.set", "set");
778 return exec_find (cmd->next, str);
780 return exec_show (cmd->next);
782 return exec_base (cmd->next);
784 return exec_help (cmd->next);
786 return exec_status (cmd->next);
788 return exec_target (cmd->next);
790 return exec_account (cmd->next);
792 fprintf (reply_fd, "%s\n",
793 gw_res_get (info.kernel_res, "gw.err.unimplemented",
794 "Not implemented yet"));
799 fprintf (reply_fd, "\n> %s\n", str);
800 fprintf (reply_fd, " ^ %s\n",
801 gw_res_get (info.kernel_res, "gw.err.unknown.command",
803 "Use help to see list of commands"));
808 int urp_start (int continuation, struct str_queue *queue)
810 char subject_str[128];
813 info.reply_fname = NULL;
815 if (email_header (queue, info.from_str, subject_str))
817 gw_log (GW_LOG_WARN, KERNEL_LOG, "No message body");
820 tty_init (stdout, 40, 70);
823 info.reply_fname = tempnam (gw_res_get (info.kernel_res,
824 "gw.reply.tmp.dir", NULL),
825 gw_res_get (info.kernel_res,
826 "gw.reply.tmp.prefix", "gwr"));
828 reply_fd = fopen (info.reply_fname, "w");
831 gw_log (GW_LOG_FATAL|GW_LOG_ERRNO, KERNEL_LOG, "Cannot create %s",
835 tty_init (reply_fd, 0, 0);
836 fprintf (reply_fd, "From: %s\n",
837 gw_res_get (info.kernel_res, "gw.msg.from","Email-gateway"));
838 fprintf (reply_fd, "Subject: ");
840 fprintf (reply_fd, "Z39.50 Re: %s", subject_str);
842 fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res,
845 fprintf (reply_fd, "\n");
846 gw_log (GW_LOG_ACCT, KERNEL_LOG, "User start %s", info.from_str);
849 gw_log (GW_LOG_WARN, KERNEL_LOG, "No From in email header");
850 fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res, "gw.msg.greeting",
851 "Email->Z39.50 gateway"));
853 fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res,
859 int urp_command (struct str_queue *queue)
863 while (str_queue_deq (queue, line_buf, LINE_MAX))
865 if (line_buf[0] == '\n')
868 while (str_queue_deq (queue, 0, 0))
874 if ((cp = strchr (line_buf, '\n')))
876 gw_log (GW_LOG_ACCT, KERNEL_LOG, "cmd: %s", line_buf);
877 if (isalpha (line_buf[0]))
878 exec_command (line_buf);
886 if (!info.command_no)
888 fprintf (reply_fd, "%s\n",
889 gw_res_get (info.kernel_res, "gw.err.nullbody", "No body"));
898 assert (info.reply_fname);
902 mta = gw_res_get (info.kernel_res, "gw.reply.mta",
903 "/usr/lib/sendmail");
904 sprintf (cmd, "%s %s < %s", mta, info.from_str, info.reply_fname);
906 mta_code = system (cmd);
908 gw_log (GW_LOG_FATAL, KERNEL_LOG,
909 "Reply '%s' got exit code %d", cmd, mta_code);
911 unlink (info.reply_fname);
912 gw_log (GW_LOG_ACCT, KERNEL_LOG, "User end %s", info.from_str);