1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2013 Index Data
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
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
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
20 #include <metaproxy/filter.hpp>
21 #include <metaproxy/package.hpp>
22 #include <metaproxy/util.hpp>
23 #include "filter_http_rewrite.hpp"
24 #include "html_parser.hpp"
30 #include <boost/regex.hpp>
31 #include <boost/lexical_cast.hpp>
32 #include <boost/algorithm/string.hpp>
36 namespace mp = metaproxy_1;
37 namespace yf = mp::filter;
39 namespace metaproxy_1 {
41 class HttpRewrite::Replace {
45 std::map<int, std::string> group_index;
46 const std::string search_replace(
47 std::map<std::string, std::string> & vars,
48 const std::string & txt) const;
50 const std::map<std::string, std::string> & vars) const;
54 class HttpRewrite::Rule {
56 std::list<Replace> replace_list;
57 const std::string test_patterns(
58 std::map<std::string, std::string> & vars,
59 const std::string & txt) const;
61 class HttpRewrite::Within {
70 class HttpRewrite::Phase {
73 std::list<Within> within_list;
75 void rewrite_reqline(mp::odr & o, Z_HTTP_Request *hreq,
76 std::map<std::string, std::string> & vars) const;
77 void rewrite_headers(mp::odr & o, Z_HTTP_Header *headers,
78 std::map<std::string, std::string> & vars) const;
79 void rewrite_body(mp::odr & o,
80 char **content_buf, int *content_len,
81 std::map<std::string, std::string> & vars) const;
83 class HttpRewrite::Event : public HTMLParserEvent {
84 void openTagStart(const char *tag, int tag_len);
85 void anyTagEnd(const char *tag, int tag_len, int close_it);
86 void attribute(const char *tag, int tag_len,
87 const char *attr, int attr_len,
88 const char *value, int val_len,
90 void closeTag(const char *tag, int tag_len);
91 void text(const char *value, int len);
94 std::stack<std::list<Within>::const_iterator> s_within;
95 std::map<std::string, std::string> &m_vars;
97 Event(const Phase *p, std::map<std::string, std::string> &vars);
104 yf::HttpRewrite::HttpRewrite() :
105 req_phase(new Phase), res_phase(new Phase)
109 yf::HttpRewrite::~HttpRewrite()
113 void yf::HttpRewrite::process(mp::Package & package) const
115 yaz_log(YLOG_LOG, "HttpRewrite begins....");
116 Z_GDU *gdu = package.request().get();
117 //map of request/response vars
118 std::map<std::string, std::string> vars;
119 //we have an http req
120 if (gdu && gdu->which == Z_GDU_HTTP_Request)
122 Z_HTTP_Request *hreq = gdu->u.HTTP_Request;
124 req_phase->rewrite_reqline(o, hreq, vars);
125 yaz_log(YLOG_LOG, ">> Request headers");
126 req_phase->rewrite_headers(o, hreq->headers, vars);
127 req_phase->rewrite_body(o,
128 &hreq->content_buf, &hreq->content_len, vars);
129 package.request() = gdu;
132 gdu = package.response().get();
133 if (gdu && gdu->which == Z_GDU_HTTP_Response)
135 Z_HTTP_Response *hres = gdu->u.HTTP_Response;
136 yaz_log(YLOG_LOG, "Response code %d", hres->code);
138 yaz_log(YLOG_LOG, "<< Respose headers");
139 res_phase->rewrite_headers(o, hres->headers, vars);
140 res_phase->rewrite_body(o, &hres->content_buf,
141 &hres->content_len, vars);
142 package.response() = gdu;
146 void yf::HttpRewrite::Phase::rewrite_reqline (mp::odr & o,
147 Z_HTTP_Request *hreq,
148 std::map<std::string, std::string> & vars) const
150 //rewrite the request line
152 if (strstr(hreq->path, "http://") == hreq->path)
154 yaz_log(YLOG_LOG, "Path in the method line is absolute, "
155 "possibly a proxy request");
160 //TODO what about proto
162 path += z_HTTP_header_lookup(hreq->headers, "Host");
167 std::list<Within>::const_iterator it = within_list.begin();
168 for (; it != within_list.end(); it++)
171 RulePtr rule = it->rule;
172 yaz_log(YLOG_LOG, "Proxy request URL is %s", path.c_str());
173 std::string npath = rule->test_patterns(vars, path);
176 yaz_log(YLOG_LOG, "Rewritten request URL is %s", npath.c_str());
177 hreq->path = odr_strdup(o, npath.c_str());
182 void yf::HttpRewrite::Phase::rewrite_headers(mp::odr & o,
183 Z_HTTP_Header *headers,
184 std::map<std::string, std::string> & vars) const
186 for (Z_HTTP_Header *header = headers; header; header = header->next)
188 std::list<Within>::const_iterator it = within_list.begin();
189 for (; it != within_list.end(); it++)
191 if (it->header.length() > 0 &&
192 yaz_strcasecmp(it->header.c_str(), header->name) == 0)
194 std::string sheader(header->name);
196 sheader += header->value;
198 RulePtr rule = it->rule;
199 std::string out = rule->test_patterns(vars, sheader);
202 size_t pos = out.find(": ");
203 if (pos == std::string::npos)
205 yaz_log(YLOG_LOG, "Header malformed during rewrite, ignoring");
208 header->name = odr_strdup(o, out.substr(0, pos).c_str());
209 header->value = odr_strdup(o,
211 std::string::npos).c_str());
218 void yf::HttpRewrite::Phase::rewrite_body(mp::odr & o,
221 std::map<std::string, std::string> & vars) const
226 for (i = 0; i < *content_len; i++)
227 if ((*content_buf)[i] == 0)
228 return; // binary content. skip
231 Event ev(this, vars);
233 parser.set_verbose(m_verbose);
235 std::string buf(*content_buf, *content_len);
237 parser.parse(ev, buf.c_str());
238 const char *res = ev.result();
239 *content_buf = odr_strdup(o, res);
240 *content_len = strlen(res);
244 yf::HttpRewrite::Event::Event(const Phase *p,
245 std::map<std::string, std::string> & vars
246 ) : m_phase(p), m_vars(vars)
251 yf::HttpRewrite::Event::~Event()
256 const char *yf::HttpRewrite::Event::result()
258 return wrbuf_cstr(m_w);
261 void yf::HttpRewrite::Event::openTagStart(const char *tag, int tag_len)
263 wrbuf_putc(m_w, '<');
264 wrbuf_write(m_w, tag, tag_len);
266 std::string t(tag, tag_len);
267 std::list<Within>::const_iterator it = m_phase->within_list.begin();
268 for (; it != m_phase->within_list.end(); it++)
270 if (it->tag.length() > 0 && yaz_strcasecmp(it->tag.c_str(),
273 std::vector<std::string> attr;
274 boost::split(attr, it->attr, boost::is_any_of(","));
276 for (i = 0; i < attr.size(); i++)
278 if (attr[i].compare("#text") == 0)
288 void yf::HttpRewrite::Event::anyTagEnd(const char *tag, int tag_len,
293 if (!s_within.empty())
295 std::list<Within>::const_iterator it = s_within.top();
296 std::string t(tag, tag_len);
297 if (yaz_strcasecmp(it->tag.c_str(), t.c_str()) == 0)
302 wrbuf_putc(m_w, '/');
303 wrbuf_putc(m_w, '>');
306 void yf::HttpRewrite::Event::attribute(const char *tag, int tag_len,
307 const char *attr, int attr_len,
308 const char *value, int val_len,
311 std::list<Within>::const_iterator it = m_phase->within_list.begin();
314 for (; it != m_phase->within_list.end(); it++)
316 std::string t(tag, tag_len);
317 if (it->tag.length() == 0 ||
318 yaz_strcasecmp(it->tag.c_str(), t.c_str()) == 0)
320 std::string a(attr, attr_len);
321 std::vector<std::string> attr;
322 boost::split(attr, it->attr, boost::is_any_of(","));
324 for (i = 0; i < attr.size(); i++)
326 if (attr[i].compare("#text") &&
327 yaz_strcasecmp(attr[i].c_str(), a.c_str()) == 0)
335 wrbuf_putc(m_w, ' ');
336 wrbuf_write(m_w, attr, attr_len);
339 wrbuf_puts(m_w, "=");
340 wrbuf_puts(m_w, sep);
345 std::string input(value, val_len);
346 output = it->rule->test_patterns(m_vars, input);
349 wrbuf_write(m_w, value, val_len);
351 wrbuf_puts(m_w, output.c_str());
352 wrbuf_puts(m_w, sep);
356 void yf::HttpRewrite::Event::closeTag(const char *tag, int tag_len)
358 if (!s_within.empty())
360 std::list<Within>::const_iterator it = s_within.top();
361 std::string t(tag, tag_len);
362 if (yaz_strcasecmp(it->tag.c_str(), t.c_str()) == 0)
365 wrbuf_puts(m_w, "</");
366 wrbuf_write(m_w, tag, tag_len);
369 void yf::HttpRewrite::Event::text(const char *value, int len)
371 std::list<Within>::const_iterator it = m_phase->within_list.end();
372 if (!s_within.empty())
375 if (it != m_phase->within_list.end())
377 std::string input(value, len);
378 output = it->rule->test_patterns(m_vars, input);
381 wrbuf_write(m_w, value, len);
383 wrbuf_puts(m_w, output.c_str());
388 * Tests pattern from the vector in order and executes recipe on
391 const std::string yf::HttpRewrite::Rule::test_patterns(
392 std::map<std::string, std::string> & vars,
393 const std::string & txt) const
395 std::list<Replace>::const_iterator it = replace_list.begin();
397 for (; it != replace_list.end(); it++)
399 std::string out = it->search_replace(vars, txt);
400 if (!out.empty()) return out;
405 const std::string yf::HttpRewrite::Replace::search_replace(
406 std::map<std::string, std::string> & vars,
407 const std::string & txt) const
409 //exec regex against value
410 boost::regex re(regex);
412 std::string::const_iterator start, end;
416 while (regex_search(start, end, what, re)) //find next full match
419 for (i = 1; i < what.size(); ++i)
421 //check if the group is named
422 std::map<int, std::string>::const_iterator it
423 = group_index.find(i);
424 if (it != group_index.end())
426 vars[it->second] = what[i];
430 //prepare replacement string
431 std::string rvalue = sub_vars(vars);
432 yaz_log(YLOG_LOG, "! Rewritten '%s' to '%s'",
433 what.str(0).c_str(), rvalue.c_str());
434 out.append(start, what[0].first);
436 start = what[0].second; //move search forward
438 //if we had a match cat the last part
439 if (start != txt.begin())
440 out.append(start, end);
444 void yf::HttpRewrite::Replace::parse_groups()
448 const std::string & str = regex;
450 yaz_log(YLOG_LOG, "Parsing groups from '%s'", str.c_str());
451 for (size_t i = 0; i < str.size(); ++i)
454 if (!esc && str[i] == '\\')
459 if (!esc && str[i] == '(') //group starts
462 if (i+1 < str.size() && str[i+1] == '?') //group with attrs
465 if (i+1 < str.size() && str[i+1] == ':') //non-capturing
467 if (gnum > 0) gnum--;
473 if (i+1 < str.size() && str[i+1] == 'P') //optional, python
475 if (i+1 < str.size() && str[i+1] == '<') //named
480 while (++i < str.size())
482 if (str[i] == '>') { term = true; break; }
483 if (!isalnum(str[i]))
484 throw mp::filter::FilterException
485 ("Only alphanumeric chars allowed, found "
489 + boost::lexical_cast<std::string>(i));
493 throw mp::filter::FilterException
494 ("Unterminated group name '" + gname
495 + " in '" + str +"'");
496 group_index[gnum] = gname;
497 yaz_log(YLOG_LOG, "Found named group '%s' at $%d",
498 gname.c_str(), gnum);
507 std::string yf::HttpRewrite::Replace::sub_vars(
508 const std::map<std::string, std::string> & vars) const
512 const std::string & in = recipe;
513 for (size_t i = 0; i < in.size(); ++i)
515 if (!esc && in[i] == '\\')
520 if (!esc && in[i] == '$') //var
522 if (i+1 < in.size() && in[i+1] == '{') //ref prefix
527 while (++i < in.size())
529 if (in[i] == '}') { term = true; break; }
532 if (!term) throw mp::filter::FilterException
533 ("Unterminated var ref in '"+in+"' at "
534 + boost::lexical_cast<std::string>(i));
535 std::map<std::string, std::string>::const_iterator it
537 if (it != vars.end())
544 throw mp::filter::FilterException
545 ("Malformed or trimmed var ref in '"
546 +in+"' at "+boost::lexical_cast<std::string>(i));
557 yf::HttpRewrite::Phase::Phase() : m_verbose(0)
561 void yf::HttpRewrite::configure_phase(const xmlNode *ptr, Phase &phase)
563 static const char *names[2] = { "verbose", 0 };
564 std::string values[1];
566 mp::xml::parse_attr(ptr, names, values);
568 phase.m_verbose = atoi(values[0].c_str());
570 std::map<std::string, RulePtr > rules;
571 for (ptr = ptr->children; ptr; ptr = ptr->next)
573 if (ptr->type != XML_ELEMENT_NODE)
575 else if (!strcmp((const char *) ptr->name, "rule"))
577 static const char *names[2] = { "name", 0 };
578 std::string values[1];
579 values[0] = "default";
580 mp::xml::parse_attr(ptr, names, values);
582 RulePtr rule(new Rule);
583 for (xmlNode *p = ptr->children; p; p = p->next)
585 if (p->type != XML_ELEMENT_NODE)
587 if (!strcmp((const char *) p->name, "rewrite"))
590 const struct _xmlAttr *attr;
591 for (attr = p->properties; attr; attr = attr->next)
593 if (!strcmp((const char *) attr->name, "from"))
594 replace.regex = mp::xml::get_text(attr->children);
595 else if (!strcmp((const char *) attr->name, "to"))
596 replace.recipe = mp::xml::get_text(attr->children);
598 throw mp::filter::FilterException
600 + std::string((const char *) attr->name)
601 + " in rewrite section of http_rewrite");
603 yaz_log(YLOG_LOG, "Found rewrite rule from '%s' to '%s'",
604 replace.regex.c_str(), replace.recipe.c_str());
605 replace.parse_groups();
606 if (!replace.regex.empty())
607 rule->replace_list.push_back(replace);
610 throw mp::filter::FilterException
612 + std::string((const char *) p->name)
613 + " in http_rewrite filter");
615 rules[values[0]] = rule;
617 else if (!strcmp((const char *) ptr->name, "within"))
619 static const char *names[6] =
620 { "header", "attr", "tag", "rule", "reqline", 0 };
621 std::string values[5];
622 mp::xml::parse_attr(ptr, names, values);
624 w.header = values[0];
627 std::map<std::string,RulePtr>::const_iterator it =
628 rules.find(values[3]);
629 if (it == rules.end())
630 throw mp::filter::FilterException
631 ("Reference to non-existing rule '" + values[3] +
632 "' in http_rewrite filter");
634 w.reqline = values[4] == "1";
635 phase.within_list.push_back(w);
639 throw mp::filter::FilterException
641 + std::string((const char *) ptr->name)
642 + " in http_rewrite filter");
647 void yf::HttpRewrite::configure(const xmlNode * ptr, bool test_only,
650 for (ptr = ptr->children; ptr; ptr = ptr->next)
652 if (ptr->type != XML_ELEMENT_NODE)
654 else if (!strcmp((const char *) ptr->name, "request"))
656 configure_phase(ptr, *req_phase);
658 else if (!strcmp((const char *) ptr->name, "response"))
660 configure_phase(ptr, *res_phase);
664 throw mp::filter::FilterException
666 + std::string((const char *) ptr->name)
667 + " in http_rewrite1 filter");
672 static mp::filter::Base* filter_creator()
674 return new mp::filter::HttpRewrite;
678 struct metaproxy_1_filter_struct metaproxy_1_filter_http_rewrite = {
689 * c-file-style: "Stroustrup"
690 * indent-tabs-mode: nil
692 * vim: shiftwidth=4 tabstop=8 expandtab