src/errorpage.cc

   1
   2 /*
   3  * $Id: errorpage.cc,v 1.230 2008/02/26 21:49:34 amosjeffries Exp $
   4  *
   5  * DEBUG: section 4     Error Generation
   6  * AUTHOR: Duane Wessels
   7  *
   8  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   9  * ----------------------------------------------------------
  10  *
  11  *  Squid is the result of efforts by numerous individuals from
  12  *  the Internet community; see the CONTRIBUTORS file for full
  13  *  details.   Many organizations have provided support for Squid's
  14  *  development; see the SPONSORS file for full details.  Squid is
  15  *  Copyrighted (C) 2001 by the Regents of the University of
  16  *  California; see the COPYRIGHT file for full details.  Squid
  17  *  incorporates software developed and/or copyrighted by other
  18  *  sources; see the CREDITS file for full details.
  19  *
  20  *  This program is free software; you can redistribute it and/or modify
  21  *  it under the terms of the GNU General Public License as published by
  22  *  the Free Software Foundation; either version 2 of the License, or
  23  *  (at your option) any later version.
  24  *
  25  *  This program is distributed in the hope that it will be useful,
  26  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  *  GNU General Public License for more details.
  29  *
  30  *  You should have received a copy of the GNU General Public License
  31  *  along with this program; if not, write to the Free Software
  32  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  33  *
  34  */
  35 #include "config.h"
  36
  37 #include "errorpage.h"
  38 #include "AuthUserRequest.h"
  39 #include "SquidTime.h"
  40 #include "Store.h"
  41 #include "HttpReply.h"
  42 #include "HttpRequest.h"
  43 #include "MemObject.h"
  44 #include "fde.h"
  45 #include "MemBuf.h"
  46 #include "URLScheme.h"
  47 #include "wordlist.h"
  48
  49 /**
  50  \defgroup ErrorPageInternal Error Page Internals
  51  \ingroup ErrorPageAPI
  52  *
  53  \section Abstract Abstract:
  54  *   These routines are used to generate error messages to be
  55  *   sent to clients.  The error type is used to select between
  56  *   the various message formats. (formats are stored in the
  57  *   Config.errorDirectory)
  58  */
  59
  60
  61 #ifndef DEFAULT_SQUID_ERROR_DIR
  62 /** Where to look for errors if config path fails.
  63  \note Please use ./configure --datadir=/path instead of patching
  64  */
  65 #define DEFAULT_SQUID_ERROR_DIR   DEFAULT_SQUID_DATA_DIR"/errors"
  66 #endif
  67
  68 /// \ingroup ErrorPageInternal
  69 CBDATA_CLASS_INIT(ErrorState);
  70
  71 /* local types */
  72
  73 /// \ingroup ErrorPageInternal
  74 typedef struct
  75 {
  76     int id;
  77     char *page_name;
  78 } ErrorDynamicPageInfo;
  79
  80 /* local constant and vars */
  81
  82 /**
  83  \ingroup ErrorPageInternal
  84  *
  85  \note  hard coded error messages are not appended with %S
  86  *      automagically to give you more control on the format
  87  */
  88 static const struct
  89 {
  90     int type;                   /* and page_id */
  91     const char *text;
  92 }
  93
  94 error_hard_text[] = {
  95
  96                         {
  97                             ERR_SQUID_SIGNATURE,
  98                             "\n<br>\n"
  99                             "<hr>\n"
 100                             "<div id=\"footer\">\n"
 101                             "Generated %T by %h (%s)\n"
 102                             "</div>\n"
 103                             "</body></html>\n"
 104                         },
 105                         {
 106                             TCP_RESET,
 107                             "reset"
 108                         }
 109                     };
 110
 111 /// \ingroup ErrorPageInternal
 112 static Vector<ErrorDynamicPageInfo *> ErrorDynamicPages;
 113
 114 /* local prototypes */
 115
 116 /// \ingroup ErrorPageInternal
 117 static const int error_hard_text_count = sizeof(error_hard_text) / sizeof(*error_hard_text);
 118
 119 /// \ingroup ErrorPageInternal
 120 static char **error_text = NULL;
 121
 122 /// \ingroup ErrorPageInternal
 123 static int error_page_count = 0;
 124
 125 /// \ingroup ErrorPageInternal
 126 static MemBuf error_stylesheet;
 127
 128 static char *errorTryLoadText(const char *page_name, const char *dir, bool silent = false);
 129 static char *errorLoadText(const char *page_name);
 130 static const char *errorFindHardText(err_type type);
 131 static ErrorDynamicPageInfo *errorDynamicPageInfoCreate(int id, const char *page_name);
 132 static void errorDynamicPageInfoDestroy(ErrorDynamicPageInfo * info);
 133 static IOCB errorSendComplete;
 134
 135
 136 /// \ingroup ErrorPageInternal
 137 err_type &operator++ (err_type &anErr)
 138 {
 139     int tmp = (int)anErr;
 140     anErr = (err_type)(++tmp);
 141     return anErr;
 142 }
 143
 144 /// \ingroup ErrorPageInternal
 145 int operator - (err_type const &anErr, err_type const &anErr2)
 146 {
 147     return (int)anErr - (int)anErr2;
 148 }
 149
 150 void
 151 errorInitialize(void)
 152 {
 153     err_type i;
 154     const char *text;
 155     error_page_count = ERR_MAX + ErrorDynamicPages.size();
 156     error_text = static_cast<char **>(xcalloc(error_page_count, sizeof(char *)));
 157
 158     for (i = ERR_NONE, ++i; i < error_page_count; ++i) {
 159         safe_free(error_text[i]);
 160
 161         if ((text = errorFindHardText(i))) {
 162             /**\par
 163              * Index any hard-coded error text into defaults.
 164              */
 165             error_text[i] = xstrdup(text);
 166
 167         } else if (i < ERR_MAX) {
 168             /**\par
 169              * Index precompiled fixed template files from one of two sources:
 170              *  (a) default language translation directory (error_default_language)
 171              *  (b) admin specified custom directory (error_directory)
 172              */
 173             error_text[i] = errorLoadText(err_type_str[i]);
 174
 175         } else {
 176             /** \par
 177              * Index any unknown file names used by deny_info.
 178              */
 179             ErrorDynamicPageInfo *info = ErrorDynamicPages.items[i - ERR_MAX];
 180             assert(info && info->id == i && info->page_name);
 181
 182             if (strchr(info->page_name, ':') == NULL) {
 183                 /** But only if they are not redirection URL. */
 184                 error_text[i] = errorLoadText(info->page_name);
 185             }
 186         }
 187     }
 188
 189     error_stylesheet.reset();
 190
 191     // look for and load stylesheet into global MemBuf for it.
 192     if(Config.errorStylesheet) {
 193         char *temp = errorTryLoadText(Config.errorStylesheet,NULL);
 194         if(temp) {
 195             error_stylesheet.Printf("%s",temp);
 196             safe_free(temp);
 197         }
 198     }
 199 }
 200
 201 void
 202 errorClean(void)
 203 {
 204     if (error_text) {
 205         int i;
 206
 207         for (i = ERR_NONE + 1; i < error_page_count; i++)
 208             safe_free(error_text[i]);
 209
 210         safe_free(error_text);
 211     }
 212
 213     while (ErrorDynamicPages.size())
 214         errorDynamicPageInfoDestroy(ErrorDynamicPages.pop_back());
 215
 216     error_page_count = 0;
 217 }
 218
 219 /// \ingroup ErrorPageInternal
 220 static const char *
 221 errorFindHardText(err_type type)
 222 {
 223     int i;
 224
 225     for (i = 0; i < error_hard_text_count; i++)
 226         if (error_hard_text[i].type == type)
 227             return error_hard_text[i].text;
 228
 229     return NULL;
 230 }
 231
 232 /**
 233  * \ingroup ErrorPageInternal
 234  *
 235  * Load into the in-memory error text Index a file probably available at:
 236  *  (a) admin specified custom directory (error_directory)
 237  *  (b) default language translation directory (error_default_language)
 238  *  (c) English sub-directory where errors should ALWAYS exist
 239  */
 240 static char *
 241 errorLoadText(const char *page_name)
 242 {
 243     char *text = NULL;
 244
 245     /** test error_directory configured location */
 246     if(Config.errorDirectory)
 247         text = errorTryLoadText(page_name, Config.errorDirectory);
 248
 249 #if USE_ERR_LOCALES
 250     /** test error_default_language location */
 251     if(!text && Config.errorDefaultLanguage) {
 252         char dir[256];
 253         snprintf(dir,256,"%s/%s", DEFAULT_SQUID_ERROR_DIR, Config.errorDefaultLanguage);
 254         text = errorTryLoadText(page_name, dir);
 255         if(!text) {
 256             debugs(1, DBG_CRITICAL, "Unable to load default error language files. Reset to backups.");
 257         }
 258     }
 259 #endif
 260
 261     /* test default location if failed (templates == English translation base templates) */
 262     if (!text) {
 263         text = errorTryLoadText(page_name, DEFAULT_SQUID_ERROR_DIR"/templates");
 264     }
 265
 266     /* giving up if failed */
 267     if (!text)
 268         fatal("failed to find or read error text file.");
 269
 270     return text;
 271 }
 272
 273 /// \ingroup ErrorPageInternal
 274 static char *
 275 errorTryLoadText(const char *page_name, const char *dir, bool silent)
 276 {
 277     int fd;
 278     char path[MAXPATHLEN];
 279     char buf[4096];
 280     char *text;
 281     ssize_t len;
 282     MemBuf textbuf;
 283
 284     // maybe received compound parts, maybe an absolute page_name and no dir
 285     if(dir)
 286         snprintf(path, sizeof(path), "%s/%s", dir, page_name);
 287     else
 288         snprintf(path, sizeof(path), "%s", page_name);
 289
 290     fd = file_open(path, O_RDONLY | O_TEXT);
 291
 292     if (fd < 0) {
 293         /* with dynamic locale negotiation we may see some failures before a success. */
 294         if(!silent)
 295             debugs(4, DBG_CRITICAL, HERE << "'" << path << "': " << xstrerror());
 296         return NULL;
 297     }
 298
 299     textbuf.init();
 300
 301     while((len = FD_READ_METHOD(fd, buf, sizeof(buf))) > 0) {
 302         textbuf.append(buf, len);
 303     }
 304
 305     if (len < 0) {
 306         debugs(4, DBG_CRITICAL, HERE << "failed to fully read: '" << path << "': " << xstrerror());
 307     }
 308
 309     file_close(fd);
 310
 311     if (strstr(textbuf.buf, "%s") == NULL)
 312         textbuf.append("%S", 2);        /* add signature */
 313
 314     /* Shrink memory size down to exact size. MemBuf has a tencendy
 315      * to be rather large..
 316      */
 317     text = xstrdup(textbuf.buf);
 318
 319     textbuf.clean();
 320
 321     return text;
 322 }
 323
 324 /// \ingroup ErrorPageInternal
 325 static ErrorDynamicPageInfo *
 326 errorDynamicPageInfoCreate(int id, const char *page_name)
 327 {
 328     ErrorDynamicPageInfo *info = new ErrorDynamicPageInfo;
 329     info->id = id;
 330     info->page_name = xstrdup(page_name);
 331     return info;
 332 }
 333
 334 /// \ingroup ErrorPageInternal
 335 static void
 336 errorDynamicPageInfoDestroy(ErrorDynamicPageInfo * info)
 337 {
 338     assert(info);
 339     safe_free(info->page_name);
 340     delete info;
 341 }
 342
 343 /// \ingroup ErrorPageInternal
 344 static int
 345 errorPageId(const char *page_name)
 346 {
 347     for (int i = 0; i < ERR_MAX; i++) {
 348         if (strcmp(err_type_str[i], page_name) == 0)
 349             return i;
 350     }
 351
 352     for (size_t j = 0; j < ErrorDynamicPages.size(); j++) {
 353         if (strcmp(ErrorDynamicPages.items[j]->page_name, page_name) == 0)
 354             return j + ERR_MAX;
 355     }
 356
 357     return ERR_NONE;
 358 }
 359
 360 err_type
 361 errorReservePageId(const char *page_name)
 362 {
 363     ErrorDynamicPageInfo *info;
 364     int id = errorPageId(page_name);
 365
 366     if (id == ERR_NONE) {
 367         info = errorDynamicPageInfoCreate(ERR_MAX + ErrorDynamicPages.size(), page_name);
 368         ErrorDynamicPages.push_back(info);
 369         id = info->id;
 370     }
 371
 372     return (err_type)id;
 373 }
 374
 375 /// \ingroup ErrorPageInternal
 376 static const char *
 377 errorPageName(int pageId)
 378 {
 379     if (pageId >= ERR_NONE && pageId < ERR_MAX)         /* common case */
 380         return err_type_str[pageId];
 381
 382     if (pageId >= ERR_MAX && pageId - ERR_MAX < (ssize_t)ErrorDynamicPages.size())
 383         return ErrorDynamicPages.items[pageId - ERR_MAX]->page_name;
 384
 385     return "ERR_UNKNOWN";       /* should not happen */
 386 }
 387
 388 ErrorState *
 389 errorCon(err_type type, http_status status, HttpRequest * request)
 390 {
 391     ErrorState *err = new ErrorState;
 392     err->page_id = type;        /* has to be reset manually if needed */
 393     err->err_language = NULL;
 394     err->type = type;
 395     err->httpStatus = status;
 396
 397     if (request != NULL) {
 398         err->request = HTTPMSGLOCK(request);
 399         err->src_addr = request->client_addr;
 400     }
 401
 402     return err;
 403 }
 404
 405 void
 406 errorAppendEntry(StoreEntry * entry, ErrorState * err)
 407 {
 408     assert(entry->mem_obj != NULL);
 409     assert (entry->isEmpty());
 410     debugs(4, 4, "Creating an error page for entry " << entry <<
 411            " with errorstate " << err <<
 412            " page id " << err->page_id);
 413
 414     if (entry->store_status != STORE_PENDING) {
 415         debugs(4, 2, "Skipping error page due to store_status: " << entry->store_status);
 416         /*
 417          * If the entry is not STORE_PENDING, then no clients
 418          * care about it, and we don't need to generate an
 419          * error message
 420          */
 421         assert(EBIT_TEST(entry->flags, ENTRY_ABORTED));
 422         assert(entry->mem_obj->nclients == 0);
 423         errorStateFree(err);
 424         return;
 425     }
 426
 427     if (err->page_id == TCP_RESET) {
 428         if (err->request) {
 429             debugs(4, 2, "RSTing this reply");
 430             err->request->flags.setResetTCP();
 431         }
 432     }
 433
 434     entry->lock();
 435     entry->buffer();
 436     entry->replaceHttpReply( err->BuildHttpReply() );
 437     EBIT_CLR(entry->flags, ENTRY_FWD_HDR_WAIT);
 438     entry->flush();
 439     entry->complete();
 440     entry->negativeCache();
 441     entry->releaseRequest();
 442     entry->unlock();
 443     errorStateFree(err);
 444 }
 445
 446 void
 447 errorSend(int fd, ErrorState * err)
 448 {
 449     HttpReply *rep;
 450     debugs(4, 3, "errorSend: FD " << fd << ", err=" << err);
 451     assert(fd >= 0);
 452     /*
 453      * ugh, this is how we make sure error codes get back to
 454      * the client side for logging and error tracking.
 455      */
 456
 457     if (err->request)
 458         err->request->errType = err->type;
 459
 460     /* moved in front of errorBuildBuf @?@ */
 461     err->flags.flag_cbdata = 1;
 462
 463     rep = err->BuildHttpReply();
 464
 465     comm_write_mbuf(fd, rep->pack(), errorSendComplete, err);
 466
 467     delete rep;
 468 }
 469
 470 /**
 471  \ingroup ErrorPageAPI
 472  *
 473  * Called by commHandleWrite() after data has been written
 474  * to the client socket.
 475  *
 476  \note If there is a callback, the callback is responsible for
 477  *     closeing the FD, otherwise we do it ourseves.
 478  */
 479 static void
 480 errorSendComplete(int fd, char *bufnotused, size_t size, comm_err_t errflag, int xerrno, void *data)
 481 {
 482     ErrorState *err = static_cast<ErrorState *>(data);
 483     debugs(4, 3, "errorSendComplete: FD " << fd << ", size=" << size);
 484
 485     if (errflag != COMM_ERR_CLOSING) {
 486         if (err->callback) {
 487             debugs(4, 3, "errorSendComplete: callback");
 488             err->callback(fd, err->callback_data, size);
 489         } else {
 490             comm_close(fd);
 491             debugs(4, 3, "errorSendComplete: comm_close");
 492         }
 493     }
 494
 495     errorStateFree(err);
 496 }
 497
 498 void
 499 errorStateFree(ErrorState * err)
 500 {
 501     HTTPMSGUNLOCK(err->request);
 502     safe_free(err->redirect_url);
 503     safe_free(err->url);
 504     safe_free(err->dnsserver_msg);
 505     safe_free(err->request_hdrs);
 506     wordlistDestroy(&err->ftp.server_msg);
 507     safe_free(err->ftp.request);
 508     safe_free(err->ftp.reply);
 509     AUTHUSERREQUESTUNLOCK(err->auth_user_request, "errstate");
 510     safe_free(err->err_msg);
 511 #if USE_ERR_LOCALES
 512     if(err->err_language != Config.errorDefaultLanguage)
 513 #endif
 514         safe_free(err->err_language);
 515     cbdataFree(err);
 516 }
 517
 518 int
 519 ErrorState::Dump(MemBuf * mb)
 520 {
 521     MemBuf str;
 522     const char *p = NULL;       /* takes priority over mb if set */
 523     char ntoabuf[MAX_IPSTRLEN];
 524
 525     str.reset();
 526     /* email subject line */
 527     str.Printf("CacheErrorInfo - %s", errorPageName(type));
 528     mb->Printf("?subject=%s", rfc1738_escape_part(str.buf));
 529     str.reset();
 530     /* email body */
 531     str.Printf("CacheHost: %s\r\n", getMyHostname());
 532     /* - Err Msgs */
 533     str.Printf("ErrPage: %s\r\n", errorPageName(type));
 534
 535     if (xerrno) {
 536         str.Printf("Err: (%d) %s\r\n", xerrno, strerror(xerrno));
 537     } else {
 538         str.Printf("Err: [none]\r\n");
 539     }
 540
 541     if (auth_user_request->denyMessage())
 542         str.Printf("Auth ErrMsg: %s\r\n", auth_user_request->denyMessage());
 543
 544     if (dnsserver_msg) {
 545         str.Printf("DNS Server ErrMsg: %s\r\n", dnsserver_msg);
 546     }
 547
 548     /* - TimeStamp */
 549     str.Printf("TimeStamp: %s\r\n\r\n", mkrfc1123(squid_curtime));
 550
 551     /* - IP stuff */
 552     str.Printf("ClientIP: %s\r\n", src_addr.NtoA(ntoabuf,MAX_IPSTRLEN));
 553
 554     if (request && request->hier.host) {
 555         str.Printf("ServerIP: %s\r\n", request->hier.host);
 556     }
 557
 558     str.Printf("\r\n");
 559     /* - HTTP stuff */
 560     str.Printf("HTTP Request:\r\n");
 561
 562     if (NULL != request) {
 563         Packer p;
 564         str.Printf("%s %s HTTP/%d.%d\n",
 565                    RequestMethodStr(request->method),
 566                    request->urlpath.size() ? request->urlpath.buf() : "/",
 567                    request->http_ver.major, request->http_ver.minor);
 568         packerToMemInit(&p, &str);
 569         request->header.packInto(&p);
 570         packerClean(&p);
 571     } else if (request_hdrs) {
 572         p = request_hdrs;
 573     } else {
 574         p = "[none]";
 575     }
 576
 577     str.Printf("\r\n");
 578     /* - FTP stuff */
 579
 580     if (ftp.request) {
 581         str.Printf("FTP Request: %s\r\n", ftp.request);
 582         str.Printf("FTP Reply: %s\r\n", ftp.reply);
 583         str.Printf("FTP Msg: ");
 584         wordlistCat(ftp.server_msg, &str);
 585         str.Printf("\r\n");
 586     }
 587
 588     str.Printf("\r\n");
 589     mb->Printf("&body=%s", rfc1738_escape_part(str.buf));
 590     str.clean();
 591     return 0;
 592 }
 593
 594 /// \ingroup ErrorPageInternal
 595 #define CVT_BUF_SZ 512
 596
 597 const char *
 598 ErrorState::Convert(char token)
 599 {
 600     static MemBuf mb;
 601     const char *p = NULL;       /* takes priority over mb if set */
 602     int do_quote = 1;
 603     char ntoabuf[MAX_IPSTRLEN];
 604
 605     mb.reset();
 606
 607     switch (token) {
 608
 609     case 'a':
 610
 611         if (request && request->auth_user_request)
 612             p = request->auth_user_request->username();
 613
 614         if (!p)
 615             p = "-";
 616
 617         break;
 618
 619     case 'B':
 620         p = request ? ftpUrlWith2f(request) : "[no URL]";
 621
 622         break;
 623
 624     case 'c':
 625         p = errorPageName(type);
 626
 627         break;
 628
 629     case 'e':
 630         mb.Printf("%d", xerrno);
 631
 632         break;
 633
 634     case 'E':
 635
 636         if (xerrno)
 637             mb.Printf("(%d) %s", xerrno, strerror(xerrno));
 638         else
 639             mb.Printf("[No Error]");
 640
 641         break;
 642
 643     case 'f':
 644         /* FTP REQUEST LINE */
 645         if (ftp.request)
 646             p = ftp.request;
 647         else
 648             p = "nothing";
 649
 650         break;
 651
 652     case 'F':
 653         /* FTP REPLY LINE */
 654         if (ftp.request)
 655             p = ftp.reply;
 656         else
 657             p = "nothing";
 658
 659         break;
 660
 661     case 'g':
 662         /* FTP SERVER MESSAGE */
 663         wordlistCat(ftp.server_msg, &mb);
 664
 665         break;
 666
 667     case 'h':
 668         mb.Printf("%s", getMyHostname());
 669
 670         break;
 671
 672     case 'H':
 673         if (request) {
 674             if (request->hier.host)
 675                 p = request->hier.host;
 676             else
 677                 p = request->GetHost();
 678         } else
 679             p = "[unknown host]";
 680
 681         break;
 682
 683     case 'i':
 684         mb.Printf("%s", src_addr.NtoA(ntoabuf,MAX_IPSTRLEN));
 685
 686         break;
 687
 688     case 'I':
 689         if (request && request->hier.host) {
 690             mb.Printf("%s", request->hier.host);
 691         } else
 692             p = "[unknown]";
 693
 694         break;
 695
 696     case 'l':
 697         mb.append(error_stylesheet.content(), error_stylesheet.contentSize());
 698         do_quote = 0;
 699         break;
 700
 701     case 'L':
 702         if (Config.errHtmlText) {
 703             mb.Printf("%s", Config.errHtmlText);
 704             do_quote = 0;
 705         } else
 706             p = "[not available]";
 707
 708         break;
 709
 710     case 'm':
 711         p = auth_user_request->denyMessage("[not available]");
 712
 713         break;
 714
 715     case 'M':
 716         p = request ? RequestMethodStr(request->method) : "[unknown method]";
 717
 718         break;
 719
 720     case 'o':
 721         p = external_acl_message ? external_acl_message : "[not available]";
 722
 723         break;
 724
 725     case 'p':
 726         if (request) {
 727             mb.Printf("%d", (int) request->port);
 728         } else {
 729             p = "[unknown port]";
 730         }
 731
 732         break;
 733
 734     case 'P':
 735         p = request ? ProtocolStr[request->protocol] : "[unknown protocol]";
 736         break;
 737
 738     case 'R':
 739
 740         if (NULL != request) {
 741             Packer p;
 742             mb.Printf("%s %s HTTP/%d.%d\n",
 743                       RequestMethodStr(request->method),
 744                       request->urlpath.size() ? request->urlpath.buf() : "/",
 745                       request->http_ver.major, request->http_ver.minor);
 746             packerToMemInit(&p, &mb);
 747             request->header.packInto(&p);
 748             packerClean(&p);
 749         } else if (request_hdrs) {
 750             p = request_hdrs;
 751         } else {
 752             p = "[no request]";
 753         }
 754
 755         break;
 756
 757     case 's':
 758         p = visible_appname_string;
 759         break;
 760
 761     case 'S':
 762         /* signature may contain %-escapes, recursion */
 763
 764         if (page_id != ERR_SQUID_SIGNATURE) {
 765             const int saved_id = page_id;
 766             page_id = ERR_SQUID_SIGNATURE;
 767             MemBuf *sign_mb = BuildContent();
 768             mb.Printf("%s", sign_mb->content());
 769             sign_mb->clean();
 770             delete sign_mb;
 771             page_id = saved_id;
 772             do_quote = 0;
 773         } else {
 774             /* wow, somebody put %S into ERR_SIGNATURE, stop recursion */
 775             p = "[%S]";
 776         }
 777
 778         break;
 779
 780     case 't':
 781         mb.Printf("%s", mkhttpdlogtime(&squid_curtime));
 782         break;
 783
 784     case 'T':
 785         mb.Printf("%s", mkrfc1123(squid_curtime));
 786         break;
 787
 788     case 'U':
 789         p = request ? urlCanonicalClean(request) : url ? url : "[no URL]";
 790         break;
 791
 792     case 'u':
 793         p = request ? urlCanonical(request) : url ? url : "[no URL]";
 794         break;
 795
 796     case 'w':
 797
 798         if (Config.adminEmail)
 799             mb.Printf("%s", Config.adminEmail);
 800         else
 801             p = "[unknown]";
 802
 803         break;
 804
 805     case 'W':
 806         if (Config.adminEmail && Config.onoff.emailErrData)
 807             Dump(&mb);
 808
 809         break;
 810
 811     case 'z':
 812         if (dnsserver_msg)
 813             p = dnsserver_msg;
 814         else
 815             p = "[unknown]";
 816
 817         break;
 818
 819     case 'Z':
 820         if (err_msg)
 821             p = err_msg;
 822         else
 823             p = "[unknown]";
 824
 825         break;
 826
 827     case '%':
 828         p = "%";
 829
 830         break;
 831
 832     default:
 833         mb.Printf("%%%c", token);
 834
 835         do_quote = 0;
 836
 837         break;
 838     }
 839
 840     if (!p)
 841         p = mb.buf;             /* do not use mb after this assignment! */
 842
 843     assert(p);
 844
 845     debugs(4, 3, "errorConvert: %%" << token << " --> '" << p << "'" );
 846
 847     if (do_quote)
 848         p = html_quote(p);
 849
 850     return p;
 851 }
 852
 853 HttpReply *
 854 ErrorState::BuildHttpReply()
 855 {
 856     HttpReply *rep = new HttpReply;
 857     const char *name = errorPageName(page_id);
 858     /* no LMT for error pages; error pages expire immediately */
 859     HttpVersion version(1, 0);
 860
 861     if (strchr(name, ':')) {
 862         /* Redirection */
 863         rep->setHeaders(version, HTTP_MOVED_TEMPORARILY, NULL, "text/html", 0, 0, squid_curtime);
 864
 865         if (request) {
 866             char *quoted_url = rfc1738_escape_part(urlCanonical(request));
 867             httpHeaderPutStrf(&rep->header, HDR_LOCATION, name, quoted_url);
 868         }
 869
 870         httpHeaderPutStrf(&rep->header, HDR_X_SQUID_ERROR, "%d %s", httpStatus, "Access Denied");
 871     } else {
 872         MemBuf *content = BuildContent();
 873         rep->setHeaders(version, httpStatus, NULL, "text/html", content->contentSize(), 0, squid_curtime);
 874         /*
 875          * include some information for downstream caches. Implicit
 876          * replaceable content. This isn't quite sufficient. xerrno is not
 877          * necessarily meaningful to another system, so we really should
 878          * expand it. Additionally, we should identify ourselves. Someone
 879          * might want to know. Someone _will_ want to know OTOH, the first
 880          * X-CACHE-MISS entry should tell us who.
 881          */
 882         httpHeaderPutStrf(&rep->header, HDR_X_SQUID_ERROR, "%s %d", name, xerrno);
 883
 884 #if USE_ERR_LOCALES
 885         /*
 886          * If error page auto-negotiate is enabled in any way, send the Vary.
 887          * RFC 2616 section 13.6 and 14.44 says MAY and SHOULD do this.
 888          * We have even better reasons though:
 889          * see http://wiki.squid-cache.org/KnowledgeBase/VaryNotCaching
 890          */
 891         if(!Config.errorDirectory) {
 892             /* We 'negotiated' this ONLY from the Accept-Language. */
 893             rep->header.delById(HDR_VARY);
 894             rep->header.putStr(HDR_VARY, "Accept-Language");
 895         }
 896
 897         /* add the Content-Language header according to RFC section 14.12 */
 898         if(err_language) {
 899             rep->header.putStr(HDR_CONTENT_LANGUAGE, err_language);
 900         }
 901         else
 902 #endif /* USE_ERROR_LOCALES */
 903         {
 904             /* default templates are in English */
 905             /* language is known unless error_directory override used */
 906             if(!Config.errorDirectory)
 907                 rep->header.putStr(HDR_CONTENT_LANGUAGE, "en");
 908         }
 909
 910         httpBodySet(&rep->body, content);
 911         /* do not memBufClean() or delete the content, it was absorbed by httpBody */
 912     }
 913
 914     return rep;
 915 }
 916
 917 MemBuf *
 918 ErrorState::BuildContent()
 919 {
 920     MemBuf *content = new MemBuf;
 921     const char *m = NULL;
 922     const char *p;
 923     const char *t;
 924
 925     assert(page_id > ERR_NONE && page_id < error_page_count);
 926
 927 #if USE_ERR_LOCALES
 928     String hdr;
 929     char dir[256];
 930     int l = 0;
 931
 932     /** error_directory option in squid.conf overrides translations.
 933      * Otherwise locate the Accept-Language header
 934      */
 935     if(!Config.errorDirectory && request && request->header.getList(HDR_ACCEPT_LANGUAGE, &hdr) ) {
 936
 937         const char *buf = hdr.buf(); // raw header string for parsing
 938         int pos = 0; // current parsing position in header string
 939         char *reset = NULL; // where to reset the p pointer for each new tag file
 940         char *dt = NULL;
 941
 942         /* prep the directory path string to prevent snprintf ... */
 943         l = strlen(DEFAULT_SQUID_ERROR_DIR);
 944         memcpy(dir, DEFAULT_SQUID_ERROR_DIR, l);
 945         dir[ l++ ] = '/';
 946         reset = dt = dir + l;
 947
 948         debugs(4, 6, HERE << "Testing Header: '" << hdr << "'");
 949
 950         while( pos < hdr.size() ) {
 951
 952 /*
 953  * Header value format:
 954  *  - sequence of whitespace delimited tags
 955  *  - each tag may suffix with ';'.* which we can ignore.
 956  *  - IFF a tag contains only two characters we can wildcard ANY translations matching: <it> '-'? .*
 957  *    with preference given to an exact match.
 958  */
 959             while(pos < hdr.size() && buf[pos] != ';' && buf[pos] != ',' && !xisspace(buf[pos]) && dt < (dir+256) ) {
 960                 *dt++ = xtolower(buf[pos++]);
 961             }
 962             *dt++ = '\0'; // nul-terminated the filename content string before system use.
 963
 964             debugs(4, 9, HERE << "STATE: dt='" << dt << "', reset='" << reset << "', reset[1]='" << reset[1] << "', pos=" << pos << ", buf='" << &buf[pos] << "'");
 965
 966             /* if we found anything we might use, try it. */
 967             if(*reset != '\0') {
 968
 969                 debugs(4, 6, HERE << "Found language '" << reset << "', testing for available template in: '" << dir << "'");
 970                 m = errorTryLoadText( err_type_str[page_id], dir, false);
 971
 972                 if(m) {
 973                     /* store the language we found for the Content-Language reply header */
 974                     err_language = xstrdup(reset);
 975                     break;
 976                 }
 977                 else if(Config.errorLogMissingLanguages) {
 978                     debugs(4, DBG_IMPORTANT, "WARNING: Error Pages Missing Language: " << reset);
 979                 }
 980
 981 #if HAVE_GLOB
 982                 if( (dt - reset) == 2) {
 983                     /* TODO glob the error directory for sub-dirs matching: <tag> '-*'   */
 984                     /* use first result. */
 985                     debugs(4,2, HERE << "wildcard fallback errors not coded yet.");
 986                 }
 987 #endif
 988             }
 989
 990             dt = reset; // reset for next tag testing. we replace the failed name instead of cloning.
 991
 992             // IFF we terminated the tag on ';' we need to skip the 'q=' bit to the next ',' or end.
 993             while(pos < hdr.size() && buf[pos] != ',') pos++;
 994             if(buf[pos] == ',') pos++;
 995         }
 996     }
 997 #endif /* USE_ERR_LOCALES */
 998
 999     /** \par
1000      * If client-specific error templates are not enabled or available.
1001      * fall back to the old style squid.conf settings.
1002      */
1003     if(!m) {
1004         m = error_text[page_id];
1005 #if USE_ERR_LOCALES
1006         if(!Config.errorDirectory)
1007             err_language = Config.errorDefaultLanguage;
1008 #endif
1009         debugs(4, 2, HERE << "No existing error page language negotiated for " << errorPageName(page_id) << ". Using default error file.");
1010     }
1011
1012     assert(m);
1013     content->init();
1014
1015     while ((p = strchr(m, '%'))) {
1016         content->append(m, p - m);      /* copy */
1017         t = Convert(*++p);              /* convert */
1018         content->Printf("%s", t);       /* copy */
1019         m = p + 1;                      /* advance */
1020     }
1021
1022     if (*m)
1023         content->Printf("%s", m);       /* copy tail */
1024
1025     assert((size_t)content->contentSize() == strlen(content->content()));
1026
1027     return content;
1028 }