]>
Commit | Line | Data |
---|---|---|
aa839030 | 1 | /* |
63be0a78 | 2 | * DEBUG: section 4 Error Generation |
3 | * AUTHOR: Duane Wessels | |
aa839030 | 4 | * |
5 | * SQUID Web Proxy Cache http://www.squid-cache.org/ | |
6 | * ---------------------------------------------------------- | |
7 | * | |
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. | |
16 | * | |
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. | |
26ac0430 | 21 | * |
aa839030 | 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. | |
26ac0430 | 26 | * |
aa839030 | 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. | |
30 | * | |
31 | * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org> | |
32 | */ | |
33 | ||
34 | #ifndef SQUID_ERRORPAGE_H | |
35 | #define SQUID_ERRORPAGE_H | |
36 | ||
37 | #include "squid.h" | |
38 | #include "cbdata.h" | |
9837e5f0 | 39 | #include "ip/IpAddress.h" |
aa839030 | 40 | |
63be0a78 | 41 | /** |
42 | \defgroup ErrorPageAPI Error Pages API | |
43 | \ingroup Components | |
44 | \section ErrorPageStringCodes Error Page % codes for text insertion. | |
45 | * | |
46 | \verbatim | |
47 | a - User identity x | |
48 | B - URL with FTP %2f hack x | |
49 | c - Squid error code x | |
50 | d - seconds elapsed since request received x | |
51 | e - errno x | |
52 | E - strerror() x | |
53 | f - FTP request line x | |
54 | F - FTP reply line x | |
55 | g - FTP server message x | |
56 | h - cache hostname x | |
57 | H - server host name x | |
58 | i - client IP address x | |
59 | I - server IP address x | |
8e1a6bde | 60 | l - HREF link for CSS stylesheet inclusion x |
63be0a78 | 61 | L - HREF link for more info/contact x |
62 | M - Request Method x | |
63 | m - Error message returned by auth helper x | |
64 | o - Message returned external acl helper x | |
65 | p - URL port # x | |
66 | P - Protocol x | |
67 | R - Full HTTP Request x | |
68 | S - squid signature from ERR_SIGNATURE x | |
69 | s - caching proxy software with version x | |
70 | t - local time x | |
71 | T - UTC x | |
72 | U - URL without password x | |
73 | u - URL with password x | |
74 | w - cachemgr email address x | |
75 | W - error data (to be included in the mailto links) | |
76 | z - dns server error message x | |
77 | Z - Preformatted error message x | |
78 | \endverbatim | |
79 | */ | |
80 | ||
9554bbf2 | 81 | class AuthUserRequest; |
c70281f8 AJ |
82 | class HttpReply; |
83 | class MemBuf; | |
9554bbf2 | 84 | |
63be0a78 | 85 | /// \ingroup ErrorPageAPI |
aa839030 | 86 | class ErrorState |
87 | { | |
c70281f8 AJ |
88 | public: |
89 | /** | |
90 | * Allocates and initializes an error response | |
91 | */ | |
92 | HttpReply *BuildHttpReply(void); | |
93 | ||
94 | private: | |
95 | /** | |
96 | * Locates error page template to be used for this error | |
97 | * and constructs the HTML page content from it. | |
98 | */ | |
99 | MemBuf *BuildContent(void); | |
100 | ||
101 | /** | |
15b02e9a AJ |
102 | * Generates the Location: header value for a deny_info error page |
103 | * to be used for this error. | |
c70281f8 | 104 | */ |
15b02e9a AJ |
105 | void DenyInfoLocation(const char *name, HttpRequest *request, MemBuf &result); |
106 | ||
107 | /** | |
108 | * Map the Error page and deny_info template % codes into textual output. | |
05320519 | 109 | * |
15b02e9a AJ |
110 | * Several of the codes produce blocks of non-URL compatible results. |
111 | * When processing the deny_info location URL they will be skipped. | |
112 | * | |
113 | * \param token The token following % which need to be converted | |
114 | * \param url_presentable URL-encode the the output for deny_info redirect | |
115 | */ | |
116 | const char *Convert(char token, bool url_presentable); | |
c70281f8 AJ |
117 | |
118 | /** | |
119 | * CacheManager / Debug dump of the ErrorState object. | |
120 | * Writes output into the given MemBuf. | |
121 | \retval 0 successful completion. | |
122 | */ | |
123 | int Dump(MemBuf * mb); | |
2cc81f1f | 124 | |
125 | public: | |
aa839030 | 126 | err_type type; |
127 | int page_id; | |
ccb24616 | 128 | char *err_language; |
aa839030 | 129 | http_status httpStatus; |
76f142cd | 130 | AuthUserRequest *auth_user_request; |
aa839030 | 131 | HttpRequest *request; |
132 | char *url; | |
133 | int xerrno; | |
134 | u_short port; | |
3ff65596 | 135 | String dnsError; ///< DNS lookup error message |
aa839030 | 136 | time_t ttl; |
137 | ||
b7ac5457 | 138 | Ip::Address src_addr; |
aa839030 | 139 | char *redirect_url; |
140 | ERCB *callback; | |
141 | void *callback_data; | |
142 | ||
26ac0430 | 143 | struct { |
3d0ac046 HN |
144 | unsigned int flag_cbdata:1; |
145 | } flags; | |
aa839030 | 146 | |
26ac0430 | 147 | struct { |
aa839030 | 148 | wordlist *server_msg; |
149 | char *request; | |
150 | char *reply; | |
0477a072 AJ |
151 | char *cwd_msg; |
152 | MemBuf *listing; | |
3d0ac046 | 153 | } ftp; |
aa839030 | 154 | |
aa839030 | 155 | char *request_hdrs; |
156 | char *err_msg; /* Preformatted error message from the cache */ | |
2cc81f1f | 157 | |
158 | private: | |
aa839030 | 159 | CBDATA_CLASS2(ErrorState); |
160 | }; | |
161 | ||
63be0a78 | 162 | /** |
163 | \ingroup ErrorPageAPI | |
164 | * | |
165 | * This function finds the error messages formats, and stores | |
166 | * them in error_text[] | |
167 | * | |
168 | \par Global effects: | |
169 | * error_text[] - is modified | |
170 | */ | |
aa839030 | 171 | SQUIDCEXTERN void errorInitialize(void); |
63be0a78 | 172 | |
173 | /// \ingroup ErrorPageAPI | |
aa839030 | 174 | SQUIDCEXTERN void errorClean(void); |
63be0a78 | 175 | |
63be0a78 | 176 | /** |
177 | \ingroup ErrorPageAPI | |
178 | * | |
179 | * This function generates a error page from the info contained | |
180 | * by err and then sends it to the client. | |
181 | * The callback function errorSendComplete() is called after | |
182 | * the page has been written to the client socket (fd). | |
183 | * errorSendComplete() deallocates err. We need to add | |
184 | * err to the cbdata because comm_write() requires it | |
185 | * for all callback data pointers. | |
186 | * | |
187 | \note normally errorSend() should only be called from | |
188 | * routines in ssl.c and pass.c, where we don't have any | |
189 | * StoreEntry's. In client_side.c we must allocate a StoreEntry | |
190 | * for errors and use errorAppendEntry() to account for | |
191 | * persistent/pipeline connections. | |
192 | * | |
193 | \param fd socket where page object is to be written | |
194 | \param err This object is destroyed after use in this function. | |
195 | */ | |
196 | SQUIDCEXTERN void errorSend(int fd, ErrorState *err); | |
197 | ||
198 | /** | |
199 | \ingroup ErrorPageAPI | |
200 | * | |
201 | * This function generates a error page from the info contained | |
202 | * by err and then stores the text in the specified store | |
203 | * entry. | |
204 | * This function should only be called by "server | |
205 | * side routines" which need to communicate errors to the | |
206 | * client side. It should also be called from client_side.c | |
207 | * because we now support persistent connections, and | |
208 | * cannot assume that we can immediately write to the socket | |
209 | * for an error. | |
210 | * | |
211 | \param entry ?? | |
212 | \param err This object is destroyed after use in this function. | |
213 | */ | |
214 | SQUIDCEXTERN void errorAppendEntry(StoreEntry *entry, ErrorState *err); | |
215 | ||
216 | /// \ingroup ErrorPageAPI | |
aa839030 | 217 | SQUIDCEXTERN void errorStateFree(ErrorState * err); |
63be0a78 | 218 | |
219 | /// \ingroup ErrorPageAPI | |
aa839030 | 220 | SQUIDCEXTERN err_type errorReservePageId(const char *page_name); |
aa839030 | 221 | |
63be0a78 | 222 | /** |
223 | \ingroup ErrorPageAPI | |
224 | * | |
225 | * This function creates a ErrorState object. | |
226 | */ | |
227 | SQUIDCEXTERN ErrorState *errorCon(err_type type, http_status, HttpRequest * request); | |
aa839030 | 228 | |
229 | #endif /* SQUID_ERRORPAGE_H */ |