New presentation formats. f0=full, f1=brief, f2=mid
[egate.git] / kernel / urp.c
index 29b0e62..6816906 100644 (file)
@@ -2,7 +2,48 @@
  * Europagate, 1995
  *
  * $Log: urp.c,v $
- * Revision 1.6  1995/02/17 14:41:14  quinn
+ * Revision 1.19  1995/03/02 09:32:11  adam
+ * New presentation formats. f0=full, f1=brief, f2=mid
+ *
+ * Revision 1.18  1995/03/01  14:32:26  adam
+ * Better diagnostics. Default is, that only one database selected when
+ * several are known.
+ *
+ * Revision 1.17  1995/02/28  13:16:26  adam
+ * Configurable From: added.
+ *
+ * Revision 1.16  1995/02/23  10:08:20  adam
+ * Added logging of all user commands.
+ *
+ * Revision 1.15  1995/02/23  08:32:17  adam
+ * Changed header.
+ *
+ * Revision 1.13  1995/02/22  16:54:42  adam
+ * Qualifiers of LOC target updated. More logging messages.
+ *
+ * Revision 1.12  1995/02/22  15:51:51  adam
+ * Bug fix: swap of parameter number and offset in function present.
+ *
+ * Revision 1.11  1995/02/22  15:22:33  adam
+ * Much more checking of run-time state. Show command never retrieves
+ * more records than indicated by the previous search request. Help
+ * command available. The maximum number of records retrieved can be
+ * controlled now.
+ *
+ * Revision 1.10  1995/02/22  08:51:35  adam
+ * Output function can be customized in fml, which is used to print
+ * the reply to reply_fd.
+ *
+ * Revision 1.9  1995/02/21  17:46:21  adam
+ * Minor changes.
+ *
+ * Revision 1.8  1995/02/21  12:12:00  adam
+ * Diagnostic record with error info. observed.
+ *
+ * Revision 1.7  1995/02/20  21:16:20  adam
+ * FML support. Bug fixes. Profile for drewdb.
+ *
+ * Revision 1.6  1995/02/17  14:41:14  quinn
  * Added simple display of records.
  *
  * Revision 1.5  1995/02/17  14:22:13  adam
 #include <ctype.h>
 #include <string.h>
 #include <unistd.h>
+#include <fcntl.h>
 
 #include "kernel.h"
-#include <iso2709.h>
 
 #define LINE_MAX 256
 
+static void put_esc_str (const char *s)
+{
+    int escape_flag = 0;
+    while (*s)
+    {
+        if (*s == '\\' && s[1])
+        {
+            switch (*++s)
+            {
+            case 'n':
+                fputc ('\n', reply_fd);
+                break;
+            case 't':
+                fputc ('\t', reply_fd);
+                break;
+            default:
+                fputc (*s, reply_fd);
+                break;
+            }
+            escape_flag = 1;
+        }
+        else
+        {
+            if (*s != ' ' || !escape_flag)
+                fputc (*s, reply_fd);
+            escape_flag = 0;
+        }
+        s++;
+    }
+}
+
 static int reopen_target (void)
 {
     const char *v;
     if (info.zass)
-        gw_log (GW_LOG_WARN, "urp", "Zass free...");
+        gw_log (GW_LOG_WARN, KERNEL_LOG, "Zass free...");
     info.zass = zass_open (info.hostname, info.port);
     if (!info.zass)
     {
@@ -54,11 +126,24 @@ static int reopen_target (void)
     }
     v = gw_res_get (info.kernel_res, "gw.description", NULL);
     if (v)
-        fprintf (reply_fd, "%s\n", v);
-    fprintf (reply_fd, "%s %s:%d\n %s\n",
-             gw_res_get (info.kernel_res, "gw.msg.databases",
-                         "Available databases on"),
-             info.hostname, info.port, info.databases);
+    {
+        put_esc_str (v);
+        fprintf (reply_fd, "\n");
+    }
+    fprintf (reply_fd, "%s %s:%d\n",
+             gw_res_get (info.kernel_res, "gw.msg.connect",
+                         "Connection established to"),
+             info.hostname, info.port);
+    if (*info.databases)
+        fprintf (reply_fd, "%s:\n%s\n",
+                 gw_res_get (info.kernel_res, "gw.msg.databases",
+                             "Available databases"),
+                 info.databases);
+    if (*info.database)
+        fprintf (reply_fd, "%s:\n%s\n",
+                 gw_res_get (info.kernel_res, "gw.msg.database",
+                             "Selected databases"),
+                 info.database);
     return 0;
 }
 
@@ -169,14 +254,57 @@ static int email_header (FILE *inf, char *from_str, char *subject_str)
     return 1;
 }
 
+static void help_general (void)
+{
+    put_esc_str (gw_res_get (info.kernel_res, "gw.help.general",
+                             "Commands available in this service:\n"));
+}
+
+static int exec_help (struct ccl_token *list)
+{
+    help_general ();
+
+#if 0
+    put_esc_str (gw_res_get (info.kernel_res, "gw.help.target",
+                             "target <name> - selects a given target\n"));
+
+    put_esc_str (gw_res_get (info.kernel_res, "gw.help.base",
+                             "base <base>..  - selects databases\n"));
+
+    put_esc_str (gw_res_get (info.kernel_res, "gw.help.find",
+                             "find <query>   - performs a search request\n"));
+
+    put_esc_str (gw_res_get (info.kernel_res, "gw.help.show",
+                             "show <spec>    - retrieves and displays "
+                             "records\n"));
+    put_esc_str (gw_res_get (info.kernel_res, "gw.help.help",
+                             "help           - displays help\n"));
+#endif
+    return 0;
+}
+
+static void display_diag_error (int code, const char *addinfo)
+{
+    static char str[20];
+
+    sprintf (str, "gw.bib1.diag.%d", code);
+    fprintf (reply_fd, "%s %d:\n %s: '%s'\n",
+             gw_res_get (info.kernel_res, "gw.msg.z39errcode", 
+                         "Z39.50 Error"),
+             code,
+             gw_res_get (info.kernel_res, str, ""), addinfo);
+}
+
 static int exec_find (struct ccl_token *list)
 {
     const struct zass_searchent *p;
+    struct gw_user_set *us;
 
     struct ccl_rpn_node *rpn;
     int error;
     const char *pos;
 
+    us = user_set_add ("Default", -1);
     rpn = ccl_find (info.bibset, list, &error, &pos);
     if (!rpn)
     {
@@ -199,18 +327,27 @@ static int exec_find (struct ccl_token *list)
     ccl_pr_tree (rpn, reply_fd);
     fprintf (reply_fd, "\n");
 
-    if (!info.zass)
-        return -2;
-    p = zass_search (info.zass, rpn, "Default", info.databases);
+    if (!*info.database )
+    {
+        fprintf (reply_fd, "%s\n",
+                 gw_res_get (info.kernel_res, "gw.err.no.database",
+                             "You must select database"));
+        return -3;
+    }
+    gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Searching in database %s",
+            info.database );
+    assert (info.zass);
+    p = zass_search (info.zass, rpn, "Default", info.database );
     if (!p)
         return -1;
+    if (p->errcode != -1)
+    {
+        display_diag_error (p->errcode, p->errstring);
+        return -2;
+    }
     fprintf (reply_fd, "%d %s\n", p->num,
              gw_res_get (info.kernel_res, "gw.msg.hits", "hit(s)"));
-    if (p->errcode != -1)
-        fprintf (reply_fd, "%s %d: %s\n",
-                 gw_res_get (info.kernel_res, "gw.msg.z39errcode",
-                             "Z39.50 error code"),
-                 p->errcode, p->errstring);
+    us->hits = p->num;
     return 0;
 }
 
@@ -232,9 +369,10 @@ static int exec_base (struct ccl_token *list)
     struct ccl_token *li = list;
     int len = 0;
 
+    assert (info.zass);
     if (list->kind == CCL_TOK_EOL)
         return -1;
-    free (info.databases);
+    free (info.database);
     while (li->kind != CCL_TOK_EOL)
     {
         len += li->len + 1;
@@ -242,52 +380,288 @@ static int exec_base (struct ccl_token *list)
         if (li->kind == CCL_TOK_COMMA)
             li = li->next;
     }
-    info.databases = malloc (len);
-    assert (info.databases);
+    info.database  = malloc (len);
+    assert (info.database );
     len = 0;
     li = list;
     while (li->kind != CCL_TOK_EOL)
     {
-        memcpy (info.databases+len, li->name, li->len);
+        memcpy (info.database+len, li->name, li->len);
         len += li->len;
-        info.databases[len++] = ',';
+        info.database[len++] = ',';
         li = li->next;
         if (li->kind == CCL_TOK_COMMA)
             li = li->next;
     }
-    info.databases[len-1] = '\0';
+    info.database[len-1] = '\0';
     return 0;
 }
 
-static int exec_show (struct ccl_token *list)
+struct command_word show_tab [] = 
 {
-    const struct zass_presentent *zp;
-    zass_record *pp;
-    char num_str[20];
-    int num;
+{   "f", "format"},
+{   "p", "position"},
+{   NULL, NULL }
+};
 
-    if (list->kind == CCL_TOK_EOL)
-        return -1;
-    if (!info.zass)
-        return -2;
+static void present (const char *set, int offset, int number,
+                     struct ccl_token *format_token)
+{
+    const struct zass_presentent *zp;
+    int len;
+    int max_number;
+    char format_str[16];
     
-    memcpy (num_str, list->name, list->len);
-    num_str[list->len] = '\0';
-
-    num = atoi (num_str);
-    if (!num)
-        return -3;
-    gw_log (GW_LOG_DEBUG, "urp", "zass_present of %d records", num);
-    zp = zass_present(info.zass, "Default", 1, num);
+    max_number = atoi (gw_res_get (info.kernel_res, "gw.max.show", 
+                                   "200"));
+    if (number > max_number)
+        number = max_number;
+    gw_log (GW_LOG_DEBUG, KERNEL_LOG, "present in set %s", set);
+    gw_log (GW_LOG_DEBUG, KERNEL_LOG, "present of %d records from offset %d",
+            number, offset);
+    zp = zass_present(info.zass, (char *) set, offset, number);
     if (zp)
     {
-       fprintf(reply_fd, "Got %d records\n", zp->num);
-       for (pp = zp->records; pp; pp = pp->next)
-       {
-           Iso2709Rec p = iso2709_cvt(pp->record);
-           iso2709_display(p, reply_fd);
-           iso2709_rm(p);
-       }
+        int i;
+        zass_record *pp;
+        char path[128];
+        int  record_log_fd = -1;
+        const char *record_log_name;
+
+        record_log_name = gw_res_get (info.kernel_res, "gw.marc.log",
+                                      NULL);
+        if (record_log_name)
+        {
+            sprintf (path, "%s/%s", gw_res_get (info.kernel_res,
+                                                "gw.path", "."),
+                     record_log_name );
+            record_log_fd = open (path, O_WRONLY|O_CREAT|O_APPEND, 0666);
+            if (record_log_fd == -1)
+                gw_log (GW_LOG_WARN, "Cannot open %s", path);
+        }
+        fprintf (reply_fd, gw_res_get (info.kernel_res,
+                                       "gw.msg.records",
+                                       "Got %d records"),
+                 zp->num);
+        fprintf (reply_fd, "\n");
+        for (i = 0, pp = zp->records; pp; pp = pp->next, i++)
+        {
+            Iso2709Rec rec;
+#if USE_FML
+            const char *arg_ar[5];
+#endif
+            fprintf (reply_fd, "--- %d/%d ---\n",
+                     i+offset, offset+zp->num-1);
+            if (!gw_res_get (info.kernel_res, "gw.ignore.which", NULL))
+            {
+                if (pp->which == ZASS_REC_DIAG)
+                {
+                    display_diag_error (pp->errcode, pp->errstring);
+                    continue;
+                }
+                else if (pp->which != ZASS_REC_USMARC)
+                {
+                    fprintf (reply_fd, "Unknown record kind %d\n",
+                             pp->which);
+                    continue;
+                }
+            }
+            if (record_log_fd != -1)
+                write (record_log_fd, pp->record, strlen(pp->record));
+            rec = iso2709_cvt (pp->record);
+            if (rec)
+            {
+#if USE_FML
+                if (format_token)
+                {
+                    len = format_token->len;
+                   if (len >= sizeof(format_str))
+                       len = sizeof(format_str)-1;
+                    memcpy (format_str, format_token->name, len);
+                    format_str[len] = '\0';
+                }
+                if (info.fml && format_token && 
+                    (!strcmp (format_str, "0") || !strcmp (format_str, "1")
+                    || !strcmp(format_str, "2")))
+                {
+                    arg_ar[0] = "\\f";
+                    arg_ar[1] = format_str;
+                    arg_ar[2] = " \\list";
+                    arg_ar[3] = marc_to_str (info.fml, rec);
+                    arg_ar[4] = NULL;
+                    fml_exec_call_argv (info.fml, arg_ar);
+                }
+                else
+                    iso2709_display (rec, reply_fd);
+#else
+                iso2709_display (rec, reply_fd);
+#endif
+                iso2709_rm (rec);
+            }
+            else
+                fprintf (reply_fd, "Not a MARC record\n");
+        }
+        if (record_log_fd != -1)
+            close (record_log_fd);
+    }
+}
+
+static int exec_show (struct ccl_token *list)
+{
+    char tmp_str[20];
+    struct ccl_token *set_token = NULL;
+    struct ccl_token *format_token = NULL;
+    struct ccl_token *li = list;
+    int no_of_present = 0;
+
+    assert (info.zass);
+    while (li->kind != CCL_TOK_EOL)
+    {
+        int modifier_no = 0;
+        if (li->next->kind == CCL_TOK_EQ)
+        {
+            if (li->kind == CCL_TOK_SET)    /* set = <name> ? */
+            {
+                li = li->next->next;
+                set_token = li;
+            }
+            else 
+            {
+                modifier_no = command_search (show_tab, li, "ccl.token.");
+                if (!modifier_no)
+                {
+                    fprintf (reply_fd, "Unknown modifier in show\n");
+                    return -1;
+                }
+                li = li->next->next;
+                if (modifier_no == 1)       /* f = <name> ? */
+                    format_token = li;
+                else if (modifier_no == 2)  /* p = <name> ? */
+                {
+                    if (li->kind != CCL_TOK_EOL   /* p = <name> - <name> ? */
+                        && li->next->kind == CCL_TOK_MINUS
+                        && li->next->next != CCL_TOK_EOL)
+                        li = li->next->next;
+                }
+            }
+            if (!li->next)
+            {
+                fprintf (reply_fd, "%s\n", "Missing token after '='");
+                return -2;
+            }
+            li = li->next;
+        }
+        else
+            li = li->next;
+    }
+    if (set_token)
+        gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Got set=%.*s", set_token->len,
+                set_token->name);
+    if (format_token)
+        gw_log (GW_LOG_DEBUG, KERNEL_LOG, "Got format=%.*s", format_token->len,
+                format_token->name);
+
+    li = list;
+    while (li->kind != CCL_TOK_EOL)
+    {
+        int modifier_no = 0;
+        int offset = 0;
+        int number = 0;
+        int len;
+        if (li->next->kind == CCL_TOK_EQ && li->kind != CCL_TOK_SET)
+        {
+            modifier_no = command_search (show_tab, li, "ccl.token.");
+            li = li->next->next;
+            if (modifier_no == 2)  /* p = <name> ? */
+            {
+                if (li->kind != CCL_TOK_EOL   /* p = <name> - <name> ? */
+                    && li->next->kind == CCL_TOK_MINUS
+                    && li->next->next != CCL_TOK_EOL)
+                {
+                    len = li->len;
+                    memcpy (tmp_str, li->name, len);
+                    tmp_str [len] = '\0';
+                    offset = atoi (tmp_str);
+                    li = li->next->next;
+
+                    len = li->len;
+                    memcpy (tmp_str, li->name, len);
+                    tmp_str [len] = '\0';
+                    number = atoi (tmp_str) - offset + 1;
+                }
+                else
+                {
+                    len = li->len;
+                    memcpy (tmp_str, li->name, len);
+                    tmp_str [len] = '\0';
+                    offset = atoi (tmp_str);
+                    number = 1;
+                }
+            }
+            li = li->next;
+        }
+        else
+        {
+            len = li->len;
+            memcpy (tmp_str, li->name, len);
+            tmp_str[len] = '\0';
+            number = atoi (tmp_str);
+            offset = 1;
+            li = li->next;
+        }
+        if (offset > 0 && number > 0)
+        {
+            struct gw_user_set *us;
+
+            if (set_token)
+            {
+                len = set_token->len;
+                memcpy (tmp_str, set_token->name, len);
+                tmp_str[len] = '\0';
+                us = user_set_search (tmp_str);
+            }
+            else
+                us = user_set_search (NULL);
+            if (us && us->hits != -1) /* proper result-set? */
+            {
+                if (offset <= us->hits)
+                {
+                    if (offset+number-1 > us->hits)
+                        number = us->hits - offset+1;
+                    present (us->name, offset, number, format_token);
+                }
+            }
+            else if (!no_of_present) /* display error message once! */
+            {
+                fprintf (reply_fd, "%s\n",
+                         gw_res_get (info.kernel_res, "gw.err.no.set",
+                                     "No result-set generated"));
+            }
+            no_of_present++;
+        }
+    }
+    if (!no_of_present) /* no records shown so far? */
+    {
+        struct gw_user_set *us;
+        int default_show;
+        
+        us = user_set_search (NULL);
+        if (us && us->hits != -1)    /* proper result-set? */
+        {
+            default_show = atoi (gw_res_get (info.kernel_res,
+                                             "gw.default.show", "20"));
+            if (us->hits > default_show)
+                present (us->name, 1, default_show, format_token);
+            else if (us->hits > 0)
+                present (us->name, 1, us->hits, format_token);
+        }
+        else                         /* display error message */
+        {
+            fprintf (reply_fd, "%s\n",
+                     gw_res_get (info.kernel_res, "gw.err.no.set",
+                                 "No result-set generated"));
+            return -3;
+        }        
     }
     return 0;
 }
@@ -300,9 +674,17 @@ static int exec_command (const char *str)
     if (cmd->kind != CCL_TOK_EOL &&
         (no = command_search (command_tab, cmd, "ccl.command.")))
     {
-        if (!info.zass && no != 9)
+        if (!info.zass && no != 9 && no != 4)
             reopen_target ();
-        fprintf (reply_fd, "\n> %s", str);
+        fprintf (reply_fd, "\n> %s\n", str);
+        if (!info.zass && (no == 1 || no == 2 || no == 3))
+        {
+            fprintf (reply_fd, "%s\n",
+                     gw_res_get (info.kernel_res, "gw.err.no.target",
+                                 "No connection established - "
+                                 "command ignored"));
+            return 0;
+        }
         switch (no)
         {
         case 1:
@@ -311,6 +693,8 @@ static int exec_command (const char *str)
             return exec_show (cmd->next);
         case 3:
             return exec_base (cmd->next);
+        case 4:
+            return exec_help (cmd->next);
         case 9:
             return exec_target (cmd->next);
         default:
@@ -321,10 +705,11 @@ static int exec_command (const char *str)
     }
     else
     {
-        fprintf (reply_fd, "\n> %s", str);
+        fprintf (reply_fd, "\n> %s\n", str);
         fprintf (reply_fd, "  ^ %s\n", 
                  gw_res_get (info.kernel_res, "gw.err.unknown.command",
-                             "unknown command"));
+                             "unknown command. "
+                             "Use help to see list of commands"));
     }
     return 0;
 }
@@ -338,7 +723,7 @@ int urp (FILE *inf)
 
     if (email_header (inf, from_str, subject_str))
     {
-        gw_log (GW_LOG_WARN, "urp", "No message body");
+        gw_log (GW_LOG_WARN, KERNEL_LOG, "No message body");
         return -1;
     }
     if (*from_str)
@@ -351,39 +736,50 @@ int urp (FILE *inf)
         reply_fd = fopen (reply_fname, "w");
         if (!reply_fd)
         {
-            gw_log (GW_LOG_FATAL, "urp", "Cannot create %s",
+            gw_log (GW_LOG_FATAL, KERNEL_LOG, "Cannot create %s",
                     reply_fname);
             return -1;
         }
+        fprintf (reply_fd, "From: %s\n",
+                 gw_res_get (info.kernel_res, "gw.msg.from","Email-gateway"));
         fprintf (reply_fd, "Subject: ");
         if (*subject_str)
             fprintf (reply_fd, "Z39.50 Re: %s", subject_str);
         else
             fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res,
                                                    "gw.msg.subject",
-                                                   "Your Z39.50 Query"));
+                                                   "Your Query"));
         fprintf (reply_fd, "\n");
+        gw_log (GW_LOG_ACCT, KERNEL_LOG, "User start %s", from_str);
     }
     else
-        gw_log (GW_LOG_WARN, "urp", "No From in email header");
+        gw_log (GW_LOG_WARN, KERNEL_LOG, "No From in email header");
     fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res, "gw.msg.greeting",
                                            "Email->Z39.50 gateway"));
     while (fgets (line_buf, LINE_MAX, inf))
     {
+        char *cp;
+
         if (line_buf[0] == '\n')
             break;
+        if ((cp = strchr (line_buf, '\n')))
+            *cp = '\0';
+        gw_log (GW_LOG_ACCT, KERNEL_LOG, "cmd: %s", line_buf);
         ccl_token_and = gw_res_get (info.kernel_res, "ccl.token.and", "and");
         ccl_token_or = gw_res_get (info.kernel_res, "ccl.token.or", "or");
         ccl_token_not = gw_res_get (info.kernel_res, "ccl.token.not", "not");
-        ccl_token_set = gw_res_get (info.kernel_res, "ccl.token.set", "set");       
+        ccl_token_set = gw_res_get (info.kernel_res, "ccl.token.set", "set");
         if (isalpha (line_buf[0]))
             exec_command (line_buf);
         command_no++;
     }
     if (!command_no)
+    {
         fprintf (reply_fd, "%s\n", gw_res_get (info.kernel_res,
                                                "gw.err.nullbody",
                                                "No body"));
+        help_general ();
+    }
     if (*from_str)
     {
         const char *mta;
@@ -400,9 +796,10 @@ int urp (FILE *inf)
         
         mta_code = system (cmd);
         if (mta_code)
-            gw_log (GW_LOG_FATAL, "urp", "Reply '%s' got exit code %d",
+            gw_log (GW_LOG_FATAL, KERNEL_LOG, "Reply '%s' got exit code %d",
                     cmd, mta_code);
         unlink (reply_fname);        
+        gw_log (GW_LOG_ACCT, KERNEL_LOG, "User end %s", from_str);
     }
     return 0;
 }