src/filter_cql_to_rpn.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 <metaproxy/util.hpp>
  21
  22 #include <metaproxy/filter.hpp>
  23 #include <metaproxy/package.hpp>
  24
  25 #include "filter_cql_to_rpn.hpp"
  26
  27 #include <yazpp/z-query.h>
  28 #include <yaz/cql.h>
  29 #include <yazpp/cql2rpn.h>
  30 #include <yaz/zgdu.h>
  31 #include <yaz/diagbib1.h>
  32 #include <yaz/srw.h>
  33
  34
  35 namespace mp = metaproxy_1;
  36 namespace yf = metaproxy_1::filter;
  37
  38 namespace metaproxy_1 {
  39     namespace filter {
  40         class CQLtoRPN::Impl {
  41         public:
  42             Impl();
  43             ~Impl();
  44             void process(metaproxy_1::Package & package);
  45             void configure(const xmlNode * ptr);
  46         private:
  47             yazpp_1::Yaz_cql2rpn m_cql2rpn;
  48         };
  49     }
  50 }
  51
  52
  53 // define Pimpl wrapper forwarding to Impl
  54
  55 yf::CQLtoRPN::CQLtoRPN() : m_p(new Impl)
  56 {
  57 }
  58
  59 yf::CQLtoRPN::~CQLtoRPN()
  60 {  // must have a destructor because of boost::scoped_ptr
  61 }
  62
  63 void yf::CQLtoRPN::configure(const xmlNode *xmlnode, bool test_only,
  64                              const char *path)
  65 {
  66     m_p->configure(xmlnode);
  67 }
  68
  69 void yf::CQLtoRPN::process(mp::Package &package) const
  70 {
  71     m_p->process(package);
  72 }
  73
  74
  75 // define Implementation stuff
  76
  77 yf::CQLtoRPN::Impl::Impl()
  78 {
  79 }
  80
  81 yf::CQLtoRPN::Impl::~Impl()
  82 {
  83 }
  84
  85 void yf::CQLtoRPN::Impl::configure(const xmlNode *xmlnode)
  86 {
  87
  88     /*
  89       <filter type="cql_rpn">
  90       <conversion file="pqf.properties"/>
  91       </filter>
  92     */
  93
  94     std::string fname;
  95     for (xmlnode = xmlnode->children; xmlnode; xmlnode = xmlnode->next)
  96     {
  97         if (xmlnode->type != XML_ELEMENT_NODE)
  98             continue;
  99         if (!strcmp((const char *) xmlnode->name, "conversion"))
 100         {
 101             const struct _xmlAttr *attr;
 102             for (attr = xmlnode->properties; attr; attr = attr->next)
 103             {
 104                 if (!strcmp((const char *) attr->name, "file"))
 105                     fname = mp::xml::get_text(attr);
 106                 else
 107                     throw mp::filter::FilterException(
 108                         "Bad attribute " + std::string((const char *)
 109                                                        attr->name));
 110             }
 111         }
 112         else
 113         {
 114             throw mp::filter::FilterException("Bad element "
 115                                                + std::string((const char *)
 116                                                              xmlnode->name));
 117         }
 118     }
 119     if (fname.length() == 0)
 120     {
 121         throw mp::filter::FilterException("Missing conversion configuration "
 122                                           "for filter cql_rpn");
 123     }
 124
 125     int error = 0;
 126     if (!m_cql2rpn.parse_spec_file(fname.c_str(), &error))
 127     {
 128         throw mp::filter::FilterException("Bad or missing "
 129                                           "CQL to RPN configuration "
 130                                           + fname);
 131     }
 132 }
 133
 134 void yf::CQLtoRPN::Impl::process(mp::Package &package)
 135 {
 136     Z_GDU *gdu = package.request().get();
 137
 138     if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 139         Z_APDU_searchRequest)
 140     {
 141         Z_APDU *apdu_req = gdu->u.z3950;
 142         Z_SearchRequest *sr = gdu->u.z3950->u.searchRequest;
 143         if (sr->query && sr->query->which == Z_Query_type_104 &&
 144             sr->query->u.type_104->which == Z_External_CQL)
 145         {
 146             char *addinfo = 0;
 147             Z_RPNQuery *rpnquery = 0;
 148             mp::odr odr;
 149
 150             int r = m_cql2rpn.query_transform(sr->query->u.type_104->u.cql,
 151                                                  &rpnquery, odr,
 152                                                  &addinfo);
 153             if (r == -3)
 154             {
 155                 Z_APDU *f_apdu =
 156                     odr.create_searchResponse(
 157                         apdu_req,
 158                         YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
 159                         "Missing CQL to RPN configuration");
 160                 package.response() = f_apdu;
 161                 return;
 162             }
 163             else if (r)
 164             {
 165                 int error_code = yaz_diag_srw_to_bib1(r);
 166
 167                 Z_APDU *f_apdu =
 168                     odr.create_searchResponse(apdu_req, error_code, addinfo);
 169                 package.response() = f_apdu;
 170                 return;
 171             }
 172             else
 173             {   // conversion OK
 174
 175                 sr->query->which = Z_Query_type_1;
 176                 sr->query->u.type_1 = rpnquery;
 177                 package.request() = gdu;
 178             }
 179         }
 180     }
 181     package.move();
 182 }
 183
 184
 185 static mp::filter::Base* filter_creator()
 186 {
 187     return new mp::filter::CQLtoRPN;
 188 }
 189
 190 extern "C" {
 191     struct metaproxy_1_filter_struct metaproxy_1_filter_cql_to_rpn = {
 192         0,
 193         "cql_rpn",
 194         filter_creator
 195     };
 196 }
 197
 198 /*
 199  * Local variables:
 200  * c-basic-offset: 4
 201  * c-file-style: "Stroustrup"
 202  * indent-tabs-mode: nil
 203  * End:
 204  * vim: shiftwidth=4 tabstop=8 expandtab
 205  */
 206