For non-CF targets database arguments are parsed.
[metaproxy-moved-to-github.git] / src / filter_zoom.cpp
1 /* This file is part of Metaproxy.
2    Copyright (C) 2005-2011 Index Data
3
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
7 version.
8
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17 */
18
19 #include "config.hpp"
20 #include "filter_zoom.hpp"
21 #include <yaz/zoom.h>
22 #include <yaz/yaz-version.h>
23 #include <yaz/srw.h>
24 #include <metaproxy/package.hpp>
25 #include <metaproxy/util.hpp>
26 #include "torus.hpp"
27
28 #include <libxslt/xsltutils.h>
29 #include <libxslt/transform.h>
30
31 #include <boost/thread/mutex.hpp>
32 #include <boost/thread/condition.hpp>
33 #include <yaz/ccl_xml.h>
34 #include <yaz/ccl.h>
35 #include <yaz/rpn2cql.h>
36 #include <yaz/rpn2solr.h>
37 #include <yaz/pquery.h>
38 #include <yaz/cql.h>
39 #include <yaz/oid_db.h>
40 #include <yaz/diagbib1.h>
41 #include <yaz/log.h>
42 #include <yaz/zgdu.h>
43 #include <yaz/querytowrbuf.h>
44
45 namespace mp = metaproxy_1;
46 namespace yf = mp::filter;
47
48 namespace metaproxy_1 {
49     namespace filter {
50         struct Zoom::Searchable : boost::noncopyable {
51             std::string authentication;
52             std::string cfAuth;
53             std::string cfProxy;
54             std::string cfSubDb;
55             std::string udb;
56             std::string target;
57             std::string query_encoding;
58             std::string sru;
59             std::string request_syntax;
60             std::string element_set;
61             std::string record_encoding;
62             std::string transform_xsl_fname;
63             bool use_turbomarc;
64             bool piggyback;
65             CCL_bibset ccl_bibset;
66             Searchable(CCL_bibset base);
67             ~Searchable();
68         };
69         class Zoom::Backend : boost::noncopyable {
70             friend class Impl;
71             friend class Frontend;
72             std::string zurl;
73             ZOOM_connection m_connection;
74             ZOOM_resultset m_resultset;
75             std::string m_frontend_database;
76             SearchablePtr sptr;
77             xsltStylesheetPtr xsp;
78         public:
79             Backend(SearchablePtr sptr);
80             ~Backend();
81             void connect(std::string zurl, int *error, const char **addinfo);
82             void search_pqf(const char *pqf, Odr_int *hits,
83                             int *error, const char **addinfo);
84             void search_cql(const char *cql, Odr_int *hits,
85                             int *error, const char **addinfo);
86             void present(Odr_int start, Odr_int number, ZOOM_record *recs,
87                          int *error, const char **addinfo);
88             void set_option(const char *name, const char *value);
89             const char *get_option(const char *name);
90             void get_zoom_error(int *error, const char **addinfo);
91         };
92         class Zoom::Frontend : boost::noncopyable {
93             friend class Impl;
94             Impl *m_p;
95             bool m_is_virtual;
96             bool m_in_use;
97             yazpp_1::GDU m_init_gdu;
98             BackendPtr m_backend;
99             void handle_package(mp::Package &package);
100             void handle_search(mp::Package &package);
101             void handle_present(mp::Package &package);
102             BackendPtr get_backend_from_databases(std::string &database,
103                                                   int *error,
104                                                   char **addinfo,
105                                                   ODR odr);
106             Z_Records *get_records(Odr_int start,
107                                    Odr_int number_to_present,
108                                    int *error,
109                                    const char **addinfo,
110                                    Odr_int *number_of_records_returned,
111                                    ODR odr, BackendPtr b,
112                                    Odr_oid *preferredRecordSyntax,
113                                    const char *element_set_name);
114         public:
115             Frontend(Impl *impl);
116             ~Frontend();
117         };
118         class Zoom::Impl {
119             friend class Frontend;
120         public:
121             Impl();
122             ~Impl();
123             void process(metaproxy_1::Package & package);
124             void configure(const xmlNode * ptr, bool test_only);
125         private:
126             void configure_local_records(const xmlNode * ptr, bool test_only);
127             FrontendPtr get_frontend(mp::Package &package);
128             void release_frontend(mp::Package &package);
129             SearchablePtr parse_torus_record(const xmlNode *ptr);
130             struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
131             std::map<mp::Session, FrontendPtr> m_clients;            
132             boost::mutex m_mutex;
133             boost::condition m_cond_session_ready;
134             std::string torus_url;
135             std::map<std::string,std::string> fieldmap;
136             std::string xsldir;
137             CCL_bibset bibset;
138             std::string element_transform;
139             std::string element_raw;
140             std::map<std::string,SearchablePtr> s_map;
141         };
142     }
143 }
144
145 // define Pimpl wrapper forwarding to Impl
146  
147 yf::Zoom::Zoom() : m_p(new Impl)
148 {
149 }
150
151 yf::Zoom::~Zoom()
152 {  // must have a destructor because of boost::scoped_ptr
153 }
154
155 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only)
156 {
157     m_p->configure(xmlnode, test_only);
158 }
159
160 void yf::Zoom::process(mp::Package &package) const
161 {
162     m_p->process(package);
163 }
164
165
166 // define Implementation stuff
167
168 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
169 {
170     m_connection = ZOOM_connection_create(0);
171     m_resultset = 0;
172     xsp = 0;
173 }
174
175 yf::Zoom::Backend::~Backend()
176 {
177     if (xsp)
178         xsltFreeStylesheet(xsp);
179     ZOOM_connection_destroy(m_connection);
180     ZOOM_resultset_destroy(m_resultset);
181 }
182
183
184 void yf::Zoom::Backend::get_zoom_error(int *error, const char **addinfo)
185 {
186     const char *msg = 0;
187     *error = ZOOM_connection_error(m_connection, &msg, addinfo);
188     if (*error)
189     {
190         if (*error >= ZOOM_ERROR_CONNECT)
191         {
192             // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
193             *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
194             if (addinfo)
195                 *addinfo = msg;
196         }
197     }
198 }
199
200 void yf::Zoom::Backend::connect(std::string zurl,
201                                 int *error, const char **addinfo)
202 {
203     ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
204     get_zoom_error(error, addinfo);
205 }
206
207 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
208                                    int *error, const char **addinfo)
209 {
210     m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
211     get_zoom_error(error, addinfo);
212     if (*error == 0)
213         *hits = ZOOM_resultset_size(m_resultset);
214     else
215         *hits = 0;
216 }
217
218 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
219                                    int *error, const char **addinfo)
220 {
221     ZOOM_query q = ZOOM_query_create();
222
223     ZOOM_query_cql(q, cql);
224
225     m_resultset = ZOOM_connection_search(m_connection, q);
226     ZOOM_query_destroy(q);
227     get_zoom_error(error, addinfo);
228     if (*error == 0)
229         *hits = ZOOM_resultset_size(m_resultset);
230     else
231         *hits = 0;
232 }
233
234 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
235                                 ZOOM_record *recs,
236                                 int *error, const char **addinfo)
237 {
238     ZOOM_resultset_records(m_resultset, recs, start, number);
239     get_zoom_error(error, addinfo);
240 }
241
242 void yf::Zoom::Backend::set_option(const char *name, const char *value)
243 {
244     ZOOM_connection_option_set(m_connection, name, value);
245     if (m_resultset)
246         ZOOM_resultset_option_set(m_resultset, name, value);
247 }
248
249 const char *yf::Zoom::Backend::get_option(const char *name)
250 {
251     return ZOOM_connection_option_get(m_connection, name);
252 }
253
254 yf::Zoom::Searchable::Searchable(CCL_bibset base)
255 {
256     piggyback = true;
257     use_turbomarc = true;
258     ccl_bibset = ccl_qual_dup(base);
259 }
260
261 yf::Zoom::Searchable::~Searchable()
262 {
263     ccl_qual_rm(&ccl_bibset);
264 }
265
266 yf::Zoom::Frontend::Frontend(Impl *impl) : 
267     m_p(impl), m_is_virtual(false), m_in_use(true)
268 {
269 }
270
271 yf::Zoom::Frontend::~Frontend()
272 {
273 }
274
275 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
276 {
277     boost::mutex::scoped_lock lock(m_mutex);
278
279     std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
280     
281     while(true)
282     {
283         it = m_clients.find(package.session());
284         if (it == m_clients.end())
285             break;
286         
287         if (!it->second->m_in_use)
288         {
289             it->second->m_in_use = true;
290             return it->second;
291         }
292         m_cond_session_ready.wait(lock);
293     }
294     FrontendPtr f(new Frontend(this));
295     m_clients[package.session()] = f;
296     f->m_in_use = true;
297     return f;
298 }
299
300 void yf::Zoom::Impl::release_frontend(mp::Package &package)
301 {
302     boost::mutex::scoped_lock lock(m_mutex);
303     std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
304     
305     it = m_clients.find(package.session());
306     if (it != m_clients.end())
307     {
308         if (package.session().is_closed())
309         {
310             m_clients.erase(it);
311         }
312         else
313         {
314             it->second->m_in_use = false;
315         }
316         m_cond_session_ready.notify_all();
317     }
318 }
319
320 yf::Zoom::Impl::Impl() : element_transform("pz2") , element_raw("raw")
321 {
322     bibset = ccl_qual_mk();
323 }
324
325 yf::Zoom::Impl::~Impl()
326
327     ccl_qual_rm(&bibset);
328 }
329
330 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
331 {
332     Zoom::SearchablePtr s(new Searchable(bibset));
333     
334     for (ptr = ptr->children; ptr; ptr = ptr->next)
335     {
336         if (ptr->type != XML_ELEMENT_NODE)
337             continue;
338         if (!strcmp((const char *) ptr->name, "layer"))
339             ptr = ptr->children;
340         else if (!strcmp((const char *) ptr->name,
341                          "authentication"))
342         {
343             s->authentication = mp::xml::get_text(ptr);
344         }
345         else if (!strcmp((const char *) ptr->name,
346                          "cfAuth"))
347         {
348             s->cfAuth = mp::xml::get_text(ptr);
349         } 
350         else if (!strcmp((const char *) ptr->name,
351                          "cfProxy"))
352         {
353             s->cfProxy = mp::xml::get_text(ptr);
354         }  
355         else if (!strcmp((const char *) ptr->name,
356                          "cfSubDb"))
357         {
358             s->cfSubDb = mp::xml::get_text(ptr);
359         }  
360         else if (!strcmp((const char *) ptr->name, "udb"))
361         {
362             s->udb = mp::xml::get_text(ptr);
363         }
364         else if (!strcmp((const char *) ptr->name, "zurl"))
365         {
366             s->target = mp::xml::get_text(ptr);
367         }
368         else if (!strcmp((const char *) ptr->name, "sru"))
369         {
370             s->sru = mp::xml::get_text(ptr);
371         }
372         else if (!strcmp((const char *) ptr->name,
373                          "queryEncoding"))
374         {
375             s->query_encoding = mp::xml::get_text(ptr);
376         }
377         else if (!strcmp((const char *) ptr->name,
378                          "piggyback"))
379         {
380             s->piggyback = mp::xml::get_bool(ptr, true);
381         }
382         else if (!strcmp((const char *) ptr->name,
383                          "requestSyntax"))
384         {
385             s->request_syntax = mp::xml::get_text(ptr);
386         }
387         else if (!strcmp((const char *) ptr->name,
388                          "elementSet"))
389         {
390             s->element_set = mp::xml::get_text(ptr);
391         }
392         else if (!strcmp((const char *) ptr->name,
393                          "recordEncoding"))
394         {
395             s->record_encoding = mp::xml::get_text(ptr);
396         }
397         else if (!strcmp((const char *) ptr->name,
398                          "transform"))
399         {
400             s->transform_xsl_fname = mp::xml::get_text(ptr);
401         }
402         else if (!strcmp((const char *) ptr->name,
403                          "useTurboMarc"))
404         {
405             ; // useTurboMarc is ignored
406         }
407         else if (!strncmp((const char *) ptr->name,
408                           "cclmap_", 7))
409         {
410             std::string value = mp::xml::get_text(ptr);
411             ccl_qual_fitem(s->ccl_bibset, value.c_str(),
412                            (const char *) ptr->name + 7);
413         }
414     }
415     return s;
416 }
417
418 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
419 {
420     while (ptr && ptr->type != XML_ELEMENT_NODE)
421         ptr = ptr->next;
422     
423     if (ptr)
424     {
425         if (!strcmp((const char *) ptr->name, "records"))
426         {
427             for (ptr = ptr->children; ptr; ptr = ptr->next)
428             {
429                 if (ptr->type != XML_ELEMENT_NODE)
430                     continue;
431                 if (!strcmp((const char *) ptr->name, "record"))
432                 {
433                     SearchablePtr s = parse_torus_record(ptr);
434                     if (s)
435                     {
436                         std::string udb = s->udb;
437                         if (udb.length())
438                             s_map[s->udb] = s;
439                         else
440                         {
441                             throw mp::filter::FilterException
442                                 ("No udb for local torus record");
443                         }
444                     }
445                 }
446                 else
447                 {
448                     throw mp::filter::FilterException
449                         ("Bad element " 
450                          + std::string((const char *) ptr->name)
451                          + " in zoom filter inside element "
452                          "<torus><records>");
453                 }
454             }
455         }
456         else
457         {
458             throw mp::filter::FilterException
459                 ("Bad element " 
460                  + std::string((const char *) ptr->name)
461                  + " in zoom filter inside element <torus>");
462         }
463     }
464 }
465
466 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only)
467 {
468     for (ptr = ptr->children; ptr; ptr = ptr->next)
469     {
470         if (ptr->type != XML_ELEMENT_NODE)
471             continue;
472         else if (!strcmp((const char *) ptr->name, "torus"))
473         {
474             const struct _xmlAttr *attr;
475             for (attr = ptr->properties; attr; attr = attr->next)
476             {
477                 if (!strcmp((const char *) attr->name, "url"))
478                     torus_url = mp::xml::get_text(attr->children);
479                 else if (!strcmp((const char *) attr->name, "xsldir"))
480                     xsldir = mp::xml::get_text(attr->children);
481                 else if (!strcmp((const char *) attr->name, "element_transform"))
482                     element_transform = mp::xml::get_text(attr->children);
483                 else if (!strcmp((const char *) attr->name, "element_raw"))
484                     element_raw = mp::xml::get_text(attr->children);
485                 else
486                     throw mp::filter::FilterException(
487                         "Bad attribute " + std::string((const char *)
488                                                        attr->name));
489             }
490             configure_local_records(ptr->children, test_only);
491         }
492         else if (!strcmp((const char *) ptr->name, "cclmap"))
493         {
494             const char *addinfo = 0;
495             ccl_xml_config(bibset, ptr, &addinfo);
496         }
497         else if (!strcmp((const char *) ptr->name, "fieldmap"))
498         {
499             const struct _xmlAttr *attr;
500             std::string ccl_field;
501             std::string cql_field;
502             for (attr = ptr->properties; attr; attr = attr->next)
503             {
504                 if (!strcmp((const char *) attr->name, "ccl"))
505                     ccl_field = mp::xml::get_text(attr->children);
506                 else if (!strcmp((const char *) attr->name, "cql"))
507                     cql_field = mp::xml::get_text(attr->children);
508                 else
509                     throw mp::filter::FilterException(
510                         "Bad attribute " + std::string((const char *)
511                                                        attr->name));
512             }
513             if (cql_field.length())
514                 fieldmap[cql_field] = ccl_field;
515         }
516         else
517         {
518             throw mp::filter::FilterException
519                 ("Bad element " 
520                  + std::string((const char *) ptr->name)
521                  + " in zoom filter");
522         }
523     }
524 }
525
526 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
527     std::string &database, int *error, char **addinfo, ODR odr)
528 {
529     std::list<BackendPtr>::const_iterator map_it;
530     if (m_backend && m_backend->m_frontend_database == database)
531         return m_backend;
532
533     std::string db_args;
534     std::string torus_db;
535     size_t db_arg_pos = database.find(',');
536     if (db_arg_pos != std::string::npos)
537     {
538         torus_db = database.substr(0, db_arg_pos);
539         db_args = database.substr(db_arg_pos + 1);
540     }
541     else
542         torus_db = database;
543  
544     SearchablePtr sptr;
545
546     std::map<std::string,SearchablePtr>::iterator it;
547     it = m_p->s_map.find(torus_db);
548     if (it != m_p->s_map.end())
549         sptr = it->second;
550     else
551     {
552         xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db);
553         if (!doc)
554         {
555             *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
556             *addinfo = odr_strdup(odr, database.c_str());
557             BackendPtr b;
558             return b;
559         }
560         const xmlNode *ptr = xmlDocGetRootElement(doc);
561         if (ptr)
562         {   // presumably ptr is a records element node
563             // parse first record in document
564             for (ptr = ptr->children; ptr; ptr = ptr->next)
565             {
566                 if (ptr->type == XML_ELEMENT_NODE
567                     && !strcmp((const char *) ptr->name, "record"))
568                 {
569                     sptr = m_p->parse_torus_record(ptr);
570                     break;
571                 }
572             }
573         }
574         xmlFreeDoc(doc);
575     }
576
577     if (!sptr)
578     {
579         *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
580         *addinfo = odr_strdup(odr, database.c_str());
581         BackendPtr b;
582         return b;
583     }
584         
585     xsltStylesheetPtr xsp = 0;
586     if (sptr->transform_xsl_fname.length())
587     {
588         std::string fname;
589
590         if (m_p->xsldir.length()) 
591             fname = m_p->xsldir + "/" + sptr->transform_xsl_fname;
592         else
593             fname = sptr->transform_xsl_fname;
594         xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
595         if (!xsp_doc)
596         {
597             *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
598             *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname.c_str()));
599             sprintf(*addinfo, "xmlParseFile failed. File %s", fname.c_str());
600             BackendPtr b;
601             return b;
602         }
603         xsp = xsltParseStylesheetDoc(xsp_doc);
604         if (!xsp)
605         {
606             *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
607             *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
608             BackendPtr b;
609             xmlFreeDoc(xsp_doc);
610             return b;
611         }
612     }
613
614     m_backend.reset();
615
616     BackendPtr b(new Backend(sptr));
617
618     b->xsp = xsp;
619     b->m_frontend_database = database;
620     std::string authentication = sptr->authentication;
621         
622     b->set_option("timeout", "40");
623
624     if (sptr->query_encoding.length())
625         b->set_option("rpnCharset", sptr->query_encoding.c_str());
626
627     if (sptr->cfAuth.length())
628     {
629         // A CF target
630         b->set_option("user", sptr->cfAuth.c_str());
631         if (authentication.length() && db_args.length() == 0)
632         {
633             // no database (auth) args specified already.. and the
634             // Torus authentication has it.. Generate the args that CF
635             // understands..
636             size_t found = authentication.find('/');
637             if (found != std::string::npos)
638             {
639                 db_args += "user=" + mp::util::uri_encode(authentication.substr(0, found))
640                     + "&password=" + mp::util::uri_encode(authentication.substr(found+1));
641             }
642             else
643                 db_args += "user=" + mp::util::uri_encode(authentication);
644         }
645     }
646     else
647     {
648         // A non-CF target
649         if (db_args.length())
650         {
651             // user has specified backend authentication
652             const char *param_user = 0;
653             const char *param_password = 0;
654             char **names;
655             char **values;
656             int i;
657             int no_parms = yaz_uri_to_array(db_args.c_str(),
658                                             odr, &names, &values);
659             for (i = 0; i < no_parms; i++)
660             {
661                 const char *name = names[i];
662                 const char *value = values[i];
663                 if (!strcmp(name, "user"))
664                     param_user = value;
665                 else if (!strcmp(name, "password"))
666                     param_password = value;
667                 else
668                 {
669                     BackendPtr notfound;
670                     char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
671                     *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
672                     sprintf(msg, "Bad database argument: %s", name);
673                     *addinfo = msg;
674                     return notfound;
675                 }
676             }
677             if (param_user && param_password)
678             {
679                 char *auth = (char*) odr_malloc(
680                     odr, strlen(param_user) + strlen(param_password) + 2);
681                 strcpy(auth, param_user);
682                 strcat(auth, "/");
683                 strcat(auth, param_password);
684                 b->set_option("user", auth);
685             }
686             db_args.clear(); // no arguments to be passed (non-CF)
687         }
688         else
689         {
690             // use authentication from Torus, if given
691             if (authentication.length())
692                 b->set_option("user", authentication.c_str());
693         }
694     }
695     if (sptr->cfProxy.length())
696     {
697         if (db_args.length())
698             db_args += "&";
699         db_args += "proxy=" + mp::util::uri_encode(sptr->cfProxy);
700     }
701     if (sptr->cfSubDb.length())
702     {
703         if (db_args.length())
704             db_args += "&";
705         db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
706     }
707
708     std::string url;
709     if (sptr->sru.length())
710     {
711         url = "http://" + sptr->target;
712         b->set_option("sru", sptr->sru.c_str());
713     }
714     else
715     {
716         url = sptr->target;
717     }
718     if (db_args.length())
719         url += "," + db_args;
720     yaz_log(YLOG_LOG, "url=%s", url.c_str());
721     const char *addinfo_c = 0;
722     b->connect(url, error, &addinfo_c);
723     if (addinfo_c)
724         *addinfo = odr_strdup(odr, addinfo_c);
725     if (*error == 0)
726     {
727         m_backend = b;
728     }
729     return b;
730 }
731
732 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
733                                            Odr_int number_to_present,
734                                            int *error,
735                                            const char **addinfo,
736                                            Odr_int *number_of_records_returned,
737                                            ODR odr,
738                                            BackendPtr b,
739                                            Odr_oid *preferredRecordSyntax,
740                                            const char *element_set_name)
741 {
742     *number_of_records_returned = 0;
743     Z_Records *records = 0;
744     bool enable_pz2_retrieval = false; // whether target profile is used
745     bool enable_pz2_transform = false; // whether XSLT is used as well
746
747     if (start < 0 || number_to_present <= 0)
748         return records;
749     
750     if (number_to_present > 10000)
751         number_to_present = 10000;
752     
753     ZOOM_record *recs = (ZOOM_record *)
754         odr_malloc(odr, number_to_present * sizeof(*recs));
755
756     char oid_name_str[OID_STR_MAX];
757     const char *syntax_name = 0;
758     
759     if (preferredRecordSyntax &&
760         !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
761         && element_set_name)
762     {
763         if (!strcmp(element_set_name, m_p->element_transform.c_str()))
764         {
765             enable_pz2_retrieval = true;
766             enable_pz2_transform = true;
767         }
768         else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
769         {
770             enable_pz2_retrieval = true;
771         }
772     }
773     
774     if (enable_pz2_retrieval)
775     {
776         if (b->sptr->request_syntax.length())
777             syntax_name = b->sptr->request_syntax.c_str();
778     }
779     else if (preferredRecordSyntax)
780         syntax_name =
781             yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
782
783     b->set_option("preferredRecordSyntax", syntax_name);
784
785     if (enable_pz2_retrieval)
786     {
787         element_set_name = 0;
788         if (b->sptr->element_set.length())
789             element_set_name = b->sptr->element_set.c_str();
790     }
791
792     b->set_option("elementSetName", element_set_name);
793
794     b->present(start, number_to_present, recs, error, addinfo);
795
796     Odr_int i = 0;
797     if (!*error)
798     {
799         for (i = 0; i < number_to_present; i++)
800             if (!recs[i])
801                 break;
802     }
803     if (i > 0)
804     {  // only return records if no error and at least one record
805         char *odr_database = odr_strdup(odr,
806                                         b->m_frontend_database.c_str());
807         Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
808             odr_malloc(odr, sizeof(*npl));
809         *number_of_records_returned = i;
810         npl->num_records = i;
811         npl->records = (Z_NamePlusRecord **)
812             odr_malloc(odr, i * sizeof(*npl->records));
813         for (i = 0; i < number_to_present; i++)
814         {
815             Z_NamePlusRecord *npr = 0;
816             const char *addinfo;
817             int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
818                                               &addinfo, 0 /* diagset */);
819                 
820             if (sur_error)
821             {
822                 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
823                                             addinfo);
824             }
825             else if (enable_pz2_retrieval)
826             {
827                 char rec_type_str[100];
828
829                 strcpy(rec_type_str, b->sptr->use_turbomarc ?
830                        "txml" : "xml");
831                 // prevent buffer overflow ...
832                 if (b->sptr->record_encoding.length() > 0 &&
833                     b->sptr->record_encoding.length() < 
834                     (sizeof(rec_type_str)-20))
835                 {
836                     strcat(rec_type_str, "; charset=");
837                     strcat(rec_type_str, b->sptr->record_encoding.c_str());
838                 }
839                 
840                 int rec_len;
841                 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
842                                                       &rec_len);
843                 if (rec_buf && b->xsp && enable_pz2_transform)
844                 {
845                     xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
846                     if (rec_doc)
847                     { 
848                         xmlDoc *rec_res;
849                         rec_res = xsltApplyStylesheet(b->xsp, rec_doc, 0);
850
851                         if (rec_res)
852                             xsltSaveResultToString((xmlChar **) &rec_buf, &rec_len,
853                                                    rec_res, b->xsp);
854                     }
855                 }
856
857                 if (rec_buf)
858                 {
859                     npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
860                     npr->databaseName = odr_database;
861                     npr->which = Z_NamePlusRecord_databaseRecord;
862                     npr->u.databaseRecord =
863                         z_ext_record_xml(odr, rec_buf, rec_len);
864                 }
865                 else
866                 {
867                     npr = zget_surrogateDiagRec(
868                         odr, odr_database, 
869                         YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
870                         rec_type_str);
871                 }
872             }
873             else
874             {
875                 Z_External *ext =
876                     (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
877                 if (ext)
878                 {
879                     npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
880                     npr->databaseName = odr_database;
881                     npr->which = Z_NamePlusRecord_databaseRecord;
882                     npr->u.databaseRecord = ext;
883                 }
884                 else
885                 {
886                     npr = zget_surrogateDiagRec(
887                         odr, odr_database, 
888                         YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
889                         "ZOOM_record, type ext");
890                 }
891             }
892             npl->records[i] = npr;
893         }
894         records = (Z_Records*) odr_malloc(odr, sizeof(*records));
895         records->which = Z_Records_DBOSD;
896         records->u.databaseOrSurDiagnostics = npl;
897     }
898     return records;
899 }
900     
901 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
902                                                     ODR odr)
903 {
904     struct cql_node *r = 0;
905     if (!cn)
906         return 0;
907     switch (cn->which)
908     {
909     case CQL_NODE_ST:
910         if (cn->u.st.index)
911         {
912             std::map<std::string,std::string>::const_iterator it;
913             it = fieldmap.find(cn->u.st.index);
914             if (it == fieldmap.end())
915                 return cn;
916             if (it->second.length())
917                 cn->u.st.index = odr_strdup(odr, it->second.c_str());
918             else
919                 cn->u.st.index = 0;
920         }
921         break;
922     case CQL_NODE_BOOL:
923         r = convert_cql_fields(cn->u.boolean.left, odr);
924         if (!r)
925             r = convert_cql_fields(cn->u.boolean.right, odr);
926         break;
927     case CQL_NODE_SORT:
928         r = convert_cql_fields(cn->u.sort.search, odr);
929         break;
930     }
931     return r;
932 }
933
934 void yf::Zoom::Frontend::handle_search(mp::Package &package)
935 {
936     Z_GDU *gdu = package.request().get();
937     Z_APDU *apdu_req = gdu->u.z3950;
938     Z_APDU *apdu_res = 0;
939     mp::odr odr;
940     Z_SearchRequest *sr = apdu_req->u.searchRequest;
941     if (sr->num_databaseNames != 1)
942     {
943         apdu_res = odr.create_searchResponse(
944             apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
945         package.response() = apdu_res;
946         return;
947     }
948
949     int error = 0;
950     char *addinfo_s = 0;
951     std::string db(sr->databaseNames[0]);
952     BackendPtr b = get_backend_from_databases(db, &error, &addinfo_s, odr);
953     if (error)
954     {
955         apdu_res = 
956             odr.create_searchResponse(
957                 apdu_req, error, addinfo_s);
958         package.response() = apdu_res;
959         return;
960     }
961
962     const char *addinfo_c = 0;
963     b->set_option("setname", "default");
964
965     Odr_int hits = 0;
966     Z_Query *query = sr->query;
967     WRBUF ccl_wrbuf = 0;
968     WRBUF pqf_wrbuf = 0;
969
970     if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
971     {
972         // RPN
973         pqf_wrbuf = wrbuf_alloc();
974         yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
975     }
976     else if (query->which == Z_Query_type_2)
977     {
978         // CCL
979         ccl_wrbuf = wrbuf_alloc();
980         wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
981                     query->u.type_2->len);
982     }
983     else if (query->which == Z_Query_type_104 &&
984              query->u.type_104->which == Z_External_CQL)
985     {
986         // CQL
987         const char *cql = query->u.type_104->u.cql;
988         CQL_parser cp = cql_parser_create();
989         int r = cql_parser_string(cp, cql);
990         if (r)
991         {
992             cql_parser_destroy(cp);
993             apdu_res = 
994                 odr.create_searchResponse(apdu_req, 
995                                           YAZ_BIB1_MALFORMED_QUERY,
996                                           "CQL syntax error");
997             package.response() = apdu_res;
998             return;
999         }
1000         struct cql_node *cn = cql_parser_result(cp);
1001         struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1002         if (cn_error)
1003         {
1004             // hopefully we are getting a ptr to a index+relation+term node
1005             addinfo_c = 0;
1006             if (cn_error->which == CQL_NODE_ST)
1007                 addinfo_c = cn_error->u.st.index;
1008
1009             apdu_res = 
1010                 odr.create_searchResponse(apdu_req, 
1011                                           YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1012                                           addinfo_c);
1013             package.response() = apdu_res;
1014             return;
1015         }
1016         char ccl_buf[1024];
1017
1018         r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1019         if (r == 0)
1020         {
1021             ccl_wrbuf = wrbuf_alloc();
1022             wrbuf_puts(ccl_wrbuf, ccl_buf);
1023         }
1024         cql_parser_destroy(cp);
1025         if (r)
1026         {
1027             apdu_res = 
1028                 odr.create_searchResponse(apdu_req, 
1029                                           YAZ_BIB1_MALFORMED_QUERY,
1030                                           "CQL to CCL conversion error");
1031             package.response() = apdu_res;
1032             return;
1033         }
1034     }
1035     else
1036     {
1037         apdu_res = 
1038             odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1039         package.response() = apdu_res;
1040         return;
1041     }
1042
1043     if (ccl_wrbuf)
1044     {
1045         // CCL to PQF
1046         assert(pqf_wrbuf == 0);
1047         int cerror, cpos;
1048         struct ccl_rpn_node *cn;
1049         yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1050         cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1051                           &cerror, &cpos);
1052         wrbuf_destroy(ccl_wrbuf);
1053         if (!cn)
1054         {
1055             char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1056             int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1057
1058             switch (cerror)
1059             {
1060             case CCL_ERR_UNKNOWN_QUAL:
1061                 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1062                 break;
1063             case CCL_ERR_TRUNC_NOT_LEFT: 
1064             case CCL_ERR_TRUNC_NOT_RIGHT:
1065             case CCL_ERR_TRUNC_NOT_BOTH:
1066                 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1067                 break;
1068             }
1069             apdu_res = 
1070                 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1071             package.response() = apdu_res;
1072             return;
1073         }
1074         pqf_wrbuf = wrbuf_alloc();
1075         ccl_pquery(pqf_wrbuf, cn);
1076         ccl_rpn_delete(cn);
1077     }
1078     
1079     assert(pqf_wrbuf);
1080     if (b->get_option("sru"))
1081     {
1082         int status = 0;
1083         Z_RPNQuery *zquery;
1084         zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1085         WRBUF wrb = wrbuf_alloc();
1086             
1087         if (!strcmp(b->get_option("sru"), "solr"))
1088         {
1089             solr_transform_t cqlt = solr_transform_create();
1090             
1091             status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1092             
1093             solr_transform_close(cqlt);
1094         }
1095         else
1096         {
1097             cql_transform_t cqlt = cql_transform_create();
1098             
1099             status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1100             
1101             cql_transform_close(cqlt);
1102         }
1103         if (status == 0)
1104         {
1105             yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1106             b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo_c);
1107         }
1108         
1109         wrbuf_destroy(wrb);
1110         wrbuf_destroy(pqf_wrbuf);
1111         if (status)
1112         {
1113             apdu_res = 
1114                 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1115                                           "can not convert from RPN to CQL/SOLR");
1116             package.response() = apdu_res;
1117             return;
1118         }
1119     }
1120     else
1121     {
1122         yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1123         b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo_c);
1124         wrbuf_destroy(pqf_wrbuf);
1125     }
1126     
1127     
1128     const char *element_set_name = 0;
1129     Odr_int number_to_present = 0;
1130     if (!error)
1131         mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1132     
1133     Odr_int number_of_records_returned = 0;
1134     Z_Records *records = get_records(
1135         0, number_to_present, &error, &addinfo_c,
1136         &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1137         element_set_name);
1138     apdu_res = odr.create_searchResponse(apdu_req, error, addinfo_c);
1139     if (records)
1140     {
1141         apdu_res->u.searchResponse->records = records;
1142         apdu_res->u.searchResponse->numberOfRecordsReturned =
1143             odr_intdup(odr, number_of_records_returned);
1144     }
1145     apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1146     package.response() = apdu_res;
1147 }
1148
1149 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1150 {
1151     Z_GDU *gdu = package.request().get();
1152     Z_APDU *apdu_req = gdu->u.z3950;
1153     Z_APDU *apdu_res = 0;
1154     Z_PresentRequest *pr = apdu_req->u.presentRequest;
1155
1156     mp::odr odr;
1157     if (!m_backend)
1158     {
1159         package.response() = odr.create_presentResponse(
1160             apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1161         return;
1162     }
1163     const char *element_set_name = 0;
1164     Z_RecordComposition *comp = pr->recordComposition;
1165     if (comp && comp->which != Z_RecordComp_simple)
1166     {
1167         package.response() = odr.create_presentResponse(
1168             apdu_req, 
1169             YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1170         return;
1171     }
1172     if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1173         element_set_name = comp->u.simple->u.generic;
1174     Odr_int number_of_records_returned = 0;
1175     int error = 0;
1176     const char *addinfo = 0;
1177     Z_Records *records = get_records(
1178         *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1179         &error, &addinfo, &number_of_records_returned, odr, m_backend,
1180         pr->preferredRecordSyntax, element_set_name);
1181
1182     apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1183     if (records)
1184     {
1185         apdu_res->u.presentResponse->records = records;
1186         apdu_res->u.presentResponse->numberOfRecordsReturned =
1187             odr_intdup(odr, number_of_records_returned);
1188     }
1189     package.response() = apdu_res;
1190 }
1191
1192 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1193 {
1194     Z_GDU *gdu = package.request().get();
1195     if (!gdu)
1196         ;
1197     else if (gdu->which == Z_GDU_Z3950)
1198     {
1199         Z_APDU *apdu_req = gdu->u.z3950;
1200         if (apdu_req->which == Z_APDU_initRequest)
1201         {
1202             mp::odr odr;
1203             package.response() = odr.create_close(
1204                 apdu_req,
1205                 Z_Close_protocolError,
1206                 "double init");
1207         }
1208         else if (apdu_req->which == Z_APDU_searchRequest)
1209         {
1210             handle_search(package);
1211         }
1212         else if (apdu_req->which == Z_APDU_presentRequest)
1213         {
1214             handle_present(package);
1215         }
1216         else
1217         {
1218             mp::odr odr;
1219             package.response() = odr.create_close(
1220                 apdu_req,
1221                 Z_Close_protocolError,
1222                 "zoom filter cannot handle this APDU");
1223             package.session().close();
1224         }
1225     }
1226     else
1227     {
1228         package.session().close();
1229     }
1230 }
1231
1232 void yf::Zoom::Impl::process(mp::Package &package)
1233 {
1234     FrontendPtr f = get_frontend(package);
1235     Z_GDU *gdu = package.request().get();
1236
1237     if (f->m_is_virtual)
1238     {
1239         f->handle_package(package);
1240     }
1241     else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1242              Z_APDU_initRequest)
1243     {
1244         Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1245         f->m_init_gdu = gdu;
1246         
1247         mp::odr odr;
1248         Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1249         Z_InitResponse *resp = apdu->u.initResponse;
1250         
1251         int i;
1252         static const int masks[] = {
1253             Z_Options_search,
1254             Z_Options_present,
1255             -1 
1256         };
1257         for (i = 0; masks[i] != -1; i++)
1258             if (ODR_MASK_GET(req->options, masks[i]))
1259                 ODR_MASK_SET(resp->options, masks[i]);
1260         
1261         static const int versions[] = {
1262             Z_ProtocolVersion_1,
1263             Z_ProtocolVersion_2,
1264             Z_ProtocolVersion_3,
1265             -1
1266         };
1267         for (i = 0; versions[i] != -1; i++)
1268             if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1269                 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1270             else
1271                 break;
1272         
1273         *resp->preferredMessageSize = *req->preferredMessageSize;
1274         *resp->maximumRecordSize = *req->maximumRecordSize;
1275         
1276         package.response() = apdu;
1277         f->m_is_virtual = true;
1278     }
1279     else
1280         package.move();
1281
1282     release_frontend(package);
1283 }
1284
1285
1286 static mp::filter::Base* filter_creator()
1287 {
1288     return new mp::filter::Zoom;
1289 }
1290
1291 extern "C" {
1292     struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1293         0,
1294         "zoom",
1295         filter_creator
1296     };
1297 }
1298
1299
1300 /*
1301  * Local variables:
1302  * c-basic-offset: 4
1303  * c-file-style: "Stroustrup"
1304  * indent-tabs-mode: nil
1305  * End:
1306  * vim: shiftwidth=4 tabstop=8 expandtab
1307  */
1308