zoom: log diagnostics and records as they pass
[metaproxy-moved-to-github.git] / src / filter_zoom.cpp
index b48b58f..84fb20c 100644 (file)
@@ -122,7 +122,14 @@ namespace metaproxy_1 {
                                                   char **addinfo,
                                                   ODR odr);
 
-
+            bool create_content_session(mp::Package &package,
+                                        BackendPtr b,
+                                        int *error,
+                                        char **addinfo,
+                                        ODR odr,
+                                        std::string authentication,
+                                        std::string proxy);
+            
             void prepare_elements(BackendPtr b,
                                   Odr_oid *preferredRecordSyntax,
                                   const char *element_set_name,
@@ -130,7 +137,8 @@ namespace metaproxy_1 {
                                   bool &enable_pz2_transform,
                                   bool &assume_marc8_charset);
 
-            Z_Records *get_records(Odr_int start,
+            Z_Records *get_records(Package &package,
+                                   Odr_int start,
                                    Odr_int number_to_present,
                                    int *error,
                                    char **addinfo,
@@ -138,6 +146,9 @@ namespace metaproxy_1 {
                                    ODR odr, BackendPtr b,
                                    Odr_oid *preferredRecordSyntax,
                                    const char *element_set_name);
+
+            void log_diagnostic(mp::Package &package,
+                                int error, const char *addinfo);
         public:
             Frontend(Impl *impl);
             ~Frontend();
@@ -239,7 +250,6 @@ void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
             {
                 strcat(*addinfo, ": ");
                 strcat(*addinfo, zoom_addinfo);
-                strcat(*addinfo, " ");
             }
         }
         else
@@ -308,6 +318,7 @@ yf::Zoom::Searchable::Searchable(CCL_bibset base)
     piggyback = true;
     use_turbomarc = true;
     sortStrategy = "embed";
+    urlRecipe = "${md-electronic-url}";
     ccl_bibset = ccl_qual_dup(base);
 }
 
@@ -430,7 +441,8 @@ yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
         {
             s->sru = mp::xml::get_text(ptr);
         }
-        else if (!strcmp((const char *) ptr->name, "SRUVersion"))
+        else if (!strcmp((const char *) ptr->name, "SRUVersion") ||
+                 !strcmp((const char *) ptr->name, "sruVersion"))
         {
             s->sru_version = mp::xml::get_text(ptr);
         }
@@ -647,6 +659,54 @@ void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
     }
 }
 
+bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
+                                                BackendPtr b,
+                                                int *error, char **addinfo,
+                                                ODR odr,
+                                                std::string authentication,
+                                                std::string proxy)
+{
+    if (b->sptr->contentConnector.length())
+    {
+        char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
+        strcpy(fname, m_p->content_tmp_file.c_str());
+        char *xx = strstr(fname, "XXXXXX");
+        if (!xx)
+        {
+            xx = fname + strlen(fname);
+            strcat(fname, "XXXXXX");
+        }
+        char tmp_char = xx[6];
+        sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
+        xx[6] = tmp_char;
+
+        FILE *file = fopen(fname, "w");
+        if (!file)
+        {
+            package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
+            *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
+            *addinfo = (char *)  odr_malloc(odr, 40 + strlen(fname));
+            sprintf(*addinfo, "Could not create %s", fname);
+            xfree(fname);
+            return false;
+        }
+        b->content_session_id.assign(xx, 6);
+        WRBUF w = wrbuf_alloc();
+        wrbuf_puts(w, "#content_proxy\n");
+        wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
+        if (authentication.length())
+            wrbuf_printf(w, "auth: %s\n", authentication.c_str());
+        if (proxy.length())
+            wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
+
+        fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file);
+        fclose(file);
+        package.log("zoom", YLOG_LOG, "content file: %s", fname);
+        xfree(fname);
+    }
+    return true;
+}
+
 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
     mp::Package &package,
     std::string &database, int *error, char **addinfo, ODR odr)
@@ -667,11 +727,14 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
         torus_db = database;
 
     std::string authentication;
+    std::string content_authentication;
     std::string proxy;
     std::string realm = m_p->default_realm;
 
     const char *param_user = 0;
     const char *param_password = 0;
+    const char *param_content_user = 0;
+    const char *param_content_password = 0;
     int no_parms = 0;
 
     char **names;
@@ -697,6 +760,10 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
             param_user = value;
         else if (!strcmp(name, "password"))
             param_password = value;
+        else if (!strcmp(name, "content-user"))
+            param_content_user = value;
+        else if (!strcmp(name, "content-password"))
+            param_content_password = value;
         else if (!strcmp(name, "proxy"))
             proxy = value;
         else if (!strcmp(name, "cproxysession"))
@@ -727,6 +794,12 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
         if (param_password)
             authentication += "/" + std::string(param_password);
     }
+    if (param_content_user)
+    {
+        content_authentication = std::string(param_content_user);
+        if (param_content_password)
+            content_authentication += "/" + std::string(param_content_password);
+    }
     SearchablePtr sptr;
 
     std::map<std::string,SearchablePtr>::iterator it;
@@ -735,7 +808,8 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
         sptr = it->second;
     else if (m_p->torus_url.length() > 0)
     {
-        xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db, realm,
+        xmlDoc *doc = mp::get_searchable(package,
+                                         m_p->torus_url, torus_db, realm,
                                          m_p->proxy);
         if (!doc)
         {
@@ -861,7 +935,7 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
     if (m_p->apdu_log) 
         b->set_option("apdulog", "1");
 
-    if (sptr->piggyback)
+    if (sptr->piggyback && sptr->sru.length())
         b->set_option("count", "1"); /* some SRU servers INSIST on getting
                                         maximumRecords > 0 */
     b->set_option("piggyback", sptr->piggyback ? "1" : "0");
@@ -922,48 +996,6 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
         if (proxy.length())
             b->set_option("proxy", proxy);
     }
-    if (b->sptr->contentConnector.length())
-    {
-        char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
-        strcpy(fname, m_p->content_tmp_file.c_str());
-        char *xx = strstr(fname, "XXXXXX");
-        if (!xx)
-        {
-            xx = fname + strlen(fname);
-            strcat(fname, "XXXXXX");
-        }
-        char tmp_char = xx[6];
-        sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
-        xx[6] = tmp_char;
-
-        FILE *file = fopen(fname, "w");
-        if (!file)
-        {
-            package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
-            *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
-            *addinfo = (char *)  odr_malloc(odr, 40 + strlen(fname));
-            sprintf(*addinfo, "Could not create %s", fname);
-            xfree(fname);
-            BackendPtr backend_null;
-            return backend_null;
-        }
-        b->content_session_id.assign(xx, 6);
-        WRBUF w = wrbuf_alloc();
-        wrbuf_puts(w, "#content_proxy\n");
-        wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
-        if (authentication.length())
-            wrbuf_printf(w, "auth: %s\n", authentication.c_str());
-        if (proxy.length())
-            wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
-        if (sptr->cfProxy.length())
-            wrbuf_printf(w, "cfproxy: %s\n", sptr->cfProxy.c_str());
-
-        fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file);
-        fclose(file);
-        package.log("zoom", YLOG_LOG, "file %s created", fname);
-        xfree(fname);
-    }
-
     std::string url;
     if (sptr->sru.length())
     {
@@ -989,9 +1021,11 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
     package.log("zoom", YLOG_LOG, "url: %s", url.c_str());
     b->connect(url, error, addinfo, odr);
     if (*error == 0)
-    {
+        create_content_session(package, b, error, addinfo, odr,
+                               content_authentication.length() ?
+                               content_authentication : authentication, proxy);
+    if (*error == 0)
         m_backend = b;
-    }
     return b;
 }
 
@@ -1055,7 +1089,8 @@ void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
         b->set_option("schema", element_set_name);
 }
 
-Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
+Z_Records *yf::Zoom::Frontend::get_records(Package &package,
+                                           Odr_int start,
                                            Odr_int number_to_present,
                                            int *error,
                                            char **addinfo,
@@ -1077,6 +1112,10 @@ Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
                      enable_pz2_transform,
                      assume_marc8_charset);
 
+    package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s",
+                enable_pz2_retrieval ? "yes" : "no",
+                enable_pz2_transform ? "yes" : "no");
+
     if (start < 0 || number_to_present <=0)
         return records;
     
@@ -1109,11 +1148,15 @@ Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
         {
             Z_NamePlusRecord *npr = 0;
             const char *addinfo;
+
+            package.log("zoom", YLOG_LOG, "Inspecting record at position %d",
+                        start + i);
             int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
                                               &addinfo, 0 /* diagset */);
                 
             if (sur_error)
             {
+                log_diagnostic(package, sur_error, addinfo);
                 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
                                             addinfo);
             }
@@ -1133,7 +1176,9 @@ Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
                     strcat(rec_type_str, "; charset=");
                     strcat(rec_type_str, record_encoding);
                 }
-                
+
+                package.log("zoom", YLOG_LOG, "Getting record of type %s",
+                            rec_type_str);
                 int rec_len;
                 xmlChar *xmlrec_buf = 0;
                 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
@@ -1142,11 +1187,16 @@ Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
                 {
                     std::string addinfo("ZOOM_record_get failed for type ");
 
+                    int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
                     addinfo += rec_type_str;
-                    npr = zget_surrogateDiagRec(
-                        odr, odr_database, 
-                        YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
-                        addinfo.c_str());
+                    log_diagnostic(package, error, addinfo.c_str());
+                    npr = zget_surrogateDiagRec(odr, odr_database,
+                                                error, addinfo.c_str());
+                }
+                else
+                {
+                    package.log_write(rec_buf, rec_len);
+                    package.log_write("\r\n", 2);
                 }
 
                 if (rec_buf && b->xsp && enable_pz2_transform)
@@ -1154,10 +1204,11 @@ Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
                     xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
                     if (!rec_doc)
                     {
+                        const char *addinfo = "xml parse failed for record";
+                        int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
+                        log_diagnostic(package, error, addinfo);
                         npr = zget_surrogateDiagRec(
-                            odr, odr_database, 
-                            YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
-                            "xml parse failed for record");
+                            odr, odr_database, error, addinfo);
                     }
                     else
                     { 
@@ -1169,19 +1220,22 @@ Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
                             xsltSaveResultToString(&xmlrec_buf, &rec_len,
                                                    rec_res, b->xsp);
                             rec_buf = (const char *) xmlrec_buf;
+                            package.log("zoom", YLOG_LOG, "xslt successful");
+                            package.log_write(rec_buf, rec_len);
 
                             xmlFreeDoc(rec_res);
                         }
                         if (!rec_buf)
                         {
                             std::string addinfo;
+                            int error =
+                                YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 
                             addinfo = "xslt apply failed for "
                                 + b->sptr->transform_xsl_fname;
+                            log_diagnostic(package, error, addinfo.c_str());
                             npr = zget_surrogateDiagRec(
-                                odr, odr_database, 
-                                YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
-                                addinfo.c_str());
+                                odr, odr_database, error, addinfo.c_str());
                         }
                         xmlFreeDoc(rec_doc);
                     }
@@ -1305,6 +1359,18 @@ struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
     return r;
 }
 
+void yf::Zoom::Frontend::log_diagnostic(mp::Package &package,
+                                        int error, const char *addinfo)
+{
+    const char *err_msg = yaz_diag_bib1_str(error);
+    if (addinfo)
+        package.log("zoom", YLOG_WARN, "Diagnostic %d %s: %s",
+                    error, err_msg, addinfo);
+    else
+        package.log("zoom", YLOG_WARN, "Diagnostic %d %s:",
+                    error, err_msg);
+}
+
 void yf::Zoom::Frontend::handle_search(mp::Package &package)
 {
     Z_GDU *gdu = package.request().get();
@@ -1314,8 +1380,9 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package)
     Z_SearchRequest *sr = apdu_req->u.searchRequest;
     if (sr->num_databaseNames != 1)
     {
-        apdu_res = odr.create_searchResponse(
-            apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
+        int error = YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED;
+        log_diagnostic(package, error, 0);
+        apdu_res = odr.create_searchResponse(apdu_req, error, 0);
         package.response() = apdu_res;
         return;
     }
@@ -1327,8 +1394,8 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package)
                                               &addinfo, odr);
     if (error)
     {
-        apdu_res = 
-            odr.create_searchResponse(apdu_req, error, addinfo);
+        log_diagnostic(package, error, addinfo);
+        apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
         package.response() = apdu_res;
         return;
     }
@@ -1373,11 +1440,11 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package)
         if (r)
         {
             cql_parser_destroy(cp);
-            package.log("zoom", YLOG_WARN, "CQL syntax error");
+            error = YAZ_BIB1_MALFORMED_QUERY;
+            const char *addinfo = "CQL syntax error";
+            log_diagnostic(package, error, addinfo);
             apdu_res = 
-                odr.create_searchResponse(apdu_req, 
-                                          YAZ_BIB1_MALFORMED_QUERY,
-                                          "CQL syntax error");
+                odr.create_searchResponse(apdu_req, error, addinfo);
             package.response() = apdu_res;
             return;
         }
@@ -1386,14 +1453,13 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package)
         if (cn_error)
         {
             // hopefully we are getting a ptr to a index+relation+term node
+            error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
             addinfo = 0;
             if (cn_error->which == CQL_NODE_ST)
                 addinfo = cn_error->u.st.index;
-
-            apdu_res = 
-                odr.create_searchResponse(apdu_req, 
-                                          YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
-                                          addinfo);
+            
+            log_diagnostic(package, error, addinfo);
+            apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
             package.response() = apdu_res;
             return;
         }
@@ -1450,18 +1516,21 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package)
         cql_parser_destroy(cp);
         if (r)
         {
-            apdu_res = 
-                odr.create_searchResponse(apdu_req, 
-                                          YAZ_BIB1_MALFORMED_QUERY,
-                                          "CQL to CCL conversion error");
+            error = YAZ_BIB1_MALFORMED_QUERY;
+            const char *addinfo = "CQL to CCL conversion error";
+
+            log_diagnostic(package, error, addinfo);
+            apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
             package.response() = apdu_res;
             return;
         }
     }
     else
     {
-        apdu_res = 
-            odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
+        error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
+        const char *addinfo = 0;
+        log_diagnostic(package, error, addinfo);
+        apdu_res =  odr.create_searchResponse(apdu_req, error, addinfo);
         package.response() = apdu_res;
         return;
     }
@@ -1479,21 +1548,21 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package)
         if (!cn)
         {
             char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
-            int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
+            error = YAZ_BIB1_MALFORMED_QUERY;
 
             switch (cerror)
             {
             case CCL_ERR_UNKNOWN_QUAL:
-                z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
+                error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
                 break;
             case CCL_ERR_TRUNC_NOT_LEFT: 
             case CCL_ERR_TRUNC_NOT_RIGHT:
             case CCL_ERR_TRUNC_NOT_BOTH:
-                z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
+                error = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
                 break;
             }
-            apdu_res = 
-                odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
+            log_diagnostic(package, error, addinfo);
+            apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
             package.response() = apdu_res;
             return;
         }
@@ -1543,9 +1612,10 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package)
         wrbuf_destroy(pqf_wrbuf);
         if (status)
         {
-            apdu_res = 
-                odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
-                                          "can not convert from RPN to CQL/SOLR");
+            error = YAZ_BIB1_MALFORMED_QUERY;
+            const char *addinfo = "can not convert from RPN to CQL/SOLR";
+            log_diagnostic(package, error, addinfo);
+            apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
             package.response() = apdu_res;
             return;
         }
@@ -1566,9 +1636,12 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package)
     
     Odr_int number_of_records_returned = 0;
     Z_Records *records = get_records(
+        package,
         0, number_to_present, &error, &addinfo,
         &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
         element_set_name);
+    if (error)
+        log_diagnostic(package, error, addinfo);
     apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
     if (records)
     {
@@ -1608,7 +1681,7 @@ void yf::Zoom::Frontend::handle_present(mp::Package &package)
     Odr_int number_of_records_returned = 0;
     int error = 0;
     char *addinfo = 0;
-    Z_Records *records = get_records(
+    Z_Records *records = get_records(package,
         *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
         &error, &addinfo, &number_of_records_returned, odr, m_backend,
         pr->preferredRecordSyntax, element_set_name);