2 * DEBUG: section 04 Error Generation
3 * AUTHOR: Duane Wessels
5 * SQUID Web Proxy Cache http://www.squid-cache.org/
6 * ----------------------------------------------------------
8 * Squid is the result of efforts by numerous individuals from
9 * the Internet community; see the CONTRIBUTORS file for full
10 * details. Many organizations have provided support for Squid's
11 * development; see the SPONSORS file for full details. Squid is
12 * Copyrighted (C) 2001 by the Regents of the University of
13 * California; see the COPYRIGHT file for full details. Squid
14 * incorporates software developed and/or copyrighted by other
15 * sources; see the CREDITS file for full details.
17 * This program is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation; either version 2 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program; if not, write to the Free Software
29 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
31 * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
34 #ifndef SQUID_ERRORPAGE_H
35 #define SQUID_ERRORPAGE_H
38 #include "auth/UserRequest.h"
40 #include "comm/forward.h"
41 #include "ip/Address.h"
44 \defgroup ErrorPageAPI Error Pages API
46 \section ErrorPageStringCodes Error Page % codes for text insertion.
50 B - URL with FTP %2f hack x
51 c - Squid error code x
52 d - seconds elapsed since request received x
55 f - FTP request line x
57 g - FTP server message x
59 H - server host name x
60 i - client IP address x
61 I - server IP address x
62 l - HREF link for CSS stylesheet inclusion x
63 L - HREF link for more info/contact x
65 m - Error message returned by auth helper x
66 o - Message returned external acl helper x
69 R - Full HTTP Request x
70 S - squid signature from ERR_SIGNATURE x
71 s - caching proxy software with version x
74 U - URL without password x
75 u - URL with password x
76 w - cachemgr email address x
77 W - error data (to be included in the mailto links)
78 z - dns server error message x
79 Z - Preformatted error message x
86 /// \ingroup ErrorPageAPI
91 * Allocates and initializes an error response
93 HttpReply
*BuildHttpReply(void);
97 * Locates error page template to be used for this error
98 * and constructs the HTML page content from it.
100 MemBuf
*BuildContent(void);
103 * Generates the Location: header value for a deny_info error page
104 * to be used for this error.
106 void DenyInfoLocation(const char *name
, HttpRequest
*request
, MemBuf
&result
);
109 * Map the Error page and deny_info template % codes into textual output.
111 * Several of the codes produce blocks of non-URL compatible results.
112 * When processing the deny_info location URL they will be skipped.
114 * \param token The token following % which need to be converted
115 * \param building_deny_info_url Perform special deny_info actions, such as URL-encoding and token skipping.
117 const char *Convert(char token
, bool building_deny_info_url
);
120 * CacheManager / Debug dump of the ErrorState object.
121 * Writes output into the given MemBuf.
122 \retval 0 successful completion.
124 int Dump(MemBuf
* mb
);
130 http_status httpStatus
;
131 AuthUserRequest::Pointer auth_user_request
;
132 HttpRequest
*request
;
136 String dnsError
; ///< DNS lookup error message
139 Ip::Address src_addr
;
145 unsigned int flag_cbdata
:1;
149 wordlist
*server_msg
;
157 char *err_msg
; /* Preformatted error message from the cache */
160 CBDATA_CLASS2(ErrorState
);
164 \ingroup ErrorPageAPI
166 * This function finds the error messages formats, and stores
167 * them in error_text[]
170 * error_text[] - is modified
172 SQUIDCEXTERN
void errorInitialize(void);
174 /// \ingroup ErrorPageAPI
175 SQUIDCEXTERN
void errorClean(void);
178 * \ingroup ErrorPageAPI
180 * This function generates a error page from the info contained
181 * by err and then sends it to the client.
182 * The callback function errorSendComplete() is called after
183 * the page has been written to the client (clientConn).
184 * errorSendComplete() deallocates err. We need to add
185 * err to the cbdata because comm_write() requires it
186 * for all callback data pointers.
188 * \note normally errorSend() should only be called from
189 * routines in ssl.c and pass.c, where we don't have any
190 * StoreEntry's. In client_side.c we must allocate a StoreEntry
191 * for errors and use errorAppendEntry() to account for
192 * persistent/pipeline connections.
194 * \param clientConn socket where page object is to be written
195 * \param err This object is destroyed after use in this function.
197 SQUIDCEXTERN
void errorSend(const Comm::ConnectionPointer
&conn
, ErrorState
*err
);
200 \ingroup ErrorPageAPI
202 * This function generates a error page from the info contained
203 * by err and then stores the text in the specified store
205 * This function should only be called by "server
206 * side routines" which need to communicate errors to the
207 * client side. It should also be called from client_side.c
208 * because we now support persistent connections, and
209 * cannot assume that we can immediately write to the socket
213 \param err This object is destroyed after use in this function.
215 SQUIDCEXTERN
void errorAppendEntry(StoreEntry
*entry
, ErrorState
*err
);
217 /// \ingroup ErrorPageAPI
218 SQUIDCEXTERN
void errorStateFree(ErrorState
* err
);
220 /// \ingroup ErrorPageAPI
221 SQUIDCEXTERN err_type
errorReservePageId(const char *page_name
);
224 \ingroup ErrorPageAPI
226 * This function creates a ErrorState object.
228 SQUIDCEXTERN ErrorState
*errorCon(err_type type
, http_status
, HttpRequest
* request
);
229 SQUIDCEXTERN
const char *errorPageName(int pageId
); ///< error ID to string
231 #endif /* SQUID_ERRORPAGE_H */