/*
- * DEBUG: section 04 Error Generation
- * AUTHOR: Duane Wessels
+ * Copyright (C) 1996-2017 The Squid Software Foundation and contributors
*
- * SQUID Web Proxy Cache http://www.squid-cache.org/
- * ----------------------------------------------------------
- *
- * Squid is the result of efforts by numerous individuals from
- * the Internet community; see the CONTRIBUTORS file for full
- * details. Many organizations have provided support for Squid's
- * development; see the SPONSORS file for full details. Squid is
- * Copyrighted (C) 2001 by the Regents of the University of
- * California; see the COPYRIGHT file for full details. Squid
- * incorporates software developed and/or copyrighted by other
- * sources; see the CREDITS file for full details.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
- *
- * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
*/
+/* DEBUG: section 04 Error Generation */
+
#ifndef SQUID_ERRORPAGE_H
#define SQUID_ERRORPAGE_H
-#include "squid-old.h"
-#if USE_AUTH
-#include "auth/UserRequest.h"
-#endif
#include "cbdata.h"
#include "comm/forward.h"
#include "err_detail_type.h"
+#include "err_type.h"
+#include "http/StatusCode.h"
#include "ip/Address.h"
-#include "MemBuf.h"
-#if USE_SSL
+#include "SquidString.h"
+/* auth/UserRequest.h is empty unless USE_AUTH is defined */
+#include "auth/UserRequest.h"
+#if USE_OPENSSL
#include "ssl/ErrorDetail.h"
#endif
+/// error page callback
+typedef void ERCB(int fd, void *, size_t);
+
/**
\defgroup ErrorPageAPI Error Pages API
\ingroup Components
*/
class HttpReply;
+class HttpRequest;
class MemBuf;
+class StoreEntry;
+class wordlist;
/// \ingroup ErrorPageAPI
class ErrorState
{
+ CBDATA_CLASS(ErrorState);
+
public:
- ErrorState(err_type type, http_status, HttpRequest * request);
+ ErrorState(err_type type, Http::StatusCode, HttpRequest * request);
ErrorState(); // not implemented.
~ErrorState();
+ /// Creates a general request forwarding error with the right http_status.
+ static ErrorState *NewForwarding(err_type type, HttpRequest *request);
+
/**
* Allocates and initializes an error response
*/
HttpReply *BuildHttpReply(void);
/// set error type-specific detail code
- void detailError(int detailCode);
+ void detailError(int dCode) {detailCode = dCode;}
private:
/**
err_type type;
int page_id;
char *err_language;
- http_status httpStatus;
+ Http::StatusCode httpStatus;
#if USE_AUTH
Auth::UserRequest::Pointer auth_user_request;
#endif
ERCB *callback;
void *callback_data;
- struct {
- unsigned int flag_cbdata:1;
- } flags;
-
struct {
wordlist *server_msg;
char *request;
char *request_hdrs;
char *err_msg; /* Preformatted error message from the cache */
-#if USE_SSL
+#if USE_OPENSSL
Ssl::ErrorDetail *detail;
#endif
/// type-specific detail about the transaction error;
/// overwrites xerrno; overwritten by detail, if any.
int detailCode;
-private:
- CBDATA_CLASS2(ErrorState);
};
/**
\par Global effects:
* error_text[] - is modified
*/
-SQUIDCEXTERN void errorInitialize(void);
+void errorInitialize(void);
/// \ingroup ErrorPageAPI
-SQUIDCEXTERN void errorClean(void);
+void errorClean(void);
/**
* \ingroup ErrorPageAPI
\param clientConn socket where page object is to be written
\param err This object is destroyed after use in this function.
*/
-SQUIDCEXTERN void errorSend(const Comm::ConnectionPointer &conn, ErrorState *err);
+void errorSend(const Comm::ConnectionPointer &conn, ErrorState *err);
/**
\ingroup ErrorPageAPI
\param entry ??
\param err This object is destroyed after use in this function.
*/
-SQUIDCEXTERN void errorAppendEntry(StoreEntry *entry, ErrorState *err);
+void errorAppendEntry(StoreEntry *entry, ErrorState *err);
/// \ingroup ErrorPageAPI
-SQUIDCEXTERN err_type errorReservePageId(const char *page_name);
+err_type errorReservePageId(const char *page_name);
-SQUIDCEXTERN const char *errorPageName(int pageId); ///< error ID to string
+const char *errorPageName(int pageId); ///< error ID to string
/**
\ingroup ErrorPageAPI
* template selected (eg because of a "Accept-Language: *"), or not available
* template found this function return false.
*/
- bool loadFor(HttpRequest *request);
+ bool loadFor(const HttpRequest *request);
/**
* Load the file given by "path". It uses the "parse()" method.
/**
* Parses the Accept-Language header value and return one language item on
* each call.
+ * Will ignore any whitespace, q-values, and detectably invalid language
+ * codes in the header.
+ *
* \param hdr is the Accept-Language header value
- * \param lang a buffer given by the user to store parsed language
+ * \param lang a buffer to store parsed language code in
* \param langlen the length of the lang buffer
- * \param pos it is used to store the state of parsing. Must be "0" on first call
- * \return true on success, false otherwise
+ * \param pos is used to store the offset state of parsing. Must be "0" on first call.
+ * Will be altered to point at the start of next field-value.
+ * \return true if something looking like a language token has been placed in lang, false otherwise
*/
bool strHdrAcptLangGetItem(const String &hdr, char *lang, int langLen, size_t &pos);
+
#endif /* SQUID_ERRORPAGE_H */
+
projects / thirdparty / squid.git / blobdiff