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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Passenger: Configuration.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<h1>Configuration.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Phusion Passenger - http://www.modrails.com/</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright (c) 2008, 2009 Phusion</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span>
<a name="l00008"></a>00008 <span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span>
<a name="l00009"></a>00009 <span class="comment"> * in the Software without restriction, including without limitation the rights</span>
<a name="l00010"></a>00010 <span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
<a name="l00011"></a>00011 <span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span>
<a name="l00012"></a>00012 <span class="comment"> * furnished to do so, subject to the following conditions:</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * The above copyright notice and this permission notice shall be included in</span>
<a name="l00015"></a>00015 <span class="comment"> * all copies or substantial portions of the Software.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<a name="l00018"></a>00018 <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<a name="l00019"></a>00019 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
<a name="l00020"></a>00020 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<a name="l00021"></a>00021 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
<a name="l00022"></a>00022 <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
<a name="l00023"></a>00023 <span class="comment"> * THE SOFTWARE.</span>
<a name="l00024"></a>00024 <span class="comment"> */</span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_CONFIGURATION_H_</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_CONFIGURATION_H_</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor"> #include "Utils.h"</span>
<a name="l00030"></a>00030 <span class="preprocessor"> #include "MessageChannel.h"</span>
<a name="l00031"></a>00031 <span class="preprocessor"> #include "Logging.h"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#endif</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00034"></a>00034 <span class="comment">/* The APR headers must come after the Passenger headers. See Hooks.cpp</span>
<a name="l00035"></a>00035 <span class="comment"> * to learn why.</span>
<a name="l00036"></a>00036 <span class="comment"> *</span>
<a name="l00037"></a>00037 <span class="comment"> * MessageChannel.h must be included -- even though we don't actually use</span>
<a name="l00038"></a>00038 <span class="comment"> * MessageChannel.h in here, it's necessary to make sure that apr_want.h</span>
<a name="l00039"></a>00039 <span class="comment"> * doesn't b0rk on 'struct iovec'.</span>
<a name="l00040"></a>00040 <span class="comment"> */</span>
<a name="l00041"></a>00041 <span class="preprocessor">#include <apr_pools.h></span>
<a name="l00042"></a>00042 <span class="preprocessor">#include <httpd.h></span>
<a name="l00043"></a>00043 <span class="preprocessor">#include <http_config.h></span>
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">/**</span>
<a name="l00046"></a>00046 <span class="comment"> * @defgroup Configuration Apache module configuration</span>
<a name="l00047"></a>00047 <span class="comment"> * @ingroup Core</span>
<a name="l00048"></a>00048 <span class="comment"> * @{</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor"> #include <set></span>
<a name="l00053"></a>00053 <span class="preprocessor"> #include <string></span>
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="keyword">namespace </span>Passenger {
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="keyword">using namespace </span>std;
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /**</span>
<a name="l00060"></a>00060 <span class="comment"> * Per-directory configuration information.</span>
<a name="l00061"></a>00061 <span class="comment"> *</span>
<a name="l00062"></a>00062 <span class="comment"> * Use the getter methods to query information, because those will return</span>
<a name="l00063"></a>00063 <span class="comment"> * the default value if the value is not specified.</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a>00065 <span class="keyword">struct </span>DirConfig {
<a name="l00066"></a>00066 <span class="keyword">enum</span> Threeway { ENABLED, DISABLED, UNSET };
<a name="l00067"></a>00067 <span class="keyword">enum</span> SpawnMethod { SM_UNSET, SM_SMART, SM_SMART_LV2, SM_CONSERVATIVE };
<a name="l00068"></a>00068
<a name="l00069"></a>00069 Threeway enabled;
<a name="l00070"></a>00070
<a name="l00071"></a>00071 std::set<std::string> railsBaseURIs;
<a name="l00072"></a>00072 std::set<std::string> rackBaseURIs;
<a name="l00073"></a>00073 <span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment"> /** Whether to autodetect Rails applications. */</span>
<a name="l00075"></a>00075 Threeway autoDetectRails;
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment"> /** Whether to autodetect Rack applications. */</span>
<a name="l00078"></a>00078 Threeway autoDetectRack;
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> /** Whether to autodetect WSGI applications. */</span>
<a name="l00081"></a>00081 Threeway autoDetectWSGI;
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment"> /** Whether mod_rewrite should be allowed for Rails applications. */</span>
<a name="l00084"></a>00084 Threeway allowModRewrite;
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> /** The environment (i.e. value for RAILS_ENV) under which</span>
<a name="l00087"></a>00087 <span class="comment"> * Rails applications should operate. */</span>
<a name="l00088"></a>00088 <span class="keyword">const</span> <span class="keywordtype">char</span> *railsEnv;
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment"> /** The path to the application's root (for example: RAILS_ROOT</span>
<a name="l00091"></a>00091 <span class="comment"> * for Rails applications, directory containing 'config.ru'</span>
<a name="l00092"></a>00092 <span class="comment"> * for Rack applications). If this value is NULL, the default</span>
<a name="l00093"></a>00093 <span class="comment"> * autodetected path will be used.</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 <span class="keyword">const</span> <span class="keywordtype">char</span> *appRoot;
<a name="l00096"></a>00096 <span class="comment"></span>
<a name="l00097"></a>00097 <span class="comment"> /** The environment (i.e. value for RACK_ENV) under which</span>
<a name="l00098"></a>00098 <span class="comment"> * Rack applications should operate. */</span>
<a name="l00099"></a>00099 <span class="keyword">const</span> <span class="keywordtype">char</span> *rackEnv;
<a name="l00100"></a>00100 <span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment"> /** The Rails spawn method to use. */</span>
<a name="l00102"></a>00102 SpawnMethod spawnMethod;
<a name="l00103"></a>00103 <span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment"> /**</span>
<a name="l00105"></a>00105 <span class="comment"> * The idle timeout, in seconds, of Rails framework spawners.</span>
<a name="l00106"></a>00106 <span class="comment"> * May also be 0 (which indicates that the framework spawner should</span>
<a name="l00107"></a>00107 <span class="comment"> * never idle timeout) or -1 (which means that the value is not specified).</span>
<a name="l00108"></a>00108 <span class="comment"> */</span>
<a name="l00109"></a>00109 <span class="keywordtype">long</span> frameworkSpawnerTimeout;
<a name="l00110"></a>00110 <span class="comment"></span>
<a name="l00111"></a>00111 <span class="comment"> /**</span>
<a name="l00112"></a>00112 <span class="comment"> * The idle timeout, in seconds, of Rails application spawners.</span>
<a name="l00113"></a>00113 <span class="comment"> * May also be 0 (which indicates that the application spawner should</span>
<a name="l00114"></a>00114 <span class="comment"> * never idle timeout) or -1 (which means that the value is not specified).</span>
<a name="l00115"></a>00115 <span class="comment"> */</span>
<a name="l00116"></a>00116 <span class="keywordtype">long</span> appSpawnerTimeout;
<a name="l00117"></a>00117 <span class="comment"></span>
<a name="l00118"></a>00118 <span class="comment"> /**</span>
<a name="l00119"></a>00119 <span class="comment"> * The maximum number of requests that the spawned application may process</span>
<a name="l00120"></a>00120 <span class="comment"> * before exiting. A value of 0 means unlimited.</span>
<a name="l00121"></a>00121 <span class="comment"> */</span>
<a name="l00122"></a>00122 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxRequests;
<a name="l00123"></a>00123 <span class="comment"></span>
<a name="l00124"></a>00124 <span class="comment"> /** Indicates whether the maxRequests option was explicitly specified</span>
<a name="l00125"></a>00125 <span class="comment"> * in the directory configuration. */</span>
<a name="l00126"></a>00126 <span class="keywordtype">bool</span> maxRequestsSpecified;
<a name="l00127"></a>00127 <span class="comment"></span>
<a name="l00128"></a>00128 <span class="comment"> /**</span>
<a name="l00129"></a>00129 <span class="comment"> * The maximum amount of memory (in MB) the spawned application may use.</span>
<a name="l00130"></a>00130 <span class="comment"> * A value of 0 means unlimited.</span>
<a name="l00131"></a>00131 <span class="comment"> */</span>
<a name="l00132"></a>00132 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> memoryLimit;
<a name="l00133"></a>00133 <span class="comment"></span>
<a name="l00134"></a>00134 <span class="comment"> /** Indicates whether the memoryLimit option was explicitly specified</span>
<a name="l00135"></a>00135 <span class="comment"> * in the directory configuration. */</span>
<a name="l00136"></a>00136 <span class="keywordtype">bool</span> memoryLimitSpecified;
<a name="l00137"></a>00137 <span class="comment"></span>
<a name="l00138"></a>00138 <span class="comment"> /** Whether symlinks in the document root path should be resolved.</span>
<a name="l00139"></a>00139 <span class="comment"> * The implication of this is documented in the users guide, section</span>
<a name="l00140"></a>00140 <span class="comment"> * "How Phusion Passenger detects whether a virtual host is a web application".</span>
<a name="l00141"></a>00141 <span class="comment"> */</span>
<a name="l00142"></a>00142 Threeway resolveSymlinksInDocRoot;
<a name="l00143"></a>00143 <span class="comment"></span>
<a name="l00144"></a>00144 <span class="comment"> /** Whether high performance mode should be turned on. */</span>
<a name="l00145"></a>00145 Threeway highPerformance;
<a name="l00146"></a>00146 <span class="comment"></span>
<a name="l00147"></a>00147 <span class="comment"> /** Whether global queuing should be used. */</span>
<a name="l00148"></a>00148 Threeway useGlobalQueue;
<a name="l00149"></a>00149 <span class="comment"></span>
<a name="l00150"></a>00150 <span class="comment"> /**</span>
<a name="l00151"></a>00151 <span class="comment"> * Whether encoded slashes in URLs should be supported. This however conflicts</span>
<a name="l00152"></a>00152 <span class="comment"> * with mod_rewrite support because of a bug/limitation in Apache, so it's one</span>
<a name="l00153"></a>00153 <span class="comment"> * or the other.</span>
<a name="l00154"></a>00154 <span class="comment"> */</span>
<a name="l00155"></a>00155 Threeway allowEncodedSlashes;
<a name="l00156"></a>00156 <span class="comment"></span>
<a name="l00157"></a>00157 <span class="comment"> /**</span>
<a name="l00158"></a>00158 <span class="comment"> * Throttle the number of stat() calls on files like</span>
<a name="l00159"></a>00159 <span class="comment"> * restart.txt to the once per given number of seconds.</span>
<a name="l00160"></a>00160 <span class="comment"> */</span>
<a name="l00161"></a>00161 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> statThrottleRate;
<a name="l00162"></a>00162 <span class="comment"></span>
<a name="l00163"></a>00163 <span class="comment"> /** Indicates whether the statThrottleRate option was</span>
<a name="l00164"></a>00164 <span class="comment"> * explicitly specified in the directory configuration. */</span>
<a name="l00165"></a>00165 <span class="keywordtype">bool</span> statThrottleRateSpecified;
<a name="l00166"></a>00166 <span class="comment"></span>
<a name="l00167"></a>00167 <span class="comment"> /** The directory in which Passenger should look for</span>
<a name="l00168"></a>00168 <span class="comment"> * restart.txt. NULL means that the default directory</span>
<a name="l00169"></a>00169 <span class="comment"> * should be used.</span>
<a name="l00170"></a>00170 <span class="comment"> */</span>
<a name="l00171"></a>00171 <span class="keyword">const</span> <span class="keywordtype">char</span> *restartDir;
<a name="l00172"></a>00172 <span class="comment"></span>
<a name="l00173"></a>00173 <span class="comment"> /**</span>
<a name="l00174"></a>00174 <span class="comment"> * The directory in which Passenger should place upload buffer</span>
<a name="l00175"></a>00175 <span class="comment"> * files. NULL means that the default directory should be used.</span>
<a name="l00176"></a>00176 <span class="comment"> */</span>
<a name="l00177"></a>00177 <span class="keyword">const</span> <span class="keywordtype">char</span> *uploadBufferDir;
<a name="l00178"></a>00178
<a name="l00179"></a>00179 <span class="comment">/*************************************/</span>
<a name="l00180"></a>00180 <span class="comment">/*************************************/</span>
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="keywordtype">bool</span> isEnabled()<span class="keyword"> const </span>{
<a name="l00183"></a>00183 <span class="keywordflow">return</span> enabled != DISABLED;
<a name="l00184"></a>00184 }
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="keywordtype">string</span> getAppRoot(<span class="keyword">const</span> <span class="keywordtype">char</span> *documentRoot)<span class="keyword"> const </span>{
<a name="l00187"></a>00187 <span class="keywordflow">if</span> (appRoot == NULL) {
<a name="l00188"></a>00188 <span class="keywordflow">if</span> (resolveSymlinksInDocRoot == DirConfig::ENABLED) {
<a name="l00189"></a>00189 <span class="keywordflow">return</span> extractDirName(resolveSymlink(documentRoot));
<a name="l00190"></a>00190 } <span class="keywordflow">else</span> {
<a name="l00191"></a>00191 <span class="keywordflow">return</span> extractDirName(documentRoot);
<a name="l00192"></a>00192 }
<a name="l00193"></a>00193 } <span class="keywordflow">else</span> {
<a name="l00194"></a>00194 <span class="keywordflow">return</span> appRoot;
<a name="l00195"></a>00195 }
<a name="l00196"></a>00196 }
<a name="l00197"></a>00197
<a name="l00198"></a>00198 <span class="keywordtype">string</span> getAppRoot(<span class="keyword">const</span> <span class="keywordtype">string</span> &documentRoot)<span class="keyword"> const </span>{
<a name="l00199"></a>00199 <span class="keywordflow">if</span> (appRoot == NULL) {
<a name="l00200"></a>00200 <span class="keywordflow">if</span> (resolveSymlinksInDocRoot == DirConfig::ENABLED) {
<a name="l00201"></a>00201 <span class="keywordflow">return</span> extractDirName(resolveSymlink(documentRoot));
<a name="l00202"></a>00202 } <span class="keywordflow">else</span> {
<a name="l00203"></a>00203 <span class="keywordflow">return</span> extractDirName(documentRoot);
<a name="l00204"></a>00204 }
<a name="l00205"></a>00205 } <span class="keywordflow">else</span> {
<a name="l00206"></a>00206 <span class="keywordflow">return</span> appRoot;
<a name="l00207"></a>00207 }
<a name="l00208"></a>00208 }
<a name="l00209"></a>00209
<a name="l00210"></a>00210 <span class="keyword">const</span> <span class="keywordtype">char</span> *getRailsEnv()<span class="keyword"> const </span>{
<a name="l00211"></a>00211 <span class="keywordflow">if</span> (railsEnv != NULL) {
<a name="l00212"></a>00212 <span class="keywordflow">return</span> railsEnv;
<a name="l00213"></a>00213 } <span class="keywordflow">else</span> {
<a name="l00214"></a>00214 <span class="keywordflow">return</span> <span class="stringliteral">"production"</span>;
<a name="l00215"></a>00215 }
<a name="l00216"></a>00216 }
<a name="l00217"></a>00217
<a name="l00218"></a>00218 <span class="keyword">const</span> <span class="keywordtype">char</span> *getRackEnv()<span class="keyword"> const </span>{
<a name="l00219"></a>00219 <span class="keywordflow">if</span> (rackEnv != NULL) {
<a name="l00220"></a>00220 <span class="keywordflow">return</span> rackEnv;
<a name="l00221"></a>00221 } <span class="keywordflow">else</span> {
<a name="l00222"></a>00222 <span class="keywordflow">return</span> <span class="stringliteral">"production"</span>;
<a name="l00223"></a>00223 }
<a name="l00224"></a>00224 }
<a name="l00225"></a>00225
<a name="l00226"></a>00226 <span class="keyword">const</span> <span class="keywordtype">char</span> *getSpawnMethodString() {
<a name="l00227"></a>00227 <span class="keywordflow">switch</span> (spawnMethod) {
<a name="l00228"></a>00228 <span class="keywordflow">case</span> SM_SMART:
<a name="l00229"></a>00229 <span class="keywordflow">return</span> <span class="stringliteral">"smart"</span>;
<a name="l00230"></a>00230 <span class="keywordflow">case</span> SM_SMART_LV2:
<a name="l00231"></a>00231 <span class="keywordflow">return</span> <span class="stringliteral">"smart-lv2"</span>;
<a name="l00232"></a>00232 <span class="keywordflow">case</span> SM_CONSERVATIVE:
<a name="l00233"></a>00233 <span class="keywordflow">return</span> <span class="stringliteral">"conservative"</span>;
<a name="l00234"></a>00234 <span class="keywordflow">default</span>:
<a name="l00235"></a>00235 <span class="keywordflow">return</span> <span class="stringliteral">"smart-lv2"</span>;
<a name="l00236"></a>00236 }
<a name="l00237"></a>00237 }
<a name="l00238"></a>00238
<a name="l00239"></a>00239 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> getMaxRequests() {
<a name="l00240"></a>00240 <span class="keywordflow">if</span> (maxRequestsSpecified) {
<a name="l00241"></a>00241 <span class="keywordflow">return</span> maxRequests;
<a name="l00242"></a>00242 } <span class="keywordflow">else</span> {
<a name="l00243"></a>00243 <span class="keywordflow">return</span> 0;
<a name="l00244"></a>00244 }
<a name="l00245"></a>00245 }
<a name="l00246"></a>00246
<a name="l00247"></a>00247 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> getMemoryLimit() {
<a name="l00248"></a>00248 <span class="keywordflow">if</span> (memoryLimitSpecified) {
<a name="l00249"></a>00249 <span class="keywordflow">return</span> memoryLimit;
<a name="l00250"></a>00250 } <span class="keywordflow">else</span> {
<a name="l00251"></a>00251 <span class="keywordflow">return</span> 200;
<a name="l00252"></a>00252 }
<a name="l00253"></a>00253 }
<a name="l00254"></a>00254
<a name="l00255"></a>00255 <span class="keywordtype">bool</span> highPerformanceMode()<span class="keyword"> const </span>{
<a name="l00256"></a>00256 <span class="keywordflow">return</span> highPerformance == ENABLED;
<a name="l00257"></a>00257 }
<a name="l00258"></a>00258
<a name="l00259"></a>00259 <span class="keywordtype">bool</span> usingGlobalQueue()<span class="keyword"> const </span>{
<a name="l00260"></a>00260 <span class="keywordflow">return</span> useGlobalQueue == ENABLED;
<a name="l00261"></a>00261 }
<a name="l00262"></a>00262
<a name="l00263"></a>00263 <span class="keywordtype">bool</span> allowsEncodedSlashes()<span class="keyword"> const </span>{
<a name="l00264"></a>00264 <span class="keywordflow">return</span> allowEncodedSlashes == ENABLED;
<a name="l00265"></a>00265 }
<a name="l00266"></a>00266
<a name="l00267"></a>00267 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> getStatThrottleRate()<span class="keyword"> const </span>{
<a name="l00268"></a>00268 <span class="keywordflow">if</span> (statThrottleRateSpecified) {
<a name="l00269"></a>00269 <span class="keywordflow">return</span> statThrottleRate;
<a name="l00270"></a>00270 } <span class="keywordflow">else</span> {
<a name="l00271"></a>00271 <span class="keywordflow">return</span> 0;
<a name="l00272"></a>00272 }
<a name="l00273"></a>00273 }
<a name="l00274"></a>00274
<a name="l00275"></a>00275 <span class="keyword">const</span> <span class="keywordtype">char</span> *getRestartDir()<span class="keyword"> const </span>{
<a name="l00276"></a>00276 <span class="keywordflow">if</span> (restartDir != NULL) {
<a name="l00277"></a>00277 <span class="keywordflow">return</span> restartDir;
<a name="l00278"></a>00278 } <span class="keywordflow">else</span> {
<a name="l00279"></a>00279 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
<a name="l00280"></a>00280 }
<a name="l00281"></a>00281 }
<a name="l00282"></a>00282
<a name="l00283"></a>00283 <span class="keywordtype">string</span> getUploadBufferDir()<span class="keyword"> const </span>{
<a name="l00284"></a>00284 <span class="keywordflow">if</span> (uploadBufferDir != NULL) {
<a name="l00285"></a>00285 <span class="keywordflow">return</span> uploadBufferDir;
<a name="l00286"></a>00286 } <span class="keywordflow">else</span> {
<a name="l00287"></a>00287 <span class="keywordflow">return</span> getPassengerTempDir() + <span class="stringliteral">"/webserver_private"</span>;
<a name="l00288"></a>00288 }
<a name="l00289"></a>00289 }
<a name="l00290"></a>00290
<a name="l00291"></a>00291 <span class="comment">/*************************************/</span>
<a name="l00292"></a>00292 };
<a name="l00293"></a>00293 <span class="comment"></span>
<a name="l00294"></a>00294 <span class="comment"> /**</span>
<a name="l00295"></a>00295 <span class="comment"> * Server-wide (global, not per-virtual host) configuration information.</span>
<a name="l00296"></a>00296 <span class="comment"> *</span>
<a name="l00297"></a>00297 <span class="comment"> * Use the getter methods to query information, because those will return</span>
<a name="l00298"></a>00298 <span class="comment"> * the default value if the value is not specified.</span>
<a name="l00299"></a>00299 <span class="comment"> */</span>
<a name="l00300"></a>00300 <span class="keyword">struct </span>ServerConfig {<span class="comment"></span>
<a name="l00301"></a>00301 <span class="comment"> /** The filename of the Ruby interpreter to use. */</span>
<a name="l00302"></a>00302 <span class="keyword">const</span> <span class="keywordtype">char</span> *ruby;
<a name="l00303"></a>00303 <span class="comment"></span>
<a name="l00304"></a>00304 <span class="comment"> /** The Passenger root folder. */</span>
<a name="l00305"></a>00305 <span class="keyword">const</span> <span class="keywordtype">char</span> *root;
<a name="l00306"></a>00306 <span class="comment"></span>
<a name="l00307"></a>00307 <span class="comment"> /** The log verbosity. */</span>
<a name="l00308"></a>00308 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> logLevel;
<a name="l00309"></a>00309 <span class="comment"></span>
<a name="l00310"></a>00310 <span class="comment"> /** The maximum number of simultaneously alive application</span>
<a name="l00311"></a>00311 <span class="comment"> * instances. */</span>
<a name="l00312"></a>00312 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxPoolSize;
<a name="l00313"></a>00313 <span class="comment"></span>
<a name="l00314"></a>00314 <span class="comment"> /** Whether the maxPoolSize option was explicitly specified in</span>
<a name="l00315"></a>00315 <span class="comment"> * this server config. */</span>
<a name="l00316"></a>00316 <span class="keywordtype">bool</span> maxPoolSizeSpecified;
<a name="l00317"></a>00317 <span class="comment"></span>
<a name="l00318"></a>00318 <span class="comment"> /** The maximum number of simultaneously alive Rails application</span>
<a name="l00319"></a>00319 <span class="comment"> * that a single Rails application may occupy. */</span>
<a name="l00320"></a>00320 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxInstancesPerApp;
<a name="l00321"></a>00321 <span class="comment"></span>
<a name="l00322"></a>00322 <span class="comment"> /** Whether the maxInstancesPerApp option was explicitly specified in</span>
<a name="l00323"></a>00323 <span class="comment"> * this server config. */</span>
<a name="l00324"></a>00324 <span class="keywordtype">bool</span> maxInstancesPerAppSpecified;
<a name="l00325"></a>00325 <span class="comment"></span>
<a name="l00326"></a>00326 <span class="comment"> /** The maximum number of seconds that an application may be</span>
<a name="l00327"></a>00327 <span class="comment"> * idle before it gets terminated. */</span>
<a name="l00328"></a>00328 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> poolIdleTime;
<a name="l00329"></a>00329 <span class="comment"></span>
<a name="l00330"></a>00330 <span class="comment"> /** Whether the poolIdleTime option was explicitly specified in</span>
<a name="l00331"></a>00331 <span class="comment"> * this server config. */</span>
<a name="l00332"></a>00332 <span class="keywordtype">bool</span> poolIdleTimeSpecified;
<a name="l00333"></a>00333 <span class="comment"></span>
<a name="l00334"></a>00334 <span class="comment"> /** Whether user switching support is enabled. */</span>
<a name="l00335"></a>00335 <span class="keywordtype">bool</span> userSwitching;
<a name="l00336"></a>00336 <span class="comment"></span>
<a name="l00337"></a>00337 <span class="comment"> /** Whether the userSwitching option was explicitly specified in</span>
<a name="l00338"></a>00338 <span class="comment"> * this server config. */</span>
<a name="l00339"></a>00339 <span class="keywordtype">bool</span> userSwitchingSpecified;
<a name="l00340"></a>00340 <span class="comment"></span>
<a name="l00341"></a>00341 <span class="comment"> /** The user that applications must run as if user switching</span>
<a name="l00342"></a>00342 <span class="comment"> * fails or is disabled. NULL means the option is not specified.</span>
<a name="l00343"></a>00343 <span class="comment"> */</span>
<a name="l00344"></a>00344 <span class="keyword">const</span> <span class="keywordtype">char</span> *defaultUser;
<a name="l00345"></a>00345 <span class="comment"></span>
<a name="l00346"></a>00346 <span class="comment"> /** The temp directory that Passenger should use. NULL</span>
<a name="l00347"></a>00347 <span class="comment"> * means unspecified.</span>
<a name="l00348"></a>00348 <span class="comment"> */</span>
<a name="l00349"></a>00349 <span class="keyword">const</span> <span class="keywordtype">char</span> *tempDir;
<a name="l00350"></a>00350
<a name="l00351"></a>00351 <span class="keyword">const</span> <span class="keywordtype">char</span> *getRuby()<span class="keyword"> const </span>{
<a name="l00352"></a>00352 <span class="keywordflow">if</span> (ruby != NULL) {
<a name="l00353"></a>00353 <span class="keywordflow">return</span> ruby;
<a name="l00354"></a>00354 } <span class="keywordflow">else</span> {
<a name="l00355"></a>00355 <span class="keywordflow">return</span> <span class="stringliteral">"ruby"</span>;
<a name="l00356"></a>00356 }
<a name="l00357"></a>00357 }
<a name="l00358"></a>00358
<a name="l00359"></a>00359 <span class="keyword">const</span> <span class="keywordtype">char</span> *getDefaultUser()<span class="keyword"> const </span>{
<a name="l00360"></a>00360 <span class="keywordflow">if</span> (defaultUser != NULL) {
<a name="l00361"></a>00361 <span class="keywordflow">return</span> defaultUser;
<a name="l00362"></a>00362 } <span class="keywordflow">else</span> {
<a name="l00363"></a>00363 <span class="keywordflow">return</span> <span class="stringliteral">"nobody"</span>;
<a name="l00364"></a>00364 }
<a name="l00365"></a>00365 }
<a name="l00366"></a>00366
<a name="l00367"></a>00367 <span class="keyword">const</span> <span class="keywordtype">char</span> *getTempDir()<span class="keyword"> const </span>{
<a name="l00368"></a>00368 <span class="keywordflow">if</span> (tempDir != NULL) {
<a name="l00369"></a>00369 <span class="keywordflow">return</span> tempDir;
<a name="l00370"></a>00370 } <span class="keywordflow">else</span> {
<a name="l00371"></a>00371 <span class="keywordflow">return</span> getSystemTempDir();
<a name="l00372"></a>00372 }
<a name="l00373"></a>00373 }
<a name="l00374"></a>00374 };
<a name="l00375"></a>00375 }
<a name="l00376"></a>00376
<a name="l00377"></a>00377 <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00378"></a>00378 <span class="preprocessor">#endif</span>
<a name="l00379"></a>00379 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00380"></a>00380 <span class="comment">/** Configuration hook for per-directory configuration structure creation. */</span>
<a name="l00381"></a>00381 <span class="keywordtype">void</span> *<a class="code" href="group__Configuration.html#g92dc583c1fa5f8025149799e356a6c78" title="Configuration hook for per-directory configuration structure creation.">passenger_config_create_dir</a>(apr_pool_t *p, <span class="keywordtype">char</span> *dirspec);
<a name="l00382"></a>00382 <span class="comment"></span>
<a name="l00383"></a>00383 <span class="comment">/** Configuration hook for per-directory configuration structure merging. */</span>
<a name="l00384"></a>00384 <span class="keywordtype">void</span> *<a class="code" href="group__Configuration.html#g17787a036ef3f4dc46ae0acc9da2c7b0" title="Configuration hook for per-directory configuration structure merging.">passenger_config_merge_dir</a>(apr_pool_t *p, <span class="keywordtype">void</span> *basev, <span class="keywordtype">void</span> *addv);
<a name="l00385"></a>00385 <span class="comment"></span>
<a name="l00386"></a>00386 <span class="comment">/** Configuration hook for per-server configuration structure creation. */</span>
<a name="l00387"></a>00387 <span class="keywordtype">void</span> *<a class="code" href="group__Configuration.html#ga93bd8d426649b4e86da38eb67a49178" title="Configuration hook for per-server configuration structure creation.">passenger_config_create_server</a>(apr_pool_t *p, server_rec *s);
<a name="l00388"></a>00388 <span class="comment"></span>
<a name="l00389"></a>00389 <span class="comment">/** Configuration hook for per-server configuration structure merging. */</span>
<a name="l00390"></a>00390 <span class="keywordtype">void</span> *<a class="code" href="group__Configuration.html#g95c963a61867190928d912779952b15e" title="Configuration hook for per-server configuration structure merging.">passenger_config_merge_server</a>(apr_pool_t *p, <span class="keywordtype">void</span> *basev, <span class="keywordtype">void</span> *overridesv);
<a name="l00391"></a>00391
<a name="l00392"></a>00392 <span class="keywordtype">void</span> passenger_config_merge_all_servers(apr_pool_t *pool, server_rec *main_server);
<a name="l00393"></a>00393 <span class="comment"></span>
<a name="l00394"></a>00394 <span class="comment">/** Apache module commands array. */</span>
<a name="l00395"></a>00395 <span class="keyword">extern</span> <span class="keyword">const</span> command_rec <a class="code" href="group__Configuration.html#g21954abbf4018583acb9d8daef3dfd95" title="Apache module commands array.">passenger_commands</a>[];
<a name="l00396"></a>00396
<a name="l00397"></a>00397 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00398"></a>00398 <span class="preprocessor"></span> }
<a name="l00399"></a>00399 <span class="preprocessor">#endif</span>
<a name="l00400"></a>00400 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00401"></a>00401 <span class="comment">/**</span>
<a name="l00402"></a>00402 <span class="comment"> * @}</span>
<a name="l00403"></a>00403 <span class="comment"> */</span>
<a name="l00404"></a>00404
<a name="l00405"></a>00405 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_CONFIGURATION_H_ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 5 11:13:03 2010 for Passenger by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
|
