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
|
<!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: Utils.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>Utils.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_UTILS_H_</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_UTILS_H_</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <boost/shared_ptr.hpp></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <sys/types.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <sys/stat.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <string></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <vector></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <utility></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <sstream></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include <cstdio></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <climits></span>
<a name="l00037"></a>00037 <span class="preprocessor">#include <cstdlib></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include <cstring></span>
<a name="l00039"></a>00039 <span class="preprocessor">#include <errno.h></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <unistd.h></span>
<a name="l00041"></a>00041 <span class="preprocessor">#include "StaticString.h"</span>
<a name="l00042"></a>00042 <span class="preprocessor">#include "Exceptions.h"</span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">namespace </span>Passenger {
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="keyword">using namespace </span>std;
<a name="l00047"></a>00047 <span class="keyword">using namespace </span>boost;
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">static</span> <span class="keyword">const</span> uid_t USER_NOT_GIVEN = (uid_t) -1;
<a name="l00050"></a>00050 <span class="keyword">static</span> <span class="keyword">const</span> gid_t GROUP_NOT_GIVEN = (gid_t) -1;
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">typedef</span> <span class="keyword">struct </span>CachedFileStat CachedFileStat;
<a name="l00053"></a>00053 <span class="keyword">class </span>ResourceLocator;
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment">/** Enumeration which indicates what kind of file a file is. */</span>
<a name="l00056"></a><a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d">00056</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {<span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment"> /** The file doesn't exist. */</span>
<a name="l00058"></a><a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d9fc66834fe96c52799397496b8df8486">00058</a> <a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d9fc66834fe96c52799397496b8df8486" title="The file doesn&#39;t exist.">FT_NONEXISTANT</a>,<span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /** A regular file or a symlink to a regular file. */</span>
<a name="l00060"></a><a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d1538596a928321d1a282c6bb06e80563">00060</a> <a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d1538596a928321d1a282c6bb06e80563" title="A regular file or a symlink to a regular file.">FT_REGULAR</a>,<span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment"> /** A directory. */</span>
<a name="l00062"></a><a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07dbb09dbba1071b4770913363db2462eee">00062</a> <a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07dbb09dbba1071b4770913363db2462eee" title="A directory.">FT_DIRECTORY</a>,<span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment"> /** Something else, e.g. a pipe or a socket. */</span>
<a name="l00064"></a><a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d3e89b9a7be074975e007d9f7cd77f4ff">00064</a> <a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d3e89b9a7be074975e007d9f7cd77f4ff" title="Something else, e.g.">FT_OTHER</a>
<a name="l00065"></a>00065 } FileType;
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment">/**</span>
<a name="l00068"></a>00068 <span class="comment"> * Convenience shortcut for creating a <tt>shared_ptr</tt>.</span>
<a name="l00069"></a>00069 <span class="comment"> * Instead of:</span>
<a name="l00070"></a>00070 <span class="comment"> * @code</span>
<a name="l00071"></a>00071 <span class="comment"> * shared_ptr<Foo> foo;</span>
<a name="l00072"></a>00072 <span class="comment"> * ...</span>
<a name="l00073"></a>00073 <span class="comment"> * foo = shared_ptr<Foo>(new Foo());</span>
<a name="l00074"></a>00074 <span class="comment"> * @endcode</span>
<a name="l00075"></a>00075 <span class="comment"> * one can write:</span>
<a name="l00076"></a>00076 <span class="comment"> * @code</span>
<a name="l00077"></a>00077 <span class="comment"> * shared_ptr<Foo> foo;</span>
<a name="l00078"></a>00078 <span class="comment"> * ...</span>
<a name="l00079"></a>00079 <span class="comment"> * foo = ptr(new Foo());</span>
<a name="l00080"></a>00080 <span class="comment"> * @endcode</span>
<a name="l00081"></a>00081 <span class="comment"> *</span>
<a name="l00082"></a>00082 <span class="comment"> * @param pointer The item to put in the shared_ptr object.</span>
<a name="l00083"></a>00083 <span class="comment"> * @ingroup Support</span>
<a name="l00084"></a>00084 <span class="comment"> */</span>
<a name="l00085"></a>00085 <span class="keyword">template</span><<span class="keyword">typename</span> T> shared_ptr<T>
<a name="l00086"></a><a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396">00086</a> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(T *pointer) {
<a name="l00087"></a>00087 <span class="keywordflow">return</span> shared_ptr<T>(pointer);
<a name="l00088"></a>00088 }
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment">/**</span>
<a name="l00091"></a>00091 <span class="comment"> * Used internally by toString(). Do not use directly.</span>
<a name="l00092"></a>00092 <span class="comment"> *</span>
<a name="l00093"></a>00093 <span class="comment"> * @internal</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 <span class="keyword">template</span><<span class="keyword">typename</span> T>
<a name="l00096"></a><a class="code" href="structPassenger_1_1AnythingToString.html">00096</a> <span class="keyword">struct </span><a class="code" href="structPassenger_1_1AnythingToString.html" title="Used internally by toString().">AnythingToString</a> {
<a name="l00097"></a>00097 <span class="keywordtype">string</span> operator()(T something) {
<a name="l00098"></a>00098 stringstream s;
<a name="l00099"></a>00099 s << something;
<a name="l00100"></a>00100 <span class="keywordflow">return</span> s.str();
<a name="l00101"></a>00101 }
<a name="l00102"></a>00102 };
<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"> * Used internally by toString(). Do not use directly.</span>
<a name="l00106"></a>00106 <span class="comment"> *</span>
<a name="l00107"></a>00107 <span class="comment"> * @internal</span>
<a name="l00108"></a>00108 <span class="comment"> */</span>
<a name="l00109"></a>00109 <span class="keyword">template</span><>
<a name="l00110"></a><a class="code" href="structPassenger_1_1AnythingToString_3_01vector_3_01string_01_4_01_4.html">00110</a> <span class="keyword">struct </span><a class="code" href="structPassenger_1_1AnythingToString.html" title="Used internally by toString().">AnythingToString</a>< vector<string> > {
<a name="l00111"></a>00111 <span class="keywordtype">string</span> operator()(<span class="keyword">const</span> vector<string> &v) {
<a name="l00112"></a>00112 <span class="keywordtype">string</span> result(<span class="stringliteral">"["</span>);
<a name="l00113"></a>00113 vector<string>::const_iterator it;
<a name="l00114"></a>00114 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i;
<a name="l00115"></a>00115 <span class="keywordflow">for</span> (it = v.begin(), i = 0; it != v.end(); it++, i++) {
<a name="l00116"></a>00116 result.append(<span class="stringliteral">"'"</span>);
<a name="l00117"></a>00117 result.append(*it);
<a name="l00118"></a>00118 <span class="keywordflow">if</span> (i == v.size() - 1) {
<a name="l00119"></a>00119 result.append(<span class="stringliteral">"'"</span>);
<a name="l00120"></a>00120 } <span class="keywordflow">else</span> {
<a name="l00121"></a>00121 result.append(<span class="stringliteral">"', "</span>);
<a name="l00122"></a>00122 }
<a name="l00123"></a>00123 }
<a name="l00124"></a>00124 result.append(<span class="stringliteral">"]"</span>);
<a name="l00125"></a>00125 <span class="keywordflow">return</span> result;
<a name="l00126"></a>00126 }
<a name="l00127"></a>00127 };
<a name="l00128"></a>00128 <span class="comment"></span>
<a name="l00129"></a>00129 <span class="comment">/**</span>
<a name="l00130"></a>00130 <span class="comment"> * Convert anything to a string.</span>
<a name="l00131"></a>00131 <span class="comment"> *</span>
<a name="l00132"></a>00132 <span class="comment"> * @param something The thing to convert.</span>
<a name="l00133"></a>00133 <span class="comment"> * @ingroup Support</span>
<a name="l00134"></a>00134 <span class="comment"> */</span>
<a name="l00135"></a>00135 <span class="keyword">template</span><<span class="keyword">typename</span> T> <span class="keywordtype">string</span>
<a name="l00136"></a><a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407">00136</a> <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(T something) {
<a name="l00137"></a>00137 <span class="keywordflow">return</span> <a class="code" href="structPassenger_1_1AnythingToString.html" title="Used internally by toString().">AnythingToString<T></a>()(something);
<a name="l00138"></a>00138 }
<a name="l00139"></a>00139 <span class="comment"></span>
<a name="l00140"></a>00140 <span class="comment">/**</span>
<a name="l00141"></a>00141 <span class="comment"> * Converts the given string to an integer.</span>
<a name="l00142"></a>00142 <span class="comment"> * @ingroup Support</span>
<a name="l00143"></a>00143 <span class="comment"> */</span>
<a name="l00144"></a>00144 <span class="keywordtype">int</span> <a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &s);
<a name="l00145"></a>00145 <span class="comment"></span>
<a name="l00146"></a>00146 <span class="comment">/**</span>
<a name="l00147"></a>00147 <span class="comment"> * Converts the given string to a long integer.</span>
<a name="l00148"></a>00148 <span class="comment"> * @ingroup Support</span>
<a name="l00149"></a>00149 <span class="comment"> */</span>
<a name="l00150"></a>00150 <span class="keywordtype">long</span> <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &s);
<a name="l00151"></a>00151 <span class="comment"></span>
<a name="l00152"></a>00152 <span class="comment">/** Round <em>number</em> up to the nearest multiple of <em>multiple</em>. */</span>
<a name="l00153"></a>00153 <span class="keyword">template</span><<span class="keyword">typename</span> IntType> IntType
<a name="l00154"></a><a class="code" href="namespacePassenger.html#6b2bc9d6fa3848e01fd8c164d30737cc">00154</a> <a class="code" href="namespacePassenger.html#6b2bc9d6fa3848e01fd8c164d30737cc" title="Round number up to the nearest multiple of multiple.">roundUp</a>(IntType number, IntType multiple) {
<a name="l00155"></a>00155 <span class="keywordflow">return</span> (number + multiple - 1) / multiple * multiple;
<a name="l00156"></a>00156 }
<a name="l00157"></a>00157 <span class="comment"></span>
<a name="l00158"></a>00158 <span class="comment">/**</span>
<a name="l00159"></a>00159 <span class="comment"> * Split the given string using the given separator.</span>
<a name="l00160"></a>00160 <span class="comment"> *</span>
<a name="l00161"></a>00161 <span class="comment"> * @param str The string to split.</span>
<a name="l00162"></a>00162 <span class="comment"> * @param sep The separator to use.</span>
<a name="l00163"></a>00163 <span class="comment"> * @param output The vector to write the output to.</span>
<a name="l00164"></a>00164 <span class="comment"> * @ingroup Support</span>
<a name="l00165"></a>00165 <span class="comment"> */</span>
<a name="l00166"></a>00166 <span class="keywordtype">void</span> <a class="code" href="group__Support.html#g4b8320aedc6a164a535c920234e3d8bf" title="Split the given string using the given separator.">split</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &str, <span class="keywordtype">char</span> sep, vector<string> &output);
<a name="l00167"></a>00167 <span class="comment"></span>
<a name="l00168"></a>00168 <span class="comment">/**</span>
<a name="l00169"></a>00169 <span class="comment"> * Check whether the specified file exists.</span>
<a name="l00170"></a>00170 <span class="comment"> *</span>
<a name="l00171"></a>00171 <span class="comment"> * @param filename The filename to check.</span>
<a name="l00172"></a>00172 <span class="comment"> * @param cstat A CachedFileStat object, if you want to use cached statting.</span>
<a name="l00173"></a>00173 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
<a name="l00174"></a>00174 <span class="comment"> * @return Whether the file exists.</span>
<a name="l00175"></a>00175 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
<a name="l00176"></a>00176 <span class="comment"> * @throws TimeRetrievalException</span>
<a name="l00177"></a>00177 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00178"></a>00178 <span class="comment"> * @ingroup Support</span>
<a name="l00179"></a>00179 <span class="comment"> */</span>
<a name="l00180"></a>00180 <span class="keywordtype">bool</span> <a class="code" href="group__Support.html#g2a62e38a72c6c65992e3361f6d80c7ef" title="Check whether the specified file exists.">fileExists</a>(<span class="keyword">const</span> StaticString &filename, CachedFileStat *cstat = 0,
<a name="l00181"></a>00181 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
<a name="l00182"></a>00182 <span class="comment"></span>
<a name="l00183"></a>00183 <span class="comment">/**</span>
<a name="l00184"></a>00184 <span class="comment"> * Check whether 'filename' exists and what kind of file it is.</span>
<a name="l00185"></a>00185 <span class="comment"> *</span>
<a name="l00186"></a>00186 <span class="comment"> * @param filename The filename to check.</span>
<a name="l00187"></a>00187 <span class="comment"> * @param mstat A CachedFileStat object, if you want to use cached statting.</span>
<a name="l00188"></a>00188 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
<a name="l00189"></a>00189 <span class="comment"> * @return The file type.</span>
<a name="l00190"></a>00190 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
<a name="l00191"></a>00191 <span class="comment"> * @throws TimeRetrievalException</span>
<a name="l00192"></a>00192 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00193"></a>00193 <span class="comment"> * @ingroup Support</span>
<a name="l00194"></a>00194 <span class="comment"> */</span>
<a name="l00195"></a>00195 FileType <a class="code" href="group__Support.html#g15298b031377d3ecb80295bd5b1a8180" title="Check whether &#39;filename&#39; exists and what kind of file it is.">getFileType</a>(<span class="keyword">const</span> StaticString &filename, CachedFileStat *cstat = 0,
<a name="l00196"></a>00196 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
<a name="l00197"></a>00197 <span class="comment"></span>
<a name="l00198"></a>00198 <span class="comment">/**</span>
<a name="l00199"></a>00199 <span class="comment"> * Create the given file with the given contents, permissions and ownership.</span>
<a name="l00200"></a>00200 <span class="comment"> * This function does not leave behind junk files: if the ownership cannot be set</span>
<a name="l00201"></a>00201 <span class="comment"> * or if not all data can be written then then the file will be deleted.</span>
<a name="l00202"></a>00202 <span class="comment"> *</span>
<a name="l00203"></a>00203 <span class="comment"> * @param filename The file to create.</span>
<a name="l00204"></a>00204 <span class="comment"> * @param contents The contents to write to the file.</span>
<a name="l00205"></a>00205 <span class="comment"> * @param permissions The desired file permissions.</span>
<a name="l00206"></a>00206 <span class="comment"> * @param owner The desired file owner. Specify USER_NOT_GIVEN if you want to use the current</span>
<a name="l00207"></a>00207 <span class="comment"> * process's owner as the file owner.</span>
<a name="l00208"></a>00208 <span class="comment"> * @param group The desired file group. Specify GROUP_NOT_GIVEN if you want to use the current</span>
<a name="l00209"></a>00209 <span class="comment"> * process's group as the file group.</span>
<a name="l00210"></a>00210 <span class="comment"> * @param overwrite Whether to overwrite the file if it exists. If set to false</span>
<a name="l00211"></a>00211 <span class="comment"> * and the file exists then nothing will happen.</span>
<a name="l00212"></a>00212 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
<a name="l00213"></a>00213 <span class="comment"> * @ingroup Support</span>
<a name="l00214"></a>00214 <span class="comment"> */</span>
<a name="l00215"></a>00215 <span class="keywordtype">void</span> <a class="code" href="group__Support.html#g6f414070373465da2e12947463f69953" title="Create the given file with the given contents, permissions and ownership.">createFile</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &filename, <span class="keyword">const</span> StaticString &contents,
<a name="l00216"></a>00216 mode_t permissions = S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH,
<a name="l00217"></a>00217 uid_t owner = USER_NOT_GIVEN, gid_t group = GROUP_NOT_GIVEN,
<a name="l00218"></a>00218 <span class="keywordtype">bool</span> overwrite = <span class="keyword">true</span>);
<a name="l00219"></a>00219 <span class="comment"></span>
<a name="l00220"></a>00220 <span class="comment">/**</span>
<a name="l00221"></a>00221 <span class="comment"> * Returns a canonical version of the specified path. All symbolic links</span>
<a name="l00222"></a>00222 <span class="comment"> * and relative path elements are resolved.</span>
<a name="l00223"></a>00223 <span class="comment"> *</span>
<a name="l00224"></a>00224 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
<a name="l00225"></a>00225 <span class="comment"> * @ingroup Support</span>
<a name="l00226"></a>00226 <span class="comment"> */</span>
<a name="l00227"></a>00227 <span class="keywordtype">string</span> <a class="code" href="group__Support.html#gf3b0a483f0a252ae08d9de9f8b267d36" title="Returns a canonical version of the specified path.">canonicalizePath</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &path);
<a name="l00228"></a>00228 <span class="comment"></span>
<a name="l00229"></a>00229 <span class="comment">/**</span>
<a name="l00230"></a>00230 <span class="comment"> * If <em>path</em> refers to a symlink, then this function resolves the</span>
<a name="l00231"></a>00231 <span class="comment"> * symlink for 1 level. That is, if the symlink points to another symlink,</span>
<a name="l00232"></a>00232 <span class="comment"> * then the other symlink will not be resolved. The resolved path is returned.</span>
<a name="l00233"></a>00233 <span class="comment"> *</span>
<a name="l00234"></a>00234 <span class="comment"> * If the symlink doesn't point to an absolute path, then this function will</span>
<a name="l00235"></a>00235 <span class="comment"> * prepend <em>path</em>'s directory to the result.</span>
<a name="l00236"></a>00236 <span class="comment"> *</span>
<a name="l00237"></a>00237 <span class="comment"> * If <em>path</em> doesn't refer to a symlink then this method will return</span>
<a name="l00238"></a>00238 <span class="comment"> * <em>path</em>.</span>
<a name="l00239"></a>00239 <span class="comment"> *</span>
<a name="l00240"></a>00240 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
<a name="l00241"></a>00241 <span class="comment"> * @ingroup Support</span>
<a name="l00242"></a>00242 <span class="comment"> */</span>
<a name="l00243"></a>00243 <span class="keywordtype">string</span> <a class="code" href="group__Support.html#gc3d2b3d608188527d888e63d22c5163c" title="If path refers to a symlink, then this function resolves the symlink for 1 level...">resolveSymlink</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &path);
<a name="l00244"></a>00244 <span class="comment"></span>
<a name="l00245"></a>00245 <span class="comment">/**</span>
<a name="l00246"></a>00246 <span class="comment"> * Given a path, extracts its directory name.</span>
<a name="l00247"></a>00247 <span class="comment"> *</span>
<a name="l00248"></a>00248 <span class="comment"> * @ingroup Support</span>
<a name="l00249"></a>00249 <span class="comment"> */</span>
<a name="l00250"></a>00250 <span class="keywordtype">string</span> <a class="code" href="group__Support.html#ge651ece5281f22dc5fc974079f7c9187" title="Given a path, extracts its directory name.">extractDirName</a>(<span class="keyword">const</span> StaticString &path);
<a name="l00251"></a>00251 <span class="comment"></span>
<a name="l00252"></a>00252 <span class="comment">/**</span>
<a name="l00253"></a>00253 <span class="comment"> * Given a path, extracts its base name.</span>
<a name="l00254"></a>00254 <span class="comment"> *</span>
<a name="l00255"></a>00255 <span class="comment"> * @ingroup Support</span>
<a name="l00256"></a>00256 <span class="comment"> */</span>
<a name="l00257"></a>00257 <span class="keywordtype">string</span> <a class="code" href="group__Support.html#geb750234207485fa57609174ca8d4359" title="Given a path, extracts its base name.">extractBaseName</a>(<span class="keyword">const</span> StaticString &path);
<a name="l00258"></a>00258 <span class="comment"></span>
<a name="l00259"></a>00259 <span class="comment">/**</span>
<a name="l00260"></a>00260 <span class="comment"> * Escape the given raw string into an XML value.</span>
<a name="l00261"></a>00261 <span class="comment"> *</span>
<a name="l00262"></a>00262 <span class="comment"> * @throws std::bad_alloc Something went wrong.</span>
<a name="l00263"></a>00263 <span class="comment"> * @ingroup Support</span>
<a name="l00264"></a>00264 <span class="comment"> */</span>
<a name="l00265"></a>00265 <span class="keywordtype">string</span> <a class="code" href="group__Support.html#ge74addedf73782a1eb1f6dd48d6fce06" title="Escape the given raw string into an XML value.">escapeForXml</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &input);
<a name="l00266"></a>00266 <span class="comment"></span>
<a name="l00267"></a>00267 <span class="comment">/**</span>
<a name="l00268"></a>00268 <span class="comment"> * Returns the username of the user that the current process is running as.</span>
<a name="l00269"></a>00269 <span class="comment"> * If the user has no associated username, then "UID xxxx" is returned,</span>
<a name="l00270"></a>00270 <span class="comment"> * where xxxx is the current UID.</span>
<a name="l00271"></a>00271 <span class="comment"> */</span>
<a name="l00272"></a>00272 <span class="keywordtype">string</span> <a class="code" href="namespacePassenger.html#de80218e8b836b796f8b960b6225b439" title="Returns the username of the user that the current process is running as.">getProcessUsername</a>();
<a name="l00273"></a>00273 <span class="comment"></span>
<a name="l00274"></a>00274 <span class="comment">/**</span>
<a name="l00275"></a>00275 <span class="comment"> * Converts a mode string into a mode_t value.</span>
<a name="l00276"></a>00276 <span class="comment"> *</span>
<a name="l00277"></a>00277 <span class="comment"> * At this time only the symbolic mode strings are supported, e.g. something like looks</span>
<a name="l00278"></a>00278 <span class="comment"> * this: "u=rwx,g=w,o=rx". The grammar is as follows:</span>
<a name="l00279"></a>00279 <span class="comment"> * @code</span>
<a name="l00280"></a>00280 <span class="comment"> * mode ::= (clause ("," clause)*)?</span>
<a name="l00281"></a>00281 <span class="comment"> * clause ::= who "=" permission*</span>
<a name="l00282"></a>00282 <span class="comment"> * who ::= "u" | "g" | "o"</span>
<a name="l00283"></a>00283 <span class="comment"> * permission ::= "r" | "w" | "x" | "s"</span>
<a name="l00284"></a>00284 <span class="comment"> * @endcode</span>
<a name="l00285"></a>00285 <span class="comment"> *</span>
<a name="l00286"></a>00286 <span class="comment"> * Notes:</span>
<a name="l00287"></a>00287 <span class="comment"> * - The mode value starts with 0. So if you specify "u=rwx", then the group and world</span>
<a name="l00288"></a>00288 <span class="comment"> * permissions will be empty (set to 0).</span>
<a name="l00289"></a>00289 <span class="comment"> * - The "s" permission is only allowed for who == "u" or who == "g".</span>
<a name="l00290"></a>00290 <span class="comment"> * - The return value does not depend on the umask.</span>
<a name="l00291"></a>00291 <span class="comment"> *</span>
<a name="l00292"></a>00292 <span class="comment"> * @throws InvalidModeStringException The mode string cannot be parsed.</span>
<a name="l00293"></a>00293 <span class="comment"> */</span>
<a name="l00294"></a>00294 mode_t <a class="code" href="namespacePassenger.html#da53f5a9bdcf3d22d4a710e7ea3678e9" title="Converts a mode string into a mode_t value.">parseModeString</a>(<span class="keyword">const</span> StaticString &mode);
<a name="l00295"></a>00295 <span class="comment"></span>
<a name="l00296"></a>00296 <span class="comment">/**</span>
<a name="l00297"></a>00297 <span class="comment"> * Return the path name for the directory in which the system stores general</span>
<a name="l00298"></a>00298 <span class="comment"> * temporary files. This is usually "/tmp", but might be something else depending</span>
<a name="l00299"></a>00299 <span class="comment"> * on some environment variables.</span>
<a name="l00300"></a>00300 <span class="comment"> *</span>
<a name="l00301"></a>00301 <span class="comment"> * @ensure result != NULL</span>
<a name="l00302"></a>00302 <span class="comment"> * @ingroup Support</span>
<a name="l00303"></a>00303 <span class="comment"> */</span>
<a name="l00304"></a>00304 <span class="keyword">const</span> <span class="keywordtype">char</span> *<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="l00305"></a>00305
<a name="l00306"></a>00306 <span class="comment">/* Create a temporary directory for storing Phusion Passenger instance-specific</span>
<a name="l00307"></a>00307 <span class="comment"> * temp files, such as temporarily buffered uploads, sockets for backend</span>
<a name="l00308"></a>00308 <span class="comment"> * processes, etc.</span>
<a name="l00309"></a>00309 <span class="comment"> * The directory that will be created is the one returned by</span>
<a name="l00310"></a>00310 <span class="comment"> * <tt>getPassengerTempDir(false, parentDir)</tt>. This call stores the path to</span>
<a name="l00311"></a>00311 <span class="comment"> * this temp directory in an internal variable, so that subsequent calls to</span>
<a name="l00312"></a>00312 <span class="comment"> * getPassengerTempDir() will return the same path.</span>
<a name="l00313"></a>00313 <span class="comment"> *</span>
<a name="l00314"></a>00314 <span class="comment"> * The created temp directory will have several subdirectories:</span>
<a name="l00315"></a>00315 <span class="comment"> * - webserver_private - for storing the web server's buffered uploads.</span>
<a name="l00316"></a>00316 <span class="comment"> * - info - for storing files that allow external tools to query information</span>
<a name="l00317"></a>00317 <span class="comment"> * about a running Phusion Passenger instance.</span>
<a name="l00318"></a>00318 <span class="comment"> * - backends - for storing Unix sockets created by backend processes.</span>
<a name="l00319"></a>00319 <span class="comment"> * - master - for storing files such as the Passenger HelperServer socket.</span>
<a name="l00320"></a>00320 <span class="comment"> *</span>
<a name="l00321"></a>00321 <span class="comment"> * If a (sub)directory already exists, then it will not result in an error.</span>
<a name="l00322"></a>00322 <span class="comment"> *</span>
<a name="l00323"></a>00323 <span class="comment"> * The <em>userSwitching</em> and <em>lowestUser</em> arguments passed to</span>
<a name="l00324"></a>00324 <span class="comment"> * this method are used for determining the optimal permissions for the</span>
<a name="l00325"></a>00325 <span class="comment"> * (sub)directories. The permissions will be set as tightly as possible based</span>
<a name="l00326"></a>00326 <span class="comment"> * on the values. The <em>workerUid</em> and <em>workerGid</em> arguments</span>
<a name="l00327"></a>00327 <span class="comment"> * will be used for determining the owner of certain subdirectories.</span>
<a name="l00328"></a>00328 <span class="comment"> *</span>
<a name="l00329"></a>00329 <span class="comment"> * @note You should only call this method inside the web server's master</span>
<a name="l00330"></a>00330 <span class="comment"> * process. In case of Apache, this is the Apache control process,</span>
<a name="l00331"></a>00331 <span class="comment"> * the one that tends to run as root. This is because this function</span>
<a name="l00332"></a>00332 <span class="comment"> * will set directory permissions and owners/groups, which may require</span>
<a name="l00333"></a>00333 <span class="comment"> * root privileges.</span>
<a name="l00334"></a>00334 <span class="comment"> *</span>
<a name="l00335"></a>00335 <span class="comment"> * @param parentDir The directory under which the Phusion Passenger-specific</span>
<a name="l00336"></a>00336 <span class="comment"> * temp directory should be created. This argument may be the</span>
<a name="l00337"></a>00337 <span class="comment"> * empty string, in which case getSystemTempDir() will be used</span>
<a name="l00338"></a>00338 <span class="comment"> * as the parent directory.</span>
<a name="l00339"></a>00339 <span class="comment"> * @param userSwitching Whether user switching is turned on.</span>
<a name="l00340"></a>00340 <span class="comment"> * @param lowestUser The user that the spawn manager and the pool server will</span>
<a name="l00341"></a>00341 <span class="comment"> * run as, if user switching is turned off.</span>
<a name="l00342"></a>00342 <span class="comment"> * @param workerUid The UID that the web server's worker processes are running</span>
<a name="l00343"></a>00343 <span class="comment"> * as. On Apache, this is the UID that's associated with the</span>
<a name="l00344"></a>00344 <span class="comment"> * 'User' directive.</span>
<a name="l00345"></a>00345 <span class="comment"> * @param workerGid The GID that the web server's worker processes are running</span>
<a name="l00346"></a>00346 <span class="comment"> * as. On Apache, this is the GID that's associated with the</span>
<a name="l00347"></a>00347 <span class="comment"> * 'Group' directive.</span>
<a name="l00348"></a>00348 <span class="comment"> * @throws IOException Something went wrong.</span>
<a name="l00349"></a>00349 <span class="comment"> * @throws SystemException Something went wrong.</span>
<a name="l00350"></a>00350 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
<a name="l00351"></a>00351 <span class="comment"> */</span>
<a name="l00352"></a>00352 <span class="comment">/* void createPassengerTempDir(const string &parentDir, bool userSwitching,</span>
<a name="l00353"></a>00353 <span class="comment"> const string &lowestUser,</span>
<a name="l00354"></a>00354 <span class="comment"> uid_t workerUid, gid_t workerGid); */</span>
<a name="l00355"></a>00355 <span class="comment"></span>
<a name="l00356"></a>00356 <span class="comment">/**</span>
<a name="l00357"></a>00357 <span class="comment"> * Create the directory at the given path, creating intermediate directories</span>
<a name="l00358"></a>00358 <span class="comment"> * if necessary. The created directories' permissions are exactly as specified</span>
<a name="l00359"></a>00359 <span class="comment"> * by the 'mode' parameter (i.e. the umask will be ignored). You can specify</span>
<a name="l00360"></a>00360 <span class="comment"> * this directory's owner and group through the 'owner' and 'group' parameters.</span>
<a name="l00361"></a>00361 <span class="comment"> * A value of USER_NOT_GIVEN for 'owner' and/or GROUP_NOT_GIVEN 'group' means</span>
<a name="l00362"></a>00362 <span class="comment"> * that the owner/group should not be changed.</span>
<a name="l00363"></a>00363 <span class="comment"> *</span>
<a name="l00364"></a>00364 <span class="comment"> * If 'path' already exists, then nothing will happen.</span>
<a name="l00365"></a>00365 <span class="comment"> *</span>
<a name="l00366"></a>00366 <span class="comment"> * @param mode A mode string, as supported by parseModeString().</span>
<a name="l00367"></a>00367 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
<a name="l00368"></a>00368 <span class="comment"> * @throws InvalidModeStringException The mode string cannot be parsed.</span>
<a name="l00369"></a>00369 <span class="comment"> */</span>
<a name="l00370"></a>00370 <span class="keywordtype">void</span> <a class="code" href="namespacePassenger.html#448f25263af0b37b91caee3d294ec4aa" title="Create the directory at the given path, creating intermediate directories if necessary...">makeDirTree</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &path, <span class="keyword">const</span> StaticString &mode = <span class="stringliteral">"u=rwx,g=,o="</span>,
<a name="l00371"></a>00371 uid_t owner = USER_NOT_GIVEN, gid_t group = GROUP_NOT_GIVEN);
<a name="l00372"></a>00372 <span class="comment"></span>
<a name="l00373"></a>00373 <span class="comment">/**</span>
<a name="l00374"></a>00374 <span class="comment"> * Remove an entire directory tree recursively. If the directory doesn't exist then this</span>
<a name="l00375"></a>00375 <span class="comment"> * function does nothing.</span>
<a name="l00376"></a>00376 <span class="comment"> *</span>
<a name="l00377"></a>00377 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
<a name="l00378"></a>00378 <span class="comment"> */</span>
<a name="l00379"></a>00379 <span class="keywordtype">void</span> <a class="code" href="namespacePassenger.html#8422d210cbd2f62d21254415b5a7f747" title="Remove an entire directory tree recursively.">removeDirTree</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &path);
<a name="l00380"></a>00380 <span class="comment"></span>
<a name="l00381"></a>00381 <span class="comment">/**</span>
<a name="l00382"></a>00382 <span class="comment"> * Check whether the specified directory is a valid Ruby on Rails</span>
<a name="l00383"></a>00383 <span class="comment"> * application root directory.</span>
<a name="l00384"></a>00384 <span class="comment"> *</span>
<a name="l00385"></a>00385 <span class="comment"> * @param cstat A CachedFileStat object, if you want to use cached statting.</span>
<a name="l00386"></a>00386 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
<a name="l00387"></a>00387 <span class="comment"> * @throws FileSystemException Unable to check because of a system error.</span>
<a name="l00388"></a>00388 <span class="comment"> * @throws TimeRetrievalException</span>
<a name="l00389"></a>00389 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00390"></a>00390 <span class="comment"> * @ingroup Support</span>
<a name="l00391"></a>00391 <span class="comment"> */</span>
<a name="l00392"></a>00392 <span class="keywordtype">bool</span> <a class="code" href="group__Support.html#g5e6bc7ff22b7c61238d7913521936f71" title="Check whether the specified directory is a valid Ruby on Rails application root directory...">verifyRailsDir</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &dir, CachedFileStat *cstat = 0,
<a name="l00393"></a>00393 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
<a name="l00394"></a>00394 <span class="comment"></span>
<a name="l00395"></a>00395 <span class="comment">/**</span>
<a name="l00396"></a>00396 <span class="comment"> * Check whether the specified directory is a valid Rack application</span>
<a name="l00397"></a>00397 <span class="comment"> * root directory.</span>
<a name="l00398"></a>00398 <span class="comment"> *</span>
<a name="l00399"></a>00399 <span class="comment"> * @param cstat A CachedFileStat object, if you want to use cached statting.</span>
<a name="l00400"></a>00400 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
<a name="l00401"></a>00401 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
<a name="l00402"></a>00402 <span class="comment"> * @throws TimeRetrievalException</span>
<a name="l00403"></a>00403 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00404"></a>00404 <span class="comment"> * @ingroup Support</span>
<a name="l00405"></a>00405 <span class="comment"> */</span>
<a name="l00406"></a>00406 <span class="keywordtype">bool</span> <a class="code" href="group__Support.html#g53969f8e3ee68d1d99ffe75af8db9be8" title="Check whether the specified directory is a valid Rack application root directory...">verifyRackDir</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &dir, CachedFileStat *cstat = 0,
<a name="l00407"></a>00407 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
<a name="l00408"></a>00408 <span class="comment"></span>
<a name="l00409"></a>00409 <span class="comment">/**</span>
<a name="l00410"></a>00410 <span class="comment"> * Check whether the specified directory is a valid WSGI application</span>
<a name="l00411"></a>00411 <span class="comment"> * root directory.</span>
<a name="l00412"></a>00412 <span class="comment"> *</span>
<a name="l00413"></a>00413 <span class="comment"> * @param cstat A CachedFileStat object, if you want to use cached statting.</span>
<a name="l00414"></a>00414 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
<a name="l00415"></a>00415 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
<a name="l00416"></a>00416 <span class="comment"> * @throws TimeRetrievalException</span>
<a name="l00417"></a>00417 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00418"></a>00418 <span class="comment"> * @ingroup Support</span>
<a name="l00419"></a>00419 <span class="comment"> */</span>
<a name="l00420"></a>00420 <span class="keywordtype">bool</span> <a class="code" href="group__Support.html#gaec51d2912999d611994c49341f36247" title="Check whether the specified directory is a valid WSGI application root directory...">verifyWSGIDir</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &dir, CachedFileStat *cstat = 0,
<a name="l00421"></a>00421 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
<a name="l00422"></a>00422
<a name="l00423"></a>00423 <span class="keywordtype">void</span> prestartWebApps(<span class="keyword">const</span> ResourceLocator &locator, <span class="keyword">const</span> <span class="keywordtype">string</span> &serializedprestartURLs);
<a name="l00424"></a>00424 <span class="comment"></span>
<a name="l00425"></a>00425 <span class="comment">/**</span>
<a name="l00426"></a>00426 <span class="comment"> * Generate a secure, random token of the <tt>size</tt> bytes and put</span>
<a name="l00427"></a>00427 <span class="comment"> * the result into <tt>buf</tt>.</span>
<a name="l00428"></a>00428 <span class="comment"> *</span>
<a name="l00429"></a>00429 <span class="comment"> * This method is thread-safe.</span>
<a name="l00430"></a>00430 <span class="comment"> *</span>
<a name="l00431"></a>00431 <span class="comment"> * @throws FileSystemException</span>
<a name="l00432"></a>00432 <span class="comment"> * @throws IOException</span>
<a name="l00433"></a>00433 <span class="comment"> * @throws boost::thread_interrupted A system call has been interrupted.</span>
<a name="l00434"></a>00434 <span class="comment"> * @ingroup Support</span>
<a name="l00435"></a>00435 <span class="comment"> */</span>
<a name="l00436"></a>00436 <span class="keywordtype">void</span> <a class="code" href="group__Support.html#geb1ed5adc17a8f98fbc9a4e96bb3ae95" title="Generate a secure, random token of the size bytes and put the result into buf.">generateSecureToken</a>(<span class="keywordtype">void</span> *buf, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size);
<a name="l00437"></a>00437 <span class="comment"></span>
<a name="l00438"></a>00438 <span class="comment">/**</span>
<a name="l00439"></a>00439 <span class="comment"> * Given a prefix string, a middle string and a postfix string, try to build a string</span>
<a name="l00440"></a>00440 <span class="comment"> * that looks like <tt>prefix + middle + postfix</tt>, with as many characters from</span>
<a name="l00441"></a>00441 <span class="comment"> * <tt>midle</tt> preserved as possible.</span>
<a name="l00442"></a>00442 <span class="comment"> *</span>
<a name="l00443"></a>00443 <span class="comment"> * If <tt>prefix + middle + postfix</tt> does not fit in <tt>max</tt> characters,</span>
<a name="l00444"></a>00444 <span class="comment"> * then <tt>middle</tt> will be truncated so that it fits. If <tt>max</tt> is too</span>
<a name="l00445"></a>00445 <span class="comment"> * small to contain even 1 character from <tt>middle</tt>, then an ArgumentException</span>
<a name="l00446"></a>00446 <span class="comment"> * will be thrown.</span>
<a name="l00447"></a>00447 <span class="comment"> *</span>
<a name="l00448"></a>00448 <span class="comment"> * @code</span>
<a name="l00449"></a>00449 <span class="comment"> * fillInMiddle(18, "server.", "1234", ".socket"); // "server.1234.socket"</span>
<a name="l00450"></a>00450 <span class="comment"> * fillInMiddle(16, "server.", "1234", ".socket"); // "server.12.socket"</span>
<a name="l00451"></a>00451 <span class="comment"> * fillInMiddle(14, "server.", "1234", ".socket"); // ArgumentException</span>
<a name="l00452"></a>00452 <span class="comment"> * @endcode</span>
<a name="l00453"></a>00453 <span class="comment"> *</span>
<a name="l00454"></a>00454 <span class="comment"> * @returns The resulting string, with <tt>middle</tt> possibly truncated.</span>
<a name="l00455"></a>00455 <span class="comment"> * @throws ArgumentException <tt>max</tt> is too small to contain even 1</span>
<a name="l00456"></a>00456 <span class="comment"> * character from <tt>middle</tt>.</span>
<a name="l00457"></a>00457 <span class="comment"> * @post result.size() <= max</span>
<a name="l00458"></a>00458 <span class="comment"> */</span>
<a name="l00459"></a>00459 <span class="keywordtype">string</span> <a class="code" href="namespacePassenger.html#d88884ee6e2184ef8656fc20f0549b0b" title="Given a prefix string, a middle string and a postfix string, try to build a string...">fillInMiddle</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> max, <span class="keyword">const</span> <span class="keywordtype">string</span> &prefix, <span class="keyword">const</span> <span class="keywordtype">string</span> &middle, <span class="keyword">const</span> <span class="keywordtype">string</span> &postfix = <span class="stringliteral">""</span>);
<a name="l00460"></a>00460 <span class="comment"></span>
<a name="l00461"></a>00461 <span class="comment">/**</span>
<a name="l00462"></a>00462 <span class="comment"> * Convert the given binary data to hexadecimal.</span>
<a name="l00463"></a>00463 <span class="comment"> */</span>
<a name="l00464"></a>00464 <span class="keywordtype">string</span> <a class="code" href="namespacePassenger.html#1d4b16a419fe7231bc8b7036266f8131" title="Convert the given binary data to hexadecimal.">toHex</a>(<span class="keyword">const</span> StaticString &data);
<a name="l00465"></a>00465 <span class="comment"></span>
<a name="l00466"></a>00466 <span class="comment">/**</span>
<a name="l00467"></a>00467 <span class="comment"> * Convert the given binary data to hexadecimal. This form accepts an</span>
<a name="l00468"></a>00468 <span class="comment"> * output buffer which must be at least data.size() * 2 bytes large.</span>
<a name="l00469"></a>00469 <span class="comment"> */</span>
<a name="l00470"></a>00470 <span class="keywordtype">void</span> <a class="code" href="namespacePassenger.html#1d4b16a419fe7231bc8b7036266f8131" title="Convert the given binary data to hexadecimal.">toHex</a>(<span class="keyword">const</span> StaticString &data, <span class="keywordtype">char</span> *output);
<a name="l00471"></a>00471 <span class="comment"></span>
<a name="l00472"></a>00472 <span class="comment">/**</span>
<a name="l00473"></a>00473 <span class="comment"> * Convert a signal number to its associated name.</span>
<a name="l00474"></a>00474 <span class="comment"> */</span>
<a name="l00475"></a>00475 <span class="keywordtype">string</span> <a class="code" href="namespacePassenger.html#979cb43cef743bf261c329b13e712366" title="Convert a signal number to its associated name.">getSignalName</a>(<span class="keywordtype">int</span> sig);
<a name="l00476"></a>00476 <span class="comment"></span>
<a name="l00477"></a>00477 <span class="comment">/**</span>
<a name="l00478"></a>00478 <span class="comment"> * Create a new Unix server socket which is bounded to <tt>filename</tt>.</span>
<a name="l00479"></a>00479 <span class="comment"> *</span>
<a name="l00480"></a>00480 <span class="comment"> * @param filename The filename to bind the socket to.</span>
<a name="l00481"></a>00481 <span class="comment"> * @param backlogSize The size of the socket's backlog. Specify 0 to use the</span>
<a name="l00482"></a>00482 <span class="comment"> * platform's maximum allowed backlog size.</span>
<a name="l00483"></a>00483 <span class="comment"> * @param autoDelete Whether <tt>filename</tt> should be deleted, if it already exists.</span>
<a name="l00484"></a>00484 <span class="comment"> * @return The file descriptor of the newly created Unix server socket.</span>
<a name="l00485"></a>00485 <span class="comment"> * @throws RuntimeException Something went wrong.</span>
<a name="l00486"></a>00486 <span class="comment"> * @throws SystemException Something went wrong while creating the Unix server socket.</span>
<a name="l00487"></a>00487 <span class="comment"> * @throws boost::thread_interrupted A system call has been interrupted.</span>
<a name="l00488"></a>00488 <span class="comment"> * @ingroup Support</span>
<a name="l00489"></a>00489 <span class="comment"> */</span>
<a name="l00490"></a>00490 <span class="keywordtype">int</span> <a class="code" href="group__Support.html#g5d3b342a34d81e7506744e90ee2f9b8b" title="Create a new Unix server socket which is bounded to filename.">createUnixServer</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> backlogSize = 0, <span class="keywordtype">bool</span> autoDelete = <span class="keyword">true</span>);
<a name="l00491"></a>00491 <span class="comment"></span>
<a name="l00492"></a>00492 <span class="comment">/**</span>
<a name="l00493"></a>00493 <span class="comment"> * Connect to a Unix server socket at <tt>filename</tt>.</span>
<a name="l00494"></a>00494 <span class="comment"> *</span>
<a name="l00495"></a>00495 <span class="comment"> * @param filename The filename of the socket to connect to.</span>
<a name="l00496"></a>00496 <span class="comment"> * @return The file descriptor of the connected client socket.</span>
<a name="l00497"></a>00497 <span class="comment"> * @throws RuntimeException Something went wrong.</span>
<a name="l00498"></a>00498 <span class="comment"> * @throws SystemException Something went wrong while connecting to the Unix server.</span>
<a name="l00499"></a>00499 <span class="comment"> * @throws boost::thread_interrupted A system call has been interrupted.</span>
<a name="l00500"></a>00500 <span class="comment"> * @ingroup Support</span>
<a name="l00501"></a>00501 <span class="comment"> */</span>
<a name="l00502"></a>00502 <span class="keywordtype">int</span> <a class="code" href="group__Support.html#gae3993db9dfa0b05c97b67ccefd2b619" title="Connect to a Unix server socket at filename.">connectToUnixServer</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename);
<a name="l00503"></a>00503 <span class="comment"></span>
<a name="l00504"></a>00504 <span class="comment">/**</span>
<a name="l00505"></a>00505 <span class="comment"> * Connect to a TCP server socket at the given host name and port.</span>
<a name="l00506"></a>00506 <span class="comment"> *</span>
<a name="l00507"></a>00507 <span class="comment"> * @param hostname The host name of the TCP server.</span>
<a name="l00508"></a>00508 <span class="comment"> * @param port The port number of the TCP server.</span>
<a name="l00509"></a>00509 <span class="comment"> * @return The file descriptor of the connected client socket.</span>
<a name="l00510"></a>00510 <span class="comment"> * @throws IOException Something went wrong while connecting to the Unix server.</span>
<a name="l00511"></a>00511 <span class="comment"> * @throws SystemException Something went wrong while connecting to the Unix server.</span>
<a name="l00512"></a>00512 <span class="comment"> * @throws boost::thread_interrupted A system call has been interrupted.</span>
<a name="l00513"></a>00513 <span class="comment"> * @ingroup Support</span>
<a name="l00514"></a>00514 <span class="comment"> */</span>
<a name="l00515"></a>00515 <span class="keywordtype">int</span> <a class="code" href="group__Support.html#gaf4965fbefc2dfe26c1380c621962e68" title="Connect to a TCP server socket at the given host name and port.">connectToTcpServer</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *hostname, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> port);
<a name="l00516"></a>00516
<a name="l00517"></a>00517
<a name="l00518"></a>00518 <span class="comment"></span>
<a name="l00519"></a>00519 <span class="comment">/**</span>
<a name="l00520"></a>00520 <span class="comment"> * Represents a buffered upload file.</span>
<a name="l00521"></a>00521 <span class="comment"> *</span>
<a name="l00522"></a>00522 <span class="comment"> * @ingroup Support</span>
<a name="l00523"></a>00523 <span class="comment"> */</span>
<a name="l00524"></a><a class="code" href="classPassenger_1_1BufferedUpload.html">00524</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1BufferedUpload.html" title="Represents a buffered upload file.">BufferedUpload</a> {
<a name="l00525"></a>00525 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00526"></a>00526 <span class="comment"> /** The file handle. */</span>
<a name="l00527"></a><a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac">00527</a> FILE *<a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac" title="The file handle.">handle</a>;
<a name="l00528"></a>00528 <span class="comment"></span>
<a name="l00529"></a>00529 <span class="comment"> /**</span>
<a name="l00530"></a>00530 <span class="comment"> * Create an empty upload bufer file, and open it for reading and writing.</span>
<a name="l00531"></a>00531 <span class="comment"> *</span>
<a name="l00532"></a>00532 <span class="comment"> * @throws SystemException Something went wrong.</span>
<a name="l00533"></a>00533 <span class="comment"> */</span>
<a name="l00534"></a><a class="code" href="classPassenger_1_1BufferedUpload.html#51489619731ea95c2ece27faab9e24fc">00534</a> <a class="code" href="classPassenger_1_1BufferedUpload.html#51489619731ea95c2ece27faab9e24fc" title="Create an empty upload bufer file, and open it for reading and writing.">BufferedUpload</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &dir, <span class="keyword">const</span> <span class="keywordtype">char</span> *identifier = <span class="stringliteral">"temp"</span>) {
<a name="l00535"></a>00535 <span class="keywordtype">char</span> templ[PATH_MAX];
<a name="l00536"></a>00536 <span class="keywordtype">int</span> fd;
<a name="l00537"></a>00537
<a name="l00538"></a>00538 snprintf(templ, <span class="keyword">sizeof</span>(templ), <span class="stringliteral">"%s/%s.XXXXXX"</span>, dir.c_str(), identifier);
<a name="l00539"></a>00539 templ[<span class="keyword">sizeof</span>(templ) - 1] = <span class="charliteral">'\0'</span>;
<a name="l00540"></a>00540 fd = mkstemp(templ);
<a name="l00541"></a>00541 <span class="keywordflow">if</span> (fd == -1) {
<a name="l00542"></a>00542 <span class="keywordtype">char</span> message[1024];
<a name="l00543"></a>00543 <span class="keywordtype">int</span> e = errno;
<a name="l00544"></a>00544
<a name="l00545"></a>00545 snprintf(message, <span class="keyword">sizeof</span>(message), <span class="stringliteral">"Cannot create a temporary file '%s'"</span>, templ);
<a name="l00546"></a>00546 message[<span class="keyword">sizeof</span>(message) - 1] = <span class="charliteral">'\0'</span>;
<a name="l00547"></a>00547 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(message, e);
<a name="l00548"></a>00548 }
<a name="l00549"></a>00549
<a name="l00550"></a>00550 <span class="comment">/* We use a POSIX trick here: the file's permissions are set to "u=,g=,o="</span>
<a name="l00551"></a>00551 <span class="comment"> * and the file is deleted immediately from the filesystem, while we</span>
<a name="l00552"></a>00552 <span class="comment"> * keep its file handle open. The result is that no other processes</span>
<a name="l00553"></a>00553 <span class="comment"> * will be able to access this file's contents anymore, except us.</span>
<a name="l00554"></a>00554 <span class="comment"> * We now have an anonymous disk-backed buffer.</span>
<a name="l00555"></a>00555 <span class="comment"> */</span>
<a name="l00556"></a>00556 fchmod(fd, 0000);
<a name="l00557"></a>00557 unlink(templ);
<a name="l00558"></a>00558
<a name="l00559"></a>00559 <a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac" title="The file handle.">handle</a> = fdopen(fd, <span class="stringliteral">"w+"</span>);
<a name="l00560"></a>00560 }
<a name="l00561"></a>00561
<a name="l00562"></a>00562 ~<a class="code" href="classPassenger_1_1BufferedUpload.html" title="Represents a buffered upload file.">BufferedUpload</a>() {
<a name="l00563"></a>00563 fclose(<a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac" title="The file handle.">handle</a>);
<a name="l00564"></a>00564 }
<a name="l00565"></a>00565 };
<a name="l00566"></a>00566 <span class="comment"></span>
<a name="l00567"></a>00567 <span class="comment">/**</span>
<a name="l00568"></a>00568 <span class="comment"> * Fills the given memory space or string with zeroes when a MemoryZeroGuard object</span>
<a name="l00569"></a>00569 <span class="comment"> * is destroyed. Useful for ensuring that buffers containing password data or</span>
<a name="l00570"></a>00570 <span class="comment"> * other sensitive information is cleared when it goes out of scope.</span>
<a name="l00571"></a>00571 <span class="comment"> */</span>
<a name="l00572"></a><a class="code" href="classPassenger_1_1MemZeroGuard.html">00572</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1MemZeroGuard.html" title="Fills the given memory space or string with zeroes when a MemoryZeroGuard object...">MemZeroGuard</a> {
<a name="l00573"></a>00573 <span class="keyword">private</span>:
<a name="l00574"></a>00574 <span class="keywordtype">void</span> *data;
<a name="l00575"></a>00575 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size;
<a name="l00576"></a>00576 <span class="keywordtype">string</span> *str;
<a name="l00577"></a>00577
<a name="l00578"></a>00578 <span class="keyword">static</span> <span class="keywordtype">void</span> securelyZeroMemory(<span class="keyword">volatile</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
<a name="l00579"></a>00579 <span class="comment">/* We do not use memset() here because the compiler may</span>
<a name="l00580"></a>00580 <span class="comment"> * optimize out memset() calls. Instead, the following</span>
<a name="l00581"></a>00581 <span class="comment"> * code is guaranteed to zero the memory.</span>
<a name="l00582"></a>00582 <span class="comment"> * http://www.dwheeler.com/secure-programs/Secure-Programs-HOWTO/protect-secrets.html</span>
<a name="l00583"></a>00583 <span class="comment"> */</span>
<a name="l00584"></a>00584 <span class="keyword">volatile</span> <span class="keywordtype">char</span> *p = (<span class="keyword">volatile</span> <span class="keywordtype">char</span> *) data;
<a name="l00585"></a>00585 <span class="keywordflow">while</span> (size--) {
<a name="l00586"></a>00586 *p++ = 0;
<a name="l00587"></a>00587 }
<a name="l00588"></a>00588 }
<a name="l00589"></a>00589
<a name="l00590"></a>00590 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00591"></a>00591 <span class="comment"> /**</span>
<a name="l00592"></a>00592 <span class="comment"> * Creates a new MemZeroGuard object with a memory region to zero.</span>
<a name="l00593"></a>00593 <span class="comment"> *</span>
<a name="l00594"></a>00594 <span class="comment"> * @param data The data to zero after destruction.</span>
<a name="l00595"></a>00595 <span class="comment"> * @param size The size of the data.</span>
<a name="l00596"></a>00596 <span class="comment"> * @pre data != NULL</span>
<a name="l00597"></a>00597 <span class="comment"> */</span>
<a name="l00598"></a><a class="code" href="classPassenger_1_1MemZeroGuard.html#73d032a0d185fe1a70683fbf25d12b50">00598</a> <a class="code" href="classPassenger_1_1MemZeroGuard.html#73d032a0d185fe1a70683fbf25d12b50" title="Creates a new MemZeroGuard object with a memory region to zero.">MemZeroGuard</a>(<span class="keywordtype">void</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
<a name="l00599"></a>00599 this->data = data;
<a name="l00600"></a>00600 this->size = size;
<a name="l00601"></a>00601 this->str = NULL;
<a name="l00602"></a>00602 }
<a name="l00603"></a>00603 <span class="comment"></span>
<a name="l00604"></a>00604 <span class="comment"> /**</span>
<a name="l00605"></a>00605 <span class="comment"> * Creates a new MemoryZeroGuard object with a string to zero.</span>
<a name="l00606"></a>00606 <span class="comment"> *</span>
<a name="l00607"></a>00607 <span class="comment"> * @param str The string to zero after destruction.</span>
<a name="l00608"></a>00608 <span class="comment"> */</span>
<a name="l00609"></a><a class="code" href="classPassenger_1_1MemZeroGuard.html#f2c179005d02719cee006280ffbba345">00609</a> <a class="code" href="classPassenger_1_1MemZeroGuard.html#f2c179005d02719cee006280ffbba345" title="Creates a new MemoryZeroGuard object with a string to zero.">MemZeroGuard</a>(<span class="keywordtype">string</span> &str) {
<a name="l00610"></a>00610 this->data = NULL;
<a name="l00611"></a>00611 this->size = NULL;
<a name="l00612"></a>00612 this->str = &str;
<a name="l00613"></a>00613 }
<a name="l00614"></a>00614 <span class="comment"></span>
<a name="l00615"></a>00615 <span class="comment"> /**</span>
<a name="l00616"></a>00616 <span class="comment"> * Zero the data immediately. The data will still be zeroed after</span>
<a name="l00617"></a>00617 <span class="comment"> * destruction of this object.</span>
<a name="l00618"></a>00618 <span class="comment"> */</span>
<a name="l00619"></a><a class="code" href="classPassenger_1_1MemZeroGuard.html#fbefb3b41c341bcaeaa9c23f698df15c">00619</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MemZeroGuard.html#fbefb3b41c341bcaeaa9c23f698df15c" title="Zero the data immediately.">zeroNow</a>() {
<a name="l00620"></a>00620 <span class="keywordflow">if</span> (str == NULL) {
<a name="l00621"></a>00621 securelyZeroMemory(data, size);
<a name="l00622"></a>00622 } <span class="keywordflow">else</span> {
<a name="l00623"></a>00623 securelyZeroMemory((<span class="keyword">volatile</span> <span class="keywordtype">void</span> *) str->c_str(), str->size());
<a name="l00624"></a>00624 }
<a name="l00625"></a>00625 }
<a name="l00626"></a>00626
<a name="l00627"></a>00627 ~<a class="code" href="classPassenger_1_1MemZeroGuard.html" title="Fills the given memory space or string with zeroes when a MemoryZeroGuard object...">MemZeroGuard</a>() {
<a name="l00628"></a>00628 <a class="code" href="classPassenger_1_1MemZeroGuard.html#fbefb3b41c341bcaeaa9c23f698df15c" title="Zero the data immediately.">zeroNow</a>();
<a name="l00629"></a>00629 }
<a name="l00630"></a>00630 };
<a name="l00631"></a>00631
<a name="l00632"></a>00632 } <span class="comment">// namespace Passenger</span>
<a name="l00633"></a>00633
<a name="l00634"></a>00634 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_UTILS_H_ */</span>
<a name="l00635"></a>00635
</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>
|
