Forwarder.cc
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2020 The Squid Software Foundation and contributors
3  *
4  * Squid software is distributed under GPLv2+ license and includes
5  * contributions from numerous individuals and organizations.
6  * Please see the COPYING and CONTRIBUTORS files for details.
7  */
8 
9 /* DEBUG: section 16 Cache Manager API */
10 
11 #include "squid.h"
12 #include "AccessLogEntry.h"
13 #include "base/AsyncJobCalls.h"
14 #include "base/TextException.h"
15 #include "comm/Connection.h"
16 #include "CommCalls.h"
17 #include "errorpage.h"
18 #include "globals.h"
19 #include "HttpReply.h"
20 #include "HttpRequest.h"
21 #include "ipc/Port.h"
22 #include "mgr/Forwarder.h"
23 #include "mgr/Request.h"
24 #include "SquidTime.h"
25 #include "Store.h"
26 
28 
30  HttpRequest* aRequest, StoreEntry* anEntry, const AccessLogEntryPointer &anAle):
31  Ipc::Forwarder(new Request(KidIdentifier, 0, aConn, aParams), 10),
32  httpRequest(aRequest), entry(anEntry), conn(aConn), ale(anAle)
33 {
34  debugs(16, 5, HERE << conn);
36  Must(httpRequest != NULL);
37  Must(entry != NULL);
38 
40  entry->lock("Mgr::Forwarder");
41 
42  closer = asyncCall(16, 5, "Mgr::Forwarder::noteCommClosed",
45 }
46 
48 {
50  Must(entry);
51  entry->unlock("Mgr::Forwarder");
52  Must(httpRequest);
53  HTTPMSGUNLOCK(httpRequest);
54  });
55 }
56 
58 void
60 {
61  if (Comm::IsConnOpen(conn)) {
62  if (closer != NULL) {
63  comm_remove_close_handler(conn->fd, closer);
64  closer = NULL;
65  }
66  conn->close();
67  }
68  conn = NULL;
70 }
71 
72 void
74 {
75  debugs(16, DBG_CRITICAL, "ERROR: uri " << entry->url() << " exceeds buffer size");
76  sendError(new ErrorState(ERR_INVALID_URL, Http::scUriTooLong, httpRequest, ale));
77  mustStop("long URI");
78 }
79 
80 void
82 {
83  sendError(new ErrorState(ERR_LIFETIME_EXP, Http::scRequestTimeout, httpRequest, ale));
85 }
86 
87 void
88 Mgr::Forwarder::handleException(const std::exception &e)
89 {
90  if (entry != NULL && httpRequest != NULL && Comm::IsConnOpen(conn))
91  sendError(new ErrorState(ERR_INVALID_RESP, Http::scInternalServerError, httpRequest, ale));
93 }
94 
96 void
98 {
99  debugs(16, 5, HERE);
100  conn = NULL; // needed?
101  mustStop("commClosed");
102 }
103 
105 void
107 {
108  debugs(16, 3, HERE);
109  Must(error != NULL);
110  Must(entry != NULL);
111  Must(httpRequest != NULL);
112 
113  entry->buffer();
114  entry->replaceHttpReply(error->BuildHttpReply());
115  entry->expires = squid_curtime;
116  delete error;
117  entry->flush();
118  entry->complete();
119 }
120 
AsyncCall::Pointer comm_add_close_handler(int fd, CLCB *handler, void *data)
Definition: comm.cc:968
void noteCommClosed(const CommCloseCbParams &params)
called when the client socket gets closed by some external force
Definition: Forwarder.cc:97
int KidIdentifier
virtual void handleTimeout()
Definition: Forwarder.cc:81
void lock(const char *context)
Definition: store.cc:439
virtual void handleException(const std::exception &e)
terminate with an error
Definition: Forwarder.cc:129
void error(char *format,...)
bool IsConnOpen(const Comm::ConnectionPointer &conn)
Definition: Connection.cc:26
void HTTPMSGUNLOCK(M *&a)
Definition: Message.h:149
#define DBG_CRITICAL
Definition: Debug.h:45
virtual void swanSong()
Definition: Forwarder.cc:67
Forwarder(const Comm::ConnectionPointer &aConn, const ActionParams &aParams, HttpRequest *aRequest, StoreEntry *anEntry, const AccessLogEntryPointer &anAle)
Definition: Forwarder.cc:29
void sendError(ErrorState *error)
send error page
Definition: Forwarder.cc:106
#define NULL
Definition: types.h:166
#define debugs(SECTION, LEVEL, CONTENT)
Definition: Debug.h:128
virtual void swanSong()
closes our copy of the client HTTP connection socket
Definition: Forwarder.cc:59
virtual void handleTimeout()
Definition: Forwarder.cc:122
Comm::ConnectionPointer conn
HTTP client connection descriptor.
Definition: Forwarder.h:54
std::ostream & HERE(std::ostream &s)
Definition: Debug.h:157
cache manager request
Definition: Request.h:22
HttpRequest * httpRequest
HTTP client request for detailing errors.
Definition: Forwarder.h:52
int conn
the current server connection FD
Definition: Transport.cc:26
StoreEntry * entry
Store entry expecting the response.
Definition: Forwarder.h:53
void HTTPMSGLOCK(Http::Message *a)
Definition: Message.h:160
time_t squid_curtime
Definition: stub_time.cc:17
AsyncCall::Pointer closer
comm_close handler for the HTTP connection
Definition: Forwarder.h:55
virtual void handleException(const std::exception &e)
terminate with an error
Definition: Forwarder.cc:88
virtual void handleError()
Definition: Forwarder.cc:73
Cache Manager Action parameters extracted from the user request.
Definition: ActionParams.h:23
#define Must(condition)
Like assert() but throws an exception instead of aborting the process.
Definition: TextException.h:69
CBDATA_NAMESPACED_CLASS_INIT(Ipc, Forwarder)
AsyncCall * asyncCall(int aDebugSection, int aDebugLevel, const char *aName, const Dialer &aDialer)
Definition: AsyncCall.h:161
virtual ~Forwarder()
Definition: Forwarder.cc:47
#define SWALLOW_EXCEPTIONS(code)
Definition: TextException.h:73
void comm_remove_close_handler(int fd, CLCB *handler, void *data)
Definition: comm.cc:995
Definition: IpcIoFile.h:23
Cache Manager API.
Definition: Action.h:19

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors