src/errorpage.cc

   1 /*
   2  * $Id$
   3  *
   4  * DEBUG: section 04    Error Generation
   5  * AUTHOR: Duane Wessels
   6  *
   7  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   8  * ----------------------------------------------------------
   9  *
  10  *  Squid is the result of efforts by numerous individuals from
  11  *  the Internet community; see the CONTRIBUTORS file for full
  12  *  details.   Many organizations have provided support for Squid's
  13  *  development; see the SPONSORS file for full details.  Squid is
  14  *  Copyrighted (C) 2001 by the Regents of the University of
  15  *  California; see the COPYRIGHT file for full details.  Squid
  16  *  incorporates software developed and/or copyrighted by other
  17  *  sources; see the CREDITS file for full details.
  18  *
  19  *  This program is free software; you can redistribute it and/or modify
  20  *  it under the terms of the GNU General Public License as published by
  21  *  the Free Software Foundation; either version 2 of the License, or
  22  *  (at your option) any later version.
  23  *
  24  *  This program is distributed in the hope that it will be useful,
  25  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  *  GNU General Public License for more details.
  28  *
  29  *  You should have received a copy of the GNU General Public License
  30  *  along with this program; if not, write to the Free Software
  31  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  32  *
  33  */
  34 #include "squid.h"
  35 #include "comm/Connection.h"
  36 #include "comm/Write.h"
  37 #include "errorpage.h"
  38 #if USE_AUTH
  39 #include "auth/UserRequest.h"
  40 #endif
  41 #include "SquidTime.h"
  42 #if USE_SSL
  43 #include "ssl/ErrorDetailManager.h"
  44 #endif
  45 #include "Store.h"
  46 #include "html_quote.h"
  47 #include "HttpReply.h"
  48 #include "HttpRequest.h"
  49 #include "MemObject.h"
  50 #include "fde.h"
  51 #include "MemBuf.h"
  52 #include "rfc1738.h"
  53 #include "URLScheme.h"
  54 #include "wordlist.h"
  55 #include "err_detail_type.h"
  56
  57 /**
  58  \defgroup ErrorPageInternal Error Page Internals
  59  \ingroup ErrorPageAPI
  60  *
  61  \section Abstract Abstract:
  62  *   These routines are used to generate error messages to be
  63  *   sent to clients.  The error type is used to select between
  64  *   the various message formats. (formats are stored in the
  65  *   Config.errorDirectory)
  66  */
  67
  68
  69 #if !defined(DEFAULT_SQUID_ERROR_DIR)
  70 /** Where to look for errors if config path fails.
  71  \note Please use ./configure --datadir=/path instead of patching
  72  */
  73 #define DEFAULT_SQUID_ERROR_DIR   DEFAULT_SQUID_DATA_DIR"/errors"
  74 #endif
  75
  76 /// \ingroup ErrorPageInternal
  77 CBDATA_CLASS_INIT(ErrorState);
  78
  79 /* local types */
  80
  81 /// \ingroup ErrorPageInternal
  82 typedef struct {
  83     int id;
  84     char *page_name;
  85     http_status page_redirect;
  86 } ErrorDynamicPageInfo;
  87
  88 /* local constant and vars */
  89
  90 /**
  91  \ingroup ErrorPageInternal
  92  *
  93  \note  hard coded error messages are not appended with %S
  94  *      automagically to give you more control on the format
  95  */
  96 static const struct {
  97     int type;                   /* and page_id */
  98     const char *text;
  99 }
 100
 101 error_hard_text[] = {
 102
 103     {
 104         ERR_SQUID_SIGNATURE,
 105         "\n<br>\n"
 106         "<hr>\n"
 107         "<div id=\"footer\">\n"
 108         "Generated %T by %h (%s)\n"
 109         "</div>\n"
 110         "</body></html>\n"
 111     },
 112     {
 113         TCP_RESET,
 114         "reset"
 115     }
 116 };
 117
 118 /// \ingroup ErrorPageInternal
 119 static Vector<ErrorDynamicPageInfo *> ErrorDynamicPages;
 120
 121 /* local prototypes */
 122
 123 /// \ingroup ErrorPageInternal
 124 static const int error_hard_text_count = sizeof(error_hard_text) / sizeof(*error_hard_text);
 125
 126 /// \ingroup ErrorPageInternal
 127 static char **error_text = NULL;
 128
 129 /// \ingroup ErrorPageInternal
 130 static int error_page_count = 0;
 131
 132 /// \ingroup ErrorPageInternal
 133 static MemBuf error_stylesheet;
 134
 135 static const char *errorFindHardText(err_type type);
 136 static ErrorDynamicPageInfo *errorDynamicPageInfoCreate(int id, const char *page_name);
 137 static void errorDynamicPageInfoDestroy(ErrorDynamicPageInfo * info);
 138 static IOCB errorSendComplete;
 139
 140 /// \ingroup ErrorPageInternal
 141 /// manages an error page template
 142 class ErrorPageFile: public TemplateFile
 143 {
 144 public:
 145     ErrorPageFile(const char *name, const err_type code): TemplateFile(name,code) { textBuf.init();}
 146
 147     /// The template text data read from disk
 148     const char *text() { return textBuf.content(); }
 149
 150 private:
 151     /// stores the data read from disk to a local buffer
 152     virtual bool parse(const char *buf, int len, bool eof) {
 153         if (len)
 154             textBuf.append(buf, len);
 155         return true;
 156     }
 157
 158     MemBuf textBuf; ///< A buffer to store the error page
 159 };
 160
 161 /// \ingroup ErrorPageInternal
 162 err_type &operator++ (err_type &anErr)
 163 {
 164     int tmp = (int)anErr;
 165     anErr = (err_type)(++tmp);
 166     return anErr;
 167 }
 168
 169 /// \ingroup ErrorPageInternal
 170 int operator - (err_type const &anErr, err_type const &anErr2)
 171 {
 172     return (int)anErr - (int)anErr2;
 173 }
 174
 175 void
 176 errorInitialize(void)
 177 {
 178     err_type i;
 179     const char *text;
 180     error_page_count = ERR_MAX + ErrorDynamicPages.size();
 181     error_text = static_cast<char **>(xcalloc(error_page_count, sizeof(char *)));
 182
 183     for (i = ERR_NONE, ++i; i < error_page_count; ++i) {
 184         safe_free(error_text[i]);
 185
 186         if ((text = errorFindHardText(i))) {
 187             /**\par
 188              * Index any hard-coded error text into defaults.
 189              */
 190             error_text[i] = xstrdup(text);
 191
 192         } else if (i < ERR_MAX) {
 193             /**\par
 194              * Index precompiled fixed template files from one of two sources:
 195              *  (a) default language translation directory (error_default_language)
 196              *  (b) admin specified custom directory (error_directory)
 197              */
 198             ErrorPageFile errTmpl(err_type_str[i], i);
 199             error_text[i] = errTmpl.loadDefault() ? xstrdup(errTmpl.text()) : NULL;
 200         } else {
 201             /** \par
 202              * Index any unknown file names used by deny_info.
 203              */
 204             ErrorDynamicPageInfo *info = ErrorDynamicPages.items[i - ERR_MAX];
 205             assert(info && info->id == i && info->page_name);
 206
 207             const char *pg = info->page_name;
 208             if (info->page_redirect != HTTP_STATUS_NONE)
 209                 pg = info->page_name +4;
 210
 211             if (strchr(pg, ':') == NULL) {
 212                 /** But only if they are not redirection URL. */
 213                 ErrorPageFile errTmpl(pg, ERR_MAX);
 214                 error_text[i] = errTmpl.loadDefault() ? xstrdup(errTmpl.text()) : NULL;
 215             }
 216         }
 217     }
 218
 219     error_stylesheet.reset();
 220
 221     // look for and load stylesheet into global MemBuf for it.
 222     if (Config.errorStylesheet) {
 223         ErrorPageFile tmpl("StylesSheet", ERR_MAX);
 224         tmpl.loadFromFile(Config.errorStylesheet);
 225         error_stylesheet.Printf("%s",tmpl.text());
 226     }
 227
 228 #if USE_SSL
 229     Ssl::errorDetailInitialize();
 230 #endif
 231 }
 232
 233 void
 234 errorClean(void)
 235 {
 236     if (error_text) {
 237         int i;
 238
 239         for (i = ERR_NONE + 1; i < error_page_count; i++)
 240             safe_free(error_text[i]);
 241
 242         safe_free(error_text);
 243     }
 244
 245     while (ErrorDynamicPages.size())
 246         errorDynamicPageInfoDestroy(ErrorDynamicPages.pop_back());
 247
 248     error_page_count = 0;
 249
 250 #if USE_SSL
 251     Ssl::errorDetailClean();
 252 #endif
 253 }
 254
 255 /// \ingroup ErrorPageInternal
 256 static const char *
 257 errorFindHardText(err_type type)
 258 {
 259     int i;
 260
 261     for (i = 0; i < error_hard_text_count; i++)
 262         if (error_hard_text[i].type == type)
 263             return error_hard_text[i].text;
 264
 265     return NULL;
 266 }
 267
 268 TemplateFile::TemplateFile(const char *name, const err_type code): silent(false), wasLoaded(false), templateName(name), templateCode(code)
 269 {
 270     assert(name);
 271 }
 272
 273 bool
 274 TemplateFile::loadDefault()
 275 {
 276     if (loaded()) // already loaded?
 277         return true;
 278
 279     /** test error_directory configured location */
 280     if (Config.errorDirectory) {
 281         char path[MAXPATHLEN];
 282         snprintf(path, sizeof(path), "%s/%s", Config.errorDirectory, templateName.termedBuf());
 283         loadFromFile(path);
 284     }
 285
 286 #if USE_ERR_LOCALES
 287     /** test error_default_language location */
 288     if (!loaded() && Config.errorDefaultLanguage) {
 289         if (!tryLoadTemplate(Config.errorDefaultLanguage)) {
 290             debugs(1, (templateCode < TCP_RESET ? DBG_CRITICAL : 3), "Unable to load default error language files. Reset to backups.");
 291         }
 292     }
 293 #endif
 294
 295     /* test default location if failed (templates == English translation base templates) */
 296     if (!loaded()) {
 297         tryLoadTemplate("templates");
 298     }
 299
 300     /* giving up if failed */
 301     if (!loaded()) {
 302         debugs(1, (templateCode < TCP_RESET ? DBG_CRITICAL : 3), "WARNING: failed to find or read error text file " << templateName);
 303         parse("Internal Error: Missing Template ", 33, '\0');
 304         parse(templateName.termedBuf(), templateName.size(), '\0');
 305     }
 306
 307     return true;
 308 }
 309
 310 bool
 311 TemplateFile::tryLoadTemplate(const char *lang)
 312 {
 313     assert(lang);
 314
 315     char path[MAXPATHLEN];
 316     /* TODO: prep the directory path string to prevent snprintf ... */
 317     snprintf(path, sizeof(path), "%s/%s/%s",
 318              DEFAULT_SQUID_ERROR_DIR, lang, templateName.termedBuf());
 319     path[MAXPATHLEN-1] = '\0';
 320
 321     if (loadFromFile(path))
 322         return true;
 323
 324 #if HAVE_GLOB
 325     if ( strlen(lang) == 2) {
 326         /* TODO glob the error directory for sub-dirs matching: <tag> '-*'   */
 327         /* use first result. */
 328         debugs(4,2, HERE << "wildcard fallback errors not coded yet.");
 329     }
 330 #endif
 331
 332     return false;
 333 }
 334
 335 bool
 336 TemplateFile::loadFromFile(const char *path)
 337 {
 338     int fd;
 339     char buf[4096];
 340     ssize_t len;
 341
 342     if (loaded()) // already loaded?
 343         return true;
 344
 345     fd = file_open(path, O_RDONLY | O_TEXT);
 346
 347     if (fd < 0) {
 348         /* with dynamic locale negotiation we may see some failures before a success. */
 349         if (!silent && templateCode < TCP_RESET)
 350             debugs(4, DBG_CRITICAL, HERE << "'" << path << "': " << xstrerror());
 351         wasLoaded = false;
 352         return wasLoaded;
 353     }
 354
 355     while ((len = FD_READ_METHOD(fd, buf, sizeof(buf))) > 0) {
 356         if (!parse(buf, len, false)) {
 357             debugs(4, DBG_CRITICAL, HERE << " parse error while reading template file: " << path);
 358             wasLoaded = false;
 359             return wasLoaded;
 360         }
 361     }
 362     parse(buf, 0, true);
 363
 364     if (len < 0) {
 365         debugs(4, DBG_CRITICAL, HERE << "failed to fully read: '" << path << "': " << xstrerror());
 366     }
 367
 368     file_close(fd);
 369
 370     wasLoaded = true;
 371     return wasLoaded;
 372 }
 373
 374 bool strHdrAcptLangGetItem(const String &hdr, char *lang, int langLen, size_t &pos)
 375 {
 376     while (pos < hdr.size()) {
 377         char *dt = lang;
 378
 379         if (!pos) {
 380             /* skip any initial whitespace. */
 381             while (pos < hdr.size() && xisspace(hdr[pos])) pos++;
 382         } else {
 383             // IFF we terminated the tag on whitespace or ';' we need to skip to the next ',' or end of header.
 384             while (pos < hdr.size() && hdr[pos] != ',') pos++;
 385             if (hdr[pos] == ',') pos++;
 386         }
 387
 388         /*
 389          * Header value format:
 390          *  - sequence of whitespace delimited tags
 391          *  - each tag may suffix with ';'.* which we can ignore.
 392          *  - IFF a tag contains only two characters we can wildcard ANY translations matching: <it> '-'? .*
 393          *    with preference given to an exact match.
 394          */
 395         bool invalid_byte = false;
 396         while (pos < hdr.size() && hdr[pos] != ';' && hdr[pos] != ',' && !xisspace(hdr[pos]) && dt < (lang + (langLen -1)) ) {
 397             if (!invalid_byte) {
 398 #if USE_HTTP_VIOLATIONS
 399                 // if accepting violations we may as well accept some broken browsers
 400                 //  which may send us the right code, wrong ISO formatting.
 401                 if (hdr[pos] == '_')
 402                     *dt = '-';
 403                 else
 404 #endif
 405                     *dt = xtolower(hdr[pos]);
 406                 // valid codes only contain A-Z, hyphen (-) and *
 407                 if (*dt != '-' && *dt != '*' && (*dt < 'a' || *dt > 'z') )
 408                     invalid_byte = true;
 409                 else
 410                     dt++; // move to next destination byte.
 411             }
 412             pos++;
 413         }
 414         *dt++ = '\0'; // nul-terminated the filename content string before system use.
 415
 416         debugs(4, 9, HERE << "STATE: dt='" << dt << "', lang='" << lang << "', pos=" << pos << ", buf='" << ((pos < hdr.size()) ? hdr.substr(pos,hdr.size()) : "") << "'");
 417
 418         /* if we found anything we might use, try it. */
 419         if (*lang != '\0' && !invalid_byte)
 420             return true;
 421     }
 422     return false;
 423 }
 424
 425 bool
 426 TemplateFile::loadFor(HttpRequest *request)
 427 {
 428     String hdr;
 429
 430 #if USE_ERR_LOCALES
 431     if (loaded()) // already loaded?
 432         return true;
 433
 434     if (!request || !request->header.getList(HDR_ACCEPT_LANGUAGE, &hdr) )
 435         return false;
 436
 437     char lang[256];
 438     size_t pos = 0; // current parsing position in header string
 439
 440     debugs(4, 6, HERE << "Testing Header: '" << hdr << "'");
 441
 442     while ( strHdrAcptLangGetItem(hdr, lang, 256, pos) ) {
 443
 444         /* wildcard uses the configured default language */
 445         if (lang[0] == '*' && lang[1] == '\0') {
 446             debugs(4, 6, HERE << "Found language '" << lang << "'. Using configured default.");
 447             return false;
 448         }
 449
 450         debugs(4, 6, HERE << "Found language '" << lang << "', testing for available template");
 451
 452         if (tryLoadTemplate(lang)) {
 453             /* store the language we found for the Content-Language reply header */
 454             errLanguage = lang;
 455             break;
 456         } else if (Config.errorLogMissingLanguages) {
 457             debugs(4, DBG_IMPORTANT, "WARNING: Error Pages Missing Language: " << lang);
 458         }
 459     }
 460 #endif
 461
 462     return loaded();
 463 }
 464
 465 /// \ingroup ErrorPageInternal
 466 static ErrorDynamicPageInfo *
 467 errorDynamicPageInfoCreate(int id, const char *page_name)
 468 {
 469     ErrorDynamicPageInfo *info = new ErrorDynamicPageInfo;
 470     info->id = id;
 471     info->page_name = xstrdup(page_name);
 472     info->page_redirect = static_cast<http_status>(atoi(page_name));
 473
 474     /* WARNING on redirection status:
 475      * 2xx are permitted, but not documented officially.
 476      * - might be useful for serving static files (PAC etc) in special cases
 477      * 3xx require a URL suitable for Location: header.
 478      * - the current design does not allow for a Location: URI as well as a local file template
 479      *   although this possibility is explicitly permitted in the specs.
 480      * 4xx-5xx require a local file template.
 481      * - sending Location: on these codes with no body is invalid by the specs.
 482      * - current result is Squid crashing or XSS problems as dynamic deny_info load random disk files.
 483      * - a future redesign of the file loading may result in loading remote objects sent inline as local body.
 484      */
 485     if (info->page_redirect == HTTP_STATUS_NONE)
 486         ; // special case okay.
 487     else if (info->page_redirect < 200 || info->page_redirect > 599) {
 488         // out of range
 489         debugs(0, DBG_CRITICAL, "FATAL: status " << info->page_redirect << " is not valid on '" << page_name << "'");
 490         self_destruct();
 491     } else if ( /* >= 200 && */ info->page_redirect < 300 && strchr(&(page_name[4]), ':')) {
 492         // 2xx require a local template file
 493         debugs(0, DBG_CRITICAL, "FATAL: status " << info->page_redirect << " requires a template on '" << page_name << "'");
 494         self_destruct();
 495     } else if (info->page_redirect >= 300 && info->page_redirect <= 399 && !strchr(&(page_name[4]), ':')) {
 496         // 3xx require an absolute URL
 497         debugs(0, DBG_CRITICAL, "FATAL: status " << info->page_redirect << " requires a URL on '" << page_name << "'");
 498         self_destruct();
 499     } else if (info->page_redirect >= 400 /* && <= 599 */ && strchr(&(page_name[4]), ':')) {
 500         // 4xx/5xx require a local template file
 501         debugs(0, DBG_CRITICAL, "FATAL: status " << info->page_redirect << " requires a template on '" << page_name << "'");
 502         self_destruct();
 503     }
 504     // else okay.
 505
 506     return info;
 507 }
 508
 509 /// \ingroup ErrorPageInternal
 510 static void
 511 errorDynamicPageInfoDestroy(ErrorDynamicPageInfo * info)
 512 {
 513     assert(info);
 514     safe_free(info->page_name);
 515     delete info;
 516 }
 517
 518 /// \ingroup ErrorPageInternal
 519 static int
 520 errorPageId(const char *page_name)
 521 {
 522     for (int i = 0; i < ERR_MAX; i++) {
 523         if (strcmp(err_type_str[i], page_name) == 0)
 524             return i;
 525     }
 526
 527     for (size_t j = 0; j < ErrorDynamicPages.size(); j++) {
 528         if (strcmp(ErrorDynamicPages.items[j]->page_name, page_name) == 0)
 529             return j + ERR_MAX;
 530     }
 531
 532     return ERR_NONE;
 533 }
 534
 535 err_type
 536 errorReservePageId(const char *page_name)
 537 {
 538     ErrorDynamicPageInfo *info;
 539     int id = errorPageId(page_name);
 540
 541     if (id == ERR_NONE) {
 542         info = errorDynamicPageInfoCreate(ERR_MAX + ErrorDynamicPages.size(), page_name);
 543         ErrorDynamicPages.push_back(info);
 544         id = info->id;
 545     }
 546
 547     return (err_type)id;
 548 }
 549
 550 /// \ingroup ErrorPageInternal
 551 const char *
 552 errorPageName(int pageId)
 553 {
 554     if (pageId >= ERR_NONE && pageId < ERR_MAX)         /* common case */
 555         return err_type_str[pageId];
 556
 557     if (pageId >= ERR_MAX && pageId - ERR_MAX < (ssize_t)ErrorDynamicPages.size())
 558         return ErrorDynamicPages.items[pageId - ERR_MAX]->page_name;
 559
 560     return "ERR_UNKNOWN";       /* should not happen */
 561 }
 562
 563 ErrorState::ErrorState(err_type t, http_status status, HttpRequest * req) :
 564         type(t),
 565         page_id(t),
 566         err_language(NULL),
 567         httpStatus(status),
 568 #if USE_AUTH
 569         auth_user_request (NULL),
 570 #endif
 571         request(NULL),
 572         url(NULL),
 573         xerrno(0),
 574         port(0),
 575         dnsError(),
 576         ttl(0),
 577         src_addr(),
 578         redirect_url(NULL),
 579         callback(NULL),
 580         callback_data(NULL),
 581         request_hdrs(NULL),
 582         err_msg(NULL),
 583 #if USE_SSL
 584         detail(NULL),
 585 #endif
 586         detailCode(ERR_DETAIL_NONE)
 587 {
 588     memset(&flags, 0, sizeof(flags));
 589     memset(&ftp, 0, sizeof(ftp));
 590
 591     if (page_id >= ERR_MAX && ErrorDynamicPages.items[page_id - ERR_MAX]->page_redirect != HTTP_STATUS_NONE)
 592         httpStatus = ErrorDynamicPages.items[page_id - ERR_MAX]->page_redirect;
 593
 594     if (req != NULL) {
 595         request = HTTPMSGLOCK(req);
 596         src_addr = req->client_addr;
 597     }
 598 }
 599
 600 void
 601 ErrorState::detailError(int detailCode)
 602 {
 603     detailCode = detailCode;
 604 }
 605
 606 void
 607 errorAppendEntry(StoreEntry * entry, ErrorState * err)
 608 {
 609     assert(entry->mem_obj != NULL);
 610     assert (entry->isEmpty());
 611     debugs(4, 4, "Creating an error page for entry " << entry <<
 612            " with errorstate " << err <<
 613            " page id " << err->page_id);
 614
 615     if (entry->store_status != STORE_PENDING) {
 616         debugs(4, 2, "Skipping error page due to store_status: " << entry->store_status);
 617         /*
 618          * If the entry is not STORE_PENDING, then no clients
 619          * care about it, and we don't need to generate an
 620          * error message
 621          */
 622         assert(EBIT_TEST(entry->flags, ENTRY_ABORTED));
 623         assert(entry->mem_obj->nclients == 0);
 624         delete err;
 625         return;
 626     }
 627
 628     if (err->page_id == TCP_RESET) {
 629         if (err->request) {
 630             debugs(4, 2, "RSTing this reply");
 631             err->request->flags.setResetTCP();
 632         }
 633     }
 634
 635     entry->lock();
 636     entry->buffer();
 637     entry->replaceHttpReply( err->BuildHttpReply() );
 638     EBIT_CLR(entry->flags, ENTRY_FWD_HDR_WAIT);
 639     entry->flush();
 640     entry->complete();
 641     entry->negativeCache();
 642     entry->releaseRequest();
 643     entry->unlock();
 644     delete err;
 645 }
 646
 647 void
 648 errorSend(const Comm::ConnectionPointer &conn, ErrorState * err)
 649 {
 650     HttpReply *rep;
 651     debugs(4, 3, HERE << conn << ", err=" << err);
 652     assert(Comm::IsConnOpen(conn));
 653
 654     /* moved in front of errorBuildBuf @?@ */
 655     err->flags.flag_cbdata = 1;
 656
 657     rep = err->BuildHttpReply();
 658
 659     MemBuf *mb = rep->pack();
 660     AsyncCall::Pointer call = commCbCall(78, 5, "errorSendComplete",
 661                                          CommIoCbPtrFun(&errorSendComplete, err));
 662     Comm::Write(conn, mb, call);
 663     delete mb;
 664
 665     delete rep;
 666 }
 667
 668 /**
 669  \ingroup ErrorPageAPI
 670  *
 671  * Called by commHandleWrite() after data has been written
 672  * to the client socket.
 673  *
 674  \note If there is a callback, the callback is responsible for
 675  *     closing the FD, otherwise we do it ourselves.
 676  */
 677 static void
 678 errorSendComplete(const Comm::ConnectionPointer &conn, char *bufnotused, size_t size, comm_err_t errflag, int xerrno, void *data)
 679 {
 680     ErrorState *err = static_cast<ErrorState *>(data);
 681     debugs(4, 3, HERE << conn << ", size=" << size);
 682
 683     if (errflag != COMM_ERR_CLOSING) {
 684         if (err->callback) {
 685             debugs(4, 3, "errorSendComplete: callback");
 686             err->callback(conn->fd, err->callback_data, size);
 687         } else {
 688             debugs(4, 3, "errorSendComplete: comm_close");
 689             conn->close();
 690         }
 691     }
 692
 693     delete err;
 694 }
 695
 696 ErrorState::~ErrorState()
 697 {
 698     HTTPMSGUNLOCK(request);
 699     safe_free(redirect_url);
 700     safe_free(url);
 701     safe_free(request_hdrs);
 702     wordlistDestroy(&ftp.server_msg);
 703     safe_free(ftp.request);
 704     safe_free(ftp.reply);
 705 #if USE_AUTH
 706     auth_user_request = NULL;
 707 #endif
 708     safe_free(err_msg);
 709 #if USE_ERR_LOCALES
 710     if (err_language != Config.errorDefaultLanguage)
 711 #endif
 712         safe_free(err_language);
 713 #if USE_SSL
 714     delete detail;
 715 #endif
 716 }
 717
 718 int
 719 ErrorState::Dump(MemBuf * mb)
 720 {
 721     MemBuf str;
 722     char ntoabuf[MAX_IPSTRLEN];
 723
 724     str.reset();
 725     /* email subject line */
 726     str.Printf("CacheErrorInfo - %s", errorPageName(type));
 727     mb->Printf("?subject=%s", rfc1738_escape_part(str.buf));
 728     str.reset();
 729     /* email body */
 730     str.Printf("CacheHost: %s\r\n", getMyHostname());
 731     /* - Err Msgs */
 732     str.Printf("ErrPage: %s\r\n", errorPageName(type));
 733
 734     if (xerrno) {
 735         str.Printf("Err: (%d) %s\r\n", xerrno, strerror(xerrno));
 736     } else {
 737         str.Printf("Err: [none]\r\n");
 738     }
 739 #if USE_AUTH
 740     if (auth_user_request->denyMessage())
 741         str.Printf("Auth ErrMsg: %s\r\n", auth_user_request->denyMessage());
 742 #endif
 743     if (dnsError.size() > 0)
 744         str.Printf("DNS ErrMsg: %s\r\n", dnsError.termedBuf());
 745
 746     /* - TimeStamp */
 747     str.Printf("TimeStamp: %s\r\n\r\n", mkrfc1123(squid_curtime));
 748
 749     /* - IP stuff */
 750     str.Printf("ClientIP: %s\r\n", src_addr.NtoA(ntoabuf,MAX_IPSTRLEN));
 751
 752     if (request && request->hier.host[0] != '\0') {
 753         str.Printf("ServerIP: %s\r\n", request->hier.host);
 754     }
 755
 756     str.Printf("\r\n");
 757     /* - HTTP stuff */
 758     str.Printf("HTTP Request:\r\n");
 759
 760     if (NULL != request) {
 761         Packer pck;
 762         String urlpath_or_slash;
 763
 764         if (request->urlpath.size() != 0)
 765             urlpath_or_slash = request->urlpath;
 766         else
 767             urlpath_or_slash = "/";
 768
 769         str.Printf("%s " SQUIDSTRINGPH " %s/%d.%d\n",
 770                    RequestMethodStr(request->method),
 771                    SQUIDSTRINGPRINT(urlpath_or_slash),
 772                    AnyP::ProtocolType_str[request->http_ver.protocol],
 773                    request->http_ver.major, request->http_ver.minor);
 774         packerToMemInit(&pck, &str);
 775         request->header.packInto(&pck);
 776         packerClean(&pck);
 777     }
 778
 779     str.Printf("\r\n");
 780     /* - FTP stuff */
 781
 782     if (ftp.request) {
 783         str.Printf("FTP Request: %s\r\n", ftp.request);
 784         str.Printf("FTP Reply: %s\r\n", (ftp.reply? ftp.reply:"[none]"));
 785         str.Printf("FTP Msg: ");
 786         wordlistCat(ftp.server_msg, &str);
 787         str.Printf("\r\n");
 788     }
 789
 790     str.Printf("\r\n");
 791     mb->Printf("&body=%s", rfc1738_escape_part(str.buf));
 792     str.clean();
 793     return 0;
 794 }
 795
 796 /// \ingroup ErrorPageInternal
 797 #define CVT_BUF_SZ 512
 798
 799 const char *
 800 ErrorState::Convert(char token, bool building_deny_info_url, bool allowRecursion)
 801 {
 802     static MemBuf mb;
 803     const char *p = NULL;       /* takes priority over mb if set */
 804     int do_quote = 1;
 805     int no_urlescape = 0;       /* if true then item is NOT to be further URL-encoded */
 806     char ntoabuf[MAX_IPSTRLEN];
 807
 808     mb.reset();
 809
 810     switch (token) {
 811
 812     case 'a':
 813 #if USE_AUTH
 814         if (request && request->auth_user_request != NULL)
 815             p = request->auth_user_request->username();
 816         if (!p)
 817 #endif
 818             p = "-";
 819         break;
 820
 821     case 'b':
 822         mb.Printf("%d", getMyPort());
 823         break;
 824
 825     case 'B':
 826         if (building_deny_info_url) break;
 827         p = request ? ftpUrlWith2f(request) : "[no URL]";
 828         break;
 829
 830     case 'c':
 831         if (building_deny_info_url) break;
 832         p = errorPageName(type);
 833         break;
 834
 835     case 'D':
 836         if (!allowRecursion)
 837             p = "%D";  // if recursion is not allowed, do not convert
 838 #if USE_SSL
 839         // currently only SSL error details implemented
 840         else if (detail) {
 841             detail->useRequest(request);
 842             const String &errDetail = detail->toString();
 843             if (errDetail.defined()) {
 844                 MemBuf *detail_mb  = ConvertText(errDetail.termedBuf(), false);
 845                 mb.append(detail_mb->content(), detail_mb->contentSize());
 846                 delete detail_mb;
 847                 do_quote = 0;
 848             }
 849         }
 850 #endif
 851         if (!mb.contentSize())
 852             mb.Printf("[No Error Detail]");
 853         break;
 854
 855     case 'e':
 856         mb.Printf("%d", xerrno);
 857         break;
 858
 859     case 'E':
 860         if (xerrno)
 861             mb.Printf("(%d) %s", xerrno, strerror(xerrno));
 862         else
 863             mb.Printf("[No Error]");
 864         break;
 865
 866     case 'f':
 867         if (building_deny_info_url) break;
 868         /* FTP REQUEST LINE */
 869         if (ftp.request)
 870             p = ftp.request;
 871         else
 872             p = "nothing";
 873         break;
 874
 875     case 'F':
 876         if (building_deny_info_url) break;
 877         /* FTP REPLY LINE */
 878         if (ftp.reply)
 879             p = ftp.reply;
 880         else
 881             p = "nothing";
 882         break;
 883
 884     case 'g':
 885         if (building_deny_info_url) break;
 886         /* FTP SERVER RESPONSE */
 887         if (ftp.listing) {
 888             mb.append(ftp.listing->content(), ftp.listing->contentSize());
 889             do_quote = 0;
 890         } else if (ftp.server_msg) {
 891             wordlistCat(ftp.server_msg, &mb);
 892         }
 893         break;
 894
 895     case 'h':
 896         mb.Printf("%s", getMyHostname());
 897         break;
 898
 899     case 'H':
 900         if (request) {
 901             if (request->hier.host[0] != '\0') // if non-empty string.
 902                 p = request->hier.host;
 903             else
 904                 p = request->GetHost();
 905         } else if (!building_deny_info_url)
 906             p = "[unknown host]";
 907         break;
 908
 909     case 'i':
 910         mb.Printf("%s", src_addr.NtoA(ntoabuf,MAX_IPSTRLEN));
 911         break;
 912
 913     case 'I':
 914         if (request && request->hier.tcpServer != NULL)
 915             p = request->hier.tcpServer->remote.NtoA(ntoabuf,MAX_IPSTRLEN);
 916         else if (!building_deny_info_url)
 917             p = "[unknown]";
 918         break;
 919
 920     case 'l':
 921         if (building_deny_info_url) break;
 922         mb.append(error_stylesheet.content(), error_stylesheet.contentSize());
 923         do_quote = 0;
 924         break;
 925
 926     case 'L':
 927         if (building_deny_info_url) break;
 928         if (Config.errHtmlText) {
 929             mb.Printf("%s", Config.errHtmlText);
 930             do_quote = 0;
 931         } else
 932             p = "[not available]";
 933         break;
 934
 935     case 'm':
 936         if (building_deny_info_url) break;
 937 #if USE_AUTH
 938         p = auth_user_request->denyMessage("[not available]");
 939 #else
 940         p = "-";
 941 #endif
 942         break;
 943
 944     case 'M':
 945         if (request)
 946             p = RequestMethodStr(request->method);
 947         else if (!building_deny_info_url)
 948             p= "[unknown method]";
 949         break;
 950
 951     case 'o':
 952         p = request ? request->extacl_message.termedBuf() : external_acl_message;
 953         if (!p && !building_deny_info_url)
 954             p = "[not available]";
 955         break;
 956
 957     case 'p':
 958         if (request) {
 959             mb.Printf("%d", (int) request->port);
 960         } else if (!building_deny_info_url) {
 961             p = "[unknown port]";
 962         }
 963         break;
 964
 965     case 'P':
 966         if (request) {
 967             p = AnyP::ProtocolType_str[request->protocol];
 968         } else if (!building_deny_info_url) {
 969             p = "[unknown protocol]";
 970         }
 971         break;
 972
 973     case 'R':
 974         if (building_deny_info_url) {
 975             p = (request->urlpath.size() != 0 ? request->urlpath.termedBuf() : "/");
 976             break;
 977         }
 978         if (NULL != request) {
 979             Packer pck;
 980             String urlpath_or_slash;
 981
 982             if (request->urlpath.size() != 0)
 983                 urlpath_or_slash = request->urlpath;
 984             else
 985                 urlpath_or_slash = "/";
 986
 987             mb.Printf("%s " SQUIDSTRINGPH " %s/%d.%d\n",
 988                       RequestMethodStr(request->method),
 989                       SQUIDSTRINGPRINT(urlpath_or_slash),
 990                       AnyP::ProtocolType_str[request->http_ver.protocol],
 991                       request->http_ver.major, request->http_ver.minor);
 992             packerToMemInit(&pck, &mb);
 993             request->header.packInto(&pck);
 994             packerClean(&pck);
 995         } else if (request_hdrs) {
 996             p = request_hdrs;
 997         } else {
 998             p = "[no request]";
 999         }
1000         break;
1001
1002     case 's':
1003         /* for backward compat we make %s show the full URL. Drop this in some future release. */
1004         if (building_deny_info_url) {
1005             p = request ? urlCanonical(request) : url;
1006             debugs(0,0, "WARNING: deny_info now accepts coded tags. Use %u to get the full URL instead of %s");
1007         } else
1008             p = visible_appname_string;
1009         break;
1010
1011     case 'S':
1012         if (building_deny_info_url) {
1013             p = visible_appname_string;
1014             break;
1015         }
1016         /* signature may contain %-escapes, recursion */
1017         if (page_id != ERR_SQUID_SIGNATURE) {
1018             const int saved_id = page_id;
1019             page_id = ERR_SQUID_SIGNATURE;
1020             MemBuf *sign_mb = BuildContent();
1021             mb.Printf("%s", sign_mb->content());
1022             sign_mb->clean();
1023             delete sign_mb;
1024             page_id = saved_id;
1025             do_quote = 0;
1026         } else {
1027             /* wow, somebody put %S into ERR_SIGNATURE, stop recursion */
1028             p = "[%S]";
1029         }
1030         break;
1031
1032     case 't':
1033         mb.Printf("%s", Time::FormatHttpd(squid_curtime));
1034         break;
1035
1036     case 'T':
1037         mb.Printf("%s", mkrfc1123(squid_curtime));
1038         break;
1039
1040     case 'U':
1041         /* Using the fake-https version of canonical so error pages see https:// */
1042         /* even when the url-path cannot be shown as more than '*' */
1043         if (request)
1044             p = urlCanonicalFakeHttps(request);
1045         else if (url)
1046             p = url;
1047         else if (!building_deny_info_url)
1048             p = "[no URL]";
1049         break;
1050
1051     case 'u':
1052         if (request)
1053             p = urlCanonical(request);
1054         else if (url)
1055             p = url;
1056         else if (!building_deny_info_url)
1057             p = "[no URL]";
1058         break;
1059
1060     case 'w':
1061         if (Config.adminEmail)
1062             mb.Printf("%s", Config.adminEmail);
1063         else if (!building_deny_info_url)
1064             p = "[unknown]";
1065         break;
1066
1067     case 'W':
1068         if (building_deny_info_url) break;
1069         if (Config.adminEmail && Config.onoff.emailErrData)
1070             Dump(&mb);
1071         no_urlescape = 1;
1072         break;
1073
1074     case 'x':
1075 #if USE_SSL
1076         if (detail)
1077             mb.Printf("%s", detail->errorName());
1078         else
1079 #endif
1080             if (!building_deny_info_url)
1081                 p = "[Unknown Error Code]";
1082         break;
1083
1084     case 'z':
1085         if (building_deny_info_url) break;
1086         if (dnsError.size() > 0)
1087             p = dnsError.termedBuf();
1088         else if (ftp.cwd_msg)
1089             p = ftp.cwd_msg;
1090         else
1091             p = "[unknown]";
1092         break;
1093
1094     case 'Z':
1095         if (building_deny_info_url) break;
1096         if (err_msg)
1097             p = err_msg;
1098         else
1099             p = "[unknown]";
1100         break;
1101
1102     case '%':
1103         p = "%";
1104         break;
1105
1106     default:
1107         mb.Printf("%%%c", token);
1108         do_quote = 0;
1109         break;
1110     }
1111
1112     if (!p)
1113         p = mb.buf;             /* do not use mb after this assignment! */
1114
1115     assert(p);
1116
1117     debugs(4, 3, "errorConvert: %%" << token << " --> '" << p << "'" );
1118
1119     if (do_quote)
1120         p = html_quote(p);
1121
1122     if (building_deny_info_url && !no_urlescape)
1123         p = rfc1738_escape_part(p);
1124
1125     return p;
1126 }
1127
1128 void
1129 ErrorState::DenyInfoLocation(const char *name, HttpRequest *aRequest, MemBuf &result)
1130 {
1131     char const *m = name;
1132     char const *p = m;
1133     char const *t;
1134
1135     if (m[0] == '3')
1136         m += 4; // skip "3xx:"
1137
1138     while ((p = strchr(m, '%'))) {
1139         result.append(m, p - m);       /* copy */
1140         t = Convert(*++p, true, true);       /* convert */
1141         result.Printf("%s", t);        /* copy */
1142         m = p + 1;                     /* advance */
1143     }
1144
1145     if (*m)
1146         result.Printf("%s", m);        /* copy tail */
1147
1148     assert((size_t)result.contentSize() == strlen(result.content()));
1149 }
1150
1151 HttpReply *
1152 ErrorState::BuildHttpReply()
1153 {
1154     HttpReply *rep = new HttpReply;
1155     const char *name = errorPageName(page_id);
1156     /* no LMT for error pages; error pages expire immediately */
1157
1158     if (name[0] == '3' || (name[0] != '2' && name[0] != '4' && name[0] != '5' && strchr(name, ':'))) {
1159         /* Redirection */
1160         http_status status = HTTP_MOVED_TEMPORARILY;
1161         // Use configured 3xx reply status if set.
1162         if (name[0] == '3')
1163             status = httpStatus;
1164         else {
1165             // Use 307 for HTTP/1.1 non-GET/HEAD requests.
1166             if (request->method != METHOD_GET && request->method != METHOD_HEAD && request->http_ver >= HttpVersion(1,1))
1167                 status = HTTP_TEMPORARY_REDIRECT;
1168         }
1169
1170         rep->setHeaders(status, NULL, "text/html", 0, 0, -1);
1171
1172         if (request) {
1173             MemBuf redirect_location;
1174             redirect_location.init();
1175             DenyInfoLocation(name, request, redirect_location);
1176             httpHeaderPutStrf(&rep->header, HDR_LOCATION, "%s", redirect_location.content() );
1177         }
1178
1179         httpHeaderPutStrf(&rep->header, HDR_X_SQUID_ERROR, "%d %s", httpStatus, "Access Denied");
1180     } else {
1181         MemBuf *content = BuildContent();
1182         rep->setHeaders(httpStatus, NULL, "text/html", content->contentSize(), 0, -1);
1183         /*
1184          * include some information for downstream caches. Implicit
1185          * replaceable content. This isn't quite sufficient. xerrno is not
1186          * necessarily meaningful to another system, so we really should
1187          * expand it. Additionally, we should identify ourselves. Someone
1188          * might want to know. Someone _will_ want to know OTOH, the first
1189          * X-CACHE-MISS entry should tell us who.
1190          */
1191         httpHeaderPutStrf(&rep->header, HDR_X_SQUID_ERROR, "%s %d", name, xerrno);
1192
1193 #if USE_ERR_LOCALES
1194         /*
1195          * If error page auto-negotiate is enabled in any way, send the Vary.
1196          * RFC 2616 section 13.6 and 14.44 says MAY and SHOULD do this.
1197          * We have even better reasons though:
1198          * see http://wiki.squid-cache.org/KnowledgeBase/VaryNotCaching
1199          */
1200         if (!Config.errorDirectory) {
1201             /* We 'negotiated' this ONLY from the Accept-Language. */
1202             rep->header.delById(HDR_VARY);
1203             rep->header.putStr(HDR_VARY, "Accept-Language");
1204         }
1205
1206         /* add the Content-Language header according to RFC section 14.12 */
1207         if (err_language) {
1208             rep->header.putStr(HDR_CONTENT_LANGUAGE, err_language);
1209         } else
1210 #endif /* USE_ERROR_LOCALES */
1211         {
1212             /* default templates are in English */
1213             /* language is known unless error_directory override used */
1214             if (!Config.errorDirectory)
1215                 rep->header.putStr(HDR_CONTENT_LANGUAGE, "en");
1216         }
1217
1218         rep->body.setMb(content);
1219         /* do not memBufClean() or delete the content, it was absorbed by httpBody */
1220     }
1221
1222     /* Make sure error codes get back to the client side for logging and error tracking */
1223     if (request) {
1224         int edc = ERR_DETAIL_NONE; // error detail code
1225 #if USE_SSL
1226         if (detail)
1227             edc = detail->errorNo();
1228         else
1229 #endif
1230             if (detailCode)
1231                 edc = detailCode;
1232             else
1233                 edc = xerrno;
1234         request->detailError(type, edc);
1235     }
1236
1237     return rep;
1238 }
1239
1240 MemBuf *
1241 ErrorState::BuildContent()
1242 {
1243     const char *m = NULL;
1244
1245     assert(page_id > ERR_NONE && page_id < error_page_count);
1246
1247 #if USE_ERR_LOCALES
1248     ErrorPageFile *localeTmpl = NULL;
1249
1250     /** error_directory option in squid.conf overrides translations.
1251      * Custom errors are always found either in error_directory or the templates directory.
1252      * Otherwise locate the Accept-Language header
1253      */
1254     if (!Config.errorDirectory && page_id < ERR_MAX) {
1255         if (err_language && err_language != Config.errorDefaultLanguage)
1256             safe_free(err_language);
1257
1258         localeTmpl = new ErrorPageFile(err_type_str[page_id], static_cast<err_type>(page_id));
1259         if (localeTmpl->loadFor(request)) {
1260             m = localeTmpl->text();
1261             assert(localeTmpl->language());
1262             err_language = xstrdup(localeTmpl->language());
1263         }
1264     }
1265 #endif /* USE_ERR_LOCALES */
1266
1267     /** \par
1268      * If client-specific error templates are not enabled or available.
1269      * fall back to the old style squid.conf settings.
1270      */
1271     if (!m) {
1272         m = error_text[page_id];
1273 #if USE_ERR_LOCALES
1274         if (!Config.errorDirectory)
1275             err_language = Config.errorDefaultLanguage;
1276 #endif
1277         debugs(4, 2, HERE << "No existing error page language negotiated for " << errorPageName(page_id) << ". Using default error file.");
1278     }
1279
1280     MemBuf *result = ConvertText(m, true);
1281 #if USE_ERR_LOCALES
1282     if (localeTmpl)
1283         delete localeTmpl;
1284 #endif
1285     return result;
1286 }
1287
1288 MemBuf *ErrorState::ConvertText(const char *text, bool allowRecursion)
1289 {
1290     MemBuf *content = new MemBuf;
1291     const char *p;
1292     const char *m = text;
1293     assert(m);
1294     content->init();
1295
1296     while ((p = strchr(m, '%'))) {
1297         content->append(m, p - m);      /* copy */
1298         const char *t = Convert(*++p, false, allowRecursion);   /* convert */
1299         content->Printf("%s", t);       /* copy */
1300         m = p + 1;                      /* advance */
1301     }
1302
1303     if (*m)
1304         content->Printf("%s", m);       /* copy tail */
1305
1306     assert((size_t)content->contentSize() == strlen(content->content()));
1307
1308     return content;
1309 }