1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
/*******************************************************************************
The MIT License (MIT)
Copyright (c) 2015 Alexander Zolotarev <me@alex.bio> from Minsk, Belarus
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*******************************************************************************/
// clang-format off
// This FastCGI server implementation is designed to store statistics received from remote clients.
// By default, everything is stored in <specified folder>/alohalytics_messages file.
// If you have tons of data, it is better to use logrotate utility to archive it (see logrotate.conf).
// Validity checks for requests should be mostly done on nginx side (see nginx.conf):
// $request_method should be POST only
// $content_length should be set and greater than zero (we re-check it below anyway)
// $content_type should be set to application/alohalytics-binary-blob
// $http_content_encoding should be set to gzip
// This binary shoud be spawn as a FastCGI app, for example:
// $ spawn-fcgi [-n] -a 127.0.0.1 -p <port number> -P /path/to/pid.file -- ./fcgi_server /dir/to/store/received/data [/optional/path/to/log.file]
// pid.file can be used by logrotate (see logrotate.conf).
// clang-format on
#include <chrono>
#include <csignal>
#include <cstdlib>
#include <ctime>
#include <exception>
#include <fstream>
#include <memory>
#include <sstream>
#include <string>
#include <thread>
#include <fcgiapp.h>
#include <fcgio.h>
#include "../src/logger.h"
#include "statistics_receiver.h"
using namespace std;
// Can be used as a basic check on the client-side if it has connected to the right server.
static const string kBodyTextForGoodServerReply = "Mahalo";
static const string kBodyTextForBadServerReply = "Hohono";
// We always reply to our clients that we have received everything they sent, even if it was a complete junk.
// The difference is only in the body of the reply.
void Reply200OKWithBody(FCGX_Stream * out, const string & body) {
FCGX_FPrintF(out, "Status: 200 OK\r\nContent-Type: text/plain\r\nContent-Length: %ld\r\n\r\n%s\n", body.size(),
body.c_str());
}
// Global variables to correctly reopen data and log files after signals from logrotate utility.
volatile sig_atomic_t gReceivedSIGHUP = 0;
volatile sig_atomic_t gReceivedSIGUSR1 = 0;
// Redirects all cout output into a file if good log_file_path was given in constructor.
// Can always ReopenLogFile() if needed (e.g. for log rotation).
struct CoutToFileRedirector {
char const * path;
unique_ptr<ofstream> log_file;
streambuf * original_cout_buf;
CoutToFileRedirector(const char * log_file_path) : path(log_file_path), original_cout_buf(cout.rdbuf()) {
ReopenLogFile();
}
void ReopenLogFile() {
if (!path) {
return;
}
log_file.reset(nullptr);
log_file.reset(new ofstream(path, ofstream::out | ofstream::app));
if (log_file->good()) {
cout.rdbuf(log_file->rdbuf());
} else {
ATLOG("ERROR: Can't open log file", path, "for writing.");
}
}
// Restore original cout streambuf.
~CoutToFileRedirector() { cout.rdbuf(original_cout_buf); }
};
int main(int argc, char * argv[]) {
if (argc < 2) {
ALOG("Usage:", argv[0], "<directory to store received data> [path to error log file]");
ALOG(" - SIGHUP reopens main data file and SIGUSR1 reopens debug log file for logrotate utility.");
return -1;
}
int result = FCGX_Init();
if (0 != result) {
ALOG("ERROR: FCGX_Init has failed with code", result);
return result;
}
FCGX_Request request;
result = FCGX_InitRequest(&request, 0, FCGI_FAIL_ACCEPT_ON_INTR);
if (0 != result) {
ALOG("ERROR: FCGX_InitRequest has failed with code", result);
return result;
}
// Redirect cout into a file if it was given in the command line.
CoutToFileRedirector log_redirector(argc > 2 ? argv[2] : nullptr);
// Correctly reopen data file on SIGHUP for logrotate.
if (SIG_ERR == ::signal(SIGHUP, [](int) { gReceivedSIGHUP = SIGHUP; })) {
ATLOG("WARNING: Can't set SIGHUP handler. Logrotate will not work correctly.");
}
// Correctly reopen debug log file on SIGUSR1 for logrotate.
if (SIG_ERR == ::signal(SIGUSR1, [](int) { gReceivedSIGUSR1 = SIGUSR1; })) {
ATLOG("WARNING: Can't set SIGUSR1 handler. Logrotate will not work correctly.");
}
// NOTE: On most systems, when we get a signal, FCGX_Accept_r blocks even with a FCGI_FAIL_ACCEPT_ON_INTR flag set
// in the request. Looks like on these systems default signal function installs the signals with the SA_RESTART flag
// set (see man sigaction for more details) and syscalls are automatically restart themselves if a signal occurs.
// To "fix" this behavior and gracefully shutdown our server, we use a trick from
// W. Richard Stevens, Stephen A. Rago, "Advanced Programming in the UNIX Environment", 2nd edition, page 329.
// It is also described here: http://comments.gmane.org/gmane.comp.web.fastcgi.devel/942
for (auto signo : {SIGTERM, SIGINT}) {
struct sigaction act;
sigemptyset(&act.sa_mask);
act.sa_flags = 0;
#ifdef SA_INTERRUPT
act.sa_flags |= SA_INTERRUPT;
#endif
act.sa_handler = [](int) { FCGX_ShutdownPending(); };
const int result = sigaction(signo, &act, nullptr);
if (result != 0) {
ATLOG("WARNING: Can't set", signo, "signal handler");
}
}
alohalytics::StatisticsReceiver receiver(argv[1]);
string gzipped_body;
long long content_length;
const char * remote_addr_str;
const char * request_uri_str;
const char * user_agent_str;
ATLOG("FastCGI Server instance is ready to serve clients' requests.");
while (FCGX_Accept_r(&request) >= 0) {
// Correctly reopen data file in the queue.
if (gReceivedSIGHUP == SIGHUP) {
receiver.ReopenDataFile();
gReceivedSIGHUP = 0;
}
// Correctly reopen debug log file.
if (gReceivedSIGUSR1 == SIGUSR1) {
log_redirector.ReopenLogFile();
gReceivedSIGUSR1 = 0;
}
FCGX_FPrintF(request.out, "Status: 200 OK\r\nContent-Type: text/plain\r\nContent-Length: %ld\r\n\r\n%s\n",
kBodyTextForGoodServerReply.size(), kBodyTextForGoodServerReply.c_str());
try {
remote_addr_str = FCGX_GetParam("REMOTE_ADDR", request.envp);
if (!remote_addr_str) {
ATLOG("WARNING: Missing REMOTE_ADDR. Please check your http server configuration.");
remote_addr_str = "";
}
request_uri_str = FCGX_GetParam("REQUEST_URI", request.envp);
if (!request_uri_str) {
ATLOG("WARNING: Missing REQUEST_URI. Please check your http server configuration.");
request_uri_str = "";
}
user_agent_str = FCGX_GetParam("HTTP_USER_AGENT", request.envp);
if (!user_agent_str) {
ATLOG("WARNING: Missing HTTP User-Agent. Please check your http server configuration.");
user_agent_str = "";
}
const char * content_length_str = FCGX_GetParam("HTTP_CONTENT_LENGTH", request.envp);
content_length = 0;
if (!content_length_str || ((content_length = atoll(content_length_str)) <= 0)) {
ATLOG("WARNING: Request is ignored due to invalid or missing Content-Length header", content_length_str,
remote_addr_str, request_uri_str, user_agent_str);
Reply200OKWithBody(request.out, kBodyTextForBadServerReply);
continue;
}
// TODO(AlexZ): Should we make a better check for Content-Length or basic exception handling would be enough?
gzipped_body.resize(content_length);
if (fcgi_istream(request.in).read(&gzipped_body[0], content_length).fail()) {
ATLOG("WARNING: Request is ignored because it's body can't be read.", remote_addr_str, request_uri_str,
user_agent_str);
Reply200OKWithBody(request.out, kBodyTextForBadServerReply);
continue;
}
// Process and store received body.
// This call can throw different exceptions.
receiver.ProcessReceivedHTTPBody(gzipped_body, AlohalyticsBaseEvent::CurrentTimestamp(), remote_addr_str,
user_agent_str, request_uri_str);
Reply200OKWithBody(request.out, kBodyTextForGoodServerReply);
} catch (const exception & ex) {
ATLOG("ERROR: Exception was thrown:", ex.what(), remote_addr_str, request_uri_str, user_agent_str);
// TODO(AlexZ): Log "bad" received body for investigation.
Reply200OKWithBody(request.out, kBodyTextForBadServerReply);
}
}
ATLOG("Shutting down FastCGI server instance.");
return 0;
}
|
