-
Notifications
You must be signed in to change notification settings - Fork 547
/
Hooks.cpp
1604 lines (1432 loc) · 53.3 KB
/
Hooks.cpp
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Phusion Passenger - http://www.modrails.com/
* Copyright (c) 2008, 2009 Phusion
*
* "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
*
* 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.
*/
#include <boost/thread.hpp>
#include <sys/time.h>
#include <sys/resource.h>
#include <exception>
#include <cstdio>
#include <unistd.h>
#include <oxt/macros.hpp>
#include "Hooks.h"
#include "Bucket.h"
#include "Configuration.h"
#include "Utils.h"
#include "Logging.h"
#include "ApplicationPoolServer.h"
#include "MessageChannel.h"
#include "DirectoryMapper.h"
#include "Timer.h"
#include "Version.h"
/* The Apache/APR headers *must* come after the Boost headers, otherwise
* compilation will fail on OpenBSD.
*
* apr_want.h *must* come after MessageChannel.h, otherwise compilation will
* fail on platforms on which apr_want.h tries to redefine 'struct iovec'.
* http://tinyurl.com/b6aatw
*/
#include <ap_config.h>
#include <httpd.h>
#include <http_config.h>
#include <http_core.h>
#include <http_request.h>
#include <http_protocol.h>
#include <http_log.h>
#include <util_script.h>
#include <apr_pools.h>
#include <apr_strings.h>
#include <apr_lib.h>
#include <unixd.h>
using namespace std;
using namespace Passenger;
extern "C" module AP_MODULE_DECLARE_DATA passenger_module;
/*
* This is the main source file which interfaces directly with Apache by
* installing hooks. The code here can look a bit convoluted, but it'll make
* more sense if you read:
* http://httpd.apache.org/docs/2.2/developer/request.html
*
* Scroll all the way down to passenger_register_hooks to get an idea of
* what we're hooking into and what we do in those hooks.
*/
/**
* If the HTTP client sends POST data larger than this value (in bytes),
* then the POST data will be fully buffered into a temporary file, before
* allocating a Ruby web application session.
* File uploads smaller than this are buffered into memory instead.
*/
#define LARGE_UPLOAD_THRESHOLD 1024 * 8
/**
* Apache hook functions, wrapped in a class.
*
* @ingroup Core
*/
class Hooks {
private:
struct AprDestructable {
virtual ~AprDestructable() { }
static apr_status_t cleanup(void *p) {
delete (AprDestructable *) p;
return APR_SUCCESS;
}
};
struct RequestNote: public AprDestructable {
DirectoryMapper mapper;
DirConfig *config;
bool forwardToBackend;
const char *handlerBeforeModRewrite;
char *filenameBeforeModRewrite;
apr_filetype_e oldFileType;
const char *handlerBeforeModAutoIndex;
RequestNote(const DirectoryMapper &m)
: mapper(m) {
forwardToBackend = false;
filenameBeforeModRewrite = NULL;
}
};
struct ErrorReport: public AprDestructable {
virtual int report(request_rec *r) = 0;
};
struct ReportFileSystemError: public ErrorReport {
FileSystemException e;
ReportFileSystemError(const FileSystemException &ex): e(ex) { }
int report(request_rec *r) {
r->status = 500;
ap_set_content_type(r, "text/html; charset=UTF-8");
ap_rputs("<h1>Passenger error #2</h1>\n", r);
ap_rputs("An error occurred while trying to access '", r);
ap_rputs(ap_escape_html(r->pool, e.filename().c_str()), r);
ap_rputs("': ", r);
ap_rputs(ap_escape_html(r->pool, e.what()), r);
if (e.code() == EACCES || e.code() == EPERM) {
ap_rputs("<p>", r);
ap_rputs("Apache doesn't have read permissions to that file. ", r);
ap_rputs("Please fix the relevant file permissions.", r);
ap_rputs("</p>", r);
}
P_ERROR("A filesystem exception occured.\n" <<
" Message: " << e.what() << "\n" <<
" Backtrace:\n" << e.backtrace());
return OK;
}
};
/**
* A StringListCreator which returns a list of environment variable
* names and values, as found in r->subprocess_env.
*/
class EnvironmentVariablesStringListCreator: public StringListCreator {
private:
request_rec *r;
public:
EnvironmentVariablesStringListCreator(request_rec *r) {
this->r = r;
}
virtual const StringListPtr getItems() const {
const apr_array_header_t *env_arr;
apr_table_entry_t *env_entries;
StringListPtr result = ptr(new StringList());
// Some standard CGI headers.
result->push_back("SERVER_SOFTWARE");
result->push_back(ap_get_server_version());
// Subprocess environment variables.
env_arr = apr_table_elts(r->subprocess_env);
env_entries = (apr_table_entry_t *) env_arr->elts;
for (int i = 0; i < env_arr->nelts; ++i) {
result->push_back(env_entries[i].key);
result->push_back(env_entries[i].val);
}
return result;
}
};
enum Threeway { YES, NO, UNKNOWN };
ApplicationPoolServerPtr applicationPoolServer;
thread_specific_ptr<ApplicationPoolPtr> threadSpecificApplicationPool;
Threeway m_hasModRewrite, m_hasModDir, m_hasModAutoIndex;
CachedFileStat cstat;
inline DirConfig *getDirConfig(request_rec *r) {
return (DirConfig *) ap_get_module_config(r->per_dir_config, &passenger_module);
}
inline ServerConfig *getServerConfig(server_rec *s) {
return (ServerConfig *) ap_get_module_config(s->module_config, &passenger_module);
}
inline RequestNote *getRequestNote(request_rec *r) {
// The union is needed in order to be compliant with
// C99/C++'s strict aliasing rules. http://tinyurl.com/g5hgh
union {
RequestNote *note;
void *pointer;
} u;
u.note = 0;
apr_pool_userdata_get(&u.pointer, "Phusion Passenger", r->pool);
return u.note;
}
/**
* Returns a usable ApplicationPool object.
*
* When using the worker MPM and global queuing, deadlocks can occur, for
* the same reason described in ApplicationPoolServer::connect(). This
* method allows us to avoid this deadlock by making sure that each
* thread gets its own connection to the application pool server.
*
* It also checks whether the currently cached ApplicationPool object
* is disconnected (which can happen if an error previously occured).
* If so, it will reconnect to the ApplicationPool server.
*/
ApplicationPoolPtr getApplicationPool() {
ApplicationPoolPtr *pool_ptr = threadSpecificApplicationPool.get();
if (pool_ptr == NULL) {
pool_ptr = new ApplicationPoolPtr(applicationPoolServer->connect());
threadSpecificApplicationPool.reset(pool_ptr);
} else if (!(*pool_ptr)->connected()) {
P_DEBUG("Reconnecting to ApplicationPool server");
*pool_ptr = applicationPoolServer->connect();
}
return *pool_ptr;
}
bool hasModRewrite() {
if (m_hasModRewrite == UNKNOWN) {
if (ap_find_linked_module("mod_rewrite.c")) {
m_hasModRewrite = YES;
} else {
m_hasModRewrite = NO;
}
}
return m_hasModRewrite == YES;
}
bool hasModDir() {
if (m_hasModDir == UNKNOWN) {
if (ap_find_linked_module("mod_dir.c")) {
m_hasModDir = YES;
} else {
m_hasModDir = NO;
}
}
return m_hasModDir == YES;
}
bool hasModAutoIndex() {
if (m_hasModAutoIndex == UNKNOWN) {
if (ap_find_linked_module("mod_autoindex.c")) {
m_hasModAutoIndex = YES;
} else {
m_hasModAutoIndex = NO;
}
}
return m_hasModAutoIndex == YES;
}
int reportDocumentRootDeterminationError(request_rec *r) {
ap_set_content_type(r, "text/html; charset=UTF-8");
ap_rputs("<h1>Passenger error #1</h1>\n", r);
ap_rputs("Cannot determine the document root for the current request.", r);
return OK;
}
int reportBusyException(request_rec *r) {
ap_custom_response(r, HTTP_SERVICE_UNAVAILABLE,
"This website is too busy right now. Please try again later.");
return HTTP_SERVICE_UNAVAILABLE;
}
/**
* Gather some information about the request and do some preparations. In this method,
* it will be determined whether the request URI should be served statically by Apache
* (in case of static assets or in case there's a page cache file available) or
* whether it should be forwarded to the backend application.
*
* The strategy is as follows:
*
* We check whether Phusion Passenger is enabled for this URI (A).
* If so, then we check whether the following situations are true:
* (B) There is a backend application defined for this URI.
* (C) r->filename already exists.
* (D) There is a page cache file for the URI.
*
* - If A is not true, or if B is not true, or if C is true, then don't do anything.
* Passenger will be disabled during the rest of this request.
* - If D is true, then we first transform r->filename to the page cache file's
* filename, and then we let Apache serve it statically.
* - If D is not true, then we forward the request to the backend application.
*
* @pre The (A) condition must be true.
* @param coreModuleWillBeRun Whether the core.c map_to_storage hook might be called after this.
* @return Whether the Passenger handler hook method should be run.
*/
bool prepareRequest(request_rec *r, DirConfig *config, const char *filename, bool coreModuleWillBeRun = false) {
TRACE_POINT();
DirectoryMapper mapper(r, config, &cstat, config->getStatThrottleRate());
try {
if (mapper.getBaseURI() == NULL) {
// (B) is not true.
return false;
}
} catch (const FileSystemException &e) {
/* DirectoryMapper tried to examine the filesystem in order
* to autodetect the application type (e.g. by checking whether
* environment.rb exists. But something went wrong, probably
* because of a permission problem. This usually
* means that the user is trying to deploy an application, but
* set the wrong permissions on the relevant folders.
* Later, in the handler hook, we inform the user about this
* problem so that he can either disable Phusion Passenger's
* autodetection routines, or fix the permissions.
*
* If it's not a permission problem then we'll disable
* Phusion Passenger for the rest of the request.
*/
if (e.code() == EACCES || e.code() == EPERM) {
// TODO: filesystem error is not always reported. need
// to figure out why. test case:
// - mkdir /foo
// - mkdir /foo/public
// - mkdir /foo/config
// - chmod 000 /foo/config
// - add vhost 'foo' with document root /foo/public
// - curl http://foo/
apr_pool_userdata_set(new ReportFileSystemError(e),
"Phusion Passenger: error report",
ReportFileSystemError::cleanup,
r->pool);
return true;
} else {
return false;
}
}
/* Save some information for the hook methods that are called later.
* The existance of this note indicates that the URI belongs to a Phusion
* Passenger-served application.
*/
RequestNote *note = new RequestNote(mapper);
note->config = config;
apr_pool_userdata_set(note, "Phusion Passenger", RequestNote::cleanup, r->pool);
try {
// (B) is true.
FileType fileType = getFileType(filename);
if (fileType == FT_REGULAR) {
// (C) is true.
return false;
}
// (C) is not true. Check whether (D) is true.
char *pageCacheFile;
/* Only GET requests may hit the page cache. This is
* important because of REST conventions, e.g.
* 'POST /foo' maps to 'FooController#create',
* while 'GET /foo' maps to 'FooController#index'.
* We wouldn't want our page caching support to interfere
* with that.
*/
if (r->method_number == M_GET) {
if (fileType == FT_DIRECTORY) {
size_t len;
len = strlen(filename);
if (len > 0 && filename[len - 1] == '/') {
pageCacheFile = apr_pstrcat(r->pool, filename,
"index.html", NULL);
} else {
pageCacheFile = apr_pstrcat(r->pool, filename,
".html", NULL);
}
} else {
pageCacheFile = apr_pstrcat(r->pool, filename,
".html", NULL);
}
if (!fileExists(pageCacheFile)) {
pageCacheFile = NULL;
}
} else {
pageCacheFile = NULL;
}
if (pageCacheFile != NULL) {
// (D) is true.
r->filename = pageCacheFile;
r->canonical_filename = pageCacheFile;
if (!coreModuleWillBeRun) {
r->finfo.filetype = APR_NOFILE;
ap_set_content_type(r, "text/html");
ap_directory_walk(r);
ap_file_walk(r);
}
return false;
} else {
// (D) is not true.
note->forwardToBackend = true;
return true;
}
} catch (const FileSystemException &e) {
/* Something went wrong while accessing the directory in which
* r->filename lives. We already know that this URI belongs to
* a backend application, so this error probably means that the
* user set the wrong permissions for his 'public' folder. We
* don't let the handler hook run so that Apache can decide how
* to display the error.
*/
return false;
}
}
/**
* Most of the high-level logic for forwarding a request to a backend application
* is contained in this method.
*/
int handleRequest(request_rec *r) {
/********** Step 1: preparation work **********/
/* Check whether an error occured in prepareRequest() that should be reported
* to the browser.
*/
// The union is needed in order to be compliant with
// C99/C++'s strict aliasing rules. http://tinyurl.com/g5hgh
union {
ErrorReport *errorReport;
void *pointer;
} u;
/* Did an error occur in any of the previous hook methods during
* this request? If so, show the error and stop here.
*/
u.errorReport = 0;
apr_pool_userdata_get(&u.pointer, "Phusion Passenger: error report", r->pool);
if (u.errorReport != 0) {
return u.errorReport->report(r);
}
RequestNote *note = getRequestNote(r);
if (note == 0 || !note->forwardToBackend) {
return DECLINED;
} else if (r->handler != NULL && strcmp(r->handler, "redirect-handler") == 0) {
// mod_rewrite is at work.
return DECLINED;
}
TRACE_POINT();
DirConfig *config = note->config;
DirectoryMapper &mapper(note->mapper);
if (mapper.getPublicDirectory().empty()) {
return reportDocumentRootDeterminationError(r);
}
/********** Step 2: handle HTTP upload data, if any **********/
int httpStatus = ap_setup_client_block(r, REQUEST_CHUNKED_DECHUNK);
if (httpStatus != OK) {
return httpStatus;
}
try {
this_thread::disable_interruption di;
this_thread::disable_syscall_interruption dsi;
Application::SessionPtr session;
bool expectingUploadData;
string uploadDataMemory;
shared_ptr<BufferedUpload> uploadDataFile;
const char *contentLength;
expectingUploadData = ap_should_client_block(r);
contentLength = lookupHeader(r, "Content-Length");
/* If the HTTP upload data is larger than a threshold, or if the HTTP
* client sent HTTP upload data using the "chunked" transfer encoding
* (which implies Content-Length == NULL), then buffer the upload
* data into a tempfile. Otherwise, buffer it into memory.
*
* We never forward the data directly to the backend process because
* the HTTP client might block indefinitely until it's done uploading.
* This would quickly exhaust the application pool.
*/
if (expectingUploadData) {
if (contentLength == NULL || atol(contentLength) > LARGE_UPLOAD_THRESHOLD) {
uploadDataFile = receiveRequestBody(r, contentLength);
} else {
receiveRequestBody(r, contentLength, uploadDataMemory);
}
}
if (expectingUploadData && contentLength == NULL) {
/* In case of "chunked" transfer encoding, we'll set the
* Content-Length header to the length of the received upload
* data. Rails requires this header for its HTTP upload data
* multipart parsing process.
*/
if (uploadDataFile != NULL) {
apr_table_set(r->headers_in, "Content-Length",
toString(ftell(uploadDataFile->handle)).c_str());
} else {
apr_table_set(r->headers_in, "Content-Length",
toString(uploadDataMemory.size()).c_str());
}
}
/********** Step 3: forwarding the request to a backend
process from the application pool **********/
UPDATE_TRACE_POINT();
try {
ServerConfig *sconfig = getServerConfig(r->server);
string publicDirectory(mapper.getPublicDirectory());
PoolOptions options(
config->getAppRoot(publicDirectory.c_str()),
true,
sconfig->getDefaultUser(),
mapper.getEnvironment(),
config->getSpawnMethodString(),
mapper.getApplicationTypeString(),
config->frameworkSpawnerTimeout,
config->appSpawnerTimeout,
config->getMaxRequests(),
config->getMemoryLimit(),
config->usingGlobalQueue(),
config->getStatThrottleRate(),
config->getRestartDir(),
mapper.getBaseURI()
);
options.environmentVariables = ptr(new EnvironmentVariablesStringListCreator(r));
session = getApplicationPool()->get(options);
P_TRACE(3, "Forwarding " << r->uri << " to PID " << session->getPid());
} catch (const SpawnException &e) {
r->status = 500;
if (e.hasErrorPage()) {
ap_set_content_type(r, "text/html; charset=utf-8");
ap_rputs(e.getErrorPage().c_str(), r);
return OK;
} else {
throw;
}
} catch (const FileSystemException &e) {
/* The application root cannot be determined. This could
* happen if, for example, the user specified 'RailsBaseURI /foo'
* while there is no filesystem entry called "foo" in the virtual
* host's document root.
*/
return ReportFileSystemError(e).report(r);
} catch (const BusyException &e) {
return reportBusyException(r);
}
UPDATE_TRACE_POINT();
sendHeaders(r, config, session, mapper.getBaseURI());
if (expectingUploadData) {
if (uploadDataFile != NULL) {
sendRequestBody(r, session, uploadDataFile);
uploadDataFile.reset();
} else {
sendRequestBody(r, session, uploadDataMemory);
}
}
try {
session->shutdownWriter();
} catch (const SystemException &e) {
// Ignore ENOTCONN. This error occurs for some people
// for unknown reasons, but it's harmless.
if (e.code() != ENOTCONN) {
throw;
}
}
/********** Step 4: forwarding the response from the backend
process back to the HTTP client **********/
UPDATE_TRACE_POINT();
apr_bucket_brigade *bb;
apr_bucket *b;
PassengerBucketStatePtr bucketState;
pid_t backendPid;
/* Setup the bucket brigade. */
bucketState = ptr(new PassengerBucketState());
bb = apr_brigade_create(r->connection->pool, r->connection->bucket_alloc);
b = passenger_bucket_create(session, bucketState, r->connection->bucket_alloc);
/* The bucket (b) still has a reference to the session, so the reset()
* call here is guaranteed not to throw any exceptions.
*/
backendPid = session->getPid();
session.reset();
APR_BRIGADE_INSERT_TAIL(bb, b);
b = apr_bucket_eos_create(r->connection->bucket_alloc);
APR_BRIGADE_INSERT_TAIL(bb, b);
/* Now read the HTTP response header, parse it and fill relevant
* information in our request_rec structure.
*/
/* I know the required size for backendData because I read
* util_script.c's source. :-(
*/
char backendData[MAX_STRING_LEN];
Timer timer;
int result = ap_scan_script_header_err_brigade(r, bb, backendData);
if (result == OK) {
// The API documentation for ap_scan_script_err_brigade() says it
// returns HTTP_OK on success, but it actually returns OK.
/* We were able to parse the HTTP response header sent by the
* backend process! Proceed with passing the bucket brigade,
* for forwarding the response body to the HTTP client.
*/
/* Manually set the Status header because
* ap_scan_script_header_err_brigade() filters it
* out. Some broken HTTP clients depend on the
* Status header for retrieving the HTTP status.
*/
if (!r->status_line || *r->status_line == '\0') {
r->status_line = apr_psprintf(r->pool,
"%d Unknown Status",
r->status);
}
apr_table_setn(r->headers_out, "Status", r->status_line);
UPDATE_TRACE_POINT();
ap_pass_brigade(r->output_filters, bb);
if (r->connection->aborted) {
P_WARN("Either the vistor clicked on the 'Stop' button in the "
"web browser, or the visitor's connection has stalled "
"and couldn't receive the data that Apache is sending "
"to it. As a result, you will probably see a 'Broken Pipe' "
"error in this log file. Please ignore it, "
"this is normal. You might also want to increase Apache's "
"TimeOut configuration option if you experience this "
"problem often.");
} else if (!bucketState->completed) {
P_WARN("Apache stopped forwarding the backend's response, "
"even though the HTTP client did not close the "
"connection. Is this an Apache bug?");
}
return OK;
} else if (backendData[0] == '\0') {
if ((long long) timer.elapsed() >= r->server->timeout / 1000) {
// Looks like an I/O timeout.
P_ERROR("No data received from " <<
"the backend application (process " <<
backendPid << ") within " <<
(r->server->timeout / 1000) << " msec. Either " <<
"the backend application is frozen, or " <<
"your TimeOut value of " <<
(r->server->timeout / 1000000) <<
" seconds is too low. Please check " <<
"whether your application is frozen, or " <<
"increase the value of the TimeOut " <<
"configuration directive.");
} else {
P_ERROR("The backend application (process " <<
backendPid << ") did not send a valid " <<
"HTTP response; instead, it sent nothing " <<
"at all. It is possible that it has crashed; " <<
"please check whether there are crashing " <<
"bugs in this application.");
}
apr_table_setn(r->err_headers_out, "Status", "500 Internal Server Error");
return HTTP_INTERNAL_SERVER_ERROR;
} else {
if ((long long) timer.elapsed() >= r->server->timeout / 1000) {
// Looks like an I/O timeout.
P_ERROR("The backend application (process " <<
backendPid << ") hasn't sent a valid " <<
"HTTP response within " <<
(r->server->timeout / 1000) << " msec. Either " <<
"the backend application froze while " <<
"sending a response, or " <<
"your TimeOut value of " <<
(r->server->timeout / 1000000) <<
" seconds is too low. Please check " <<
"whether the application is frozen, or " <<
"increase the value of the TimeOut " <<
"configuration directive. The application " <<
"has sent this data so far: [" <<
backendData << "]");
} else {
P_ERROR("The backend application (process " <<
backendPid << ") didn't send a valid " <<
"HTTP response. It might have crashed " <<
"during the middle of sending an HTTP " <<
"response, so please check whether there " <<
"are crashing problems in your application. " <<
"This is the data that it sent: [" <<
backendData << "]");
}
apr_table_setn(r->err_headers_out, "Status", "500 Internal Server Error");
return HTTP_INTERNAL_SERVER_ERROR;
}
} catch (const thread_interrupted &e) {
P_TRACE(3, "A system call was interrupted during an HTTP request. Apache "
"is probably restarting or shutting down. Backtrace:\n" <<
e.backtrace());
return HTTP_INTERNAL_SERVER_ERROR;
} catch (const tracable_exception &e) {
P_ERROR("Unexpected error in mod_passenger: " <<
e.what() << "\n" << " Backtrace:\n" << e.backtrace());
return HTTP_INTERNAL_SERVER_ERROR;
} catch (const exception &e) {
P_ERROR("Unexpected error in mod_passenger: " <<
e.what() << "\n" << " Backtrace: not available");
return HTTP_INTERNAL_SERVER_ERROR;
} catch (...) {
P_ERROR("An unexpected, unknown error occured in mod_passenger.");
throw;
}
}
/**
* Convert an HTTP header name to a CGI environment name.
*/
char *http2env(apr_pool_t *p, const char *name) {
char *env_name = apr_pstrcat(p, "HTTP_", name, NULL);
char *cp;
for (cp = env_name + 5; *cp != 0; cp++) {
if (*cp == '-') {
*cp = '_';
} else {
*cp = apr_toupper(*cp);
}
}
return env_name;
}
char *lookupName(apr_table_t *t, const char *name) {
const apr_array_header_t *hdrs_arr = apr_table_elts(t);
apr_table_entry_t *hdrs = (apr_table_entry_t *) hdrs_arr->elts;
int i;
for (i = 0; i < hdrs_arr->nelts; ++i) {
if (hdrs[i].key == NULL) {
continue;
}
if (strcasecmp(hdrs[i].key, name) == 0) {
return hdrs[i].val;
}
}
return NULL;
}
char *lookupHeader(request_rec *r, const char *name) {
return lookupName(r->headers_in, name);
}
char *lookupEnv(request_rec *r, const char *name) {
return lookupName(r->subprocess_env, name);
}
void inline addHeader(apr_table_t *table, const char *name, const char *value) {
if (name != NULL && value != NULL) {
apr_table_addn(table, name, value);
}
}
apr_status_t sendHeaders(request_rec *r, DirConfig *config, Application::SessionPtr &session, const char *baseURI) {
apr_table_t *headers;
headers = apr_table_make(r->pool, 40);
if (headers == NULL) {
return APR_ENOMEM;
}
// Set standard CGI variables.
addHeader(headers, "SERVER_SOFTWARE", ap_get_server_version());
addHeader(headers, "SERVER_PROTOCOL", r->protocol);
addHeader(headers, "SERVER_NAME", ap_get_server_name(r));
addHeader(headers, "SERVER_ADMIN", r->server->server_admin);
addHeader(headers, "SERVER_ADDR", r->connection->local_ip);
addHeader(headers, "SERVER_PORT", apr_psprintf(r->pool, "%u", ap_get_server_port(r)));
addHeader(headers, "REMOTE_ADDR", r->connection->remote_ip);
addHeader(headers, "REMOTE_PORT", apr_psprintf(r->pool, "%d", r->connection->remote_addr->port));
addHeader(headers, "REMOTE_USER", r->user);
addHeader(headers, "REQUEST_METHOD", r->method);
addHeader(headers, "QUERY_STRING", r->args ? r->args : "");
addHeader(headers, "HTTPS", lookupEnv(r, "HTTPS"));
addHeader(headers, "CONTENT_TYPE", lookupHeader(r, "Content-type"));
addHeader(headers, "DOCUMENT_ROOT", ap_document_root(r));
if (config->allowsEncodedSlashes()) {
/*
* Apache decodes encoded slashes in r->uri, so we must use r->unparsed_uri
* if we are to support encoded slashes. However mod_rewrite doesn't change
* r->unparsed_uri, so the user must make a choice between mod_rewrite
* support or encoded slashes support. Sucks. :-(
*
* http://code.google.com/p/phusion-passenger/issues/detail?id=113
* http://code.google.com/p/phusion-passenger/issues/detail?id=230
*/
addHeader(headers, "REQUEST_URI", r->unparsed_uri);
} else {
const char *request_uri;
if (r->args != NULL) {
request_uri = apr_pstrcat(r->pool, r->uri, "?", r->args, NULL);
} else {
request_uri = r->uri;
}
addHeader(headers, "REQUEST_URI", request_uri);
}
if (strcmp(baseURI, "/") == 0) {
addHeader(headers, "SCRIPT_NAME", "");
addHeader(headers, "PATH_INFO", r->uri);
} else {
addHeader(headers, "SCRIPT_NAME", baseURI);
addHeader(headers, "PATH_INFO", r->uri + strlen(baseURI));
}
// Set HTTP headers.
const apr_array_header_t *hdrs_arr;
apr_table_entry_t *hdrs;
int i;
hdrs_arr = apr_table_elts(r->headers_in);
hdrs = (apr_table_entry_t *) hdrs_arr->elts;
for (i = 0; i < hdrs_arr->nelts; ++i) {
if (hdrs[i].key) {
addHeader(headers, http2env(r->pool, hdrs[i].key), hdrs[i].val);
}
}
// Add other environment variables.
const apr_array_header_t *env_arr;
apr_table_entry_t *env;
env_arr = apr_table_elts(r->subprocess_env);
env = (apr_table_entry_t*) env_arr->elts;
for (i = 0; i < env_arr->nelts; ++i) {
addHeader(headers, env[i].key, env[i].val);
}
// Now send the headers.
string buffer;
hdrs_arr = apr_table_elts(headers);
hdrs = (apr_table_entry_t*) hdrs_arr->elts;
buffer.reserve(1024 * 4);
for (i = 0; i < hdrs_arr->nelts; ++i) {
buffer.append(hdrs[i].key);
buffer.append(1, '\0');
buffer.append(hdrs[i].val);
buffer.append(1, '\0');
}
/*
* If the last header value is an empty string, then the buffer
* will end with "\0\0". For example, if 'SSLOptions +ExportCertData'
* is set, and there's no client certificate, and 'SSL_CLIENT_CERT'
* is the last header, then the buffer will end with:
*
* "SSL_CLIENT_CERT\0\0"
*
* The data in the buffer will be processed by the AbstractRequestHandler class,
* which is implemented in Ruby. But it uses Hash[*data.split("\0")] to
* unserialize the data. Unfortunately String#split will not transform
* the trailing "\0\0" into an empty string:
*
* "SSL_CLIENT_CERT\0\0".split("\0")
* # => desired result: ["SSL_CLIENT_CERT", ""]
* # => actual result: ["SSL_CLIENT_CERT"]
*
* When that happens, Hash[..] will raise an ArgumentError because
* data.split("\0") does not return an array with a length that is a
* multiple of 2.
*
* So here, we add a dummy header to prevent situations like that from
* happening.
*/
buffer.append("_\0_\0", 4);
session->sendHeaders(buffer);
return APR_SUCCESS;
}
void throwUploadBufferingException(request_rec *r, int code) {
DirConfig *config = getDirConfig(r);
string message("An error occured while "
"buffering HTTP upload data to "
"a temporary file in ");
message.append(config->getUploadBufferDir());
switch (code) {
case ENOSPC:
message.append(". Disk directory doesn't have enough disk space, "
"so please make sure that it has "
"enough disk space for buffering file uploads, "
"or set the 'PassengerUploadBufferDir' directive "
"to a directory that has enough disk space.");
throw RuntimeException(message);
break;
case EDQUOT:
message.append(". The current Apache worker process (which is "
"running as ");
message.append(getProcessUsername());
message.append(") cannot write to this directory because of "
"disk quota limits. Please make sure that the volume "
"that this directory resides on has enough disk space "
"quota for the Apache worker process, or set the "
"'PassengerUploadBufferDir' directive to a different "
"directory that has enough disk space quota.");
throw RuntimeException(message);
break;
case ENOENT:
message.append(". This directory doesn't exist, so please make "
"sure that this directory exists, or set the "
"'PassengerUploadBufferDir' directive to a "
"directory that exists and can be written to.");
throw RuntimeException(message);
break;
case EACCES:
message.append(". The current Apache worker process (which is "
"running as ");
message.append(getProcessUsername());
message.append(") doesn't have permissions to write to this "
"directory. Please change the permissions for this "
"directory (as well as all parent directories) so that "
"it is writable by the Apache worker process, or set "
"the 'PassengerUploadBufferDir' directive to a directory "
"that Apache can write to.");
throw RuntimeException(message);
break;
default:
throw SystemException(message, code);
break;
}
}
/**
* Reads the next chunk of the request body and put it into a buffer.
*
* This is like ap_get_client_block(), but can actually report errors
* in a sane way. ap_get_client_block() tells you that something went
* wrong, but not *what* went wrong.
*
* @param r The current request.
* @param buffer A buffer to put the read data into.
* @param bufsiz The size of the buffer.
* @return The number of bytes read, or 0 on EOF.
* @throws RuntimeException Something non-I/O related went wrong, e.g.
* failure to allocate memory and stuff.
* @throws IOException An I/O error occurred while trying to read the
* request body data.
*/
unsigned long readRequestBodyFromApache(request_rec *r, char *buffer, apr_size_t bufsiz) {
apr_status_t rv;
apr_bucket_brigade *bb;
if (r->remaining < 0 || (!r->read_chunked && r->remaining == 0)) {
return 0;
}
bb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
if (bb == NULL) {
r->connection->keepalive = AP_CONN_CLOSE;
throw RuntimeException("An error occurred while receiving HTTP upload data: "
"unable to create a bucket brigade. Maybe the system doesn't have "
"enough free memory.");
}
rv = ap_get_brigade(r->input_filters, bb, AP_MODE_READBYTES,
APR_BLOCK_READ, bufsiz);
/* We lose the failure code here. This is why ap_get_client_block should
* not be used.
*/
if (rv != APR_SUCCESS) {
/* if we actually fail here, we want to just return and
* stop trying to read data from the client.
*/