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
|
<!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: ServerInstanceDir.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="namespaces.html"><span>Namespaces</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>ServerInstanceDir.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) 2010 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_SERVER_INSTANCE_DIR_H_</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_SERVER_INSTANCE_DIR_H_</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <boost/noncopyable.hpp></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <boost/shared_ptr.hpp></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#include <sys/types.h></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <dirent.h></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <unistd.h></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <pwd.h></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include <grp.h></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <cstdlib></span>
<a name="l00037"></a>00037 <span class="preprocessor">#include <cstring></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include <string></span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="preprocessor">#include "Exceptions.h"</span>
<a name="l00041"></a>00041 <span class="preprocessor">#include "Utils.h"</span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="keyword">namespace </span>Passenger {
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="keyword">using namespace </span>std;
<a name="l00046"></a>00046 <span class="keyword">using namespace </span>boost;
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keyword">class </span>ServerInstanceDir: <span class="keyword">public</span> noncopyable {
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050 <span class="comment">// Don't forget to update lib/phusion_passenger/admin_tools/server_instance.rb too.</span>
<a name="l00051"></a>00051 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> DIR_STRUCTURE_MAJOR_VERSION = 1;
<a name="l00052"></a>00052 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> DIR_STRUCTURE_MINOR_VERSION = 0;
<a name="l00053"></a>00053 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> GENERATION_STRUCTURE_MAJOR_VERSION = 1;
<a name="l00054"></a>00054 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> GENERATION_STRUCTURE_MINOR_VERSION = 0;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">class </span>Generation: <span class="keyword">public</span> noncopyable {
<a name="l00057"></a>00057 <span class="keyword">private</span>:
<a name="l00058"></a>00058 <span class="keyword">friend</span> <span class="keyword">class </span>ServerInstanceDir;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keywordtype">string</span> path;
<a name="l00061"></a>00061 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> number;
<a name="l00062"></a>00062 <span class="keywordtype">bool</span> owner;
<a name="l00063"></a>00063
<a name="l00064"></a>00064 Generation(<span class="keyword">const</span> <span class="keywordtype">string</span> &serverInstanceDir, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> number) {
<a name="l00065"></a>00065 path = serverInstanceDir + <span class="stringliteral">"/generation-"</span> + <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(number);
<a name="l00066"></a>00066 this->number = number;
<a name="l00067"></a>00067 owner = <span class="keyword">false</span>;
<a name="l00068"></a>00068 }
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keywordtype">void</span> create(<span class="keywordtype">bool</span> userSwitching, <span class="keyword">const</span> <span class="keywordtype">string</span> &defaultUser,
<a name="l00071"></a>00071 <span class="keyword">const</span> <span class="keywordtype">string</span> &defaultGroup, uid_t webServerWorkerUid,
<a name="l00072"></a>00072 gid_t webServerWorkerGid)
<a name="l00073"></a>00073 {
<a name="l00074"></a>00074 <span class="keywordtype">bool</span> runningAsRoot = geteuid() == 0;
<a name="l00075"></a>00075 <span class="keyword">struct </span>passwd *defaultUserEntry;
<a name="l00076"></a>00076 <span class="keyword">struct </span>group *defaultGroupEntry;
<a name="l00077"></a>00077 uid_t defaultUid;
<a name="l00078"></a>00078 gid_t defaultGid;
<a name="l00079"></a>00079
<a name="l00080"></a>00080 defaultUserEntry = getpwnam(defaultUser.c_str());
<a name="l00081"></a>00081 <span class="keywordflow">if</span> (defaultUserEntry == NULL) {
<a name="l00082"></a>00082 <span class="keywordflow">throw</span> NonExistentUserException(<span class="stringliteral">"Default user '"</span> + defaultUser +
<a name="l00083"></a>00083 <span class="stringliteral">"' does not exist."</span>);
<a name="l00084"></a>00084 }
<a name="l00085"></a>00085 defaultUid = defaultUserEntry->pw_uid;
<a name="l00086"></a>00086 defaultGroupEntry = getgrnam(defaultGroup.c_str());
<a name="l00087"></a>00087 <span class="keywordflow">if</span> (defaultGroupEntry == NULL) {
<a name="l00088"></a>00088 <span class="keywordflow">throw</span> NonExistentGroupException(<span class="stringliteral">"Default group '"</span> + defaultGroup +
<a name="l00089"></a>00089 <span class="stringliteral">"' does not exist."</span>);
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091 defaultGid = defaultGroupEntry->gr_gid;
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="comment">/* We set a very tight permission here: no read or write access for</span>
<a name="l00094"></a>00094 <span class="comment"> * anybody except the owner. The individual files and subdirectories</span>
<a name="l00095"></a>00095 <span class="comment"> * decide for themselves whether they're readable by anybody.</span>
<a name="l00096"></a>00096 <span class="comment"> */</span>
<a name="l00097"></a>00097 <a class="code" href="namespacePassenger.html#448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path, <span class="stringliteral">"u=rwxs,g=x,o=x"</span>);
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="comment">/* Write structure version file. */</span>
<a name="l00100"></a>00100 <span class="keywordtype">string</span> structureVersionFile = path + <span class="stringliteral">"/structure_version.txt"</span>;
<a name="l00101"></a>00101 <a class="code" href="group__Support.html#g6f414070373465da2e12947463f69953" title="Create the given file with the given contents, permissions and ownership.">createFile</a>(structureVersionFile,
<a name="l00102"></a>00102 <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(GENERATION_STRUCTURE_MAJOR_VERSION) + <span class="stringliteral">"."</span> +
<a name="l00103"></a>00103 <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(GENERATION_STRUCTURE_MINOR_VERSION),
<a name="l00104"></a>00104 S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
<a name="l00105"></a>00105
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="comment">/* We want the upload buffer directory to be only writable by the web</span>
<a name="l00108"></a>00108 <span class="comment"> * server's worker processs. Other users may not have any access to this</span>
<a name="l00109"></a>00109 <span class="comment"> * directory.</span>
<a name="l00110"></a>00110 <span class="comment"> */</span>
<a name="l00111"></a>00111 <span class="keywordflow">if</span> (runningAsRoot) {
<a name="l00112"></a>00112 <a class="code" href="namespacePassenger.html#448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">"/buffered_uploads"</span>, <span class="stringliteral">"u=rwxs,g=,o="</span>,
<a name="l00113"></a>00113 webServerWorkerUid, webServerWorkerGid);
<a name="l00114"></a>00114 } <span class="keywordflow">else</span> {
<a name="l00115"></a>00115 <a class="code" href="namespacePassenger.html#448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">"/buffered_uploads"</span>, <span class="stringliteral">"u=rwxs,g=,o="</span>);
<a name="l00116"></a>00116 }
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="comment">/* The web server must be able to directly connect to a backend. */</span>
<a name="l00119"></a>00119 <span class="keywordflow">if</span> (runningAsRoot) {
<a name="l00120"></a>00120 <span class="keywordflow">if</span> (userSwitching) {
<a name="l00121"></a>00121 <span class="comment">/* Each backend process may be running as a different user,</span>
<a name="l00122"></a>00122 <span class="comment"> * so the backends subdirectory must be world-writable.</span>
<a name="l00123"></a>00123 <span class="comment"> * However we don't want everybody to be able to know the</span>
<a name="l00124"></a>00124 <span class="comment"> * sockets' filenames, so the directory is not readable.</span>
<a name="l00125"></a>00125 <span class="comment"> */</span>
<a name="l00126"></a>00126 <a class="code" href="namespacePassenger.html#448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">"/backends"</span>, <span class="stringliteral">"u=rwxs,g=wx,o=wx"</span>);
<a name="l00127"></a>00127 } <span class="keywordflow">else</span> {
<a name="l00128"></a>00128 <span class="comment">/* All backend processes are running as defaultUser/defaultGroup,</span>
<a name="l00129"></a>00129 <span class="comment"> * so make defaultUser/defaultGroup the owner and group of the</span>
<a name="l00130"></a>00130 <span class="comment"> * subdirecory.</span>
<a name="l00131"></a>00131 <span class="comment"> *</span>
<a name="l00132"></a>00132 <span class="comment"> * The directory is not readable as a security precaution:</span>
<a name="l00133"></a>00133 <span class="comment"> * nobody should be able to know the sockets' filenames without</span>
<a name="l00134"></a>00134 <span class="comment"> * having access to the application pool.</span>
<a name="l00135"></a>00135 <span class="comment"> */</span>
<a name="l00136"></a>00136 <a class="code" href="namespacePassenger.html#448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">"/backends"</span>, <span class="stringliteral">"u=rwxs,g=x,o=x"</span>, defaultUid, defaultGid);
<a name="l00137"></a>00137 }
<a name="l00138"></a>00138 } <span class="keywordflow">else</span> {
<a name="l00139"></a>00139 <span class="comment">/* All backend processes are running as the same user as the web server,</span>
<a name="l00140"></a>00140 <span class="comment"> * so only allow access for this user.</span>
<a name="l00141"></a>00141 <span class="comment"> */</span>
<a name="l00142"></a>00142 <a class="code" href="namespacePassenger.html#448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">"/backends"</span>, <span class="stringliteral">"u=rwxs,g=,o="</span>);
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="comment">/* The helper server (containing the application pool) must be able to access</span>
<a name="l00146"></a>00146 <span class="comment"> * the spawn server's socket.</span>
<a name="l00147"></a>00147 <span class="comment"> */</span>
<a name="l00148"></a>00148 <span class="keywordflow">if</span> (runningAsRoot) {
<a name="l00149"></a>00149 <span class="keywordflow">if</span> (userSwitching) {
<a name="l00150"></a>00150 <span class="comment">/* Both the helper server and the spawn server are</span>
<a name="l00151"></a>00151 <span class="comment"> * running as root.</span>
<a name="l00152"></a>00152 <span class="comment"> */</span>
<a name="l00153"></a>00153 <a class="code" href="namespacePassenger.html#448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">"/spawn-server"</span>, <span class="stringliteral">"u=rwxs,g=,o="</span>);
<a name="l00154"></a>00154 } <span class="keywordflow">else</span> {
<a name="l00155"></a>00155 <span class="comment">/* Both the helper server and the spawn server are</span>
<a name="l00156"></a>00156 <span class="comment"> * running as defaultUser/defaultGroup.</span>
<a name="l00157"></a>00157 <span class="comment"> */</span>
<a name="l00158"></a>00158 <a class="code" href="namespacePassenger.html#448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">"/spawn-server"</span>, <span class="stringliteral">"u=rwxs,g=,o="</span>,
<a name="l00159"></a>00159 defaultUid, defaultGid);
<a name="l00160"></a>00160 }
<a name="l00161"></a>00161 } <span class="keywordflow">else</span> {
<a name="l00162"></a>00162 <a class="code" href="namespacePassenger.html#448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path + <span class="stringliteral">"/spawn-server"</span>, <span class="stringliteral">"u=rwxs,g=,o="</span>);
<a name="l00163"></a>00163 }
<a name="l00164"></a>00164
<a name="l00165"></a>00165 owner = <span class="keyword">true</span>;
<a name="l00166"></a>00166 }
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="keyword">public</span>:
<a name="l00169"></a>00169 ~Generation() {
<a name="l00170"></a>00170 <span class="keywordflow">if</span> (owner) {
<a name="l00171"></a>00171 <a class="code" href="namespacePassenger.html#8422d210cbd2f62d21254415b5a7f747" title="Remove an entire directory tree recursively.">removeDirTree</a>(path);
<a name="l00172"></a>00172 }
<a name="l00173"></a>00173 }
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getNumber()<span class="keyword"> const </span>{
<a name="l00176"></a>00176 <span class="keywordflow">return</span> number;
<a name="l00177"></a>00177 }
<a name="l00178"></a>00178
<a name="l00179"></a>00179 <span class="keywordtype">string</span> getPath()<span class="keyword"> const </span>{
<a name="l00180"></a>00180 <span class="keywordflow">return</span> path;
<a name="l00181"></a>00181 }
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <span class="keywordtype">void</span> detach() {
<a name="l00184"></a>00184 owner = <span class="keyword">false</span>;
<a name="l00185"></a>00185 }
<a name="l00186"></a>00186 };
<a name="l00187"></a>00187
<a name="l00188"></a>00188 <span class="keyword">typedef</span> shared_ptr<Generation> GenerationPtr;
<a name="l00189"></a>00189
<a name="l00190"></a>00190 <span class="keyword">private</span>:
<a name="l00191"></a>00191 <span class="keywordtype">string</span> path;
<a name="l00192"></a>00192 <span class="keywordtype">bool</span> owner;
<a name="l00193"></a>00193
<a name="l00194"></a>00194 <span class="keyword">friend</span> <span class="keyword">class </span>Generation;
<a name="l00195"></a>00195
<a name="l00196"></a>00196 <span class="keywordtype">void</span> initialize(<span class="keyword">const</span> <span class="keywordtype">string</span> &path, <span class="keywordtype">bool</span> owner) {
<a name="l00197"></a>00197 this->path = path;
<a name="l00198"></a>00198 this->owner = owner;
<a name="l00199"></a>00199
<a name="l00200"></a>00200 <span class="comment">/* Create the server instance directory. We only need to write to this</span>
<a name="l00201"></a>00201 <span class="comment"> * directory for these reasons:</span>
<a name="l00202"></a>00202 <span class="comment"> * 1. Initial population of structure files (structure_version.txt, instance.pid).</span>
<a name="l00203"></a>00203 <span class="comment"> * 2. Creating/removing a generation directory.</span>
<a name="l00204"></a>00204 <span class="comment"> * 3. Removing the entire server instance directory (after all</span>
<a name="l00205"></a>00205 <span class="comment"> * generations are removed).</span>
<a name="l00206"></a>00206 <span class="comment"> *</span>
<a name="l00207"></a>00207 <span class="comment"> * 1 and 2 are done by the helper server during initialization and before lowering</span>
<a name="l00208"></a>00208 <span class="comment"> * privilege. 3 is done during helper server shutdown by a cleanup process that's</span>
<a name="l00209"></a>00209 <span class="comment"> * running as the same user the helper server was running as before privilege</span>
<a name="l00210"></a>00210 <span class="comment"> * lowering.</span>
<a name="l00211"></a>00211 <span class="comment"> * Therefore, we make the directory only writable by the user the helper server</span>
<a name="l00212"></a>00212 <span class="comment"> * was running as before privilege is lowered. Everybody else has read and execute</span>
<a name="l00213"></a>00213 <span class="comment"> * rights though, because we want admin tools to be able to list the available</span>
<a name="l00214"></a>00214 <span class="comment"> * generations no matter what user they're running as.</span>
<a name="l00215"></a>00215 <span class="comment"> */</span>
<a name="l00216"></a>00216 <a class="code" href="namespacePassenger.html#448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(path, <span class="stringliteral">"u=rwxs,g=rx,o=rx"</span>);
<a name="l00217"></a>00217 }
<a name="l00218"></a>00218
<a name="l00219"></a>00219 <span class="keyword">public</span>:
<a name="l00220"></a>00220 ServerInstanceDir(pid_t webServerPid, <span class="keyword">const</span> <span class="keywordtype">string</span> &parentDir = <span class="stringliteral">""</span>, <span class="keywordtype">bool</span> owner = <span class="keyword">true</span>) {
<a name="l00221"></a>00221 <span class="keywordtype">string</span> theParentDir;
<a name="l00222"></a>00222
<a name="l00223"></a>00223 <span class="keywordflow">if</span> (parentDir.empty()) {
<a name="l00224"></a>00224 theParentDir = <a class="code" href="group__Support.html#g68f4105c5a8e510520b5ea3eecb66213" title="Return the path name for the directory in which the system stores general temporary...">getSystemTempDir</a>();
<a name="l00225"></a>00225 } <span class="keywordflow">else</span> {
<a name="l00226"></a>00226 theParentDir = parentDir;
<a name="l00227"></a>00227 }
<a name="l00228"></a>00228
<a name="l00229"></a>00229 <span class="comment">/* We embed the super structure version in the server instance directory name</span>
<a name="l00230"></a>00230 <span class="comment"> * because it's possible to upgrade Phusion Passenger without changing the</span>
<a name="l00231"></a>00231 <span class="comment"> * web server's PID. This way each incompatible upgrade will use its own</span>
<a name="l00232"></a>00232 <span class="comment"> * server instance directory.</span>
<a name="l00233"></a>00233 <span class="comment"> */</span>
<a name="l00234"></a>00234 initialize(theParentDir + <span class="stringliteral">"/passenger."</span> +
<a name="l00235"></a>00235 <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(DIR_STRUCTURE_MAJOR_VERSION) + <span class="stringliteral">"."</span> +
<a name="l00236"></a>00236 <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(DIR_STRUCTURE_MINOR_VERSION) + <span class="stringliteral">"."</span> +
<a name="l00237"></a>00237 toString<unsigned long long>(webServerPid),
<a name="l00238"></a>00238 owner);
<a name="l00239"></a>00239
<a name="l00240"></a>00240 }
<a name="l00241"></a>00241
<a name="l00242"></a>00242 ServerInstanceDir(<span class="keyword">const</span> <span class="keywordtype">string</span> &path, <span class="keywordtype">bool</span> owner = <span class="keyword">true</span>) {
<a name="l00243"></a>00243 initialize(path, owner);
<a name="l00244"></a>00244 }
<a name="l00245"></a>00245
<a name="l00246"></a>00246 ~ServerInstanceDir() {
<a name="l00247"></a>00247 <span class="keywordflow">if</span> (owner) {
<a name="l00248"></a>00248 GenerationPtr newestGeneration;
<a name="l00249"></a>00249 <span class="keywordflow">try</span> {
<a name="l00250"></a>00250 newestGeneration = getNewestGeneration();
<a name="l00251"></a>00251 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> FileSystemException &e) {
<a name="l00252"></a>00252 <span class="keywordflow">if</span> (e.code() == ENOENT) {
<a name="l00253"></a>00253 <span class="keywordflow">return</span>;
<a name="l00254"></a>00254 } <span class="keywordflow">else</span> {
<a name="l00255"></a>00255 <span class="keywordflow">throw</span>;
<a name="l00256"></a>00256 }
<a name="l00257"></a>00257 }
<a name="l00258"></a>00258 <span class="keywordflow">if</span> (newestGeneration == NULL) {
<a name="l00259"></a>00259 <a class="code" href="namespacePassenger.html#8422d210cbd2f62d21254415b5a7f747" title="Remove an entire directory tree recursively.">removeDirTree</a>(path);
<a name="l00260"></a>00260 }
<a name="l00261"></a>00261 }
<a name="l00262"></a>00262 }
<a name="l00263"></a>00263
<a name="l00264"></a>00264 <span class="keywordtype">string</span> getPath()<span class="keyword"> const </span>{
<a name="l00265"></a>00265 <span class="keywordflow">return</span> path;
<a name="l00266"></a>00266 }
<a name="l00267"></a>00267
<a name="l00268"></a>00268 <span class="keywordtype">void</span> detach() {
<a name="l00269"></a>00269 owner = <span class="keyword">false</span>;
<a name="l00270"></a>00270 }
<a name="l00271"></a>00271
<a name="l00272"></a>00272 GenerationPtr newGeneration(<span class="keywordtype">bool</span> userSwitching, <span class="keyword">const</span> <span class="keywordtype">string</span> &defaultUser,
<a name="l00273"></a>00273 <span class="keyword">const</span> <span class="keywordtype">string</span> &defaultGroup, uid_t webServerWorkerUid,
<a name="l00274"></a>00274 gid_t webServerWorkerGid)
<a name="l00275"></a>00275 {
<a name="l00276"></a>00276 GenerationPtr newestGeneration = getNewestGeneration();
<a name="l00277"></a>00277 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> newNumber;
<a name="l00278"></a>00278 <span class="keywordflow">if</span> (newestGeneration != NULL) {
<a name="l00279"></a>00279 newNumber = newestGeneration->getNumber() + 1;
<a name="l00280"></a>00280 } <span class="keywordflow">else</span> {
<a name="l00281"></a>00281 newNumber = 0;
<a name="l00282"></a>00282 }
<a name="l00283"></a>00283
<a name="l00284"></a>00284 GenerationPtr generation(<span class="keyword">new</span> Generation(path, newNumber));
<a name="l00285"></a>00285 generation->create(userSwitching, defaultUser, defaultGroup,
<a name="l00286"></a>00286 webServerWorkerUid, webServerWorkerGid);
<a name="l00287"></a>00287 <span class="keywordflow">return</span> generation;
<a name="l00288"></a>00288 }
<a name="l00289"></a>00289
<a name="l00290"></a>00290 GenerationPtr getGeneration(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> number)<span class="keyword"> const </span>{
<a name="l00291"></a>00291 <span class="keywordflow">return</span> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> Generation(path, number));
<a name="l00292"></a>00292 }
<a name="l00293"></a>00293
<a name="l00294"></a>00294 GenerationPtr getNewestGeneration()<span class="keyword"> const </span>{
<a name="l00295"></a>00295 DIR *dir = opendir(path.c_str());
<a name="l00296"></a>00296 <span class="keyword">struct </span>dirent *entry;
<a name="l00297"></a>00297 <span class="keywordtype">int</span> result = -1;
<a name="l00298"></a>00298
<a name="l00299"></a>00299 <span class="keywordflow">if</span> (dir == NULL) {
<a name="l00300"></a>00300 <span class="keywordtype">int</span> e = errno;
<a name="l00301"></a>00301 <span class="keywordflow">throw</span> FileSystemException(<span class="stringliteral">"Cannot open directory "</span> + path,
<a name="l00302"></a>00302 e, path);
<a name="l00303"></a>00303 }
<a name="l00304"></a>00304 <span class="keywordflow">while</span> ((entry = readdir(dir)) != NULL) {
<a name="l00305"></a>00305 <span class="keywordflow">if</span> (entry->d_type == DT_DIR
<a name="l00306"></a>00306 && strncmp(entry->d_name, <span class="stringliteral">"generation-"</span>, <span class="keyword">sizeof</span>(<span class="stringliteral">"generation-"</span>) - 1) == 0) {
<a name="l00307"></a>00307 <span class="keyword">const</span> <span class="keywordtype">char</span> *numberString = entry->d_name + <span class="keyword">sizeof</span>(<span class="stringliteral">"generation-"</span>) - 1;
<a name="l00308"></a>00308 <span class="keywordtype">int</span> number = <a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(numberString);
<a name="l00309"></a>00309 <span class="keywordflow">if</span> (number >= 0 && number > result) {
<a name="l00310"></a>00310 result = number;
<a name="l00311"></a>00311 }
<a name="l00312"></a>00312 }
<a name="l00313"></a>00313 }
<a name="l00314"></a>00314 closedir(dir);
<a name="l00315"></a>00315
<a name="l00316"></a>00316 <span class="keywordflow">if</span> (result == -1) {
<a name="l00317"></a>00317 <span class="keywordflow">return</span> GenerationPtr();
<a name="l00318"></a>00318 } <span class="keywordflow">else</span> {
<a name="l00319"></a>00319 <span class="keywordflow">return</span> getGeneration(result);
<a name="l00320"></a>00320 }
<a name="l00321"></a>00321 }
<a name="l00322"></a>00322 };
<a name="l00323"></a>00323
<a name="l00324"></a>00324 <span class="keyword">typedef</span> shared_ptr<ServerInstanceDir> ServerInstanceDirPtr;
<a name="l00325"></a>00325
<a name="l00326"></a>00326 } <span class="comment">// namespace Passenger</span>
<a name="l00327"></a>00327
<a name="l00328"></a>00328 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_SERVER_INSTANCE_DIR_H_ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 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>
|
