zoom: extra XSLT with cproxyhost param
[metaproxy-moved-to-github.git] / src / filter_zoom.cpp
index bcd618f..6ca6015 100644 (file)
@@ -123,7 +123,7 @@ namespace metaproxy_1 {
                                       std::string &database,
                                       int *error,
                                       char **addinfo,
-                                      ODR odr,
+                                      mp::odr &odr,
                                       std::string &torus_db,
                                       std::string &realm);
             void handle_present(mp::Package &package);
@@ -131,7 +131,7 @@ namespace metaproxy_1 {
                                                   std::string &database,
                                                   int *error,
                                                   char **addinfo,
-                                                  ODR odr,
+                                                  mp::odr &odr,
                                                   int *proxy_step);
 
             bool create_content_session(mp::Package &package,
@@ -148,6 +148,7 @@ namespace metaproxy_1 {
                                   const char *element_set_name,
                                   bool &enable_pz2_retrieval,
                                   bool &enable_pz2_transform,
+                                  bool &enable_record_transform,
                                   bool &assume_marc8_charset);
 
             Z_Records *get_records(Package &package,
@@ -159,6 +160,15 @@ namespace metaproxy_1 {
                                    ODR odr, BackendPtr b,
                                    Odr_oid *preferredRecordSyntax,
                                    const char *element_set_name);
+            Z_Records *get_explain_records(Package &package,
+                                           Odr_int start,
+                                           Odr_int number_to_present,
+                                           int *error,
+                                           char **addinfo,
+                                           Odr_int *number_of_records_returned,
+                                           ODR odr, BackendPtr b,
+                                           Odr_oid *preferredRecordSyntax,
+                                           const char *element_set_name);
 
             void log_diagnostic(mp::Package &package,
                                 int error, const char *addinfo);
@@ -197,11 +207,36 @@ namespace metaproxy_1 {
             std::string element_raw;
             std::string proxy;
             xsltStylesheetPtr explain_xsp;
+            xsltStylesheetPtr record_xsp;
             std::map<std::string,SearchablePtr> s_map;
+            std::string zoom_timeout;
         };
     }
 }
 
+
+static xmlNode *xml_node_search(xmlNode *ptr, int *num, int m)
+{
+    while (ptr)
+    {
+        if (ptr->type == XML_ELEMENT_NODE &&
+            !strcmp((const char *) ptr->name, "recordData"))
+        {
+            (*num)++;
+            if (m == *num)
+                return ptr;
+        }
+        else  // else: we don't want to find nested nodes
+        {   
+            xmlNode *ret_node = xml_node_search(ptr->children, num, m);
+            if (ret_node)
+                return ret_node;
+        }
+        ptr = ptr->next;
+    }
+    return 0;
+}
+
 // define Pimpl wrapper forwarding to Impl
  
 yf::Zoom::Zoom() : m_p(new Impl)
@@ -397,11 +432,13 @@ void yf::Zoom::Impl::release_frontend(mp::Package &package)
 }
 
 yf::Zoom::Impl::Impl() :
-    apdu_log(false), element_transform("pz2") , element_raw("raw")
+    apdu_log(false), element_transform("pz2") , element_raw("raw"),
+    zoom_timeout("40")
 {
     bibset = ccl_qual_mk();
 
     explain_xsp = 0;
+    record_xsp = 0;
     srand((unsigned int) time(0));
 }
 
@@ -513,8 +550,11 @@ yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
                           "cclmap_", 7))
         {
             std::string value = mp::xml::get_text(ptr);
-            ccl_qual_fitem(s->ccl_bibset, value.c_str(),
-                           (const char *) ptr->name + 7);
+            if (value.length() > 0)
+            {
+                ccl_qual_fitem(s->ccl_bibset, value.c_str(),
+                               (const char *) ptr->name + 7);
+            }
         }
         else if (!strncmp((const char *) ptr->name,
                           "sortmap_", 8))
@@ -583,6 +623,7 @@ void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
                                const char *path)
 {
     std::string explain_xslt_fname;
+    std::string record_xslt_fname;
 
     content_tmp_file = "/tmp/cf.XXXXXX.p";
     if (path && *path)
@@ -614,6 +655,8 @@ void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
                     proxy = mp::xml::get_text(attr->children);
                 else if (!strcmp((const char *) attr->name, "explain_xsl"))
                     explain_xslt_fname = mp::xml::get_text(attr->children);
+                else if (!strcmp((const char *) attr->name, "record_xsl"))
+                    record_xslt_fname = mp::xml::get_text(attr->children);
                 else
                     throw mp::filter::FilterException(
                         "Bad attribute " + std::string((const char *)
@@ -677,6 +720,19 @@ void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
                                                        attr->name));
             }
         }
+        else if (!strcmp((const char *) ptr->name, "zoom"))
+        {
+            const struct _xmlAttr *attr;
+            for (attr = ptr->properties; attr; attr = attr->next)
+            {
+                if (!strcmp((const char *) attr->name, "timeout"))
+                    zoom_timeout = mp::xml::get_text(attr->children);
+                else
+                    throw mp::filter::FilterException(
+                        "Bad attribute " + std::string((const char *)
+                                                       attr->name));
+            }
+        }
         else
         {
             throw mp::filter::FilterException
@@ -720,6 +776,41 @@ void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
             
         }
     }
+
+    if (record_xslt_fname.length())
+    {
+        const char *path = 0;
+        
+        if (xsldir.length())
+            path = xsldir.c_str();
+        else
+            path = file_path.c_str();
+        
+        char fullpath[1024];
+        char *cp = yaz_filepath_resolve(record_xslt_fname.c_str(),
+                                        path, 0, fullpath);
+        if (!cp)
+        {
+            throw mp::filter::FilterException
+                ("Cannot read XSLT " + record_xslt_fname);
+        }
+
+        xmlDoc *xsp_doc = xmlParseFile(cp);
+        if (!xsp_doc)
+        {
+            throw mp::filter::FilterException
+                ("Cannot parse XSLT " + record_xslt_fname);
+        }
+
+        record_xsp = xsltParseStylesheetDoc(xsp_doc);
+        if (!record_xsp)
+        {
+            xmlFreeDoc(xsp_doc);
+            throw mp::filter::FilterException
+                ("Cannot parse XSLT " + record_xslt_fname);
+            
+        }
+    }
 }
 
 bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
@@ -776,11 +867,12 @@ bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
 
 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
     mp::Package &package,
-    std::string &database, int *error, char **addinfo, ODR odr,
+    std::string &database, int *error, char **addinfo, mp::odr &odr,
     int *proxy_step)
 {
     std::list<BackendPtr>::const_iterator map_it;
-    if (m_backend && m_backend->m_frontend_database == database)
+    if (m_backend && !m_backend->enable_explain && 
+        m_backend->m_frontend_database == database)
         return m_backend;
 
     std::string input_args;
@@ -844,7 +936,7 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
         {
             char **dstr;
             int dnum = 0;
-            nmem_strsplit(odr->mem, ",", value, &dstr, &dnum);
+            nmem_strsplit(((ODR) odr)->mem, ",", value, &dstr, &dnum);
             if (*proxy_step >= dnum)
                 *proxy_step = 0;
             else
@@ -904,7 +996,7 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
         sptr = it->second;
     else if (torus_url.length() > 0)
     {
-        std::string torus_query = "udb=" + torus_db;
+        std::string torus_query = "udb==" + torus_db;
         xmlDoc *doc = mp::get_searchable(package,torus_url, torus_db,
                                          torus_query,
                                          realm, m_p->proxy);
@@ -1029,7 +1121,7 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
     if (sptr->query_encoding.length())
         b->set_option("rpnCharset", sptr->query_encoding);
 
-    b->set_option("timeout", "40");
+    b->set_option("timeout", m_p->zoom_timeout.c_str());
     
     if (m_p->apdu_log) 
         b->set_option("apdulog", "1");
@@ -1143,8 +1235,8 @@ void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
                                           const char *element_set_name,
                                           bool &enable_pz2_retrieval,
                                           bool &enable_pz2_transform,
+                                          bool &enable_record_transform,
                                           bool &assume_marc8_charset)
-
 {
     char oid_name_str[OID_STR_MAX];
     const char *syntax_name = 0;
@@ -1162,6 +1254,12 @@ void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
         {
             enable_pz2_retrieval = true;
         }
+        else
+        {
+            enable_pz2_retrieval = true;
+            enable_pz2_transform = true;
+            enable_record_transform = true;
+        }
     }
     
     if (enable_pz2_retrieval)
@@ -1198,6 +1296,66 @@ void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
         b->set_option("schema", element_set_name);
 }
 
+Z_Records *yf::Zoom::Frontend::get_explain_records(
+    Package &package,
+    Odr_int start,
+    Odr_int number_to_present,
+    int *error,
+    char **addinfo,
+    Odr_int *number_of_records_returned,
+    ODR odr,
+    BackendPtr b,
+    Odr_oid *preferredRecordSyntax,
+    const char *element_set_name)
+{
+    Odr_int i;
+    Z_Records *records = 0;
+
+    if (!b->explain_doc)
+    {
+        return records;
+    }
+    if (number_to_present > 10000)
+        number_to_present = 10000;
+
+    xmlNode *ptr = xmlDocGetRootElement(b->explain_doc);
+    
+    Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
+        odr_malloc(odr, sizeof(*npl));
+    npl->records = (Z_NamePlusRecord **)
+        odr_malloc(odr, number_to_present * sizeof(*npl->records));
+    
+    for (i = 0; i < number_to_present; i++)
+    {
+        int num = 0;
+        xmlNode *res = xml_node_search(ptr, &num, start + i + 1);
+        if (!res)
+            break;
+        xmlBufferPtr xml_buf = xmlBufferCreate();
+        xmlNode *tmp_node = xmlCopyNode(res->children, 1);
+        xmlNodeDump(xml_buf, tmp_node->doc, tmp_node, 0, 0);
+
+        Z_NamePlusRecord *npr =
+            (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
+        npr->databaseName = odr_strdup(odr, b->m_frontend_database.c_str());
+        npr->which = Z_NamePlusRecord_databaseRecord;
+        npr->u.databaseRecord =
+            z_ext_record_xml(odr,
+                             (const char *) xml_buf->content, xml_buf->use);
+        npl->records[i] = npr;
+        xmlFreeNode(tmp_node);
+        xmlBufferFree(xml_buf);
+    }
+    records = (Z_Records*) odr_malloc(odr, sizeof(*records));
+    records->which = Z_Records_DBOSD;
+    records->u.databaseOrSurDiagnostics = npl;
+
+    npl->num_records = i;
+    *number_of_records_returned = i;
+    return records;
+}
+
+
 Z_Records *yf::Zoom::Frontend::get_records(Package &package,
                                            Odr_int start,
                                            Odr_int number_to_present,
@@ -1214,11 +1372,13 @@ Z_Records *yf::Zoom::Frontend::get_records(Package &package,
     bool enable_pz2_retrieval = false; // whether target profile is used
     bool enable_pz2_transform = false; // whether XSLT is used as well
     bool assume_marc8_charset = false;
+    bool enable_record_transform = false;
 
     prepare_elements(b, preferredRecordSyntax,
                      element_set_name,
                      enable_pz2_retrieval,
                      enable_pz2_transform,
+                     enable_record_transform,
                      assume_marc8_charset);
 
     package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s",
@@ -1245,6 +1405,32 @@ Z_Records *yf::Zoom::Frontend::get_records(Package &package,
     }
     if (i > 0)
     {  // only return records if no error and at least one record
+
+        const char *xsl_parms[3];
+        char cproxy_host[1024];
+
+        if (b->enable_cproxy && b->content_session_id.length())
+        {
+            sprintf(cproxy_host, "%s.%s/",
+                    b->content_session_id.c_str(),
+                    m_p->content_proxy_server.c_str());
+            
+            char *q_cproxy_host = (char *) 
+                odr_malloc(odr, strlen(cproxy_host) + 3);
+            strcpy(q_cproxy_host, "\"");
+            strcat(q_cproxy_host, cproxy_host);
+            strcat(q_cproxy_host, "\"");
+
+            xsl_parms[0] = "cproxyhost";
+            xsl_parms[1] = q_cproxy_host;
+            xsl_parms[2] = 0;
+        }
+        else
+        {
+            xsl_parms[0] = 0;
+            *cproxy_host = '\0';
+        }
+
         char *odr_database = odr_strdup(odr,
                                         b->m_frontend_database.c_str());
         Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
@@ -1319,13 +1505,23 @@ Z_Records *yf::Zoom::Frontend::get_records(Package &package,
                     }
                     else
                     { 
-                        xmlDoc *rec_res = 
-                            xsltApplyStylesheet(b->xsp, rec_doc, 0);
+                        xsltStylesheetPtr xsp = b->xsp;
+                        xmlDoc *rec_res = xsltApplyStylesheet(xsp, rec_doc,
+                                                              xsl_parms);
+                        if (rec_res && m_p->record_xsp &&
+                            enable_record_transform)
+                        {
+                            xmlDoc *tmp_doc = rec_res;
 
+                            xsp = m_p->record_xsp;
+                            rec_res = xsltApplyStylesheet(xsp, tmp_doc,
+                                                          xsl_parms);
+                            xmlFreeDoc(tmp_doc);
+                        }
                         if (rec_res)
                         {
                             xsltSaveResultToString(&xmlrec_buf, &rec_len,
-                                                   rec_res, b->xsp);
+                                                   rec_res, xsp);
                             rec_buf = (const char *) xmlrec_buf;
                             package.log("zoom", YLOG_LOG, "xslt successful");
                             package.log_write(rec_buf, rec_len);
@@ -1348,22 +1544,16 @@ Z_Records *yf::Zoom::Frontend::get_records(Package &package,
                     }
                 }
 
-                if (rec_buf && b->enable_cproxy)
+                if (rec_buf)
                 {
                     xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
                     std::string res = 
                         mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
-                    if (res.length() && b->content_session_id.length())
+                    if (res.length() && *cproxy_host)
                     {
                         size_t off = res.find_first_of("://");
                         if (off != std::string::npos)
-                        {
-                            char tmp[1024];
-                            sprintf(tmp, "%s.%s/",
-                                    b->content_session_id.c_str(),
-                                    m_p->content_proxy_server.c_str());
-                            res.insert(off + 3, tmp);
-                        }
+                            res.insert(off + 3, cproxy_host);
                     }
                     if (res.length())
                     {
@@ -1482,7 +1672,7 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
                                                         std::string &database,
                                                         int *error,
                                                         char **addinfo,
-                                                        ODR odr,
+                                                        mp::odr &odr,
                                                         std::string &torus_db,
                                                         std::string &realm)
 {
@@ -1495,11 +1685,18 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
    
     Z_GDU *gdu = package.request().get();
     Z_APDU *apdu_req = gdu->u.z3950;
-    Z_APDU *apdu_res = 0;
     Z_SearchRequest *sr = apdu_req->u.searchRequest;
     Z_Query *query = sr->query;
 
-    if (query->which == Z_Query_type_104 &&
+    if (!m_p->explain_xsp)
+    {
+        *error = YAZ_BIB1_UNSPECIFIED_ERROR;
+        *addinfo =
+            odr_strdup(odr, "IR-Explain---1 unsupported. "
+                       "Torus explain_xsl not defined");
+        return m_backend;
+    }
+    else if (query->which == Z_Query_type_104 &&
         query->u.type_104->which == Z_External_CQL)
     {
         std::string torus_url = m_p->torus_searchable_url;
@@ -1514,16 +1711,24 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
             xmlFreeDoc(doc);
             doc = rec_res;
         }
-        *error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
-        *addinfo = odr_strdup(odr, "CQL, IR-Explain---1");
-
-        xmlChar *buf_out = 0;
-        int len_out;
-        xmlDocDumpMemory(doc, &buf_out, &len_out);
+        if (!doc)
+        {
+            *error = YAZ_BIB1_UNSPECIFIED_ERROR;
+            *addinfo = odr_strdup(odr, "IR-Explain---1 problem. " 
+                                  "Could not obtain Torus records for Explain");
+        }
+        else
+        {
+            xmlNode *ptr = xmlDocGetRootElement(doc);
+            int hits = 0;
+            
+            xml_node_search(ptr, &hits, 0);
 
-        fwrite(buf_out, 1, len_out, yaz_log_file());
-        
-        xmlFree(buf_out);
+            Z_APDU *apdu_res = odr.create_searchResponse(apdu_req, 0, 0);
+            apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
+            package.response() = apdu_res;
+            m_backend = b;
+        }
         if (b->explain_doc)
             xmlFreeDoc(b->explain_doc);
         b->explain_doc = doc;
@@ -1532,7 +1737,7 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
     else
     {
         *error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
-        *addinfo = odr_strdup(odr, "RPN/CCL, IR-Explain---1");
+        *addinfo = odr_strdup(odr, "IR-Explain---1 only supports CQL");
         return m_backend;
     }
 }
@@ -1575,17 +1780,19 @@ next_proxy:
         package.response() = apdu_res;
         return;
     }
-    if (b->enable_explain)
+    if (!b || b->enable_explain)
         return;
 
     b->set_option("setname", "default");
 
     bool enable_pz2_retrieval = false;
     bool enable_pz2_transform = false;
+    bool enable_record_transform = false;
     bool assume_marc8_charset = false;
     prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
                      enable_pz2_retrieval,
                      enable_pz2_transform,
+                     enable_record_transform,
                      assume_marc8_charset);
 
     Odr_int hits = 0;
@@ -1741,12 +1948,16 @@ next_proxy:
             switch (cerror)
             {
             case CCL_ERR_UNKNOWN_QUAL:
-                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:
-                error = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
+#ifdef CCL_ERR_TRUNC_NOT_EMBED
+            case CCL_ERR_TRUNC_NOT_EMBED:
+#endif
+#ifdef CCL_ERR_TRUNC_NOT_SINGLE
+            case CCL_ERR_TRUNC_NOT_SINGLE:
+#endif
+                error = YAZ_BIB1_UNSUPP_SEARCH;
                 break;
             }
             log_diagnostic(package, error, addinfo);
@@ -1880,10 +2091,21 @@ void yf::Zoom::Frontend::handle_present(mp::Package &package)
 
     if (m_backend->enable_explain)
     {
-        package.response() = odr.create_presentResponse(
-            apdu_req, YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
-            "IR-Explain---1 fetch not implemented");
-        return;
+        Z_Records *records =
+            get_explain_records(
+                package,
+                *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
+                &error, &addinfo, &number_of_records_returned, odr, m_backend,
+                pr->preferredRecordSyntax, element_set_name);
+        
+        apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
+        if (records)
+        {
+            apdu_res->u.presentResponse->records = records;
+            apdu_res->u.presentResponse->numberOfRecordsReturned =
+                odr_intdup(odr, number_of_records_returned);
+        }
+        package.response() = apdu_res;
     }
     else
     {