//Implements the HTMLTemplate class, for displaying template-based banned pages to clients // For all support, instructions and copyright go to: // http://e2guardian.org/ // Released under the GPL v2, with the OpenSSL exception described in the README file. // INCLUDES #ifdef HAVE_CONFIG_H #include "e2config.h" #endif #include "HTMLTemplate.hpp" #include "RegExp.hpp" #include "String.hpp" #include "OptionContainer.hpp" #include "Logger.hpp" #include #include #include #include #include // GLOBALS extern OptionContainer o; // IMPLEMENTATION // wipe the loaded template void HTMLTemplate::reset() { html.clear(); } // push a line onto our string list void HTMLTemplate::push(String s) { if (s.length() > 0) { html.push_back(s); } } // read in HTML template and find URL, reason, category etc. placeholders bool HTMLTemplate::readTemplateFile(const char *filename, const char *placeholders) { std::string linebuffer; RegExp re; // compile regexp for matching supported placeholders // allow optional custom placeholder string re.comp(placeholders ? placeholders : "-URL-|-REASONGIVEN-|-REASONLOGGED-|-USER-|-IP-|-HOST-|-FILTERGROUP-|-RAWFILTERGROUP-|-BYPASS-|-CATEGORIES-|-SHORTURL-|-SERVERIP-|-EXTFLAGS-|-SERVERNAME-"); RegResult Rre; unsigned int offset; String result; String line; std::ifstream templatefile(filename, std::ios::in); // e2guardian.conf if (!templatefile.good()) { E2LOGGER_error("error reading HTML template file: ", filename); return false; } while (!templatefile.eof()) { std::getline(templatefile, linebuffer); line = linebuffer.c_str(); // look for placeholders re.match(line.toCharArray(),Rre); while (Rre.numberOfMatches() > 0) { // whenever we find one, push the text before it onto the list, then the placeholder, then the text after it offset = Rre.offset(0); result = Rre.result(0).c_str(); if (offset > 0) { push(line.subString(0, offset)); push(result); line = line.subString(offset + result.length(), line.length() - offset - result.length()); } else { push(result); line = line.subString(result.length(), line.length() - result.length()); } re.match(line.toCharArray(),Rre); } // if any text remains, or we didn't find a placeholder, push the remainder of the line if (line.length() > 0) { push(line); } } if (html.size() < 1) { E2LOGGER_error("Unable to parse template file: ", filename); return false; } // add space as last line - to make safe i+1 and size -1 logic in display_hb line = " "; push(line); templatefile.close(); return true; } // encode quotes and angle brackets using URL encoding to prevent XSS in the block page void makeURLSafe(String &url) { url.replaceall("'", "%27"); url.replaceall("\"", "%22"); url.replaceall("<", "%3C"); url.replaceall(">", "%3E"); } void HTMLTemplate::display_hb(String &ebody, String *url, std::string &reason, std::string &logreason, std::string &categories, std::string *user, std::string *ip, std::string *host, int filtergroup, String grpname, String &hashed , String &localip, String &extflags) { DEBUG_debug("Displaying TEMPLATE. url:", url, " reason:", reason, " logreason:", logreason); String line; bool newline; unsigned int sz = html.size(); if (sz < 1) //template is empty return; sz--; //ignore last space line added by read function String safeurl(*url); // Take a copy of the URL so we can encode it to stop XSS bool safe = false; String servername(""); servername = o.net.server_name; for (unsigned int i = 0; i < sz; i++) { // preserve newlines from original file newline = false; line = html[i]; DEBUG_debug("Displaying TEMPLATE: ", line); // Take care SSLMITM negotiation error if (line.length() < 1){ ebody += "\n"; E2LOGGER_error("Corrupted TEMPLATE returns: ", url->c_str()); break; } // look for placeholders (split onto their own line by readTemplateFile) and replace them if (line == "-URL-") { if (!safe) { makeURLSafe(safeurl); safe = true; } line = safeurl; } else if (line == "-SHORTURL-") { if (!safe) { makeURLSafe(safeurl); safe = true; } line = safeurl; if (line.length() > 41) { line = line.subString(0, 40); line += "..."; } } else if (line == "-SERVERIP-") { line = localip; } else if (line == "-REASONGIVEN-") { String safereason = reason; makeURLSafe(safereason); line = safereason; } else if (line == "-REASONLOGGED-") { line = logreason; } else if (line == "-SERVERNAME-") { line = servername; } else if (line == "-USER-") { String safeuser(*user); makeURLSafe(safeuser); line = safeuser; } else if (line == "-IP-") { line = *ip; } else if (line == "-HOST-") { if (host == NULL) { line = ""; } else { line = *host; } } else if (line == "-FILTERGROUP-") { line = grpname; } else if (line == "-RAWFILTERGROUP-") { line = String(filtergroup + 1); } else if (line == "-CATEGORIES-") { if (categories.length() > 0) { line = categories; } else { line = "N/A"; } } else if (line == "-BYPASS-") { if (hashed.length() > 0) { if (!safe) { makeURLSafe(safeurl); safe = true; } line = safeurl; if (!(url->after("://").contains("/"))) { line += "/"; } if (url->contains("?")) { line += "&" + hashed; } else { line += "?" + hashed; } } else { line = ""; } } else if (line == "-EXTFLAGS-") { line = extflags; } else { // if this line wasn't a placeholder, and neither is the // next line, then output a newline, thus preserving line breaks // from the original template file. if (html[i + 1][0] != '-') { newline = true; } } if (line.length() > 0) { ebody += line; } if (newline) { ebody += "\n"; } } //ebody += html[sz].toCharArray(); - no longer needed as html[sz] is added as padding //ebody += "\n"; } #ifdef NOTDEF // fill in placeholders with the given information and send the resulting page to the client // only useful if you used the default set of placeholders void HTMLTemplate::display(Socket *s, String *url, std::string &reason, std::string &logreason, std::string &categories, std::string *user, std::string *ip, std::string *host, int filtergroup, String grpname, String &hashed) { String ebody; String localip = s->getLocalIP(); display_hb(ebody, url, reason, logreason, categories, user, ip, host, filtergroup, grpname, hashed, localip); s->writeString(ebody.toCharArray()); } #endif